V3 Manage Non-Borrowing Owners

Add, update, delete, re-order, or replace non-borrowing owners for the loan, specified by the loan ID, if the user has access rights to the loan.

Usage Notes

See the following notes regarding each action query parameter value:

  • add - Do not provide “id”. It will be automatically generated.
  • update - The “id” is required to update the appropriate NBO record. Only properties that are provided in the request are updated.
  • delete - The “id” of the non-borrowing owner that you want to delete is the only property required.
  • reorder - Reorders the existing collection of non-borrowing owners. All non-borrowing owner “id’s” must be provided in the payload and in the order you want them, starting with the non-borrowing owner you want to appear first, and then so on.

❗️

KNOWN ISSUE: The “reorder” action is supported, but will remove the Vesting Information if sent. Please be aware of this issue. This will be resolved in a future release.

  • replace - Replaces all non-borrowing owners in the collection with non-borrowing owner provided in the request payload (i.e., deletes existing collection and then replaces with the non-borrowing owners provided in the request). New “id’s” are generated for the replaced non-borrowing owners.
Path Params
string
required

Unique identifier of the loan. Required.

Query Params
string

Available values: add, update, delete, reorder, replace

string

Optional. View type parameter. Enumerations: entity, id
When no view parameter is provided, the API will return 204 - No Content with no response body.

string

Lock indentifier.

boolean

Empty fields can be retrieved by passing the query parameter includeEmpty=true.

Headers
string
required

Bearer token

Responses

Language
Request
Response
Choose an example:
application/json