Identity Resolution Cleanse Match API 中文翻译

这是对附件 openApiSpec-IDRCleanseMatch.pdf 的中文网页化整理版本。字段名保留英文原名,便于直接对照接口文档与代码实现;说明、规则与注意事项已翻译为中文。

接口:GET /v1/match/cleanseMatch 完整路径:https://plus.dnb.com/v1/match/cleanseMatch 返回格式:application/json 数据覆盖:全球
用途:根据输入条件进行实体匹配,并返回最佳匹配结果 说明:属于 “Company Entity Resolution” 非标准 Data Blocks 监控:Not Available

概览

接口能力 使用 Dun & Bradstreet 的专有算法,根据企业名称、地址、注册号、电话、域名等信息查找最可能匹配的企业实体。
适用范围 支持全球数据覆盖,可用于名称地址匹配、注册号匹配、电话匹配、邮编匹配、域名匹配等场景。
输出重点 返回交易信息、请求回显、匹配候选列表、匹配质量评分,以及可选的清洗/标准化信息。

小提醒:这份网页版尽量保持与原 PDF 一一对应,但为了网页可读性,对部分跨页断行内容进行了合并整理。

请求参数(Query Parameters)
参数名 类型 示例 必填 中文说明
inLanguage string ja-JP 定义匹配时使用的语言,采用 IETF BCP 47 代码。可选值包括 autoja-JPzh-hans-CNzh-hant-TWzh-hant-HKko-hang-KRen-US。默认值为 en-US。若设为 auto,系统会根据 namestreetAddressLine1 中的字符自动判断语言;亚洲语言匹配属于限量开放能力,使用前需联系 D&B。
duns string 804735132 9 位数字字符串,表示 D&B 的 D-U-N-S 编号,用于直接标识企业实体。
registrationNumber string 11514917000120 由外部机构或 D&B 分配的注册号,可唯一标识或辅助标识企业。进行“注册号匹配”时此参数必填。
registrationNumberType integer 33482 注册号类型代码。请参考 RegistrationNumberType.xlsx 或代码表 7(Registration Number Type)。除特定场景外通常可选,但对部分英国慈善/金融监管类注册号查询为必填。
name string 用于搜索实体的字符串 最长 240 个字符,用于按企业主名称、商号名或曾用名搜索。亚洲语言匹配和高吞吐匹配场景下为必填。
streetAddressLine1 string street address 企业街道地址第 1 行,最长 70 个字符。“名称+地址匹配”时必填。
streetAddressLine2 string street address line 2 企业街道地址第 2 行,最长 70 个字符。
countryISOAlpha2Code string US ISO 3166-1 两位国家/市场代码,用于标识企业所属国家。“名称+地址匹配”“注册号匹配”“电话号码匹配”时必填。国家代码替代规则请参考国家代码替代表。
postalCode string 94536 最长 10 个字符的邮政编码/邮编;进行“邮编匹配”时必填。
addressLocality string short hills 1 到 50 个字符,表示城市、城镇、乡、村、自治市等地名。
addressRegion string NJ 区域/州/省名称。如果国家为 US 或 CA,则必须为 2 个字符;其他国家最长 64 个字符。
addressCounty string Essex 县/郡名称。仅适用于高吞吐匹配,不适用于事务型 Identity Resolution、Match and Append 或多进程小批量请求。
telephoneNumber string 5555555555 企业电话号码,包含区号或城市码。亚洲匹配最长 16 个字符,非亚洲匹配最长 32 个字符;“电话号码匹配”时必填。
url string www.dnb.com 用于通过域名识别企业的 URL。
email string jones@dnb.com 用于通过邮箱域名识别企业的电子邮箱地址。
customerBillingEndorsement string request reference text 客户填写的计费备注,通常包含申请人/部门名称或客户自身的账号/案件编号,仅用于计费流程中的引用。多进程高吞吐匹配不适用,可用 customerReference 替代。
candidateMaximumQuantity integer 25 返回候选结果的最大数量。有效值为 1 到 100;默认 10。多进程场景会忽略该值;通常上限为 25,但美国/加拿大的全国范围搜索上限可达 100。不同 IDR 查询类型可能有不同限制。
confidenceLowerLevelThresholdValue integer 7 返回候选实体的最低置信度阈值,有效值 1 到 10,默认值 4。亚洲匹配和多进程高吞吐匹配会忽略该参数。
exclusionCriteria string ExcludeNonHeadQuarters,ExcludeNonMarketable 排除条件,最多 5 项。支持:ExcludeNonHeadQuarters(仅返回总部)、ExcludeNonMarketable(仅返回可营销实体)、ExcludeOutofBusiness(排除停业实体)、ExcludeUndeliverable(排除邮件不可投递实体)、ExcludeUnreachable(排除电话不可接通实体)。亚洲匹配和多进程高吞吐匹配不适用。
isCleanseAndStandardizeInformationRequired boolean true 是否在响应中返回清洗与标准化信息。
customerReference1 ~ customerReference5 string request reference text 客户自定义引用文本,用于后续订单对账或关联。最多支持 5 个字段。customerReference3 ~ customerReference5 在多进程高吞吐匹配中不适用。
HTTP 200 响应(成功)

1. 交易与请求回显

JSON 路径类型示例中文说明
transactionDetailobject-处理本次请求所使用的交易信息。
transactionDetail.transactionIDstringrlh-hi9puyoijk-jop8u-kd-d-1由 D&B 应用分配的唯一交易 ID。
transactionDetail.transactionTimestampstring2017-02-21T17:46:19.839Z响应生成时间,格式为 ISO 8601 UTC Z。
transactionDetail.inLanguagestringen-US当前产品输出所使用的语言。
transactionDetail.serviceVersionstring1请求中指定的产品版本号。
inquiryDetailobject-请求输入数据的回显。
inquiryDetail.inLanguagestringen-US请求中提交的语言。
inquiryDetail.dunsstring804735132请求中提交的 D-U-N-S 号。
inquiryDetail.registrationNumberstring11514917000120请求中提交的注册号。
inquiryDetail.registrationNumberTypeinteger1340请求中提交的注册号类型代码。详见代码表 7。
inquiryDetail.namestringCompany name请求中提交的企业名称。
inquiryDetail.address.countryISOAlpha2CodestringUS请求中提交的国家代码。可参考国家代码替代表。
inquiryDetail.address.addressLocalitystringShort Hills请求中的城市/地区名称。
inquiryDetail.address.addressRegionstringNew Jersey请求中的州/省/区域。
inquiryDetail.address.postalCodestring7040请求中的邮政编码。
inquiryDetail.address.streetAddressLine.line1string103 JFK PKWY请求中的街道地址第 1 行。
inquiryDetail.address.streetAddressLine.line2string4th Floor请求中的街道地址第 2 行。
inquiryDetail.telephoneNumberstring9739215500请求中的电话号码。
inquiryDetail.urlstringhttps://www.dnb.com请求中的 URL。
inquiryDetail.emailstringjsmith@company.com请求中的电子邮箱地址。
inquiryDetail.customerBillingEndorsementstringMy billing reminder.请求中提交的计费备注文本。
inquiryDetail.candidateMaximumQuantityinteger25请求中指定的最大候选数量。
inquiryDetail.confidenceLowerLevelThresholdValueinteger6请求中指定的最低置信度阈值。
inquiryDetail.exclusionCriteriaarray(string)ExcludeNonHeadQuarters请求中提交的排除条件。
inquiryDetail.isCleanseAndStandardizeInformationRequiredbooleantrue请求中是否要求返回清洗与标准化信息。
inquiryDetail.customerReferencearray(string)Some text to describe the request.客户针对本次交易提供的引用文本。

2. 匹配结果概览

JSON 路径类型示例中文说明
candidatesMatchedQuantityinteger100符合搜索条件的候选实体总数。
matchDataCriteriastringName and Address Lookup用于识别实体的匹配方式。可能值包括:DUNS Number Lookup、Name and Address Lookup、National ID Lookup、Telephone Number Lookup、ZIP Code Lookup、Domain Lookup。多进程高吞吐匹配不适用。
matchCandidatesarray(object)-系统找到的候选实体列表。
matchCandidates.displaySequenceinteger1候选项在结果中的显示顺序。数字越小,匹配概率通常越高。

3. 候选实体信息(matchCandidates.organization

JSON 路径类型示例中文说明
matchCandidates.organization.dunsstring804735132D-U-N-S® 编号,D&B 拥有并管理的企业唯一标识。
matchCandidates.organization.dunsControlStatus.operatingStatus.descriptionstringActive企业经营状态的高层级描述,通常为“活跃”或“已停业”。代码表见 166 [Operating Status]。
matchCandidates.organization.dunsControlStatus.operatingStatus.dnbCodeinteger9074D&B 定义的经营状态代码。示例:9074=Active,403=Out of Business。
matchCandidates.organization.dunsControlStatus.isMailUndeliverablebooleantrue是否至少有一个地址(主营、邮寄或注册地址)无法投递邮件。true 表示无法投递,false 表示可投递。
matchCandidates.organization.primaryNamestringGORMAN MANUFACTURING COMPANY, INC.企业主要名称。
matchCandidates.organization.tradeStyleNamesarray(object)-企业用于商业经营的商号名称列表。仅当客户输入命中商号名时才返回。
matchCandidates.organization.tradeStyleNames.namestringAlternate Company Name企业商号名称。
matchCandidates.organization.tradeStyleNames.priorityinteger1商号名称的重要性排序,数值越小越重要。
matchCandidates.organization.telephonearray(object)-企业语音通信电话号码信息。
matchCandidates.organization.telephone.telephoneNumberstring6505550000企业主要语音联系电话,通常由国内区号与本地号码组成。
matchCandidates.organization.telephone.isUnreachablebooleantrue电话号码是否能成功接通。true 为无法接通,false 为可接通。
matchCandidates.organization.websiteAddressarray(object)-已废弃,请勿使用。 原文档保留此字段说明,仅用于兼容旧数据结构。
matchCandidates.organization.websiteAddress.urlstringhttp://www.gorman.com已废弃。 企业官网或偏好的网站地址。
matchCandidates.organization.websiteAddress.domainNamestringgorman.com已废弃。 企业网站域名。

4. 主地址与邮寄地址

JSON 路径类型示例中文说明
matchCandidates.organization.primaryAddressobject-企业主营地址。
matchCandidates.organization.primaryAddress.addressCountry.isoAlpha2CodestringUS主营地址国家/地区 ISO 两位代码。
matchCandidates.organization.primaryAddress.addressCountry.namestringUnited States主营地址所属国家/地区名称。
matchCandidates.organization.primaryAddress.addressLocality.namestringSAN FRANCISCO主营地址的城市/地区名称。
matchCandidates.organization.primaryAddress.addressRegion.namestringCalifornia主营地址的州/省/区域名称。
matchCandidates.organization.primaryAddress.addressRegion.abbreviatedNamestringCA主营地址州/省/区域简称,例如美国新泽西州的 NJ
matchCandidates.organization.primaryAddress.postalCodestring941109999主营地址邮政编码。
matchCandidates.organization.primaryAddress.postalCodeExtensionstring9999邮编扩展码,用于标识邮编范围内的具体街道或建筑。
matchCandidates.organization.primaryAddress.streetAddress.line1string492 KOLLER ST主营地址第 1 行。
matchCandidates.organization.primaryAddress.streetAddress.line2stringSuite 100主营地址第 2 行。
matchCandidates.organization.mailingAddressobject-企业用于邮寄的地址信息。
matchCandidates.organization.mailingAddress.addressCountry.isoAlpha2CodestringUS邮寄地址国家/地区 ISO 两位代码。
matchCandidates.organization.mailingAddress.addressCountry.namestringUnited States邮寄地址国家/地区名称。
matchCandidates.organization.mailingAddress.addressLocality.namestringSAN FRANCISCO邮寄地址城市/地区名称。
matchCandidates.organization.mailingAddress.addressRegion.namestringCalifornia邮寄地址州/省/区域名称。
matchCandidates.organization.mailingAddress.addressRegion.abbreviatedNamestringCA邮寄地址州/省/区域简称。
matchCandidates.organization.mailingAddress.postalCodestring941109999邮寄地址邮编。
matchCandidates.organization.mailingAddress.postalCodeExtensionstring9999邮寄地址邮编扩展码。
matchCandidates.organization.mailingAddress.streetAddress.line1string492 KOLLER ST邮寄地址第 1 行。
matchCandidates.organization.mailingAddress.streetAddress.line2stringSuite 100邮寄地址第 2 行。

5. 注册号、关键人、集团结构

JSON 路径类型示例中文说明
matchCandidates.organization.registrationNumbersarray(object)-企业由外部权威机构颁发的标识符列表,例如商会编号、VAT 号等。
matchCandidates.organization.registrationNumbers.registrationNumberstring12-3456789由外部机构分配的注册号或字母数字标识。
matchCandidates.organization.registrationNumbers.typeDescriptionstringFederal Taxpayer Identification Number (US)注册号类型的官方名称,例如澳大利亚公司号、美国联邦纳税人识别号等。
matchCandidates.organization.registrationNumbers.typeDnBCodeinteger6863D&B 定义的注册号类型代码。详见代码表 7。
matchCandidates.organization.mostSeniorPrincipalsarray(object)-企业最高级别关键负责人信息。可能是自然人,也可能是组织。理论上仅应有一条“最高负责人”记录。
matchCandidates.organization.mostSeniorPrincipals.fullNamestringLeslie Ann Smith最高级关键负责人的完整姓名;若该关键主体为组织,则此字段填组织名称。
matchCandidates.organization.isStandalonebooleanfalse是否为独立实体。true 表示不属于任何法定家族树;false 表示属于企业家族结构。
matchCandidates.organization.corporateLinkageobject-基于多数股权或控制关系(>50%)的组织间关系。主要包括分支/事业部到总部、子公司到母公司的关系。
matchCandidates.organization.corporateLinkage.familytreeRolesPlayed.descriptionstringParent/Headquarters该实体在企业家族树中的角色,如分支、事业部、母公司、总部、子公司等。最多返回 1 个值。
matchCandidates.organization.corporateLinkage.familytreeRolesPlayed.dnbCodeinteger9141企业家族角色代码。常见值:9140 分支/事业部、9141 母公司/总部、9159 子公司、12769 分支机构。

6. 匹配质量信息(matchQualityInformation

JSON 路径类型示例中文说明
matchCandidates.matchQualityInformation.confidenceCodeinteger6置信度分值,范围 1(低)到 10(高),表示该候选项被纳入结果集时的确定性水平。
matchCandidates.matchQualityInformation.matchGradestringAZZZZZZZFZZ复合匹配等级。每个位置对应一种数据要素的评分。例如第一位可能代表名称评分,第二位可能代表街道号评分。详情请参考 Identity Resolution 指南。
matchCandidates.matchQualityInformation.matchGradeComponentsCountinteger11参与计算 Match Grade 的组成部分数量。
matchCandidates.matchQualityInformation.matchGradeComponents.componentTypestringName被匹配引擎评估的组成部分类型,如名称、门牌号等。
matchCandidates.matchQualityInformation.matchGradeComponents.componentRatingstringA该组成部分的匹配评级。
matchCandidates.matchQualityInformation.matchDataProfilestring0000000000989800000000009898匹配过程实际使用的信息概况。它是一个 28 字节字符串,由 14 个 2 字节组件构成,按顺序对应名称、门牌号、街道名、城市名、地区名、邮政信箱、电话、邮编、D-U-N-S 号、行业代码、地理密度、位置唯一性、注册号、URL。
matchCandidates.matchQualityInformation.matchDataProfileComponentsCountinteger14参与 Match Data Profile 计算的组成部分数量。
matchCandidates.matchQualityInformation.matchDataProfileComponents.componentTypestringNameMatch Data Profile 中的具体组成部分类型。
matchCandidates.matchQualityInformation.matchDataProfileComponents.componentValuestringFalse该组成部分在 Match Data Profile 中的取值。
matchCandidates.matchQualityInformation.nameMatchScorenumber85.5名称匹配得分,范围从 -1 到 100,可带小数。0 表示未匹配,100 表示最精确匹配。多进程高吞吐匹配不适用。

7. 清洗与标准化信息(cleanseAndStandardizeInformation

JSON 路径类型示例中文说明
cleanseAndStandardizeInformationobject-为行业使用与有效识别而提供的标准化值。多进程高吞吐匹配不适用。
cleanseAndStandardizeInformation.standardizedNamestringSTANDARD COMPANY标准化后的企业名称。
cleanseAndStandardizeInformation.standardizedAddress.addressCountry.isoAlpha2CodestringAR标准化后的国家代码。
cleanseAndStandardizeInformation.standardizedAddress.addressCountry.namestringARGENTINA标准化后的国家/市场名称。
cleanseAndStandardizeInformation.standardizedAddress.addressLocality.namestringBUENOS AIRES标准化后的城市/地区名称。
cleanseAndStandardizeInformation.standardizedAddress.addressRegion.namestringCIUDAD DE BUENOS AIRES标准化后的州/省/区域名称。
cleanseAndStandardizeInformation.standardizedAddress.addressRegion.abbreviatedNamestringDF标准化后的区域简称。
cleanseAndStandardizeInformation.standardizedAddress.addressCounty.namestringSOME COUNTY标准化后的县/郡名称。
cleanseAndStandardizeInformation.standardizedAddress.postalCodestring750802686标准化后的邮政编码。
cleanseAndStandardizeInformation.standardizedAddress.postalCodeExtensionstring1378标准化后的邮编扩展码。
cleanseAndStandardizeInformation.standardizedAddress.streetAddress.line1stringCALLEJUELA 508标准化后的街道地址第 1 行。
cleanseAndStandardizeInformation.standardizedAddress.streetAddress.line2stringLINE TWO标准化后的街道地址第 2 行。
cleanseAndStandardizeInformation.standardizedAddress.deliveryPointValidationStatusstringNo DPV Address邮件投递点校验状态,表示该地址是否可投递。可能值包括:Delivery Point Validated、No DPV、DPV STE Bad、Missing STE、Invalid Address、No DPV Address。
cleanseAndStandardizeInformation.standardizedAddress.deliveryPointValidationCMRAValuestringNo DPV AddressCMRA(商业邮件接收机构)校验状态,用于判断该地址是否为有效的商业代收邮件地址。
cleanseAndStandardizeInformation.standardizedAddress.isInexactAddressbooleantrue地址是否不够精确。true 表示不够严格准确;false 表示严格准确(默认假设值通常不显式返回)。
cleanseAndStandardizeInformation.standardizedAddress.addressTypestringStreet地址类型或投递类型。可能值包括:Firm、General delivery、High Rise、Military - APO/FPO addresses、Post office box、Rural or Highway Route、Street、Unknown。
其他 HTTP 状态码响应

当请求因系统故障、参数错误或参数不完整等原因未成功时,返回的结构会包含错误信息,同时通常仍会回显部分交易信息与输入参数。

JSON 路径类型示例中文说明
transactionDetailobject-处理本次请求的交易信息。
transactionDetail.transactionIDstringrlh-hi9puyoijk-jop8u-kd-d-1D&B 分配的唯一交易 ID。
transactionDetail.transactionTimestampstring2017-02-21T17:46:19.839Z错误响应的生成时间。
transactionDetail.inLanguagestringen-US产品输出语言。
transactionDetail.serviceVersionstring1请求中的产品版本号。
errorobject-记录失败原因的对象。仅在客户请求未被成功处理时出现。
error.errorCodestring-由 D&B 分配的错误代码,用于唯一标识失败原因。
error.errorMessagestring-对错误原因的解释性文本。
error.errorInformationURLstring-指向 D&B 错误说明页面的 URL,包含错误码列表及相关信息。
inquiryDetailobject-请求输入数据的回显,字段与成功响应中的 inquiryDetail 含义一致。

补充说明

由 PDF 内容翻译整理而成 · 适合直接浏览、截图、分享或继续二次修改