Create a new customer

URL Expired

The URL for this request expired after 30 days.

Create a new customer

Passport information required if country is not US

• address_line_one

  • Type: string
  • Required: true
  • Description: Address line one.

• address_line_two

  • Type: string
  • Description: Address line two.

• address_city

  • Type: string
  • Required: true
  • Description: Address city.

• address_state

  • Type: string
  • Required: true
  • Description: Address state.

• address_zip

  • Type: string
  • Required: true
  • Description: Five digit zipcode or nine digit 'ZIP+4'.

• address_country_code

  • Type: string
  • Enum: ISO 3166-1 alpha-2 country code for the customer.

Values: US, GB, CA, etc.

• name_prefix

  • Type: string
  • Description: Prefix to the customer's name.

• name_first

  • Type: string
  • Description: Customer's first name.

• name_middle

  • Type: string
  • Description: Customer's middle name.

• name_last

  • Type: string
  • Description: Customer's last name.

• name_suffix

  • Type: string
  • Description: Suffix to the customer's name.

• passport

  • Type: object
  • Description: Passport object

• customer_id

  • Type: string
  • Pattern: ^(?!can_).*$
  • Description: The ID associated with the customer for future requests. If not provided on customer creation, Canopy will generate this field.

• customer_type

  • 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: person, business

• customer_parent_id

  • Type: string
  • Description: 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

  • Type: 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: unverified, verified, retry, document

• title

  • Type: string
  • Description: Title of the customer if a person OR title of the admin if a business.

• phone_number

  • Type: string
  • Required: true
  • Description: Customer's phone number in E.164 format.

• ssn

  • Type: string
  • Description: Social security number of the customer.

• international_customer_id

  • Type: string
  • Description: Any country-specific unique identifier for the customer.

• email

  • Type: string
  • Required: true
  • Description: The Customer's email address.

• date_of_birth

  • Type: date
  • Required: true
  • Description: Customer's date of birth in ISO 8601 format.

• business_details

  • Type: object
  • Description: Business details object.

• assign_to_accounts

  • Type: array of objects | null
  • Description: 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.

• metro2_config

  • Type: object
  • Description: Metro2 credit reporting configs.

Response Codes

• 200 New Customer Created
• 401 Unauthorized.
• 403 Forbidden.
• 422 Invalid input
• 429 Too many requests.
• default Unexpected Error.