Default loan contract

Use case

In this article we will review how to default a loan contract.

Use case data
API parameters with values

The loan contract header ID is ID-1664282427 and the contract version is ID-1664282427.

...v2/contracts/ID-1664282427/versions/ID-1664282427/...

circle-info

You can find the header ID and the contract version by calling the find person contracts API endpoint.

Sample API call

To default the loan contract, make the following API call.

https://loan-api.sandbox.tuumplatform.com/api/v2/contracts/{headerId}/versions/{versionId}/default

circle-info

See more about the default loan contractarrow-up-right endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call for defaulting the loan contract.

{
  "reasonCode": "PERMANENT_INSOLVENCY",
  "comment": "Free form description"
}

Sample response

Below you find an example response body to the API call above.

chevron-rightResponsehashtag

Result

The contract with the number SM-1000 is set to the DEFAULT status.

Last updated

Was this helpful?