Fetch engagement schema

Overview

The Fetch Engagement activity is used to retrieve engagement details related to a specific party, including both financing and non-financing agreements. This process is essential for understanding the financial relationships associated with an individual or entity.

• Financing: Includes details about loan accounts and other financial instruments.
• Non-Financing Agreements: Covers deposit accounts and other agreements not classified as financing.

Usage

This activity is typically called during financial assessments or evaluations to gather engagement information on a party's financial status.

Request

The activity sends a request to the following endpoint:

• Endpoint: /engagement
• Method: POST

Request Body

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

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

Response Types

The activity returns a response in the following format:

• FetchEngagementResponseBody: Contains the engagement details when the lookup is successful.

Response Content

• Financing: An array of financing agreements (e.g., loan accounts).
• NonFinancingAgreements: An array of non-financing agreements (e.g., deposit accounts).

Integration Notes

• Ensure that the partyId provided in the request is valid and corresponds to an existing party in the system.
• The response differentiates between financing and non-financing engagements to ease decision-making based on the party's financial relationships.

Data Structures

Financing Agreement

This includes loan accounts and other relevant financial information, which may provide details such as loan amounts, types, and statuses.

Non-Financing Agreements

Covers details about deposit accounts and related agreements, useful for understanding an individual's other financial commitments.