Authentication - Atlas Open API

Atlas Open API uses Merchant IDs and API Keys for authentication. The credentials will be provided when onboarding to Atlas Open API.

Include the provided credentials in the corresponding header for each request.

Keep Your Credentials Secure

To prevent unauthorized access to sensitive data and operational actions, it’s crucial to safeguard your API Key.

Avoid exposing it in public repositories or client-side code, and always use secure storage practices.

If you suspect your credentials have been compromised, contact us immediately for a replacement.

When valid credentials are provided, each endpoint will respond as described in their documentation.

When providing invalid credentials, Atlas Open API responds with 401 Unauthorized status and response body as:

{
  "type": "Unauthorized",
  "message": "You did not provide valid credentials for this request. Please check your request and try again.",
  "details": [
    {
      "field": "api_key",
      "message": "Check if the API Key is set correctly in the X-Api-Key header."
    }
  ]
}