POST
Request a security PIN
Sends a one-time 4-digit PIN to the customer’s registered phone number by SMS. The customer then enters it as the pin confirmation method on a sensitive action:
The PIN expires after 60 seconds. Request it right before the action it confirms, and re-request if the customer takes longer.
PIN step-up is a program capability — it’s active for certain programs only (typically those using SMS-based step-up). Programs without it reject method: "pin" with a 400; use a passkey or the totp method instead. See Program capabilities.

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.

Path Parameters

customerId
string
required

The customer's id. It's the customerId from the signed-in user's application (the onboarding response, also returned on the customer's accounts).

Response

PIN sent

success
boolean
Example:

true

message
string
Example:

"PIN sent successfully"