Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include
enum<string>[]
Available options:
creator
fields[api-keys]
enum<string>[]
Available options:
name,
token,
abilities,
created_at,
last_used_at,
expires_at
fields[users]
enum<string>[]
Available options:
name,
email,
created_at,
updated_at

Body

application/json
name
string
required

The name of the API key.

Maximum string length: 255
abilities
enum<string>[]
required

The abilities/permissions granted to the API key.

A single API key ability.

Available options:
api_key:read,
api_key:write,
verification:read,
verification:write,
check:read,
check:write,
webhook_subscription:read,
webhook_subscription:write,
webhook_event:read,
aba_check:read,
aba_check:write,
invoice:read,
invoice:write

Response

ApiKeyResource

data
ApiKeyResource · object
required
included
UserResource · object[]