Generate API Key

Generate an ApiKey

get

The GenerateApiKey method enables integrators to obtain a unique API key, allowing them to act on behalf of an end customer with the customer's approval.This method requires the approval ID as a parameter, serving as confirmation that the customer has granted permission for the integrator's actions. When invoked, the method generates a distinct API key, which serves as the integrator's secure credential for accessing and interacting with the designated APIs on the customer's behalf. This mechanism ensures that integrators can securely engage with the API, fulfilling their role while adhering to the customer's authorization.

Authorizations

Bearer Token

AuthorizationstringRequired

Path parameters

approvalIdstringRequired

Responses

200

Returns an apikey

application/json

Contains integration specific apikey information.

apiKeystring · nullableOptional

The secret key - cryptographically-secure key with a entropy between 128-1024 bits

expiresstring · date-timeOptional

The date when this key will expire - Like any secret, API keys need to be rotated regularly. Any company implementing a thoughtful security policy needs to change its API keys routinely — usually once a year or on any security incident.

404

Not found

422

Request cannot be processed

get

/v1/apikey/generate/{approvalId}

HTTPcURLJavaScriptPython

GET /v1/apikey/generate/{approvalId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "apiKey": "text",
  "expires": "2026-03-01T18:12:53.524Z"
}