Create beneficiary

post

https://example.com/api/v1/beneficiaries

This API will create a new beneficiary. For hosted solution, our system will automatically send an email with the credentials to the beneficiary.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request model for creating new user

username

string

required

length ≤ 300

The unique username for the new customer.

firstName

string

required

length ≤ 50

The first name of the beneficiary.

lastName

string

required

length ≤ 50

The last name of the beneficiary.

companyName

string | null

The company name associated with the beneficiary.

address1

string | null

The primary address of the beneficiary.

address2

string | null

The secondary address of the beneficiary.

city

string | null

The city where the beneficiary resides.

state

string | null

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

zipCode

string | null

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

country

string | null

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

phoneNumber

string | null

The phone number of the beneficiary.

cellPhoneNumber

string | null

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

emailAddress

string

required

length ≤ 300

The email address of the beneficiary.

dateOfBirth

string | null

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

preferredLanguage

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

200Success

400Bad Request

500Server Error