Embedded 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-beta/identityVerification/createEmbeddedVerificationUrl

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.

Code snippet

curl --location 'https://api.boldsign.com/v1-beta/identityVerification/createEmbeddedVerificationUrl?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {your-api-key}' \
--data-raw '{
  "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 requests
import json

url = "https://api.boldsign.com/v1-beta/identityVerification/createEmbeddedVerificationUrl?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977"

payload = {
  "emailId": "alex.gayle@cubeflakes.com",
  "order": 1,
  "redirectUrl": "https://boldsign.com/"
}
headers = {
  'Content-Type': 'application/json',
  'X-API-KEY': '{your-api-key}'
}

response = requests.request("POST", url, headers=headers, data=json.dumps(payload))

print(response.text)

const axios = require('axios');

const url = "https://api.boldsign.com/v1-beta/identityVerification/createEmbeddedVerificationUrl?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977";

const payload = {
  emailId: "alex.gayle@cubeflakes.com",
  order: 1,
  redirectUrl: "https://boldsign.com/"
};

const headers = {
  'Content-Type': 'application/json',
  'X-API-KEY': '{your-api-key}' // Replace {your-api-key} with your actual API key
};

axios.post(url, payload, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.response.data);
  });

<?php

require 'vendor/autoload.php'; // Path to your autoload.php file

use GuzzleHttp\Client;

$url = 'https://api.boldsign.com/v1-beta/identityVerification/createEmbeddedVerificationUrl?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977';

$payload = [
    'emailId' => 'alex.gayle@cubeflakes.com',
    'order' => 1,
    'redirectUrl' => 'https://boldsign.com/'
];

$headers = [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '{your-api-key}' // Replace {your-api-key} with your actual API key
];

$client = new Client();

$response = $client->post($url, [
    'headers' => $headers,
    'json' => $payload
]);

echo $response->getBody()->getContents();

?>

Example response

200 Success

{
    "url": "https://account.boldsign.com/identity/verifyIdentity/?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977xxxx"
}