API Guide

Global ID Recognition API

22min

The Global ID Recognition API processes and verifies identification documents by analyzing both the front and back images of the ID, along with the issuing country and ID type. This API ensures the authenticity and validity of the provided ID through detailed OCR (Optical Character Recognition) and provides comprehensive results.



✅ Checklist

1

If your organization or service maintains stric security policies by denying access to most or all external websites, it's likely you'll need to add our static IP to a whitelist.

2

Please request [email protected] to Whitelist IP Address


The Global ID Recognition API verifies identification documents by analyzing the front and back images, issuing country, and ID type using detailed OCR (Optical Character Recognition) to ensure authenticity and validity.
POST
Request
Header Parameters
x-api-key
required
String
Workspace API Key
Body Parameters
idImage
required
String
<base64>
idBackImage
optional
String
<base64>
issuingCountry
required
String
ISO 3 Alpha Country Codes refer to https://docs.argosidentity.com/iso-alpha-3-country-codes
idType
required
String
idType - select one IdType mentioned in https://docs.argosidentity.com/idtypes
callbackUrl
required
String
Endpoint to receive the response upon successful processing


Image File Restrictions

Supported File Formats : JPEG, JPG, PNG, BMP

File Size Limit : Recommended File Size 1MB (Maximum File Size under 2MB)

Recommended Resolution and ID Card Width&Height : 125 DPI (421x266)

Error Codes

1001

Workspace is unavailable



1005

idImage is required



1006

issuingCountry is required



1010

callbackUrl is required



1012

Fail to recognize back of an idCard



1013

Invalid image format



1014

idType is required



1015

invalid inputs : {missing fields}



Callback URL Response

Parameters

statusCode number

Status Code for the API request result



apiType string

API Type



transactionId string

Unique identifier for each request



result object

Object containing the processing result



result.document_type string

Recognized ID document type



result.review_front boolean

Presence of recognition result for the front side of the ID



result.review_back boolean

Presence of recognition result for the back side of the ID



result.data object

Object containing the recognition results



result.data.raw object

Raw OCR Data Object



result.data.raw[*] object

Object for each recognized field in the Raw OCR data



result.data.raw[*].value string

Recognition value of (A)



result.data.raw[*].score number

Confidence score of (A)



result.data.raw[*].accepted boolean

Validity of (A)



result.data.raw[*].coordinates object

Bounding Box object for (A)



result.data.raw[*].coordinates.[n] object

Each vertex n of the Bounding Box for (A)

n : first, second, third, fourth



result.data.raw[*].coordinates.[n].x number

x coordinate of each vertex n of the Bounding Box for (A)



result.data.raw[*].coordinates.[n].y number

y coordinate of each vertex n of the Bounding Box for (A)



result.data.ocr object

Processed OCR result object based on confidence and validity = (B)



result.data.ocr.ocr_{*} string

Result value of each field in (B)



Callback Response Example

Success
Error



Error Codes

1003

Fail to process data



1011

Fail to recognize idCard