Create Borrower

The Create Borrower API is used to create a borrower. Each borrower can be either a "Person" or "Company" and contains the variables (i.e. data fields) that have been added to your configured borrower profile.


📘

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request Body

metadata
object

Optional associated metadata as a simple key→value map.

  • Keys are strings up to 40 characters long.
  • Values can be string, number, or boolean.
  • Up to 20 entries.
  • String values up to 500 characters.
string
enum
required

Can be either "person" or "company"

Allowed:
variables
object
required
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

string

Reason to lock the borrower, can be empty

Headers
string
enum
Defaults to 2026-04-22
Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json