Auth API

The Auth API issues Bearer tokens for authenticated API calls.

Path Structure

/[SCOPE]/auth/[COMMAND]/[USER_ID]

• SCOPE is live or sandbox; credentials are checked in that database only.
• COMMAND is currently bearer.
• USER_ID is your API user identifier.
• The request body can be empty.

GET /[SCOPE]/auth/bearer/[USER_ID]

Creates a Bearer token for the given API user.

Required Header

Authorization: Auth-token YOUR_PRIVATE_AUTH_TOKEN

Parameters

None besides USER_ID in the path.

Response

{
  "status": {
    "code": "200",
    "apiTimeConsumed": "0.012s"
  },
  "data": {
    "auth_bearer": "00000000-11111111-22222222-33333333-44444444-55555555",
    "utc_valid_to": "2026-05-17 13:00:00"
  }
}

Use With Protected Endpoints

Authorization: Bearer 00000000-11111111-22222222-33333333-44444444-55555555

Errors

Errors are returned as JSON responses with an ErrorMessage field.