Document Verification API

API FOR BACKGROUND VERIFICATION OF IDENTITY AND OTHER DOCUMENTS

Introduction

Document verification API is one among the suite of background check APIs offered by the Attestr Platform. Use this API to place orders for offline verification of identity documents.

API Details

Request

Type	URL
POST	`https://api.attestr.com`/api/`{version}`/public/factx/async/document

Request Header Parameters

Type	Name	Value / Description	Optional	Min Version	Max Version
String	Content-Type	application/json	Required	v1
String	Authorization	Basic `{authToken}`	Required	v1

If you do not have the authentication token, please refer to Register App to generate one.

Request Body Parameters

Type	Name	Description	Optional (default)	Min Version
String	tag	Unique employee Id / reference id to be passed by the client	Required	v1
String	reg	Unique document number as available on the document	Required	v1
String	docType	Type of the document. Following values are allowed. AADHAAR, PAN, DL, VOTER, PASSPORT, CUSTOM	Optional	v1
String[]	documents	Array of supporting document Ids. To generate document Ids, first upload each document using Document Upload	Optional	v1
Boolean	webhook	Boolean flag to be used for triggering webhooks once record is updated. More details below.	Optional	v1

Sample Request

JSON
    
 
{  "tag": "ABCD1234",  "reg": "AHJPT1529R",  "docType": "PAN",  "documents": ["MX17Cd6KEBSsbKSaou"],  "webhook": false}
Copy

Response Details

Http Status 200

Key	Description	Type	Min Version	Max Version
_id	Unique request Id to be used later for querying the result	String	v1
number	Unique human readable number to be used for any reference later	String	v1

Sample Output
    
 
{  "_id": "AR02zfeuv2iz5ksij09nf",  "number": "3801-575765-9695"}
Copy

Querying Document Check Result

Get Document Async Request Outcome API

Type	URL	Min Version	Max Version
GET	`https://api.attestr.com`/api/{version}/public/async/<asyncId>	v1

Request Header Parameters

Type	Name	Value / Description	Optional	Min Version	Max Version
String	Content-Type	application/json	Required	v1
String	Authorization	Basic `{authToken}`	Required	v1

Request URL Parameters

Name	Description	Min Version	Max Version
asyncId	Replace <asyncId> in the URL with the _id received in the document verification API response as described above.	v1

Response

Http Status 200

Key	Description	Type	Min Version
_id	Request Id as queried in the URL	String	v1
number	Request number	String	v1
requestId	Unique ID used by Attestr for request tracing purposes	String	v1
status	Status of the request. Possible values are - COMPLETED, INITIATED, ERRORED	String	v1
input	The input details used for verification	String	v1
output	Document check output object. Details described as below. Null if status is errored or initiated.	DocumentCheckOutputRecord	v1
error	Error object if the operation ran into errors, null otherwise. Null if status is completed or initiated.	String	v1
created	Unix timestamp when the request was placed.	Number	v1
updated	Unix timestamp when the request was last updated. Null if status is initiated.	Number	v1
signature	Signature generated using the output and client secret. Used for validating the accuracy of data. Null if status is errored or initiated.	String	v1

Document Check Output Record

Key	Description	Type	Min Version
status	One of Clear, Alert, False, MoreInfo, NoResult	String	v1
mode	Mode of verification e.g Online, Offline, Physical, Email, Telephone etc	String	v1
verified	Date on which verified data was received from the institution. For online verification, it is the date on which verification was performed. DD-MM-YYYY	Date	v1
verifier	Name of the verifying body / individual	String	v1
authority	Name of the individual or department that verified the document	String	v1
description	Description text provided by Attestr back office for each verification. This text is particularly useful for alert and false cases. HTML formatted string.	String	v1
documents	List of supporting verified letter, documents as received or prepared	Array[String]	v1
voiceRecords	In case the verification has been performed over the phone, it contains an array of voice recording media Ids. In most cases, this will be null.	Array[String]	v1

Sample Output

JSON
    
{    "status": "Clear",    "documents": [      "MX1xRollD8Szmm4iI7","MX1xX1geabcdeem4iI7"    ],    "voiceRecords": null,    "description": "The provided PAN document is valid. The same has been matched against the NSDL database and details are found to be matching.",    "verifier": "NSDL Website",    "authority": "NSDL",    "verified": "09-02-2022",    "mode": "Online"  }
Copy

Error Response

Parameter	Type	Description
code	Number	Unique error codes for different errors. Always available.
message	String	Error message describing the error. Always Available.
details	String	Detail error message. Available only for certain types of errors.

Error Codes

HTTP Status	Error Code	Error Message
400	4001	Malformed data or missing required parameter values
400	4005	Operation could not be performed due to low credits balance
401	4016	Invalid client authorization
403	4031	Unauthorized access
403	4035	Requested service is not provisioned for your account
403	4039	Client's IP address is not whitelisted
403	4035	Requested service is not provisioned for your account
429	4291	Maximum account rate limit exceeded
429	4292	Maximum API rate limit exceeded
429	4293	Maximum account daily limit exceeded
429	4294	Maximum API daily limit exceeded
500	5001	Request could not be processed

Sample Error Response

JSON
    
 
{  "code": 4001,  "message": "Malformed data or missing required parameter values"}
Copy

Webhooks

This check supports the following two webhook events.

See Webhooks for more details on how to register webhooks.

async.completed
async.errored

To enable webhooks, the API input parameter webhook must be set as true while initiating the request.

Webhook Event Payload

Key	Type	Description	Min Version
_id	String	ID of the async request. This is same as received in the output of Person / Business search API as described above.	v1
requestId	String	Unique request ID for internal tracing purposes.	v1
status	String	One of INITIATED, COMPLETED OR ERRORED	v1
output	Object	Document Check output record same as output key described in Querying Result API above.
error	Object	Error object if the check runs into errors. The structure of this is same as the Error Response object described above.	v1
signature	String	generated using hmacHexDigest of output object and client secret. Null if archived.

Last updated on