The identity and technical contract details declared by the specification.
PhoneComponents
object
Structured phone components, shared by phone input (components) and the phone output value.
3 properties
PhoneInputItem
object
A single phone value to prepare.
2 properties
PhoneLineType
string
Phone line-type classification (folded-in enrichment, requested via LINETYPE).
PhoneValue
object
Phone value: parsed/normalized components plus folded-in enrichments.
5 properties
PhoneResultAttributes
object
Attributes of a single phone result resource: the echoed input, the parsed and normalized data products, and the final prepared value.
5 properties
1 required
PhoneResultResource
object
Phone success result resource — one element of the response data[] for a successfully processed phone item. id is the request positional index (items[i] → id =…
3 properties
3 required
EmailComponents
object
Structured email components, shared by email input (components) and the email output value.
2 properties
EmailInputItem
object
A single email value to prepare.
2 properties
EmailValue
object
Email value: parsed/normalized components.
5 properties
EmailResultAttributes
object
A single email result: the echoed input, the parsed and normalized data products, and the final prepared value.
5 properties
1 required
EmailResultResource
object
Email success result resource — one element of the response data[] for a successfully processed email item. id is the request positional index (items[i] → id =…
3 properties
3 required
AddressComponents
object
Structured address components, shared by address input (components) and the address output value. All fields optional to support messy/partial values on both s…
10 properties
AddressInputItem
object
A single address value to prepare.
2 properties
AddressVerify
string
Deliverability confirmation result for an address.
AddressType
string
Whether an address is residential or commercial.
AddressPrecision
string
How precisely the coordinates locate the address.
AddressValue
object
Address value: parsed/normalized components plus folded-in enrichments. All component fields optional to support messy/partial input.
16 properties
AddressResultAttributes
object
A single address result: the echoed input, the parsed and normalized data products, and the final prepared value.
4 properties
1 required
AddressEnrichment
string
Enrichment signals available for the address domain.
AddressUnfulfilledEnrichment
object
An enrichment signal that was not returned for this item.
2 properties
1 required
AddressResultMeta
object
Per-item metadata for an address result, reporting enrichment signals that were not returned. The item is still a success, and signals that were not returned a…
1 property
AddressResultResource
object
Address success result resource — one element of the response data[] for a successfully processed address item. id is the request positional index (items[i] →…
4 properties
3 required
JobTitleInputItem
object
A single job title value to prepare.
1 property
1 required
JobTitleValue
object
Job title value: the normalized/standardized title string.
1 property
JobTitleResultAttributes
object
A single job title result: the echoed input, the parsed and normalized data products, and the final prepared value.
5 properties
1 required
JobTitleResultResource
object
Job title success result resource — one element of the response data[] for a successfully processed job-title item. id is the request positional index (items[i…
3 properties
3 required
PersonNameComponents
object
Structured person-name components, shared by person-name input (components) and the person-name output value. All fields optional to support messy/partial valu…
5 properties
PersonNameInputItem
object
A single person-name value to prepare.
2 properties
PersonNameValue
object
Person-name value: parsed/normalized components plus the reassembled full name.
6 properties
PersonNameResultAttributes
object
A single person-name result: the echoed input, the parsed and normalized data products, and the final prepared value.
5 properties
1 required
PersonNameResultResource
object
Person name success result resource — one element of the response data[] for a successfully processed person-name item. id is the request positional index (ite…
3 properties
3 required
PrepareItemError
object
Attributes of a PrepareError result resource — a single item that failed to process. Item-scoped and statusless: the HTTP status belongs to the response as a w…
1 property
PrepareErrorResource
object
Error result resource — one element of the response data[] for an item that failed to process (the value XOR error counterpart to the domain success resources,…
3 properties
3 required
DataQualityResultResource
object
Polymorphic Data Quality result resource, discriminated by type. One element of the response data[]. type encodes the OUTCOME: a successful item is its domain…
DataQualityResponse
object
Data Quality response body. data is an ARRAY of per-item result resources, in STRICT POSITIONAL 1:1 ORDER with the request's items — data[i] is the result for…
1 property
1 required
ZoomInfo.Core.Foundations.ErrorSourceModel
object
4 properties
ZoomInfo.Core.Foundations.ErrorModel
object
The object describing a specific error from the API
6 properties
3 required
ZoomInfo.Core.Foundations.ErrorResponseModel
object
The standard error response body model for the ZoomInfo API.
3 properties
1 required
PhoneEnrichment
string
Enrichment signals available for the phone domain.
PhoneRuleType
string
Phone normalization rule names.
PhoneRuleValue
string
Legal values for phone normalization rules. Valid combinations: INTFORMAT - INTERNATIONAL|NATIONAL|E164|RFC3966; LEADING1 - ADD|REMOVE|CONVERTTOPLUSONE; SEPARA…
PhoneRule
object
A single phone normalization rule. type selects the rule; value is its argument. Use only the documented type/value combinations.
2 properties
2 required
PhoneNormalizationRules
object
Inline phone custom-normalization rules, grouped by rule group.
1 property
PhonePrepareAttributes
object
Phone Data Quality request. Default steps: parse, validate, normalize. Line type enrichment is available via enrichments, custom normalization via config.
3 properties
1 required
PhoneRequestResource
object
Phone request resource. data is a single resource of this type; the batch is in attributes.items.
2 properties
2 required
EmailPrepareAttributes
object
Email Data Quality request. Default steps: parse, validate, normalize.
1 property
1 required
EmailRequestResource
object
Email request resource. data is a single resource of this type; the batch is in attributes.items.
2 properties
2 required
AddressRequestEnrichment
string
The enrichment signals selectable on an address request.
StreetLineRuleType
string
Street-line normalization rule names.
StreetLineRuleValue
string
Legal values for street-line normalization rules. Valid combinations: CASE - PROPERCASE|UPPERCASE|LOWERCASE; MULTIPLE - COMBINEONSINGLELINE|DISCARDSECONDLINE;…
StreetLineRule
object
A single street-line normalization rule. Use only the documented type/value combinations.
2 properties
2 required
CityRuleType
string
City normalization rule names.
CityRuleValue
string
Legal values for city normalization rules. Valid combinations: CASE - PROPERCASE|UPPERCASE|LOWERCASE; PREFIXES - ABBREVIATE|EXPAND; PERIODS - ADD|REMOVE; any r…
CityRule
object
A single city normalization rule. Use only the documented type/value combinations.
2 properties
2 required
StateProvinceRuleType
string
State/province normalization rule names.
StateProvinceRuleValue
string
Legal values for state/province normalization rules. Valid combinations: CASE - UPPERCASE|LOWERCASE|PROPERCASE; FORMAT - ABBREVIATE|EXPAND; any rule type may u…
StateProvinceRule
object
A single state/province normalization rule. Use only the documented type/value combinations.
2 properties
2 required
CountryRuleType
string
Country normalization rule names.
CountryRuleValue
string
Legal values for country normalization rules. Valid combinations: COUNTRYNAME - COMMONNAME|SHORTNAME|LONGNAME|ESNAME|FRNAME|CHNAME|ARNAME|RUNAME|ALPHA2|ALPHA3|…
CountryRule
object
A single country normalization rule. Use only the documented type/value combinations.
2 properties
2 required
AddressNormalizationRules
object
Inline address custom-normalization rules, grouped by rule group.
4 properties
AddressPrepareAttributes
object
Address Data Quality request. Default step: parse. Supply exactly one of enrichments or config: - enrichments — the enrichment signals to compute. - config.nor…
3 properties
1 required
AddressRequestResource
object
Address request resource. data is a single resource of this type; the batch is in attributes.items.
2 properties
2 required
JobTitleRuleType
string
Job-title normalization rule names.
JobTitleRuleValue
string
Legal values for job-title normalization rules. Valid combinations: CASE - PROPERCASE|UPPERCASE|LOWERCASE; PERIODS - ADD|REMOVE; COMMAS|MODIFIERSUFFIXES - REMO…
JobTitleRule
object
A single job-title normalization rule. Use only the documented type/value combinations.
2 properties
2 required
JobTitleNormalizationRules
object
Inline job-title custom-normalization rules, grouped by rule group.
1 property
JobTitlePrepareAttributes
object
Job Title Data Quality request. Default step: normalize. Custom normalization is available via config.
2 properties
1 required
JobTitleRequestResource
object
Job title request resource. data is a single resource of this type; the batch is in attributes.items.
2 properties
2 required
PersonNameRuleType
string
Person-name normalization rule names.
PersonNameRuleValue
string
Legal values for person-name normalization rules. Valid combinations: CASE - PROPERCASE|UPPERCASE|LOWERCASE; FIRSTNAME - CONVERTTOINITIAL; MIDDLENAME - CONVERT…
PersonNameRule
object
A single person-name normalization rule. Use only the documented type/value combinations.
2 properties
2 required
PersonNameNormalizationRules
object
Inline person-name custom-normalization rules, grouped by rule group.
1 property
PersonNamePrepareAttributes
object
Person Name Data Quality request. Default steps: parse, validate, normalize. Custom normalization is available via config.
2 properties
1 required
PersonNameRequestResource
object
Person name request resource. data is a single resource of this type; the batch is in attributes.items.
2 properties
2 required
DataQualityRequestResource
object
Polymorphic Data Quality request resource, discriminated by type. The request's data is exactly one of these (the document-level discriminator); the batch of v…
DataQualityRequest
object
Data Quality request body. data is a SINGLE resource whose type selects the domain (document-level discriminator); the batch of values is the items[] array ins…
1 property
1 required
NormalizeConfigStatus
string
Lifecycle status of a normalization configuration.
NormalizeConfigRules
object
Custom-normalization rules for a stored config, grouped by rule group. A single config may carry rules for any combination of domains. Each group is an ordered…
7 properties
NormalizeConfigAttributes
object
Attributes of a normalization configuration.
4 properties
3 required
NormalizeConfigMeta
object
Non-standard metadata for a normalization config.
2 properties
2 required
NormalizeConfig
object
A normalization configuration resource.
4 properties
3 required
NormalizeConfigPageMeta
object
Per-page metadata for paginated normalization config list responses.
4 properties
4 required
NormalizeConfigListMeta
object
Page meta-data for paginated normalization config list responses.
1 property
1 required
NormalizeConfigListLinks
object
Paging links for normalization config list responses.
5 properties
NormalizeConfigListJsonApiModel
object
JSON API model for a paginated list of normalization configs.
3 properties
1 required
NormalizeConfigJsonApiModel
object
JSON API model for a single normalization config.
1 property
1 required
NormalizeConfigAttributesCreate
object
Attributes of a normalization configuration.
3 properties
2 required
NormalizeConfigCreate
object
A normalization configuration resource.
2 properties
2 required
NormalizeConfigJsonApiModelCreate
object
JSON API model for a single normalization config.
1 property
1 required
NormalizeConfigAttributesUpdate
object
Attributes of a normalization configuration.
4 properties
NormalizeConfigUpdate
object
A normalization configuration resource.
3 properties
NormalizeConfigJsonApiModelUpdate
object
JSON API model for a single normalization config.
1 property
ScoreConfigStatus
string
Lifecycle status of a score configuration.
ScoreModelType
string
Type of scoring model.
ScoreCriterionOperator
string
Comparison operator for a score rule criterion.
ScoreCriterion
object
A single comparison criterion within a score rule.
2 properties
1 required
ScoreRule
object
A scoring rule: criteria that, when matched, contribute score to the owning element.
3 properties
3 required
ScoreElement
object
A weighted scoring element bound to a single input field.
3 properties
3 required
ScoreConfigAttributes
object
Attributes of a score configuration.
5 properties
5 required
ScoreConfigMeta
object
Non-standard metadata for a score config.
2 properties
2 required
ScoreConfig
object
A score configuration resource (identity, model type, and scoring elements).
4 properties
3 required
ScoreConfigPageMeta
object
Per-page metadata for paginated score config list responses.
4 properties
4 required
ScoreConfigListMeta
object
Page meta-data for paginated score config list responses.
1 property
1 required
ScoreConfigListLinks
object
Paging links for score config list responses.
5 properties
ScoreConfigListJsonApiModel
object
JSON API model for a paginated list of score configs.
3 properties
1 required
ScoreConfigJsonApiModel
object
JSON API model for a single score config.
1 property
1 required
ScoreConfigCreate
object
A score configuration resource (identity, model type, and scoring elements).
2 properties
2 required
ScoreConfigJsonApiModelCreate
object
JSON API model for a single score config.
1 property
1 required
ScoreConfigAttributesUpdate
object
Attributes of a score configuration.
2 properties
ScoreConfigUpdate
object
A score configuration resource (identity, model type, and scoring elements).
3 properties
ScoreConfigJsonApiModelUpdate
object
JSON API model for a single score config.
1 property
ScoreRunSummary
object
Aggregate counts describing the outcome of a score run.
4 properties
4 required
DataQualityRecord
object
A single input record, expressed as an open map of field → value pairs (for example { "industry": "Software", "country": "US" }). The record shape is intention…
RecordScoreStatus
string
Outcome of applying one score config to one record.
RecordScoreOutput
object
Score output of applying one score config to one record.
3 properties
2 required
RecordScoreResult
object
Outcome of scoring a single record under one or more configs.
2 properties
2 required
ScoreResultsAttributes
object
Score results response attributes returned by the sync run endpoint.
3 properties
3 required
ScoreResults
object
Sync score results resource.
3 properties
3 required
ScoreResultsJsonApiModel
object
JSON API model for inline sync score results.
1 property
1 required
ScoreRunRequestAttributes
object
Sync score run request attributes.
2 properties
2 required
ScoreRunRequest
object
Score run request resource.
2 properties
2 required
ScoreRunRequestJsonApiModel
object
JSON API model for a score run request.
1 property
1 required
SegmentAction
string
How multiple segments match the same record.
SegmentRuleOperator
string
Comparison operator for a segment rule.
SegmentRule
object
A single rule within a segment, representing one field-condition test.
3 properties
1 required
Segment
object
A segment within a config: a prioritized set of rules that maps matching records to an output value.
4 properties
4 required
SegmentConfigAttributes
object
Full attributes of a segment configuration.
5 properties
4 required
SegmentConfigMeta
object
Non-standard metadata for a segment config.
2 properties
2 required
SegmentConfig
object
A segment configuration resource (identity, action, and full segment/rule definitions).
4 properties
3 required
SegmentConfigPageMeta
object
Per-page metadata for paginated segment config list responses.
4 properties
4 required
SegmentConfigListMeta
object
Page metadata wrapper for paginated segment config list responses.
1 property
1 required
SegmentConfigListLinks
object
Paging links for segment config list responses.
5 properties
SegmentConfigListJsonApiModel
object
JSON API model for a paginated list of segment configs.
3 properties
1 required
SegmentConfigJsonApiModel
object
JSON API model for a single segment config.
1 property
1 required
SegmentConfigCreate
object
A segment configuration resource (identity, action, and full segment/rule definitions).
2 properties
2 required
SegmentConfigJsonApiModelCreate
object
JSON API model for a single segment config.
1 property
1 required
SegmentConfigAttributesUpdate
object
Full attributes of a segment configuration.
4 properties
SegmentConfigUpdate
object
A segment configuration resource (identity, action, and full segment/rule definitions).
3 properties
SegmentConfigJsonApiModelUpdate
object
JSON API model for a single segment config.
1 property
SegmentRunSummary
object
Aggregate counts describing the outcome of a segment run.
4 properties
4 required
RecordSegmentStatus
string
Outcome of applying one segment config to one record.
SegmentRecordOutput
object
Segment output of applying one segment config to one record.
3 properties
2 required
SegmentRecordResult
object
Outcome of segmenting a single record under one or more configs.
2 properties
2 required
SegmentResultsAttributes
object
Segment results response attributes returned by the sync run endpoint.
3 properties
3 required
SegmentResults
object
Sync segment results resource.
3 properties
3 required
SegmentResultsJsonApiModel
object
JSON API model for inline sync segment results.
1 property
1 required
SegmentRunRequestAttributes
object
Sync segment run request attributes.
2 properties
2 required
SegmentRunRequest
object
Segment run request resource.
2 properties
2 required
SegmentRunRequestJsonApiModel
object
JSON API model for a segment run request.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ZoomInfo publishes across the network.