Klaro API

1.0.0

The Klaro API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies and replies as JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Klaro API in test mode, which doesn’t affect your live data.

To gain access, please email tech@klaro.fr or contact our accounts managers.

Getting started guide

• You must use a valid JWT as a Bearer Token to send requests to the API endpoints. (To see how to create the JWT, refer to the documentation provided by your account manager)
• The API has rate limiting usage (see below)
• The API only responds to HTTPS-secured communications.
• The API returns responses in JSON format. When an API request returns an error, it is sent in the JSON response.

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 2000 requests per minute. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Example error response:

{ "error": "Rate limit exceeded", "retryAfter": 60000 }

Authentication

Klaro API uses JWT-based authorization, with tokens signed using HMAC-SHA256 to ensure authentication. You must include the JWT in each request to the API as a bearer token (header: Authorization). The payload of the JWT must have at least the iss key. For example:

{ "iss": "issuer-given-by-klaro" }

Authentication error response:

{"statusCode":401,"message":"Invalid token.","error":"Unauthorized"}

Need some help?

For technical matters, please contact tech@klaro.fr, or for other inquiries, email bonjour@klaro.fr.

This is version 1.0.0 of this API documentation. Last update on Mar 5, 2025.