Get Embedded Sign URL

get/embedded/sign_url/{signature_id}

Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.

Securityapi_key or oauth2
Request
path Parameters
signature_id
required
string

The id of the signature to get a signature url for.

Example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b
Responses
200

successful operation

4XX

failed_operation

Request samples
<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = HelloSignSDK\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$api = new HelloSignSDK\Api\EmbeddedApi($config);

$signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b";

try {
    $result = $api->embeddedSignUrl($signatureId);
    print_r($result);
} catch (HelloSignSDK\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling HelloSign API: "
        . print_r($error->getError());
}
Response samples
application/json