Identity Verification Report

The Identity Verification report offers a detailed summary of the fields extracted from the signer-uploaded document for a specified signer. This report is accessible upon either successful or failed completion of the verification process by the signer and is only accessible to the sender.

post/v1/identityVerification/report

Code snippet

curl -X POST 'https://api.boldsign.com/v1/identityVerification/report?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977' \
-h 'accept: application/json' \
-h 'X-API-KEY: {your-api-key}' \
-h 'Content-Type: application/json' \
-d '{
    "EmailId": "[email protected]",
    "Order": 1
}'

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

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

var verificationReportRequest = new VerificationReportRequest()
{
    EmailId = "[email protected]",
    Order = 1,
};

var idVerificationReport = idVerificationClient.GetReport(documentId, verificationReportRequest);

import requests
import json

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

payload = {
    "emailId": "[email protected]",
    "order": 1
}
headers = {
    'accept': 'application/json',
    'X-API-KEY': '{your-api-key}', # Replace {your-api-key} with your actual 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/identityVerification/report?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977";

const payload = {
    emailId: "[email protected]",
    order: 1
};

const headers = {
    'Accept': 'application/json',
    'X-API-KEY': '{your-api-key}', // Replace {your-api-key} with your actual 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/identityVerification/report?documentId=55a6f0cf-xxx-xxxx-xxxx-796d02cb0977';

$payload = [
    'emailId' => '[email protected]',
    'order' => 1
];

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

$client = new Client();

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

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

?>

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.
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

{
    "verificationResult": "success",
    "verifiedDate": "2024-03-07T10:47:37Z",
    "document": {
        "type": "passport",
        "firstName": "Alex",
        "lastName": "Gayle",
        "country": "US",
        "documentNumber": "000000000",
        "address": null,
        "dob": null,
        "issuedDate": {
            "day": 1,
            "month": 1,
            "year": 2015
        },
        "expirationDate": {
            "day": 12,
            "month": 1,
            "year": 2030
        },
        "documentFiles": [
            "2e96f9ad-da62-43aa-88a9-3063e73f04f8"
        ],
        "selfieFile": "2736ff3f-4a1d-49b4-94b4-43423401a566"
    }
}