---
title: "contact-verification/generate-embed-url"
method: POST
path: "/contact-verification/generate-embed-url"
tags: ["Contact Verification Endpoints"]
---

# contact-verification/generate-embed-url

`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

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `ClientAccountID` string, 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.
  - `ContactID` string, 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.
  - `VerificationType` string, required: The type(s) of verification to embed. Must be one or more of: 'address', 'idbasic', 'idenhanced'. Multiple values can be comma-separated.
  - `StylesheetUrl` string: URL of a custom stylesheet to apply to the embedded verification iframe
  - `Language` string: The language preference for the embed. Defaults to 'en'.

## Response `200`

- object
  - `Success` boolean: True if the request was successful, false if it failed
  - `ErrorMessage` string: Contains a description of the error if the request failed
  - `Link` string: The generated embed URL
  - `SingleUseToken` string: Single-use token used to generate the embed URL

---

[API](https://skmtc.dev/vopay/apis/verification.md) - [All operations](https://skmtc.dev/vopay/apis/verification/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/verification/revisions/a167619c0012?raw)