Update a user

Update a user

PUT https://sandbox-api.com/v1/users/{user_id}

Returns the user object if successful. Returns an error if update parameters are invalid (e.g. specifying an invalid phone number or incorporation date). The EIN/TIN/CRN is not included in the response.

Request Body

Name
Type
Description

address*

object

The business's address. Must be a valid address. For the address schema, see The user object.

first_name*

string

The legal business name

email*

string

The business's email address.

entity*

enum

The type of business. Acceptable values:

'SOLE_PROPRIETORSHIP', 'GENERAL_PARTNERSHIP', 'LIMITED_PARTNERSHIP', 'CORPORATION', 'LIMITED_LIABILITY_COMPANY', 'LIMITED_LIABILITY_PARTNERSHIP'

EIN/TIN/CRN*

string

The business's employer identification number (EIN), the Tax identification Number (TIN), Company Registration Number (CRN) . The EIN, TIN, CRN must be AES encrypted In CBC Mode using your secret_key

phone*

string

The business's phone number. Must be a valid phone number.

user_type*

enum

Required to be set to business for commercial users

key_people*

array

A list of owners, directors or other beneficiaries of the business. 

{
    "uuid": "50d6c5df-abd6-43de-9c48-d85146e96c11",
    "first_name": "Fairlender Inc",
    "middle_name": null,
    "last_name": null,
    "dwolla_customer_url": null,
    "user_type": "BUSINESS",
    "start_date": "2012-07-04",
    "website": null,
    "entity": "CORPORATION",
    "industry": null,
    "email": "[email protected]",
    "phone": "+237697888676",
    "address": {
        "line_1": "77 Geary Street",
        "line_2": null,
        "line_3": null,
        "zip": "94108",
        "city": "Douala",
        "region": "LT",
        "country": "CAMEROON"
    },
    "key_people": [
        {
            "uuid": "3189f45f-bdb1-4115-ab41-dde4d6207edb",
            "first_name": "Blair",
            "last_name": "Cassidy",
            "middle_name": "Dufresne",
            "title": "BENEFICIARY",
            "phone": "+237678823456",
            "email": "[email protected]",
            "citizenship": "CM",
            "address": {
                "line_1": "161 Stansfield Dr",
                "city": "Zionsville",
                "region": "LT",
                "zip": "18092",
                "country": "CAMEROON"
            }
        }
    ]
}
PreviousCreate a userNextRetrieve a user

Last updated