Copy page
Copy original Markdown fileEmbedded Manual Verification
In certain instances where automatic identity verification may not be able to verify the identity, senders have the option to manually review uploaded documents that have failed verification. This process is known as Embedded Manual Verification. The sender can review the uploaded document and manually verify the signer's identity. This process is initiated by the sender and is accessible only to the sender.
post/v1/identityVerification/createEmbeddedVerificationUrlCode snippet
curl -X POST 'https://api.boldsign.com/v1/identityVerification/createEmbeddedVerificationUrl?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: {your-api-key}' \
-d '{
"EmailId": "alex.gayle@cubeflakes.com",
"Order": 1,
"RedirectUrl": "https://boldsign.com/"
}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your-api-key}");
var idVerificationClient = new IdVerificationClient(apiClient);
var documentId = "55a6f0cf-xxx-xxxx-xxxx-796d02cb0977";
var embeddedVerificationRequest = new EmbeddedVerificationRequest()
{
EmailId = "alex.gayle@cubeflakes.com",
Order = 1,
RedirectUrl = "https://boldsign.com/",
};
var embeddedVerificationCreated = idVerificationClient.CreateEmbeddedVerificationUrl(documentId, embeddedVerificationRequest);
import boldsign
configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
identity_verification_api = boldsign.IdentityVerificationApi(api_client)
create_embedded_verification_url = boldsign.EmbeddedFileDetails(
emailId="alex.gayle@cubeflakes.com",
countryCode="+91",
phoneNumber="1234567890",
redirectUrl="www.boldsign.com",
order=1
)
document_id = "YOUR_DOCUMENT_ID" #need to give the document id which is failed in all attempts.
url_response = identity_verification_api.create_embedded_verification_url(document_id, create_embedded_verification_url)
print("Embedded url to approve verification from sender: " ,url_response)
<?php
require_once(__DIR__ . '/../vendor/autoload.php');
// Configure API key authorization: X-API-KEY
$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');
$apiInstance = new BoldSign\Api\IdentityVerificationApi($config);
$document_id = "YOUR_DOCUMENT_ID";
$embedded_manual_verification_request = new \BoldSign\Model\EmbeddedFileDetails();
$embedded_manual_verification_request->setEmailId("alex.gayle@cubeflakes.com");
$embedded_manual_verification_request->setCountryCode("+91");
$embedded_manual_verification_request->setPhoneNumber("1234567890");
$embedded_manual_verification_request->setOrder(1);
$embedded_manual_verification_request->setRedirectUrl("www.boldsign.com");
try {
$result = $apiInstance->createEmbeddedVerificationUrl($document_id, $embedded_manual_verification_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IdentityVerificationApi->embeddedManualVerification: ', $e->getMessage(), PHP_EOL;
}
ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
IdentityVerificationApi identityVerificationApi = new IdentityVerificationApi(apiClient);
String document_id ="YOUR_DOCUMENT_ID";
EmbeddedFileDetails embeddedFileDetails = new EmbeddedFileDetails();
embeddedFileDetails.setEmailId("alex.gayle@cubeflakes.com");
embeddedFileDetails.setCountryCode("+91");
embeddedFileDetails.setPhoneNumber("0123456789");
embeddedFileDetails.setRedirectUrl("www.boldsign.com");
try {
EmbeddedFileLink verificationUrl = identityVerificationApi.createEmbeddedVerificationUrl(document_id, embeddedFileDetails);
System.out.println(verificationUrl);
} catch (Exception e) {
System.err.println("Exception when calling IdentityVerificationApi-->createEmbeddedVerificationUrl");
e.printStackTrace();
}
import { IdentityVerificationApi } from "../api/identityVerificationApi";
import { EmbeddedFileDetails } from "../model";
const identityVerificationApi = new IdentityVerificationApi();
identityVerificationApi.setApiKey("YOUR_API_KEY");
var manual_verification = new EmbeddedFileDetails();
manual_verification.emailId = "alex.gayle@cubeflakes.com";
manual_verification.countryCode = "+91";
manual_verification.phoneNumber = "1234567890";
manual_verification.redirectUrl = "www.boldsign.com";
var document_id = "YOUR_DOCUMENT_ID";
async function createEmbeddedManualVerification() {
try {
var verification_url = await identityVerificationApi.createEmbeddedVerificationUrl(document_id,manual_verification);
console.log(verification_url);
} catch (error:any) {
console.error("Error occurred while calling the API:", error.message);
}
}
createEmbeddedManualVerification();
Query parameters
| documentIdstring Required | The document ID of the signer uploaded document for which the report is to be fetched. |
Request body
| EmailIdstring | The email address of the user for which the report is to be fetched. Required when Email delivery mode is assigned for the signer. |
| CountryCodestring | The country code of the user for which the report is to be fetched. Required when SMS delivery mode is assigned for the signer. |
| PhoneNumberstring | The phone number of the user for which the report is to be fetched. Required when SMS delivery mode is assigned for the signer. |
| Orderinteger | The order of the signer. |
| RedirectUrlstring | The URL to which the sender is redirected after the verification process is completed. |
| OnBehalfOfstring | The email address of the user on behalf of whom the report is to be fetched. Required when the sender is fetching the report on behalf of the sender identity. |
Example response
200 Success
{
"url": "https://account.boldsign.com/identity/verifyIdentity/?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977xxxx"
}