--- title: "Search using demographic information (demographicsSearch)" method: POST path: "/v2/demographicsSearch" --- # Search using demographic information (demographicsSearch) `POST /v2/demographicsSearch` Searches Verato using the provided demographic attributes. It returns zero or more candidate identities ordered by match score. ## Request body - ServiceRequestV2DemographicsSearch - `content` DemographicsSearchWsRequest — Request object for demographics query - `identity` Identity, required — API object representing a Patient identity - `names` Names[] - `use` string — CODE-SET data type, see documentation for more details - `prefix` string — TEXT data type, see documentation for more details - `first` string — TEXT data type, see documentation for more details - `middle` string — TEXT data type, see documentation for more details - `last` string — TEXT data type, see documentation for more details - `suffix` string — TEXT data type, see documentation for more details - `credential` string — TEXT data type, see documentation for more details - `addresses` Addresses[] - `type` string — CODE-SET data type, see documentation for more details - `line1` string — TEXT data type, see documentation for more details - `line2` string — TEXT data type, see documentation for more details - `city` string — TEXT data type, see documentation for more details - `district` string — TEXT data type, see documentation for more details - `state` string — TEXT data type, see documentation for more details - `postalCode` string — TEXT data type, see documentation for more details - `country` string — TEXT data type, see documentation for more details - `latitude` string — NUMBER data type, see documentation for more details - `longitude` string — NUMBER data type, see documentation for more details - `validFrom` string — DATE data type, see documentation for more details - `validTo` string — DATE data type, see documentation for more details - `datesOfBirth` DatesOfBirth[] - `dateOfBirth` string — DATE data type, see documentation for more details - `ssns` Ssns[] - `ssn` string — TEXT data type, see documentation for more details - `genders` Genders[] - `gender` string — CODE-SET data type, see documentation for more details - `genderIdentities` GenderIdentities[] - `genderIdentity` string — CODE-SET data type, see documentation for more details - `phoneNumbers` PhoneNumbers[] - `type` string — CODE-SET data type, see documentation for more details - `countryCode` string — TEXT data type, see documentation for more details - `areaCode` string — TEXT data type, see documentation for more details - `number` string — TEXT data type, see documentation for more details - `extension` string — TEXT data type, see documentation for more details - `validTo` string — DATE data type, see documentation for more details - `validFrom` string — DATE data type, see documentation for more details - `bestTimeToContact` object[] - `day` string — CODE-SET data type, see documentation for more details - `startTime` string — TIME data type, see documentation for more details - `endTime` string — TIME data type, see documentation for more details - `allDay` boolean — BOOLEAN data type, see documentation for more details - `emails` Emails[] - `type` string — CODE-SET data type, see documentation for more details - `email` string — TEXT data type, see documentation for more details - `validFrom` string — DATE data type, see documentation for more details - `validTo` string — DATE data type, see documentation for more details - `deathDetails` DeathDetails[] - `deceased` string — CODE-SET data type, see documentation for more details - `dateOfDeath` string — DATE data type, see documentation for more details - `city` string — TEXT data type, see documentation for more details - `county` string — TEXT data type, see documentation for more details - `state` string — TEXT data type, see documentation for more details - `country` string — TEXT data type, see documentation for more details - `externalUniqueIdentifier` ExternalUniqueIdentifier[] - `issuer` string — TEXT data type, see documentation for more details - `value` string — TEXT data type, see documentation for more details - `status` string — TEXT data type, see documentation for more details - `startDate` string — DATE data type, see documentation for more details - `endDate` string — DATE data type, see documentation for more details - `alternateIdentifiers` AlternateIdentifiers[] - `description` string — TEXT data type, see documentation for more details - `type` string — CODE-SET data type, see documentation for more details - `value` string — TEXT data type, see documentation for more details - `status` string — TEXT data type, see documentation for more details - `issuer` string — TEXT data type, see documentation for more details - `issueDate` string — DATE data type, see documentation for more details - `startDate` string — DATE data type, see documentation for more details - `endDate` string — DATE data type, see documentation for more details - `multipleBirthIndicator` MultipleBirthIndicator[] - `multipleBirthIndicator` boolean — BOOLEAN data type, see documentation for more details - `multipleBirthInteger` string — NUMBER data type, see documentation for more details - `birthPlurality` string — NUMBER data type, see documentation for more details - `citizenships` Citizenships[] - `citizenship` string — CODE-SET data type, see documentation for more details - `photos` Photos[] - `url` string — TEXT data type, see documentation for more details - `sexualOrientations` SexualOrientations[] - `sexualOrientation` string — CODE-SET data type, see documentation for more details - `races` Races[] - `race` string — CODE-SET data type, see documentation for more details - `ethnicities` Ethnicities[] - `ethnicity` string — CODE-SET data type, see documentation for more details - `religiousAffiliations` ReligiousAffiliations[] - `religiousAffiliation` string — CODE-SET data type, see documentation for more details - `maritalStatuses` MaritalStatuses[] - `maritalStatus` string — CODE-SET data type, see documentation for more details - `communicationLanguages` CommunicationLanguages[] - `language` string — CODE-SET data type, see documentation for more details - `preferred` boolean — BOOLEAN data type, see documentation for more details - `qualifications` Qualifications[] - `type` string — CODE-SET data type, see documentation for more details - `qualification` string — CODE-SET data type, see documentation for more details - `status` string — CODE-SET data type, see documentation for more details - `issuer` string — TEXT data type, see documentation for more details - `issueDate` string — DATE data type, see documentation for more details - `validFrom` string — DATE data type, see documentation for more details - `validTo` string — DATE data type, see documentation for more details - `consents` Consents[] - `name` string — TEXT data type, see documentation for more details - `type` string — CODE-SET data type, see documentation for more details - `status` string — CODE-SET data type, see documentation for more details - `isRequired` boolean — BOOLEAN data type, see documentation for more details - `decision` string — CODE-SET data type, see documentation for more details - `validFrom` string — DATE data type, see documentation for more details - `validTo` string — DATE data type, see documentation for more details - `source` string — TEXT data type, see documentation for more details - `regulatoryBasis` string — CODE-SET data type, see documentation for more details - `preferences` Preferences[] - `name` string — TEXT data type, see documentation for more details - `type` string — TEXT data type, see documentation for more details - `channels` unknown[] - unknown - `healthInsuranceCoverage` HealthInsuranceCoverage[] - `payerName` string — TEXT data type, see documentation for more details - `status` string — CODE-SET data type, see documentation for more details - `insuranceType` string — CODE-SET data type, see documentation for more details - `planType` string — CODE-SET data type, see documentation for more details - `subscriberId` string — TEXT data type, see documentation for more details - `relationship` string — CODE-SET data type, see documentation for more details - `groupNumber` string — TEXT data type, see documentation for more details - `idNumber` string — TEXT data type, see documentation for more details - `sequenceNumber` string — TEXT data type, see documentation for more details - `effectiveDate` string — TEXT data type, see documentation for more details - `endDate` string — DATE data type, see documentation for more details - `guarantor` Guarantor[] - `relationship` string — CODE-SET data type, see documentation for more details - `firstName` string — TEXT data type, see documentation for more details - `middleName` string — TEXT data type, see documentation for more details - `lastName` string — TEXT data type, see documentation for more details - `suffix` string — TEXT data type, see documentation for more details - `dob` string — DATE data type, see documentation for more details - `ssn` string — TEXT data type, see documentation for more details - `addressLine1` string — TEXT data type, see documentation for more details - `addressLine2` string — TEXT data type, see documentation for more details - `city` string — TEXT data type, see documentation for more details - `state` string — TEXT data type, see documentation for more details - `zip` string — TEXT data type, see documentation for more details - `phone` string — TEXT data type, see documentation for more details - `onHold` boolean — BOOLEAN data type, see documentation for more details - `startDate` string — DATE data type, see documentation for more details - `endDate` string — DATE data type, see documentation for more details - `upcomingAppointment` UpcomingAppointment[] - `description` string — TEXT data type, see documentation for more details - `status` string — CODE-SET data type, see documentation for more details - `cancellationDate` string — DATE data type, see documentation for more details - `cancellationReason` string — CODE-SET data type, see documentation for more details - `serviceCategory` string — CODE-SET data type, see documentation for more details - `serviceType` string — CODE-SET data type, see documentation for more details - `practitionerSpecialty` string — CODE-SET data type, see documentation for more details - `start` string — DATE data type, see documentation for more details - `end` string — DATE data type, see documentation for more details - `type` string — CODE-SET data type, see documentation for more details - `reason` string — TEXT data type, see documentation for more details - `priority` string — CODE-SET data type, see documentation for more details - `note` string — TEXT data type, see documentation for more details - `recentEncounter` RecentEncounter[] - `status` string — CODE-SET data type, see documentation for more details - `class` string — CODE-SET data type, see documentation for more details - `priority` string — CODE-SET data type, see documentation for more details - `type` string — CODE-SET data type, see documentation for more details - `serviceType` string — CODE-SET data type, see documentation for more details - `start` string — DATE data type, see documentation for more details - `end` string — DATE data type, see documentation for more details - `reason` string — TEXT data type, see documentation for more details - `diagnosis` string — TEXT data type, see documentation for more details - `specialArrangement` string — CODE-SET data type, see documentation for more details - `specialCourtesy` string — CODE-SET data type, see documentation for more details - `matchScoreThreshold` number, double — Only identities with match scores equal to or above this value will appear in the response. If not provided, then no filtering based on match score is performed. - `maxSearchResults` integer — The number of results to return at one time. Must be greater than 0. If not provided, the system's maximum number of results will be returned. Note that while very large values are acceptable, the system has a default maximum, and the response will include a warning message if that maximum is exceeded. - `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 - ServiceResponseV2DemographicsSearch - `auditId` string - `success` boolean - `warnings` string[] - `retryableError` boolean - `message` string - `content` DemographicsSearchWsResponse — Response object for demographics query - `searchResults` DemographicsSearchResult[], required — A list of search results in order of best to worst match for the Identity provided in the request. Empty if no matches were found. - `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 - … - `sources` Source[] — The source for this cluster - … - `verifiedAddressMetaData` VerifiedAddressMetaData - … - `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 - … - `sources` Source[] — The source for this cluster - … - `verifiedAddressMetaData` VerifiedAddressMetaData - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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. - `matchScore` number, double, required — Represents how well the "Identity" (or "IdentityGroupedBySource") is thought to match the identity provided in the request. - `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 - `sameIdentity` 'N' | 'U' | 'Y', required — Represents whether or not the "Identity" (or "IdentityGroupedBySource") is thought to be the same identity as provided in the request. - `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)