Getting Started
Overview
The Add On API allows you to submit customer data and monitor its progress. The ARGOS API employs RESTful Endpoints and utilizes standard HTTP methods.
The response data includes the request status and any potential error codes.
All response data is provided in JSON format.
Token authentication is required.
All requests must be performed over HTTPS; HTTP requests will fail.
Getting Started
To use the API, a valid, dedicated API key is required. You can find your API key within the Add On project in the KYC dashboard. If you are not using the Live form and are submitting via the API, please make sure to use POST.
Authentication
The API uses token-based authentication. To utilize the API, it is essential to use the dedicated API key provided by ARGOS.
Authenticate via HTTP Header
You must send the API key along with the query in the HTTP header. The API key should be included in the method request header as 'x-api-key: {yourAPIKey}'.
API Gateway Error
The API responds with standard HTTP response codes. Successful operations will return a 2XX code. A 4XX code is returned when there is an error in the information sent from the client, and a 5XX code is returned when there is an error on the ARGOS server.
400
Invalid Query String parameters
Client Error. e.g.) Invalid request syntax, incorrect request message framing.
403
User is not authorized to access this resource with an explicit deny
If the IP is not accessible within the project, the request will be blocked.
403
Forbidden
The API key is either not provided or there is an issue with the API key.
413
Request Entity Too Large
The request exceeds what the server intends or is capable of handling.
500
Internal Server Error
There may be an error on the ARGOS server. Please contact the ARGOS team.
502
Bad Gateway
The server received an invalid response from an upstream server.
Last updated