Skip to main content

Gets loanSecurities via a single related deal

GET/jsonapi/deals/{id}/loanSecurities

Where id is the identifier of the deal

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

id path required

idinteger

format: int32

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request GET "${API_BASE_URL}/jsonapi/deals/{id}/loanSecurities" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "UserId: $ADVISER_CONTACT_ID" \
  --header 'Accept: application/vnd.api+json'

Responses

200 response

application/vnd.api+json

Example response body

Generated from the OpenAPI Specification with illustrative values. Shows primary data and attributes where defined; optional links, relationships and included resources are omitted. Actual values and returned fields depend on your request and access.

{
  "data": [
    {
      "type": "deal-securities",
      "id": "1001",
      "attributes": {
        "contactForAccess": "Other",
        "isPreApproval": false,
        "contractPrice": 1,
        "landValue": 1,
        "currentValue": 1,
        "contractDate": "2026-01-15",
        "licensedRealEstateAgentContract": false,
        "propertyState": "string",
        "isElectronicTransfer": false,
        "titleType": "string",
        "title": "string",
        "valuationBasis": "string",
        "propertyType": "string",
        "propertyZoning": "string",
        "propertyHolding": "string",
        "propertyPrimaryPurpose": "string",
        "futureValue": 1,
        "buildAmount": 1,
        "propertyStatus": "string",
        "constructionType": "string",
        "constructionCategory": "string",
        "propertyTransaction": "string",
        "securityType": "string",
        "propertySuburb": "string",
        "accessFaxNumber": "string",
        "accessFaxAreaCode": "string",
        "accessMobileNumber": "string",
        "accessMobileAreaCode": "string",
        "accessPhoneNumber": "string",
        "accessPhoneAreaCode": "string",
        "accessContactLastName": "string",
        "isAnnualPropertyTax": false,
        "accessContactFirstName": "string",
        "accessContactTitle": "string"
      }
    }
  ]
}
200 responseobjectDealSecuritiesDocument ↗
metaobjectread only
jsonApiobjectread only
linksall ofread only
dataarrayrequired
includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.