Create User

post

https://test.api.promisepay.com/users

Create a User that can be associated with Items as either a buyer or a seller. Users can't be both the buyer and seller for the same Item. You can also use this endpoint to create a company for the user. To create a company for the user, you need to send company parameters in the same request. Note: Some parameters are required for user verification. See our guide on Onboarding a Payout User/Seller for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Defaults to buyer-1556506027

Unique ID that can be generated by the platform. Cannot contain '.' character. Contact Assembly support if you want user IDs to be generated automatically.

first_name

string

required

Defaults to Neol1556506027

First name of the user

last_name

string

required

Defaults to Calangi

Last name of the user

string

required

Defaults to [email protected]

Email of the user. Unique to platform.

mobile

string

International number format. Include '+' and no spaces.

address_line1

string

First line of the user address

address_line2

string

Second line of the user address

state

string

State section of the user address

city

string

City section of the user address

zip

string

Postcode

country

string

required

Defaults to AUS

ISO 3166-1 alpha-3 country code (3 char)

dob

string

Date of Birth (DD/MM/YYYY).

government_number

string

Generic parameter to capture important user verification data. eg. SSN for US users, TFN for AU users.

drivers_license_number

string

Driving license number of the user

drivers_license_state

string

State section of the user's driving license

ip_address

string

IP address

logo_url

string

URL link to the logo

color_1

string

Color code number 1

color_2

string

Color code number 2

custom_descriptor

string

When custom_descriptors are enabled, this is the information to appear on bundle direct debit statements (which show the buyer's custom_descriptor) as well as international wire payout, direct credit and PayPal payout statements (which show the seller's custom_descriptor)

authorized_signer_title

string

‘Authorised Signer Title’, which refers to the role / job title (e.g. Director or General Manager) for the individual User, who is authorised to sign contracts on behalf of the business entity / Merchant User. (Note: information required for AMEX Merchants)

company

object

This is an optional field and if provided, the company will be created for the user.

Response

201OK