CAcardda
Bank key

Retrieve one

Returns a bank key given it's id

get/v1/banking/bank_keys/{bank_key_id}

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_keys/{bank_key_id}
  • Auth
    HTTP bearer

Path parameters

bank_key_idstring required

The id of the bank key

Parameters

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

Response

Body of the searched bank key.

idstring uuid required
user_idstring required

Firebase user id of the person who provided the credentials.

source_key_idstring uuid nullable

If this key was cloned from a parent key (multi-account banks), the parent's id.

status'pending' | 'approved' | 'declined' | 'preauthorized'
rutstring
emailstring email nullable
authorization_method'coordinate_card' | 'digipass' | 'sms' | 'mobile_app' | 'signature' | 'none' nullable
priorityinteger

Sort order when several keys exist for the same company+bank. Defaults to 0.

typestring
aux_typestring nullable

Auxiliary classification used by some banks (e.g. business, personal, corporate).

kyc_completedboolean

Whether KYC was completed for the user that owns the key.

bank_errorsItems[] (unresolved $ref)
company_idsstring[]

Flat array of the company UUIDs this credential is associated with — the same set of ids carried by companies, without the nested KYC metadata. The edit form prefills its company selector from this array. Show-only: GET /v1/banking/bank_keys/{id} merges both companies and company_ids into the payload; the list/index endpoint builds companies but not company_ids.

created_atstring date-time required
updated_atstring date-time required

Changes

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