Bank key

Create a bank key

Changed on

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).

post/v1/banking/bank_keys

Request

  • Base URL
    https://api.cardda.com
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 (unresolved $ref)

Request body

OR

Example request

{
  "password": "qwerty",
  "card": "1234567890123456",
  "rut": "19"
}

Response

Existing credential — you re-entered a credential you already own and it was associated to the requested company (or companies) instead of creating a duplicate. The body is the existing bank key.

idstring uuid required
user_idstring required

Firebase user id of the person who provided the credentials.

status'pending' | 'approved' | 'declined' | 'preauthorized' required

Lifecycle of the asynchronous bank validation. A freshly created key is pending; poll until it flips to approved (or declined). A key may also land in preauthorized, which requires an extra action before approval (e.g. confirm the logged-in device).

authorization_method'token' | 'digipass' | 'device' | 'multipass' | 'santander_pass' | 'bice_pass' | 'itau_pass' nullable

Second factor pinned on this credential. Almost always null — the method is normally chosen per operation and travels in the body of the authorize / preauthorize calls (see Bank_authorization), so it is not stored on the key. Read a null here as "not pinned", not as "no second factor".

created_atstring date-time required
updated_atstring date-time required

Changes