Request Sandbox KeysSee a Demo
  • Overview
    • Quickstart
    • Payments and Disbursements
    • Errors
    • Webhooks
  • Guides
    • Compliance
    • Starter Mode
    • KYC
    • Line of Credit program
    • Buy Now Pay Later program
  • API Reference
LogoLogo
Request Sandbox KeysSee a Demo
API ReferenceBorrowers

Update a consumer borrower

PATCH
/borrowers/consumer/:borrower_id
PATCH
/api/borrowers/consumer/:borrower_id
1curl -X PATCH https://production.pier-finance.com/api/borrowers/consumer/bor_a1d0c30d77104f35b4c842b99132624e \
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  "kyc_completion_date": "2022-11-15",
15  "kyc_status": "approved"
16}'
Try it
200Updated
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}
Updates an existing borrower. The full borrower object less a few unchangeable fields needs to be supplied in the update request.
Was this page helpful?
Previous

Retrieve a borrower by id

Next
Built with
Retrieve a borrower by id
Updates an existing borrower. The full borrower object less a few unchangeable fields needs to be supplied in the update request.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

borrower_idstringRequired

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
kyc_completion_datestringOptional
Date kyc completed on the borrower (YYYY-MM-DD)
kyc_statusenumOptional
Kyc status of a consumer (*sandbox only*)
Allowed values:

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 (min. 2 characters)
last_namestring
The borrower's last name (min. 2 characters)
kyc_completion_datestring
Date kyc completed on the borrower (YYYY-MM-DD)
created_ondatetime
The date the borrower was created

Errors

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

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

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

Bearer authentication of the form Bearer <token>, where token is your auth token.

The borrower’s last name (min. 2 characters)

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

The borrower’s first name (min. 2 characters)

Kyc status of a consumer (sandbox only)