ARGOS

Verify Developer Documentation - ARGOS Identity

ARGOS Verify

Go back to Dev Guide

Global ID Recognition

Global ID Recognition API

Callback Response Example

Best Practices for Image

ID Liveness

ID Liveness API

Callback Response Exmaple

Face Compare

Face Compare API

Face Liveness

Face Liveness API

Photo Guidelines

Glossary

Supported ID types

ID Types

ISO Alpha 3 Country Codes

Blank

verify-id

Production

<p class="slate-p " >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. </p><p class="slate-p " ></p>

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. 

Image of the front side of the ID document in base64 format.

idImage

Image of the back side of the ID document in base64 format.

idBackImage

The ISO 3 Alpha Country Code of the issuing country for the ID document.

issuingCountry

The type of the ID document (e.g., Passport, Driver's License).

idType

The URL where the recognition results will be sent upon completion. If a callbackUrl is provided, the process works asynchronously, and you can refer to the Callback Response Example page for details. If no callbackUrl is provided, the process operates synchronously.

callbackUrl

API key essential for authentication and access control purposes, required for authorization.

x-api-key

apiType

result

transactionId

Everything worked as expected. When callbackUrl is not provided results are returned synchronously in the immediate response.

Unique identifier for the transaction associated with the recognition request.

Information message returned as part of the recognition response.

message

Everything worked as expected.  When callbackUrl is provided results are sent asynchronously to the specified callbackUrl upon completion.

statusCode

Identifies the specific error for troubleshooting.

errorCode

Briefly describes the error. Please refer to the error code for details.

The 400 status code indicates that the request was unacceptable, often due to missing a required parameter. In synchronous operations, where callbackUrl is not provided, the error is detected during request validation. 

The 400 status code indicates that the request was unacceptable, often due to missing a required parameter. In asynchronous operations, where callbackUrl is provided, the error is detected during request validation. 

Success

Error

<p class="slate-p " >The Callback Response Example section offers users a glimpse into the anticipated responses they will receive from API interactions, aiding in the understanding of response structure and format. By leveraging these examples, developers can enhance their integration process and streamline development efforts, ensuring seamless communication between their application and the API. This section serves as a valuable resource for testing and refining integrations effectively.</p><p class="slate-p " >The Callback Response Example section showcases sample responses that users can anticipate from API interactions, providing clarity on response structure and format. By utilizing these </p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

The Callback Response Example section offers users a glimpse into the anticipated responses they will receive from API interactions, aiding in the understanding of response structure and format. By leveraging these examples, developers can enhance their integration process and streamline development efforts, ensuring seamless communication between their application and the API. This section serves as a valuable resource for testing and refining integrations effectively.

The Callback Response Example section showcases sample responses that users can anticipate from API interactions, providing clarity on response structure and format. By utilizing these 

<p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >To ensure optimal performance and accuracy, the following image file guidelines must be followed. We support a variety of file formats, with specific recommendations for file size and resolution to ensure the best results. Please adhere to these standards for smoother and faster identity verification processing:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Supported File Formats:</strong> JPEG, JPG, PNG, BMP</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">File Size Limit:</strong> Recommended file size 1MB (maximum limit under 2MB)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Recommended Resolution and ID Card Dimensions:</strong> 125 DPI (421x266)</div></li></ul></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >The ID Liveness API section allows users to verify the authenticity of an ID document by analyzing the provided image for signs of tampering or forgery. Users can leverage different pipelines to detect screen captures, printed copies, and portrait replacements, ensuring the integrity of the ID document. Upon completion, users will receive recognition results and transaction information, facilitating secure identity verification processes.</p>

The ID Liveness API section allows users to verify the authenticity of an ID document by analyzing the provided image for signs of tampering or forgery. Users can leverage different pipelines to detect screen captures, printed copies, and portrait replacements, ensuring the integrity of the ID document. Upon completion, users will receive recognition results and transaction information, facilitating secure identity verification processes.

Image of the ID document in base64 format.

pipelines

The URL where the ID Liveness results will be sent upon completion. If a callbackUrl is provided, the process works asynchronously, and you can refer to the Callback Response Example page for details. If no callbackUrl is provided, the process operates synchronously.

<p class="slate-p " >The Callback Response Example section showcases sample responses that users can anticipate from API interactions, providing clarity on response structure and format. By utilizing these examples, users can effectively develop and test their integrations, ensuring smooth communication between their application and the API. This section serves as a valuable resource for enhancing the integration process and streamlining development efforts.</p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Callback Response Example section showcases sample responses that users can anticipate from API interactions, providing clarity on response structure and format. By utilizing these examples, users can effectively develop and test their integrations, ensuring smooth communication between their application and the API. This section serves as a valuable resource for enhancing the integration process and streamlining development efforts.

<p class="slate-p " >The Face Compare API section allows users to compare two faces to determine their similarity. With this functionality, users can easily measure the resemblance between two facial images, enabling them to identify and analyze similarities or differences.</p><p class="slate-p " ></p>

The Face Compare API section allows users to compare two faces to determine their similarity. With this functionality, users can easily measure the resemblance between two facial images, enabling them to identify and analyze similarities or differences.

The base64 encoded image of the face to be compared with the targetFace image.

originFace

The base64 encoded image of the face to be compared with the originFace image.

targetFace

The URL where the face compare results will be sent upon completion. If a callbackUrl is provided, the process works asynchronously, and you can refer to the Callback Response Example page for details. If no callbackUrl is provided, the process operates synchronously.

Unique identifier for the transaction associated with the face compare request.

Information message returned as part of the face compare response.

<p class="slate-p " ><p class="slate-p " >The <strong class="slate-bold">Face Liveness API</strong> provides users with a method to verify the authenticity of a face during identity verification by analyzing the image for signs of liveliness. This API helps detect whether the image is from a real person or a static photo, preventing spoofing attempts and ensuring secure identity verification. By utilizing advanced algorithms, the API assesses various factors in the face image to determine if it was captured from a live subject, offering an additional layer of security in identity verification processes.</p></p>

faceImage

The 400 status code indicates that the request was unacceptable, often due to missing a required parameter.

<p class="slate-p " ><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >To ensure optimal performance and accuracy, the following image file guidelines must be followed for identity verification processing</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Supported File Formats</strong>: JPEG, JPG, PNG, BMP</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">File Size Limit</strong>: Maximum 5MB (Recommended file size: under 2MB)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Resolution</strong>: Minimum Full HD (FHD) or 1080p: 1920x1080 pixels. * Images with a resolution lower than <strong class="slate-bold">640x480 pixels </strong>cannot be processed.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Compression</strong>: Maximum JPEG compression level: 70 (Uncompressed images are recommended for better accuracy)</div></li></ul></div></div></p><p class="slate-p " ></p>

Our service supports a wide range of global identification documents. These include various ID types such as driver's licenses, passports, national ID cards, and more, ensuring secure identity verification across different regions.

Document Type

Country

ID Type

<p class="slate-p " >Our service supports a wide range of global identification documents. These include various types such as government-issued IDs, passports, driver’s licenses, residence permits, and more</p><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%"><div style="width:100%">ID Type</div><div style="width:100%">Description</div></div><colgroup ><col style="width:0%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">government_id</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An official identification document issued by a government, typically used for verifying the identity of an individual.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">passport</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An official travel document issued by a government, certifying the holder&apos;s identity and nationality, primarily used for international travel.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">drivers_license</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An official document permitting a specific individual to operate motorized vehicles such as motorcycles, cars, trucks, or buses.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">residence_permit</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An official document that allows a foreign individual to reside in a country for a certain period, typically issued by the immigration authority.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">vehicle_registration_certificate</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An official document providing proof of registration of a vehicle, including details about the vehicle and the owner.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">visa</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An official endorsement placed in a passport indicating that the holder is allowed to enter, leave, or stay for a specified period in a country.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">aadhaar</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A unique 12-digit identification number issued by the Indian government to residents of India, based on their biometric and demographic data</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">pancard</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A permanent account number (PAN) card issued by the Indian government to individuals and entities, used primarily for tax purposes</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

Our service supports a wide range of global identification documents. These include various types such as government-issued IDs, passports, driver’s licenses, residence permits, and more

Sections