Create a new borrower

Creates a new borrower.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
passport
object
string

Prefix to the customer's name.

string

Customer's first name.

string

Customer's middle name.

string

Customer's last name.

string

Suffix to the customer's name.

string
required

Address line one.

string

Address line two.

string
required

Address city.

string
required

Address state.

string
required

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

string
enum

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

string

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

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:
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.

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:
string

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

string
required

Customer's phone number in E.164 format.

string

Social security number of the customer.

string

Any country-specific unique identifier for the customer.

string
required

The Customer's email address.

date
required

Customer's date of birth in ISO 8601 format.

business_details
object
assign_to_accounts
array of objects
length ≤ 100
Assign To Accounts
metro2_config
object
attributes
object

Arbitrary customer attributes

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json