Authentication

Every request needs your API key in the x-api-key header.

curl https://apidocs.borderli.io/v1/schemes \
  -H "x-api-key: brly_test_key_001"

Sandbox key

brly_test_key_001 works against the sandbox. You get production keys from the Borderli team.

Missing or invalid key

You get 401:

{
  "_tag": "AuthError",
  "type": "AuthError",
  "message": "Missing or invalid API key",
  "docs_url": "https://apidocs.borderli.io/docs/errors/AuthError",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Rate limit

Each API key may make 100 requests per minute. Every response tells you where you stand:

Header	Meaning
`x-ratelimit-limit`	Requests allowed per minute
`x-ratelimit-remaining`	Requests left in the current minute
`x-ratelimit-reset`	Unix time when the minute resets

Past the limit you get 429 RateLimitError with a retryAfter field in seconds. Wait that long and retry.

Request id

Every response carries an x-request-id header with a unique id. Error bodies repeat it as request_id. Log it and quote it when you contact support.