Users#Create

Creating a user

Example Request

curl https://{{base_url}}/users
-X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-type: application/json" \
-d '{
    "user": {
        "beneficiary_type": "individual",
        "first_name": "Marco",
        "last_name": "Pierre White",
        "company_name": null,
        "email": "marco@cheq.xyz",
        "date_of_birth": "12/12/1985",
        "address_line1": "2 Bellevue Road",
        "address_line2": "Wandsworth Common",
        "city": "London",
        "state": "London",
        "postcode": "SW177EG",
        "country": "GB",
        "nationality": "GB",
        "phone": "+447515772386",
        "ssn": null,
        "source_of_funds": null,
        "business_activity": null
    }
}'

Endpoint Information

Create User

POST https://{{base_url}}/users

Create a new Pay.so user

Request Body

Name
Type
Description

first_name

String

The user's legally recognised first name, as shown on their identity document. Required if beneficiary_type is individual.

address_line1*

String

The first line of the address where the individual resides or the business's registered office address.

address_line2

String

The second line of the address where the individual resides or the business's registered office address.

city*

String

The city where the individual resides or the business's registered office is based.

last_name

String

The user's legally recognised last name, as shown on their identity document. Required if beneficiary_type is individual.

country*

String

The country where the individual resides or the business's registered office is based, in ISO 3166-1 alpha-2 format (e.g. 'GB' for the United Kingdom).

date_of_birth*

Date

The individual's date of birth or business's date of incorporation.

email*

String

The contact email for the user.

postcode*

String

The postal/zip code where the individual resides or the business's registered office is based.

state*

String

The state/county/district where the individual resides or the business's registered office is based. If the entity is based in the US, the state must be formatted to two letters e.g. 'CA' for California

ssn*

String

If you are adding a US individual. Use SSN number. If this is a US business, use an EIN number. If it is an international business, use a registration number. If you are adding an individual based outside of the US, use a number similar to a Social Security Number for their country.

beneficiary_type*

String

Specify whether the user is an individual or a business

company_name

String

The company's legal name. Required if beneficiary_type is business.

phone*

String

The phone number of the individual or business.

source_of_funds

String

A short description of how the business is funded. For example: 'Venture Capital' or 'Token Sale'. Only required if user is a business

business_activity

String

A short statement about the business's activity. E.g. 'An API service facilitating crypto-to-fiat payments to third parties'.

nationality*

String

The country where the individual was born in ISO 3166-1 alpha-2 format (e.g. 'GB' for the United Kingdom).

{
    "user": {
        "id": "a25a4274-8f50-4579-b476-8f35b297d4ad",
        "beneficiary_type": "individual",
        "first_name": "Marco",
        "last_name": "Pierre White",
        "company_name": null,
        "email": "marco@cheq.xyz",
        "date_of_birth": "12/12/1985",
        "address_line1": "2 Bellevue Road",
        "address_line2": "Wandsworth Common",
        "city": "London",
        "state": "London",
        "postcode": "SW177EG",
        "country": "GB",
        "ssn": null,
        "website": null,
        "source_of_funds": null,
        "business_description": null,
        "kyc": {
            "general": {
                "status": "not_started",
                "moderation_comment": null
            },
            "eur": {
                "status": "not_started",
                "swift_status": "not_started"
            },
            "usd": {
                "status": "not_started",
                "swift_status": "not_started"
            },
            "ars": {
                "status": "not_started",
                "swift_status": "not_started"
            }
        }
    }
}

Users cannot be created from the following countries: [AF BY BA BI CF CU KP CD ET GT GN GW HT IR IQ LB LY ML MM NI NE RU SO SS SD SY TN VE YE ZW]

PreviousUsersNextUsers#Show