Update a specific customer's information

put

https://Contact sales to enable your sandbox/customers/{customer_id}

Path Params

customer_id

string

required

ID of the Customer

Body Params

Update an existing customer

address_line_one

string

required

Address line one.

address_line_two

string

Address line two.

address_city

string

required

Address city.

address_state

string

required

Address state.

address_zip

string

required

Five digit zipcode or nine digit 'ZIP+4'.

address_country_code

string

enum

ISO 3166-1 alpha-2 country code for the customer.

name_prefix

string

Prefix to the customer's name.

name_first

string

Customer's first name.

name_middle

string

Customer's middle name.

name_last

string

Customer's last name.

name_suffix

string

Suffix to the customer's name.

customer_type

string

enum

The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation.

Allowed:

verification_status

string

enum

The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the result.

Allowed:

phone_number

string

Customer's phone number in E.164 format.

ssn

string

Social security number of the customer.

title

string

Title of the customer if a person OR title of the admin if a business

international_customer_id

string

Any country-specific unique identifier for the customer.

string

The Customer's email address.

date_of_birth

date

Customer's date of birth in ISO 8601 format.

business_details

object

Responses

401

Unauthorized.

403

Forbidden.

404

Customer not found

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful query of information for a specific customer