How to get the identity verification report via API?
The Identity Verification report provides a summary of the information extracted from the document uploaded by the signer such as the verification status, verification date and the documents uploaded. This report is generated following the completion of the verification process, whether it is successful or unsuccessful.
To generate a verification report, the sender must provide the documentId of the document for which the report is to be generated and the emailId of the user for whom the report is requested. If SMS delivery mode was used, the sender can specify the documentId along with the country code and phone number values.
Note:Access to this report is restricted to the sender of the document, ensuring that sensitive verification details are only available to those who initiated the verification request.
Below are examples of how to generate verification report via API:
Code snippet
curl --location 'https://api.boldsign.com/v1-beta/identityVerification/report?documentId={document id}' \
--header 'accept: application/json' \
-H 'X-API-KEY: {your api key}' \
--header 'Content-Type: application/json' \
--data-raw '{
"emailId": "alexgayle@cubeflakes.com",
"order": 1
}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your-api-key}");
var idVerificationClient = new IdVerificationClient(apiClient);
var documentId = "{document id}";
var verificationReportRequest = new VerificationReportRequest()
{
EmailId = "alexgayle@cubeflakes.com",
Order = 1,
};
var idVerificationReport = idVerificationClient.GetReport(documentId, verificationReportRequest);
import requests
import json
url = "https://api.boldsign.com/v1-beta/identityVerification/report?documentId={document id}"
payload = {
"emailId": "alexgayle@cubeflakes.com",
"order": 1
}
headers = {
'accept': 'application/json',
'X-API-KEY': '{your-api-key}',
'Content-Type': 'application/json'
}
response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.text)
const axios = require('axios');
const url = "https://api.boldsign.com/v1-beta/identityVerification/report?documentId={document id}";
const payload = {
emailId: "alexgayle@cubeflakes.com",
order: 1
};
const headers = {
'Accept': 'application/json',
'X-API-KEY': '{your-api-key}',
'Content-Type': 'application/json'
};
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/report?documentId={your document id}';
$payload = [
'emailId' => 'alexgayle@cubeflakes.com',
'order' => 1
];
$headers = [
'Accept' => 'application/json',
'X-API-KEY' => '{your-api-key}',
'Content-Type' => 'application/json'
];
$client = new GuzzleHttp\Client([ 'verify' => false, ]);
$response = $client->post($url, [
'headers' => $headers,
'json' => $payload
]);
echo $response->getBody()->getContents();
In the provided code example, make sure to replace values for documentId with the ID of the document that you want to fetch the report from. Additionally, provide the emailId value with the email address of the user for whom 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, verifcation report is generated with verification status, verification date and the document used for verification.