Create a consumer borrower

POST
/borrowers/consumer

Create a consumer borrower. The created consumer resource is returned in the response.

Request

This endpoint expects an object.
addressobjectRequired

The address of the borrower

date_of_birthstringRequired

The borrower’s date of birth (YYYY-MM-DD)

emailstringRequired

The borrower’s valid email address

first_namestringRequired

The borrower’s first name

last_namestringRequired

The borrower’s last name

kyc_completion_datestringOptional

Date kyc completed on the borrower, only required if Pier is not performing KYC (YYYY-MM-DD)

kyc_statusenumOptional
Allowed values: approveddeclinedpending

Kyc status of a consumer (sandbox only)

government_identifiersobjectOptional

The borrower’s government identifiers, required fields dependent on customer configuration. Can be non-unique on sandbox environment.

Response

This endpoint returns an object.
addressobject

The address of the borrower

date_of_birthstring

The borrower’s date of birth (YYYY-MM-DD)

idstring

The ID of the borrower

emailstring

The borrower’s valid email address

first_namestring

The borrower’s first name

last_namestring

The borrower’s last name

kyc_completion_datestring

Date kyc completed on the borrower (YYYY-MM-DD)

created_ondatetime

The date the borrower was created

Errors