Contact Verification Endpoints

contact-verification/phone

This endpoint is used to intiate an phone SMS verification.

post/contact-verification/phone

Request

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring required

The client account ID associated with this phone number. This is required if client account is enabled. Use ContactID instead if client account is not enabled.

ContactIDstring required

The contact ID associated with this phone number. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.

PhoneNumberstring required

Phone number to be verified - Must be a valid phone number

VerificationTierstring

Tier of the verification request. Options are 'basic' and 'enhanced'. Defaults to 'basic' if not specified.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

VerificationRequestIDinteger

Verification Request ID for the Phone to be verified

Changes

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