API Reference

Create a bank key

post
https://api.cardda.com/v1/banking/bank_keys

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 — poll the resource until status flips from validating to
active (or invalid).

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

Bank credentials to be stored encrypted.

string
required
string
enum
required
string

Firebase user id of the person who provided the credentials.

uuid
required

The id of the company

string

The numbers of the company card. Only required in Peruvian Bank Keys

string

The user's identifier used at bank's login

Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every banking endpoint.
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 duplicate (rut + bank already enrolled).

Updated 2 months ago

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

Updated 2 months ago

Did this page help you?