Skip to main content
POST
Register a customer API bank connection

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Body

application/json
connection_source_id
string
required
Minimum string length: 1
institution_name
string
required
Minimum string length: 1
accounts
PublicBankConnectionAccountSchemaIn · object[]

Response

Created

id
integer
required
connection_source_id
string
required
status
string
required
institution_name
string | null
successfully_aggregated_at
string<date-time> | null
last_sync_at
string<date-time> | null
accounts
PublicBankConnectionAccountSchemaOut · object[]
Last modified on August 18, 2026