---
title: "gcm/recipient-contacts/generate-embed-url"
method: POST
path: "/gcm/recipient-contacts/generate-embed-url"
tags: ["Embedded Experience Endpoints"]
---

# gcm/recipient-contacts/generate-embed-url

`POST /gcm/recipient-contacts/generate-embed-url`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/gcm/recipient-contacts/generate-embed-url`
- Auth: none declared

Generate a link to the cross-border iframe for onboarding recipient contacts.

## 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
  - `ContactClientType` string, required: Type of contact client. Options are individual or business.
  - `Country` string, required: Destination country of the recipient contact (ISO 3166-1 alpha-2 or alpha-3 code).
  - `UseCase` string, required: Valid values are B2B, B2P, P2B, P2P
  - `ClientAccountID` string: Client account ID. If not provided, the primary client account will be used.
  - `ContactID` string: Contact ID. If not provided, the primary client account will be used.
  - `FirstName` string: Client's first name. Required if BusinessName is not provided.
  - `LastName` string: Client's last name. Required if BusinessName is not provided.
  - `BusinessName` string: Client's business name. Required if FirstName and LastName are not provided.
  - `SendEmail` boolean: Set to true to send an onboarding link via email. Default is false.
  - `ReceiverEmailAddress` string, email: Recipient's email address. Required if SendEmail = true.
  - `SendSMS` boolean: Set to true to send an onboarding link via SMS. Default is false.
  - `ReceiverPhoneNumber` string: Recipient's phone number. Required if SendSMS = true.
  - `RequiredPaymentMethods` string: Comma-separated list of payment methods.
  - `Label` string: Label to be added to the client account. If the label doesn't exist, it will be created and applied.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `OnboardingLink` string, required: The URL of the onboarding link.

---

[API](https://skmtc.dev/vopay/apis/global-cash-management.md) - [All operations](https://skmtc.dev/vopay/apis/global-cash-management/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/global-cash-management/revisions/1b58a7445906?raw)