API Reference

contact-verification/requests

get
https://earthnode-dev.vopay.com/api/v2/contact-verification

This endpoint is used to fetch results of the contact verification requests.

Query Params
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

integer

Value of the Contact Verification Request ID

string
required

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

string
required

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

string

A text string to search for in the email addresses used for Account Verification process.

integer

Limit the number of records that are returned.

integer

Use this parameter to set the starting point in the dataset.

string

Filter by contact verification type. Can be 'email', 'phone', 'nondoc', 'name'.

string

filter by tier of the verification request. Options are 'basic' and 'enhanced'.

string

filter by Status of the verification request. Options are 'unverified', 'verified', 'failed'.

string

Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.

date-time

Return contact verification requests that occurred on or after this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.

date-time

Return contact verification requests that occurred on or before this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.

Response

Updated 3 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago