Skip to main content
POST
Authentication is new. These endpoints are served by your application’s issuer, such as https://<name>.auth.didit.me, and never take your Didit API key.
The step_up and status query parameters on your return_to only tell your application to look. Before you act, read the step-up with Get a step-up and continue only when status is approved.

Authorizations

Authorization
string
header
required

The person's access token from POST /token/: an ES256 JWT with header typ: at+jwt, valid for at most 5 minutes. Not your Didit API key.

Body

application/json

The sensitive action the person is about to take.

action
enum<string>
required

payout (a withdrawal or transfer), bank (adding or changing a bank account) or contact (changing an email or phone number). A payout also applies the new-device rule.

Available options:
payout,
bank,
contact
return_to
string
required

Where the person returns after verifying, with step_up=<id>&status=approved added. When a rule applies, it must be one of the application's redirect URIs; when none applies, it is not checked.

Maximum string length: 2048
Example:

"https://app.example.com/payouts/confirm"

amount
string

Required for payout: the amount, up to two decimals. A JSON number is accepted too.

Pattern: ^[0-9]{1,16}(\.[0-9]{1,2})?$
Example:

"900.00"

currency
string

ISO 4217 code of amount. Defaults to the payout rule's currency; a payout in another currency is always checked.

Pattern: ^[A-Z]{3}$
Example:

"USD"

Response

No rule applies.

No rule applies: go ahead with the action.

required
enum<boolean>
required
Available options:
false