API referenceMfa

Change when a code is required

Set this business's threshold for one currency. Gated on `BUSINESS_SETTINGS_MANAGE` rather than `MFA_MANAGE_OWN`, and the difference matters: enrolling *your own* authenticator is nobody's business but yours, while deciding when the whole business is asked for one is an administrative control. Reading it stays open to everyone, so a Finance user can see why they were asked.

PUT
/api/b/v1/mfa/step-up/{currency}

Set this business's threshold for one currency.

Gated on BUSINESS_SETTINGS_MANAGE rather than MFA_MANAGE_OWN, and the difference matters: enrolling your own authenticator is nobody's business but yours, while deciding when the whole business is asked for one is an administrative control. Reading it stays open to everyone, so a Finance user can see why they were asked.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

currency*Currency
admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/api/b/v1/mfa/step-up/string" \  -H "Content-Type: application/json" \  -d '{    "threshold_minor": 500000  }'
{  "currency": "string",  "threshold_minor": 1000000,  "is_custom": true}

Go back to the default threshold DELETE

Drop your threshold so the platform default applies again. Deliberately not the same as setting it to zero: zero asks for a code on every payout, and without a way back a business that tried that could never undo it.

The business's stakeholders with their screening status GET

Next Page