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

1

Log in to Dashboard

Log in to the ID Check dashboard.

2

Access Settings Menu

Click on the Add-on menu in the top navigation bar of the dashboard.

3

Create a Project

Click the Create Project button on the Add-on page to create a new project.

4

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 requests
  • 4xx Client errors
  • 5xx Server errors
HTTP Status CodeMessageDescription
200OKThe request was successfully processed.
400Invalid Query String parametersThe request could not be processed due to missing or incorrect parameters. Please check the request parameters and try again.
403User is not authorized to access this resource with an explicit denyAccess denied. The request was made from an IP that is not whitelisted.
403ForbiddenAccess denied. An incorrect API key may have been used.
413Request Entity Too LargeThe request is too large. The data exceeds the server’s processing limits. Reduce the request size and try again.
500Internal Server ErrorA server error occurred. There may be an issue with the Argos server. Please contact the Argos team.
502Bad GatewayThe server received an invalid response from the upstream server. Try again later or contact the Argos team.