Borrowers

Create a consumer borrower

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

Request

This endpoint expects an object.
address
objectRequired
The address of the borrower
date_of_birth
stringRequired
The borrower's date of birth (YYYY-MM-DD)
email
stringRequired
The borrower's valid email address
first_name
stringRequired
The borrower's first name
last_name
stringRequired
The borrower's last name
kyc_completion_date
stringOptional
Date kyc completed on the borrower, only required if Pier is not performing KYC (YYYY-MM-DD)
kyc_status
enumOptional

Kyc status of a consumer (sandbox only)

Allowed values: approveddeclinedpending
government_identifiers
objectOptional
The borrower's government identifiers, required fields dependent on customer configuration

Response

This endpoint returns an object
address
object
The address of the borrower
date_of_birth
string
The borrower's date of birth (YYYY-MM-DD)
id
string
The ID of the borrower
email
string
The borrower's valid email address
first_name
string
The borrower's first name
last_name
string
The borrower's last name
kyc_completion_date
string
Date kyc completed on the borrower (YYYY-MM-DD)
created_on
datetime
The date the borrower was created

Errors

POST
1curl -X POST https://production.pier-finance.com/api/borrowers/consumer \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "address": {
6    "line_1": "15 Main Street",
7    "city": "Austin",
8    "state": "TX",
9    "zip": "73301",
10    "line_2": "Unit 204"
11  },
12  "date_of_birth": "1991-12-18",
13  "email": "jdough@acme.co",
14  "first_name": "Jane",
15  "last_name": "Dough",
16  "kyc_completion_date": "2022-11-15",
17  "kyc_status": "approved",
18  "government_identifiers": {
19    "ssn": "999888777"
20  }
21}'
1{
2  "address": {
3    "line_1": "15 Main Street",
4    "city": "Austin",
5    "state": "TX",
6    "zip": "73301",
7    "line_2": null
8  },
9  "date_of_birth": "1991-12-18",
10  "id": "bor_a1d0c30d77104f35b4c842b99132624e",
11  "email": "jdough@acme.co",
12  "first_name": "Jane",
13  "last_name": "Dough",
14  "kyc_completion_date": "2022-11-15",
15  "created_on": "2022-12-31T00:58:47.828Z"
16}
Built with