Getting Started
Add-on feature enables additional authentication for approved submissions in customer projects. Currently, FaceAuth (facial authentication) is supported, and future updates will introduce additional verification methods such as identity documents, official papers, and certificates. FaceAuth enhances identity verification by comparing the facial image extracted from the submitted ID during the ID Check process with the user’s submitted facial image.
Add-on API Endpoints
Webhook
API Key
The Add-on API key is used to authenticate and verify client and server requests. It ensures that the requestor is authorized, allowing Argos Identity to return the appropriate response.
How to Retrieve Add-on API Key
Log in to Dashboard
Log in to the ID Check dashboard.
Access Settings Menu
Click on the Add-on
menu in the top navigation bar of the dashboard.
Create a Project
Click the Create Project
button on the Add-on page to create a new project.
Retrieve API Key
After creating the project, click the Edit
button on the Add-on page, then locate the API Key
section. Click the icon on the right to copy the API key and use it.
HTTP Response Status Codes
HTTP response codes indicate the status of requests. Each response code follows these rules:
2xx
Successful requests4xx
Client errors5xx
Server errors
HTTP Status Code | Message | Description |
---|---|---|
200 | OK | The request was successfully processed. |
400 | Invalid Query String parameters | The request could not be processed due to missing or incorrect parameters. Please check the request parameters and try again. |
403 | User is not authorized to access this resource with an explicit deny | Access denied. The request was made from an IP that is not whitelisted. |
403 | Forbidden | Access denied. An incorrect API key may have been used. |
413 | Request Entity Too Large | The request is too large. The data exceeds the server’s processing limits. Reduce the request size and try again. |
500 | Internal Server Error | A server error occurred. There may be an issue with the Argos server. Please contact the Argos team. |
502 | Bad Gateway | The server received an invalid response from the upstream server. Try again later or contact the Argos team. |
Was this page helpful?