Identity Verification Image

The images uploaded by the signer for identity verification can be fetched using the Identity Verification Image API. These images can be accessed upon either successful or failed completion of the verification process by the signer and are accessible only to the sender. To fetch the images, you will first need the image file ID of the signer-uploaded document. This file ID can be fetched using the Identity Verification report API.

post/v1-beta/identityVerification/image

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.
fileIdstring	The image file ID of the signer uploaded document.
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/image?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,
  "fileId": "2e96f9ad-xxxx-xxxx-xxxx-3063e73f04f8"
}'

var apiClient = new ApiClient("https://api.boldsign.com", "{your-api-key}");
var idVerificationClient = new IdVerificationClient(apiClient);

var documentId = "55a6f0cf-xxx-xxxx-xxxx-796d02cb0977";

var verificationImageRequest = new VerificationImageRequest()
{
    EmailId = "alex.gayle@cubeflakes.com",
    FileId = "2e96f9ad-xxxx-xxxx-xxxx-3063e73f04f8",
    Order = 1,
};

var idVerificationImage = idVerificationClient.GetImage(documentId, verificationImageRequest);

import requests
import json

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

payload = {
  "emailId": "alex.gayle@cubeflakes.com",
  "order": 1,
  "fileId": "2e96f9ad-xxxx-xxxx-xxxx-3063e73f04f8"
}
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/image?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977";

const payload = {
  emailId: "alex.gayle@cubeflakes.com",
  order: 1,
  fileId: "2e96f9ad-xxxx-xxxx-xxxx-3063e73f04f8"
};

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';

use GuzzleHttp\Client;

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

$payload = [
    'emailId' => 'alex.gayle@cubeflakes.com',
    'order' => 1,
    'fileId' => '2e96f9ad-xxxx-xxxx-xxxx-3063e73f04f8'
];

$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

Contains the image file.