Create a bank key

Stores a new set of bank credentials for the company. Cardda encrypts the
secrets at rest; this is the only entry point that accepts plain-text
credentials. Upon creation Cardda runs an asynchronous validation against
the bank — the key starts as pending; poll the resource until status
flips to approved (or declined).

A credential can be shared across several companies. If you re-enter a
credential you already own (same user_id + type, plus rut for CL/MX or
email for US) and associate it to another company, Cardda attaches that
company to the existing key instead of creating a duplicate — the response is
200 carrying the existing key (vs 201 for a brand-new key).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Bank credentials to be stored encrypted.

Headers
uuid
required

UUID of the company on whose behalf the request is made. Send it on banking
requests to identify the acting company. Note that user-scoped list endpoints
(e.g. the recipients/transactions indexes) resolve results across all companies
the authenticated user is a member of, rather than strictly from this header.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized — missing or invalid bearer token, or company-id header not set.

422

Unprocessable entity — invalid credentials shape, or the credential is
already enrolled by a different user (user_id + rut/email +
type uniqueness). Re-entering a credential you already own (with its
identifier present) no longer 422s; it returns 200 with the existing
key (see above). Edge case: a blank-identifier reconnect (missing
rut for CL/MX or email for US) deliberately skips the association
path — as do virtual keys, which always skip it — so it can still 422
on the model's presence/uniqueness validations.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json