Borrowers

Create a consumer borrower

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

post/borrowers/consumer

Request

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

Request body

date_of_birthstring required

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

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 nullable

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

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

Example request

{
  "date_of_birth": "1991-12-18",
  "email": "jdough@acme.co",
  "first_name": "Jane",
  "last_name": "Dough",
  "government_identifiers": {
    "passport": {
      "country": "USA",
      "number": "PA0940443",
      "issue_date": "2012-12-12"
    },
    "drivers_license": {
      "country": "USA",
      "province": "USA-CA",
      "number": "D9892111",
      "issue_date": "2012-12-12"
    }
  }
}

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.