API Endpoints

Send verification code to phone number via SMS.

POST {{url}}/mfa/send-code

Headers

Name	Type	Description
Authorization*	String	Bearer token

Request Body

Name	Type	Description
recipient*	String	Phone number (ex: "[phone]")

200: OK Successful operation

{
    "statusCode": 200,
    "message": "Verification code sent!",
    "data": {
        "sid": "VEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "to": "[phone]",
        "channel": "sms",
        "status": "pending",
        "valid": false,
        "lookup": {
            "carrier": null
        },
        "amount": null,
        "payee": null,
        "sendCodeAttempts": [
            {
                "attempt_sid": "VLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                "channel": "sms",
                "time": "2022-07-07T14:17:49.467Z"
            }
        ],
        "dateCreated": "2022-07-07T14:17:49.000Z",
        "dateUpdated": "2022-07-07T14:17:49.000Z",
    }
}

400: Bad Request Invalid recipient

{
    "statusCode": 400,
    "message": [
        "Phone number should be valid and from one of these countries: US, HN"
    ],
    "error": "Bad Request"
}

429: Too Many Requests Too many requests sent

{
    "statusCode": 429,
    "message": "Max check attempts reached"
}

Verify verification code.

POST {{url}}/mfa/verify

Headers

Name	Type	Description
Authorization*	String	Bearer token

Request Body

Name	Type	Description
recipient*	String	Phone number (ex: "[phone]")
code*	String	Verification code

200: OK Successful operation

{
    "statusCode": 200,
    "message": "Verification code is correct!",
    "data": {
        "sid": "VEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "to": "[phone]",
        "channel": "sms",
        "status": "approved",
        "valid": true,
        "amount": null,
        "payee": null,
        "dateCreated": "2022-07-07T14:23:53.000Z",
        "dateUpdated": "2022-07-07T14:24:06.000Z"
    }
}

400: Bad Request Invalid recipient or code

{
    "statusCode": 400,
    "message": [
        "Phone number should be valid and from one of these countries: US, HN"
    ],
    "error": "Bad Request"
}

401: Unauthorized Incorrect code

{
    "statusCode": 401,
    "message": "Verification code is incorrect",
    "error": "Unauthorized"
}

404: Not Found Code already used or never sent to recipient

{
    "statusCode": 404,
    "message": "Verification code does not exist or is already being used",
    "error": "Not Found"
}

429: Too Many Requests Too many requests sent

{
    "statusCode": 429,
    "message": "Max check attempts reached"
}