Borrowers

Update a consumer borrower

Updates an existing borrower. The full borrower object less a few unchangeable fields needs to be supplied in the update request.

patch/borrowers/consumer/{borrower_id}

Request

Base URL
https://production.pier-finance.com/api
Auth
HTTP bearer

Path parameters

borrower_idstring required

Request body

date_of_birthstring required

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

emailstring required

The borrower's valid email address

kyc_completion_datestring nullable

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

kyc_status'approved' | 'declined' | 'pending'

Example request

{
  "date_of_birth": "1991-12-18",
  "email": "jdough@acme.co"
}

Response

date_of_birthstring required

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

idstring required

emailstring required

The borrower's valid email address

first_namestring required

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

last_namestring required

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

kyc_completion_datestring required

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

created_onstring date-time required

The date the borrower was created

Example response

{
  "date_of_birth": "1991-12-18",
  "email": "jdough@acme.co",
  "first_name": "Jane",
  "last_name": "Dough",
  "kyc_completion_date": "2022-11-15",
  "created_on": "2022-12-31T00:58:47.828Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.