Update Borrower

put

https://api.cloud.digifi.io/borrowers/{id}

The Update Borrower API is used to update a borrower. You can pass in all borrower parameters (and update the entire set of borrower data) or pass in only the parameters you want to update (and only update those parameters).

We strongly recommend to send the date value in "MM/DD/YYYY" format to avoid any issues with date representation.

Please note that each row in a variable of type Table must contain a unique string _id field.

Path Params

string

required

ID of borrower to update

Body Params

Request Body

metadata

Partial update for metadata as a key→value map.

Keys are strings up to 40 characters long.
Values can be string, number, boolean, or null (to delete the entry).
Up to 40 entries.
String values up to 500 characters.

variables

object

A dynamic key-value store for custom variables associated with an application, borrower, intermediary

This field accepts flexible data types to accommodate diverse metadata:

Primitives: - Strings (e.g., "name") - Numbers (e.g., 123) - Booleans (e.g., true) - null to clear value from variable
Structured data: - Arrays for table variables - Objects for address variables

Note for ReadMe Testing: The ReadMe API Explorer form interface only supports primitive types (string, number, null) for manual input. To test array, object, boolean types, use direct API calls (e.g., cURL or Postman)

lockEndDate

string | null

Pass Date in ISO8601 format to set lock end date (passing "2099-12-31T00:00:00.000Z" will mean lock forever), pass this param with null value to unlock the borrower

lockReason

string

Reason to lock the borrower, can be empty

Headers

api-version

string

enum

Defaults to 2024-02-26

Allowed:

Responses

200Success

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error