Borrowers API¶

Manage borrower profiles, contacts, identities, payment instruments, and related data.

Base permission: IsViewerOrAbove (read), IsLoanOfficerOrAbove (write)

Endpoints¶

Borrowers¶

Method	Path	Description	Permission
`GET`	`/borrowers`	List borrowers	`IsViewerOrAbove`
`GET`	`/borrowers/{id}`	Get borrower	`IsViewerOrAbove`
`POST`	`/borrowers`	Create borrower	`IsLoanOfficerOrAbove`
`PUT`	`/borrowers/{id}`	Update borrower	`IsLoanOfficerOrAbove`
`DELETE`	`/borrowers/{id}`	Archive borrower	`IsLoanOfficerOrAbove`
`POST`	`/borrowers/{id}/unarchive`	Unarchive borrower	`IsLoanOfficerOrAbove`
`GET`	`/borrowers/{id}/history`	Get audit history	`IsViewerOrAbove`

Create Borrower¶

POST /api/v1/borrowers

{
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1985-03-15",
  "ssn_last_four": "1234",
  "language_preference": "en",
  "external_id": "BRW-EXT-001"
}

Response (201):

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1985-03-15",
  "ssn_last_four": "1234",
  "language_preference": "en",
  "do_not_contact": false,
  "external_id": "BRW-EXT-001",
  "is_archived": false,
  "created_at": "2026-01-15T14:30:00Z",
  "updated_at": "2026-01-15T14:30:00Z"
}

Note

The full SSN is never returned in API responses. Only ssn_last_four is exposed.

Nested Resources¶

Addresses¶

Method	Path	Description
`GET`	`/borrowers/{id}/addresses`	List borrower's addresses
`POST`	`/borrowers/{id}/addresses`	Add address to borrower

Flat endpoints for update/delete:

Method	Path	Description
`GET`	`/addresses/{id}`	Get address
`PUT`	`/addresses/{id}`	Update address
`DELETE`	`/addresses/{id}`	Delete address

Create address:

{
  "address_type": "mailing",
  "street_line_1": "123 Main St",
  "street_line_2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "postal_code": "10001",
  "country": "US",
  "is_primary": true
}

Email Contacts¶

Method	Path	Description
`GET`	`/borrowers/{id}/emails`	List borrower's emails
`POST`	`/borrowers/{id}/emails`	Add email to borrower

Flat endpoints: GET /emails/{id}, PUT /emails/{id}, DELETE /emails/{id}

Phone Contacts¶

Method	Path	Description
`GET`	`/borrowers/{id}/phones`	List borrower's phones
`POST`	`/borrowers/{id}/phones`	Add phone to borrower

Flat endpoints: GET /phones/{id}, PUT /phones/{id}, DELETE /phones/{id}

Phone numbers must be in E.164 format (e.g., +12125551234).

Business Details¶

Method	Path	Description
`GET`	`/borrowers/{id}/business-detail`	Get business detail
`POST`	`/borrowers/{id}/business-detail`	Create business detail

Flat endpoints: GET /business-details/{id}, PUT /business-details/{id}

Identities¶

Method	Path	Description
`GET`	`/borrowers/{id}/identities`	List identities
`POST`	`/borrowers/{id}/identities`	Add identity

Flat endpoints: GET /borrower-identities/{id}, PUT /borrower-identities/{id}, DELETE /borrower-identities/{id}

Payment Instruments¶

Method	Path	Description
`GET`	`/borrowers/{id}/payment-instruments`	List payment instruments
`POST`	`/borrowers/{id}/payment-instruments`	Add payment instrument

Flat endpoints: GET /payment-instruments/{id}, PUT /payment-instruments/{id}, DELETE /payment-instruments/{id}

Create payment instrument:

{
  "instrument_type": "bank_account",
  "account_holder_name": "John Doe",
  "bank_name": "Chase",
  "routing_number": "021000021",
  "account_number_last_four": "6789",
  "account_type": "checking",
  "is_verified": true
}

Consents¶

Method	Path	Description
`GET`	`/borrowers/{id}/consents`	List consents
`POST`	`/borrowers/{id}/consents`	Record consent

Flat endpoints: GET /borrower-consents/{id}, POST /borrower-consents/{id}/revoke

Legal Representatives¶

Method	Path	Description
`GET`	`/borrowers/{id}/legal-reps`	List legal representatives
`POST`	`/borrowers/{id}/legal-reps`	Add legal representative

Flat endpoints: GET /legal-reps/{id}, PUT /legal-reps/{id}, DELETE /legal-reps/{id}

Autopay Plans¶

Method	Path	Description
`GET`	`/borrowers/{id}/autopay-plans`	List autopay plans
`POST`	`/borrowers/{id}/autopay-plans`	Create autopay plan

Flat endpoints: GET /autopay-plans/{id}, PUT /autopay-plans/{id}, DELETE /autopay-plans/{id}

Notes¶

Method	Path	Description
`GET`	`/borrowers/{id}/notes`	List notes on borrower
`POST`	`/borrowers/{id}/notes`	Add note to borrower

Tasks¶

Method	Path	Description
`GET`	`/borrowers/{id}/tasks`	List tasks on borrower
`POST`	`/borrowers/{id}/tasks`	Add task to borrower

Filtering¶

Parameter	Description
`q`	Search by name or email
`status`	Filter by active/archived status
`do_not_contact`	Filter by do-not-contact flag
`external_id`	Lookup by external ID