Create beneficiary

This API will create a new beneficiary. Once the account has been created, system will send an email with the credentials to the beneficiary.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 300

The unique username for the new customer.

string
required
length ≤ 50

The first name of the beneficiary.

string
required
length ≤ 50

The last name of the beneficiary.

string | null

The company name associated with the beneficiary.

string | null

The primary address of the beneficiary.

string | null

The secondary address of the beneficiary.

string | null

The city where the beneficiary resides.

string | null

The customer's state. For US users state should be in 2 character format like FL, TX.

string | null

The customer's ZIP or postal code. For US users ZIP code should be in numeric format.

string | null

The customer's two-letter country code (ISO 3166-1 alpha-2). If not specified, default country is US.

string | null

The phone number of the beneficiary.

string | null

The beneficiary's mobile phone number. This number can be used for SMS notifications.

string
required
length ≤ 300

The email address of the beneficiary.

string | null

The beneficiary's date of birth. It will be asked on a first user login. Format: "yyyy-mm-dd"

string | null

The beneficiary's preferred language code that will be used for email communications. If not specified, it will be EN. Example: EN - English, ES - Spanish etc. Availabel languages are: EN, ES, PT, FR, SK, ZH, DE, IT, HU, RU, PL, KO, JA, HI, ID, zh-CHT, NL, NB, SV, CS, DA

kyc
array of objects | null
kyc
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json