account/client-accounts/generate-embed-url

post

https://earthnode-dev.vopay.com/api/v2/account/client-accounts/generate-embed-url

Use this endpoint to generate a unique URL to onboard a new client account. To send an email containing the URL to the recipient, set SendEmail = true, and provide both the email address and full name of the recipient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientType

string

required

Type of client account you want to onboard. Options are individual, business, standard and receive-only.

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

This option is used to send the onboarding link through email. If you wish to send an email, then provide true. The default value is false.

ReceiverEmailAddress

string

Recipient's email address. Required if SendEmail = true.

SendSMS

boolean

This option is used to send the onboarding link through SMS. If you wish to send an SMS, then provide true. The default value is false.

ReceiverPhoneNumber

string

Recipient's phone number. Required if SendSMS = true.

RequiredPaymentMethods

string

Comma-separated list of payment methods.

Label

string

This option will add a Label to the client account. If the Label doesn't exist it will be created and applied.

Response

200