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.

Example Requests

Below please find the JSON body for three example requests:

Example 1: Creating a borrower that is a "Person".
Example 2: Creating a borrower that is a "Company".
Example 3: Creating a borrower that is locked and therefore can't submit applications.

{
  "type": "person",
  "variables": {
    "variable_system_name_1": "Example",
    "variable_system_name_2": 999,
    "variable_system_name_3": true,
    "variable_system_name_4": "+19172245555",
    "variable_system_name_5": "date",
    "variable_system_name_6": [{
      		"_id": "390aNZbf0yPktuYm2fJdz",
          "asset_type": "House",
          "asset_price": 100000,
        }, {
          "_id": "h31rBtqWElsqO-GNcuTuw",
          "asset_type": "Store",
          "asset_price": 50000,
        }],
  }
}

{
  "type": "company",
  "variables": {
    "variable_system_name_1": "Example",
    "variable_system_name_2": 999,
    "variable_system_name_3": true,
    "variable_system_name_4": "+19172245555",
    "variable_system_name_5": "date",
    "variable_system_name_6": [{
      		"_id": "390aNZbf0yPktuYm2fJdz",
          "asset_type": "House",
          "asset_price": 100000,
        }, {
          "_id": "h31rBtqWElsqO-GNcuTuw",
          "asset_type": "Store",
          "asset_price": 50000,
        }],
  }
}

{
    "type": "person",
    "lockEndDate": "2025-08-09T18:31:42",
    "lockReason": "Some Reason",
    "variables": {
      "variable_system_name_1": "Example",
      "variable_system_name_2": 999,
      "variable_system_name_3": true,
      "variable_system_name_4": "+19172245555",
      "variable_system_name_5": "date",
      "variable_system_name_6": [{
        	"_id": "390aNZbf0yPktuYm2fJdz",
          "asset_type": "House",
          "asset_price": 100000,
        }, {
          "_id": "h31rBtqWElsqO-GNcuTuw",
          "asset_type": "Store",
          "asset_price": 50000,
        }],
    }

}

📘
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.