Skip to content

Get Cross Deal Collateral Report

Maps collateral IDs to their parent deal IDs. This utility endpoint is useful for cross-deal reporting and collateral portfolio analysis.

Key Details

  • Request body contains collateralIds[] — an array of collateral UUIDs.
  • Response returns body[] with each collateral ID mapped to its corresponding dealId.
  • Useful when you have collateral IDs from various sources (e.g., portfolio reports, risk dashboards) and need to retrieve their parent deal context.
  • All collateral and deal IDs are UUIDs.

Request

Type: application/json

Schema: CrossDealCollateralReportFilterDto

collateralIds array [ string ]

IDs of the collateral properties to include in the report

Response

Status: 200

Type: application/json

Schema: CrossDealCollateralReportResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto
target string

Field or parameter that caused the error

code string(enum)

Error code (e.g., Duplicated, MissingMandatoryField, InvalidCreateValues, MissingEntity)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ]
body array [ DealCollateralPairDto ]
collateralId string

Unique identifier for the collateral property

dealId string

Unique identifier for the deal

POST 
/api/apiGateway/getCrossDealCollateralReport
Request Body
{
  "collateralIds": [
    "string"
  ]
}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "body": [
    {
      "collateralId": "string",
      "dealId": "string"
    }
  ]
}