VOvopay
Contact Verification Endpoints

contact-verification/name-screen

This endpoint is used to verify contacts name

post/contact-verification/name-screen

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/contact-verification/name-screen
  • 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 name. 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 name. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.

Countrystring required

Contact's country specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

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 contact name screening request

VerificationStatusstring

Status of the verification

Example response

{
  "VerificationStatus": "verified"
}

Changes

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