API Keys

Create an API key

post/v1/api-keys

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/api-keys
  • Auth: HTTP bearer

Request body

namestring required

Display name for this key

scopesstring[] required

Scopes to grant (e.g. ["banks:read", "feeds:read"])

expiresInDaysinteger

Days until expiry; omit for no expiry

cdrAcknowledgedboolean

Required for workspaces with CDR (Australian) banks: the customer acknowledges CDR data may be read into their own systems via this key.

cdrWordingVersionstring

Disclosure wording version acknowledged (paired with cdrAcknowledged).

Response

API key created. The plaintext key is shown once — store it immediately.

successtrue required
apiKeystring required

Plaintext key — shown only once

keyIdstring required
expiresAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.