Merchant Boarding API Specification

Merchant Boarding API

2FA

Two-Factor Authentication

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

string^(?!.*/).*$

Minimum:

Example:

123abc

Example Request

twoFactorAuthInitiateValidRequest

{
  "externalKey": "0aa000a-000a-00a0-00a0-00000aa00a0"
}

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

string^(?!.*/).*$

Minimum:

Example:

123abc

code required

string

Minimum:

Example:

1234

Example Request

{
  "externalKey": "0aa000a-000a-00a0-00a0-00000aa00a0",
  "code": "1234"
}

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

string

Example:

0aa000a-000a-00a0-00a0-00000aa00a0

phone required

string

Default:

null

^\d{10}$10 to 10 characters

Example:

null

Example Response

200 Get two-factor authentication status for request ID + phone.

400 Bad request example.