search

API Endpoints

hashtag
Send verification code to phone number via SMS.

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

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

hashtag
Request Body

Name
Type
Description

recipient*

String

Phone number (ex: "+11234567890")

{
    "statusCode": 200,
    "message": "Verification code sent!",
    "data": {
        "sid": "VEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "to": "+1234567890",
        "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",
    }
}

hashtag
Verify verification code.

POST {{url}}/mfa/verify

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

hashtag
Request Body

Name
Type
Description

recipient*

String

Phone number (ex: "+11234567890")

code*

String

Verification code

PreviousVerification WorkflowNextPersona

Last updated