Headers
Version Header
The entire API, including the Authorize-endpoint, and GraphQL endpoints are versioned.
The version is required on every request, and must be provided via the X-API-Version-header
.
Example:
curl --location 'https://api.prod.kyc.penneo.com/public-api/graphql' \
--header 'X-API-Version: 1' \
--header 'Content-Type: application/json' \
--data ' ... '
Supported versions
Version | Release date | Deprecation date |
---|---|---|
1 | 01-06-2020 | 6 months after version 2 |
Authorization Header
The API is accessed via a Bearer token.
This token is a standard JSON Web Token that is sent along with every request to our API via the Authorization
-header.
The token expires in 15 minutes, after which a new token must be obtained.
It is recommended that you set up a way to automatically renew tokens when they expire if doing operations that span over 15 minutes.
Example:
curl --location 'https://api.prod.kyc.penneo.com/public-api/graphql' \
--header 'X-API-Version: 1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data ' ... '
Accept Header
Use the Accept
-header to modify the response according to your needs.
Get a response without escaping of slashes
The API supplies escaped JSON by default.
If you want to have unescaped slashes in the returned data, use the Accept
-header with json/unescaped-slashes
Example:
curl --location 'https://api.prod.kyc.penneo.com/public-api/graphql' \
--header 'Accept: json/unescaped-slashes' \
--header 'X-API-Version: 1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data ' ... '