Update Application Co-Borrowers

The Update Application Co-Borrowers API can be used to add or remove co-borrower(s) from an application.

Example Requests

Below please find the JSON body for four example requests:

Example 1: Removing a co-borrower from an application.
Example 2: Adding an existing borrower to an application as a co-borrower.
Example 3: Adding a new borrower to an application as a co-borrower.
Example 4: Adding multiple borrowers to an application as co-borrowers.

{
  "coBorrowerIdToDelete": "63ca97e69ee2e89fc9163772"
}

{
  "coBorrowersToAdd": ["63ca97e69ee2e89fc9163772"]
}

{
  "coBorrowersToAdd": [
    {
      "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,
        }],
      }
    }
  ]
}

{
  "coBorrowersToAdd": [
    "63ca97e69ee2e89fc9163772",
    { 
      "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,
        }],
      }
    }
  ]
}

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