Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Users

Create User

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.

post/users

Request body

idstring required

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_namestring required

First name of the user

last_namestring required

Last name of the user

emailstring required

Email of the user. Unique to platform.

mobilestring

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

address_line1string

First line of the user address

address_line2string

Second line of the user address

statestring

State section of the user address

citystring

City section of the user address

zipstring

Postcode

countrystring required

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

dobstring

Date of Birth (DD/MM/YYYY).

government_numberstring

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

drivers_license_numberstring

Driving license number of the user

drivers_license_statestring

State section of the user's driving license

ip_addressstring

IP address

logo_urlstring

URL link to the logo

color_1string

Color code number 1

color_2string

Color code number 2

custom_descriptorstring

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_titlestring

‘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)

Example request

{
  "id": "buyer-1556506027",
  "first_name": "Neol1556506027",
  "last_name": "Calangi",
  "email": "neol.calangi+buyer1556506027@promisepay.com",
  "mobile": "+21556506027",
  "country": "AUS",
  "authorized_signer_title": "Director",
  "company": {
    "name": "ABC",
    "legal_name": "ABC Pty Ltd",
    "tax_number": "123456789",
    "business_email": "test@sample.com",
    "address_line1": "Collins",
    "city": "Melbourne",
    "state": "VIC",
    "zip": "3000",
    "country": "AUS"
  }
}

Response

OK

Example response

{
  "users": {
    "full_name": "Samuel Seller",
    "email": "samuel.seller@assemblypayments.com",
    "first_name": "Samuel",
    "last_name": "Seller",
    "id": "Seller_1234",
    "location": "AUS",
    "verification_status": "pending",
    "roles": [
      "customer"
    ],
    "dob": "encrypted",
    "government_number": "encrypted",
    "related": {
      "addresses": "fe602dcf-4175-4f88-b5be-3beb04092dcd"
    }
  }
}