Contact Verification Endpoints

contact-verification/phone/confirm

This endpoint is used to confirm a phone verification using an OTP sent via SMS.

post/contact-verification/phone/confirm

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/contact-verification/phone/confirm
  • Auth
    none declared

Request body application/x-www-form-urlencoded

Tokenstring required

The single-use token associated with the phone verification request

OTPstring required

The one-time password sent via SMS to the phone number to be verified

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

VerificationStatusstring

Status of the verification. Can be 'verified' or 'failed'.

Example response

{
  "VerificationStatus": "verified"
}

Changes

No recorded changes to this operation across all 1 revision of this API.