Fetch collateral schema

Overview

The Fetch Collaterals activity is used to retrieve collateral details related to a specific party, including assets, collateral objects, and collateral agreements. This process is essential for understanding the collateral position associated with an individual or entity.

• Assets: Includes various asset types such as real estate, vehicles, ships, shares, and more.
• Collateral Objects: Covers registered collateral objects linked to the party.
• Collateral Agreements: Contains agreements that define the terms of the collateral arrangements.

Usage

This activity is typically called during credit assessments or loan evaluations to gather collateral information on a party's asset position.

Request

The activity sends a request to the following endpoint:

• Endpoint: /collaterals
• Method: POST

Request Body

The request must include a JSON object with the following structure:

• partyId (string): The unique identifier for the party whose collaterals are to be fetched.

Response Types

The activity returns a response in the following format:

• FetchCollateralsResponseBody: Contains the collateral details when the lookup is successful.

Response Content

• assets: An array of assets owned by the party.
• collateralObjects: Registered collateral objects.
• collateralAgreements: Collateral agreements linked to the party.

Integration Notes

• Ensure that the partyId provided in the request is valid and corresponds to an existing party in the system.
• The response provides a comprehensive view of the party's collateral position across different asset types.

Data Structures

See the OpenAPI schema for detailed information about asset types and their properties.