VOvopay
Contact Verification Endpoints

contact-verification/generate-embed-url

This endpoint generates an embed URL for contact verification. The URL can be used to embed a verification iframe for address, basic ID, or enhanced ID verification.

post/contact-verification/generate-embed-url

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/contact-verification/generate-embed-url
  • 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 generate the embed URL for. This is required if client account is enabled. Use ContactID instead if client account is not enabled.

ContactIDstring required

The contact ID to generate the embed URL for. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.

VerificationTypestring required

The type(s) of verification to embed. Must be one or more of: 'address', 'idbasic', 'idenhanced'. Multiple values can be comma-separated.

StylesheetUrlstring

URL of a custom stylesheet to apply to the embedded verification iframe

Languagestring

The language preference for the embed. Defaults to 'en'.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Linkstring

The generated embed URL

SingleUseTokenstring

Single-use token used to generate the embed URL

Example response

{
  "Link": "https://earthnode-dev.vopay.com/contact-verification?Token=abc123",
  "SingleUseToken": "abc123"
}

Changes

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