POST
Request a security PIN
Sends a one-time 4-digit PIN by SMS to the phone number on the signed-in user’s application. The customer then enters it as the pin confirmation method on a sensitive action:
A successful request answers:
The PIN expires after 60 seconds and allows two attempts. Request it right before the action it confirms.

Sending a new PIN

There’s no wait between requests. Each request sends a new PIN that replaces the previous one: the old PIN stops working, and the new one gets a fresh 60 seconds and two attempts. A PIN is used up by the action it confirms. If a request fails (for example the SMS can’t be sent), the previous PIN may already have been replaced. Request a new PIN rather than using the old one.

Errors

  • No phone number on the application: this request returns 404 PHONE_NOT_FOUND.
  • A wrong, expired or used-up PIN on the confirmed action returns 422 with SCA_FAILED, SCA_EXPIRED or SCA_ATTEMPTS_EXCEEDED. See Step-up confirmation.
program.beneficiaries.stepUpMethods in GET /v1/capabilities lists the step-up methods your program intends to offer; prefer a method from that list.

In sandbox

Sandbox works the same way: a random PIN goes by real SMS to the phone number on the application. There’s no fixed test PIN, so use a phone you can read.

Authorizations

Authorization
string
header
required

The user's access_token from authentication. 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"

data
null

null: the top-level message is the whole result.