Authentication
The Risk Intelligence API uses JWT-based authentication. Clients authenticate using a client_id and
client_secret to obtain an access token, which is then used to authorize all subsequent API requests.4
Integration Steps
Section titled “Integration Steps”1. Access Token Creation
Section titled “1. Access Token Creation”Clients initiate authentication by sending a POST request to the /v1/auth endpoint with their client_id
and client_secret.
If successful, the response includes:
access_token— a short-lived token used for authenticating API requestsrefresh_token— used to renew the access token without re-authenticating
2. Access Token Refresh
Section titled “2. Access Token Refresh”When the access token expires, clients can request a new one by sending a POST request to /v1/auth/refresh with a
valid refresh_token.
3. Usage in API Requests
Section titled “3. Usage in API Requests”Include the access token in the Authorization header of every API request: Authorization: Bearer <access_token>
📈 Rate Limit
Section titled “📈 Rate Limit”To ensure fair usage and system stability, the API enforces rate limits.
- If a client exceeds the rate limit, the API responds with:
429 Too Many Requests - A
Retry-Afterheader will be included in the response, indicating how long the client must wait before retrying the request.
Maintained by EkLine