Get Uploaded Identity Verification Documents

BoldSign allows you to fetch the document uploaded by the signer for identity verification via API. These images are available whether the verification process is successful or fails, and they can only be accessed by the sender.

To retrieve these images, you first need the image file ID associated with the signer-uploaded document. This file ID can be obtained through the Identity Verification Report API, which provides details about the verification process and the associated file IDs. Refer to this for verificaton report.

Once you have the file ID, you can make a request to the Identity Verification Image API to access the images. This ensures you can review and validate the documents submitted by the signer during the verification process.

Below are examples of how to get the uploaded verification document via API:

Code snippet

curl --location 'https://api.boldsign.com/v1-beta/identityVerification/image?documentId={document Id}' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {your-api-key}' \
--data-raw '{
  "emailId": "[email protected]",
  "order": 1,
  "fileId": "{file Id}"
}'

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

var documentId = "{document Id}";

var verificationImageRequest = new VerificationImageRequest()
{
    EmailId = "[email protected]",
    FileId = "{file Id}",
    Order = 1,
};

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

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    identity_verification_api = boldsign.IdentityVerificationApi(api_client)
    identity_verification_image = boldsign.DownloadImageRequest(
       emailId="[email protected]",
       fileId="YOUR_FILE_ID",
       order=1
    )
    image_response = identity_verification_api.image("YOUR_DOCUMENT_ID", identity_verification_image)

import { IdentityVerificationApi, DownloadImageRequest } from "boldsign";

const identityVerificationApi = new IdentityVerificationApi("https://api.boldsign.com");
identityVerificationApi.setApiKey("YOUR_API_KEY");

const imageRequest = new DownloadImageRequest();
imageRequest.emailId = "[email protected]";
imageRequest.fileId = "YOUR_FILE_ID";
imageRequest.order = 1;

const idVerificationImage = identityVerificationApi.image("YOUR_DOCUMENT_ID", imageRequest);

<?php require 'vendor/autoload.php';

$config = new BoldSign\Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$apiInstance = new BoldSign\Api\IdentityVerificationApi($config);

$imageRequest = new \BoldSign\Model\DownloadImageRequest();
$imageRequest->setEmailId("[email protected]");
$imageRequest->setFileId("YOUR_FILE_ID");
$imageRequest->setOrder(1);

$result = $apiInstance->image("YOUR_DOCUMENT_ID", $imageRequest);


ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setBasePath("https://api.boldsign.com");
apiClient.setApiKey("YOUR_API_KEY");

IdentityVerificationApi identityVerificationApi = new IdentityVerificationApi(apiClient);

DownloadImageRequest downloadImageRequest = new DownloadImageRequest();
downloadImageRequest.setEmailId("[email protected]");
downloadImageRequest.setFileId("YOUR_FILE_ID");
downloadImageRequest.setOrder(1);

File idVerificationImage = identityVerificationApi.image("YOUR_DOCUMENT_ID", downloadImageRequest);

In the provided code example, make sure to replace values for documentId with the ID of the document that you want to fetch the document from. Additionally, provide thefileId with the image file ID of the signer uploaded document, emailId value with the email address of the user for which the report is to be fetched. If signing order was enabled, you can specify the order value to differentiate which order you are getting the report from. Once the codes are executed, verification images will be compiled and downloaded in a zip file.