Skip to main content

Verify a token

POST 
/mfa/:mfa_request_id/verify

Token verification is performed by sending a POST request to the below endpoint. If the token is not valid, it will return a false value in the success attribute of the JSON response. When max_attempts are reached, or valid_for has expired, or the token has already been validated, the endpoint will return a 404 Not Found HTTP code.

Permissions​

The API token must include one of the following scopes: Voice or Messaging or Fax.

Request​

Path Parameters

    mfa_request_id stringrequired

    Unique ID of the address

Body

required

    token stringrequired

    The token to verify

    Example: <TOKEN-TO-CHECK>

Responses​

OK

Schema

    success boolean

    Whether the token was successfully verified by the API. When max_attempts are reached or the request is no longer valid, the endpoint will return a 404 Not Found.

    Example: true