Create a new customer

post

https://Contact sales to enable your sandbox/customers

Customer can be created within Canopy with attached data managed in a secure and compliant way to facilitate providing the best service for products created through Canopy.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a new customer

Passport information. required if country is not US

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.

passport

object

customer_id

string

The ID associated to be with the customer for future requests. If not provided on customer creation, Canopy will generate this field.

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:

customer_parent_id

string

The customer can be a child customer to another parent customer. This is used most commonly to show a PERSON customer that is a child of a BUSINESS customer.

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:

title

string

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

phone_number

string

required

Customer's phone number in E.164 format.

ssn

string

Social security number of the customer.

international_customer_id

string

Any country-specific unique identifier for the customer.

string

required

The Customer's email address.

date_of_birth

date

required

Customer's date of birth in ISO 8601 format.

business_details

object

assign_to_accounts

array of objects | null

An array of existing accounts to which this Customer should be assigned. If left empty, the customer will not be assigned to any accounts, and can be later assigned to an account via the Update an existing customer route. Customers only become meaningful agents in Canopy's servicing system once they are assigned to accounts.

assign_to_accounts

metro2_config

object

Metro2 credit reporting configs

Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

200New Customer Created