Skip to content

Get collateral summaries for a deal

GET 
/api/apiGateway/getDealCollateralSummary/{dealId}

Get the collateral summaries for the provided deal id.

Parameters

dealId string

The unique identifier of the deal that you want to retrieve collateral summaries for.

Response

Type: application/json

Schema: CollateralSummaryResponseDto

success boolean

Indicates whether the request completed successfully.

error ErrorDto

collateralSummaries array [ CollateralSummaryDto ]

GET ${BASE_URL}/api/apiGateway/getDealCollateralSummary/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7
Accept: */*
Authorization: Bearer eyJz93a...k4laUWw

curl --request GET \
    --url "${BASE_URL}/api/apiGateway/getDealCollateralSummary/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7" \
    --header 'Accept: */*' \
    --header 'Authorization: Bearer eyJz93a...k4laUWw'
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": ["string"]
  },
  "collateralSummaries": [
    {
      "id": "string",
      "address": {
        "fullAddress": "string",
        "placeId": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        },
        "zipCode": "string",
        "number": 0,
        "street": "string",
        "city": "string",
        "county": "string",
        "state": "string",
        "country": "string",
        "additionalFreeText": "string"
      },
      "name": "string",
      "netIncome": 0,
      "netOperatingIncome": 0,
      "incomeValuation": 0,
      "alternativeValuation": 0,
      "salesValuation": 0,
      "totalSF": 0,
      "totalUnit": 0
    }
  ]
}