--- title: "Query using native ID (nativeIdQuery)" method: POST path: "/v2/nativeIdQuery" --- # Query using native ID (nativeIdQuery) `POST /v2/nativeIdQuery` Searches Verato for an identity using source name + native ID (the customer's source system identifier). ## Request body - ServiceRequestV2NativeIdQuery - `content` NativeIdQueryWsRequest — Queries link database using source information - `source` Source, required — Represents the information tracking an identity to a source that contains the identity - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `responseIdentityFormatNames` string[] — 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. - `trackingId` string ## Response `200` OK - ServiceResponseV2NativeIdQuery - `auditId` string - `success` boolean - `warnings` string[] - `retryableError` boolean - `message` string - `content` NativeIdQueryWsResponse — Service response for a Source-based query - `identityGroupedBySource` IdentityPerSource[] — 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. - `addresses` AddressPerSource[] — The addresses associated with this identity - `identityCluster` Address — API address model - `type` string - `line1` string - `line2` string - `city` string - `district` string - `state` string - `postalCode` string - `country` string - `latitude` number - `longitude` number - `validFrom` string, date - `validTo` string, date - `verifiedAddress` VerifiedAddress - `pmbDesignator` string - `zip` string - `secondaryNumber` string - `deliveryPoint` string - `country` string - `extraSecondaryDesignator` string - `streetPredirection` string - `city` string - `extraSecondaryNumber` string - `secondaryDesignator` string - `zip4` string - `urbanization` string - `primaryNumber` string - `streetName` string - `deliveryPointCheckDigit` string - `streetSuffix` string - `state` string - `cityAka` string - `streetPostdirection` string - `pmbNumber` string - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `verifiedAddressMetaData` VerifiedAddressMetaData - `verifiedAddress` string - `rdi` string - `countyFips` string - `cmra` boolean - `latitude` number, double - `precision` string - `congressionalDistrict` string - `vacant` boolean - `verificationCode` string - `longitude` number, double - `countyName` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `address` Address — API address model - `type` string - `line1` string - `line2` string - `city` string - `district` string - `state` string - `postalCode` string - `country` string - `latitude` number - `longitude` number - `validFrom` string, date - `validTo` string, date - `verifiedAddress` VerifiedAddress - `pmbDesignator` string - `zip` string - `secondaryNumber` string - `deliveryPoint` string - `country` string - `extraSecondaryDesignator` string - `streetPredirection` string - `city` string - `extraSecondaryNumber` string - `secondaryDesignator` string - `zip4` string - `urbanization` string - `primaryNumber` string - `streetName` string - `deliveryPointCheckDigit` string - `streetSuffix` string - `state` string - `cityAka` string - `streetPostdirection` string - `pmbNumber` string - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `verifiedAddressMetaData` VerifiedAddressMetaData - `verifiedAddress` string - `rdi` string - `countyFips` string - `cmra` boolean - `latitude` number, double - `precision` string - `congressionalDistrict` string - `vacant` boolean - `verificationCode` string - `longitude` number, double - `countyName` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `extendedAndCustomProperties` object - `addressDetails` AddressDetailsPerSource[] — The addresses associated with this identity - `identityCluster` AddressDetails - `country` string - `streetType` string - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `city` string - `zipcode4` string - `addressType` string - `houseNumber` string - `streetPostDirection` string - `unitNumber` string - `attributesMap` object - `streetDirection` string - `unitType` string - `zipcode` string - `streetName` string - `state` string - `line2` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `addressDetails` AddressDetails - `country` string - `streetType` string - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `city` string - `zipcode4` string - `addressType` string - `houseNumber` string - `streetPostDirection` string - `unitNumber` string - `attributesMap` object - `streetDirection` string - `unitType` string - `zipcode` string - `streetName` string - `state` string - `line2` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `genders` GenderPerSource[] — The genders associated with this identity - `identityCluster` Gender - `gender` string — The person's gender - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `gender` Gender - `gender` string — The person's gender - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `source` Source — Represents the information tracking an identity to a source that contains the identity - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `datesOfBirth` DatesOfBirthPerSource[] — The dates of birth associated with the identity - `identityCluster` DateOfBirth - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `dateOfBirth` string — The date of birth - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `dateOfBirth` DateOfBirth - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `dateOfBirth` string — The date of birth - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `phoneNumbers` PhoneNumberPerSource[] — The phone numbers associated with this identity - `identityCluster` Phone — Represents a phone number - `type` string - `countryCode` string - `areaCode` string - `number` string - `extension` string - `validTo` string, date - `validFrom` string, date - `bestTimeToContact` object - `day` string - `startTime` string, time - `endTime` string, time - `allDay` boolean - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `phoneNumber` Phone — Represents a phone number - `type` string - `countryCode` string - `areaCode` string - `number` string - `extension` string - `validTo` string, date - `validFrom` string, date - `bestTimeToContact` object - `day` string - `startTime` string, time - `endTime` string, time - `allDay` boolean - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `deathDetails` DeathDetailsPerSource[] — The death details associated with this identity - `identityCluster` DeathDetails — API address model - `deceased` string - `dateOfDeath` string, date-time - `city` string - `county` string - `state` string - `country` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `deathDetails` DeathDetails — API address model - `deceased` string - `dateOfDeath` string, date-time - `city` string - `county` string - `state` string - `country` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `emails` EmailPerSource[] — The email addresses associated with this identity - `identityCluster` Email - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `type` string - `email` string - `validFrom` string, date - `validTo` string, date - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `email` Email - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `type` string - `email` string - `validFrom` string, date - `validTo` string, date - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `names` NamePerSource[] — The names associated with the identity - `identityCluster` Name — Represents a person's name - `use` string - `prefix` string - `first` string - `middle` string - `last` string - `suffix` string - `credential` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `firstAsserted` string — The date the source first saw this property value. - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `name` Name — Represents a person's name - `use` string - `prefix` string - `first` string - `middle` string - `last` string - `suffix` string - `credential` string - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `ssns` SocialSecurityNumberPerSource[] — The Social Security Numbers associated with the identity - `identityCluster` SSN - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `attributesMap` object - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `ssn` string — The social security number - `firstAsserted` string — The date the source first saw this property value. - `lastAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `ssn` SSN - `sources` Source[] — The source for this cluster - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `attributesMap` object - `clusterStatus` 'ACTIVE' | 'INACTIVE' — The current clusterStatus - `ssn` string — The social security number - `lastAsserted` string — The date the source last saw this property value. - `firstAssertedMetaData` CustomerMetaData - `transactionType` string - `sourceLoginName` string - `sourceUserName` string - `transactionDateTime` string - `sourceTransactionDateTime` string - `customMetaData` object - `location` string - `mergedSourceRecord` MergedSourceRecord — A retired source record enriched with linkage metadata. - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `activeNativeId` string — The surviving (active) native id. - `activeSource` string — The surviving (active) source name. - `timestamp` string — The merge timestamp (UTC, ISO_LOCAL_DATE_TIME). - `deactivatedSourceRecord` Source — Represents the information tracking an identity to a source that contains the identity - `date` string — The date of the source data in ISO format (yyyy-mm-dd). - `name` string — The name of the data source. Must be unique across Verato. - `id` string — The ID of an identity within the given data source. - `linkId` 'String' — LinkId of the returned Identity, if any. Null if no match found - `identity` 'Identity' — Found identity, if any. Null if no match found - `domains` Domain[] — Domains of the returned Identity, if any. Null if none - `name` string - `id` string - `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. - `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. - `vinIds` string[] — The VIN IDs associated with the identity - `enrichedDetails` 'EnrichedDetails' — Enriched details for an Identity that is augmented from the enrich stack - `errors` string[] - `trackingId` string --- [API](https://skmtc.net/verato/apis/verato-person-api.md) · [All operations](https://skmtc.net/verato/apis/verato-person-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verato/verato-person-api/revisions/8225f2689816/schema)