Contact Verification Endpoints

contact-verification/id/non-doc

This endpoint is used to perform Non-Document ID verification on an individual. Currently only Canada is supported.

post/contact-verification/id/non-doc

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/contact-verification/id/non-doc
  • 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 to verify. This is required if client account is enabled. Use ContactID instead if client account is not enabled.

ContactIDstring required

The contact ID of the contact to verify. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.

FullNamestring required

Contact's full name

DOBstring required

Date of Birth, in date format YYYY-MM-DD (ex: 1960-01-15).

EmailAddressstring email required

Email address of the contact - Must be a valid email

Address1string required

Contact's address line 1

Address2string

Contact's address line 2

Citystring required

Contact's city

Provincestring required

Contact's province specified using two character abbreviations (eg. BC, AB)

PostalCodestring required

Contact's postal code

Countrystring required

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

TriggerAMLCheckboolean

Include an AML check if the dual process verification status is verified.

TriggerManualIDVOnFailureboolean

If the non-document verification status is not verified then initiate a manual ID verification request to the email provided above.

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 to be verified

VerificationStatusstring

Status of the verification

Example response

{
  "VerificationStatus": "Verified"
}

Changes

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