Query an entity profile

Fetch the profile that links every record of an entity across cases.

Use entityProfileDetails with a profileId, or with an entityId from a case, to fetch an entity’s current profile. entityIds lists every entity record linked to the profile.

Required scope: read-only

Request

query entityProfileDetails($input: EntityProfileDetailsInput!) {
  entityProfileDetails(input: $input) {
    ... on EntityProfile {
      profileId
      legalName
      entityType
      identifier
      registeredCountry {
        CCA2
      }
      status
      monitoring {
        status
        lastEnabledOn
        lastDisabledOn
        expiresOn
      }
      entityIds
      mergedProfileIds
    }
    ... on ValidationErrors {
      errors {
        message
      }
    }
  }
}

Variables

{
  "input": {
    "profileId": "c7e5a3b1-9d2f-4c8e-a6b4-3f1e2d0c9b8a"
  }
}

Response

{
  "data": {
    "entityProfileDetails": {
      "profileId": "c7e5a3b1-9d2f-4c8e-a6b4-3f1e2d0c9b8a",
      "legalName": "Citizen Family Trust",
      "entityType": "TRUST",
      "identifier": null,
      "registeredCountry": {
        "CCA2": "NZ"
      },
      "status": "ACTIVE",
      "monitoring": {
        "status": "NOT_SCREENED",
        "lastEnabledOn": null,
        "lastDisabledOn": null,
        "expiresOn": null
      },
      "entityIds": [
        "5102"
      ],
      "mergedProfileIds": []
    }
  }
}

---