Authorize one

Some banks allow authorization of recipients.

❗️

Allowed banks

The following banks allow the authorization of a single recipient:

  • Banco BCI

If you authorize recipients from another bank, you will receive an error.

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

The id of the bank recipient

Body Params

request body description

string

Optional selector for the bank key (crawler credential) to authorize with.
When omitted, Cardda uses the highest-priority approved bank key of the
owning account for your user (ordered by priority asc, then most recent).
Provide it only to pick a specific key.

string

Token (one-time password) for authorizing the recipient. When authorizing a
single recipient (POST /bank_recipients/{id}/authorize) send either token
or verification_code — whichever the bank requires. When validating all of a
payroll's recipients (POST /bank_payrolls/{id}/validate) both token and
verification_code are required.

string

The verification code sent to your email when the recipient was added. See the note on token for when it is required.

uuid

The id of the bank account involved (single-recipient authorize path).

uuid

The id of the sending bank account (payroll recipient-validation path).

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

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