# Query Using an Id

Search link database for Identity with supplied ID (linkId or external entity ID)

Endpoint: POST /v2/identityIdQuery
Version: 1.0.0
Security: bearerAuth

## Request fields (application/json):

  - `auditId` (object, required)
    Audit identifier for tracking

  - `auditId.auditId` (string)
    Unique audit identifier
    Example: "audit-123"

  - `customerId` (string, required)
    Customer identifier
    Example: "customer-456"

  - `auditLogMap` (object)
    Audit logging metadata
    Example: {"action":"query_identity","timestamp":"2025-12-16T10:30:00Z"}

  - `content` (object, required)
    Request object used to query by LinkId or external entity Id

  - `content.linkId` (string, required)
    The id to query for
    Example: "link-789"

  - `content.includeEnrichData` (boolean)
    Flag to include enrich data in the response, defaults to false
    Example: true

  - `content.addVeratoReferenceToEntity` (boolean)
    Flag to include verato reference data with the entity in the response

  - `content.responseIdentityFormatNames` (array)
    A set of values that indicates the different formats of the Identity to be sent back in the response. If no values are specified, "DEFAULT" is assumed.
    Example: ["DEFAULT","GROUP_BY_SOURCE"]

  - `trackingId` (string)
    Request tracking identifier
    Example: "track-101112"

## Response 200 fields (application/json):

  - `auditId` (object, required)
    Audit identifier for tracking

  - `auditId.auditId` (string)
    Unique audit identifier
    Example: "audit-123"

  - `success` (boolean, required)
    Indicates if the request was successful
    Example: true

  - `message` (string)
    Response message
    Example: "OK"

  - `unparsedJson` (string)
    Raw unparsed JSON response, if applicable

  - `warnings` (array)
    List of warning messages
    Example: ["Partial data returned"]

  - `errors` (array)
    List of error messages

  - `retryableError` (boolean)
    Indicates if the error is retryable

  - `content` (object)
    Response object for query by linkId

  - `content.linkId` (string,null)
    The linkId of the returned Identity. May differ from requested LinkId for Identities that have been merged
    Example: "link-789"

  - `content.requestedLinkId` (string)
    The linkId used in the original query
    Example: "link-789"

  - `content.identity` (object)
    API object representing a patient or entity identity

  - `content.identity.names` (array)
    Array of names for this identity

  - `content.identity.names.prefix` (string)
    Name prefix (e.g., Dr., Mr., Ms.)

  - `content.identity.names.firstName` (string)
    First name

  - `content.identity.names.middleName` (string)
    Middle name

  - `content.identity.names.lastName` (string)
    Last name

  - `content.identity.names.suffix` (string)
    Name suffix (e.g., Jr., Sr., Ph.D.)

  - `content.identity.names.sources` (array)
    Sources where this name was found

  - `content.identity.names.sources.sourceId` (string)
    Unique identifier for the source system

  - `content.identity.names.sources.sourceName` (string)
    Name of the source system

  - `content.identity.names.sources.displayName` (string)
    Display name for the source

  - `content.identity.names.sources.nativeId` (string)
    Native identifier in the source system

  - `content.identity.names.clusterStatus` (string)
    Status of this clustered attribute
    Enum: "ACTIVE", "INACTIVE"

  - `content.identity.addresses` (array)
    Array of addresses for this identity

  - `content.identity.addresses.type` (string)
    Type of address (e.g., HOME, WORK)

  - `content.identity.addresses.line1` (string)
    First line of address

  - `content.identity.addresses.line2` (string)
    Second line of address

  - `content.identity.addresses.city` (string)
    City name

  - `content.identity.addresses.state` (string)
    State or province

  - `content.identity.addresses.postalCode` (string)
    Postal or ZIP code

  - `content.identity.addresses.country` (string)
    Country name

  - `content.identity.addresses.latitude` (number)
    Latitude coordinate

  - `content.identity.addresses.longitude` (number)
    Longitude coordinate

  - `content.identity.addresses.sources` (array)
    Sources where this address was found

  - `content.identity.datesOfBirth` (array)
    Array of birth dates for this identity

  - `content.identity.datesOfBirth.dateOfBirth` (string)
    The date of birth

  - `content.identity.datesOfBirth.sources` (array)
    Sources where this date was found

  - `content.identity.datesOfBirth.clusterStatus` (string)
    Current status of this clustered attribute
    Enum: "ACTIVE", "INACTIVE"

  - `content.identity.ssns` (array)
    Array of social security numbers

  - `content.identity.ssns.ssn` (string)
    Social Security Number (typically masked or encrypted)

  - `content.identity.ssns.sources` (array)
    Sources where this SSN was found

  - `content.identity.genders` (array)
    Array of gender information

  - `content.identity.genders.gender` (string)
    Gender value (e.g., M, F, Other)

  - `content.identity.genders.sources` (array)
    Sources where this gender was found

  - `content.identity.phoneNumbers` (array)
    Array of phone numbers

  - `content.identity.phoneNumbers.countryCode` (string)
    Country code for the phone number

  - `content.identity.phoneNumbers.number` (string)
    The phone number

  - `content.identity.phoneNumbers.extension` (string)
    Phone extension if applicable

  - `content.identity.phoneNumbers.type` (string)
    Type of phone (e.g., MOBILE, HOME, WORK)

  - `content.identity.phoneNumbers.sources` (array)
    Sources where this phone was found

  - `content.identity.emails` (array)
    Array of email addresses

  - `content.identity.emails.email` (string)
    The email address

  - `content.identity.emails.type` (string)
    Type of email (e.g., PERSONAL, WORK)

  - `content.identity.emails.sources` (array)
    Sources where this email was found

  - `content.identity.deathDetails` (array)
    Death information if applicable

  - `content.identity.deathDetails.deathIndicator` (boolean)
    Whether the individual is deceased

  - `content.identity.deathDetails.deathDate` (string)
    Date of death if applicable

  - `content.identity.deathDetails.sources` (array)
    Sources where this information was found

  - `content.identityGroupedBySource` (array)
    An alternative view of the link identity where information is grouped by the source. Present if the Request object contains "GROUP_BY_SOURCE" in its identity view names list.

  - `content.customizedIdentities` (object)
    An alternative view of the link identity where information is customized according to the view name. Present if the Request object contains "CUSTOM_VIEW" in its identity view names list.

  - `content.customizedIdentitiesWithSource` (object)
    An alternative view of the link identity where information is customized according to the view name along with source information. Present if the Request object contains "CUSTOM_VIEW" in its identity view names list.

  - `content.domains` (array)
    Domains of the returned Identity, if any. Null if none

  - `content.domains.id` (string)

  - `content.domains.name` (string)

  - `content.vinIds` (array)
    The VIN IDs associated with the identity
    Example: ["vin-001","vin-002"]

  - `content.enrichedDetails` (object)
    Enriched details for an identity

  - `trackingId` (string)
    Request tracking identifier
    Example: "track-101112"