Merchant Enrollment using Two-factor authentication section.
Two Factor Auth
Initiate 2FA
post /enroll/two-factor/initiate
Initialize two-factor authentication on an existing application with a valid primary principal phone number.
Request Schema
externalKey required
Type
stringPattern
^(?!.*/).*$Range
1 to 50 charactersExample
123abcLoading...
Example Request
Example Response
200 Initiate two-factor authentication code for existing application.
400 Bad request example.
404 Not found example.
415 Unsupported media type response - Invalid content type
422 Unprocessable entity error response.
Validate 2FA Code
post /enroll/two-factor/validate
Validate two-factor authentication code for an application using the external key.
Request Schema
externalKey required
Type
stringPattern
^(?!.*/).*$Range
1 to 50 charactersExample
123abcLoading...
code required
Type
stringMinimum Length
1Example
1234Loading...
Example Request
Example Response
200 Validate two-factor authentication code for existing application.
400 Bad request example.
404 Not found example.
415 Unsupported media type response - Invalid content type
Get 2FA status
get /enroll/two-factor/status/id/{requestId}/phone/{phone}
Get two-factor authentication status by request ID and phone number.
Parameters
requestId required
Type
stringExample
0aa000a-000a-00a0-00a0-00000aa00a0Loading...
phone required
Type
stringDefault
nullPattern
^\d{10}$Range
10 to 10 charactersExample
1234567890Loading...
Example Response
200 Get two-factor authentication status for request ID + phone.
400 Bad request example.