跳转到主要内容

数据核查

端点

环境URL
生产环境POST https://api.id.unico.app/lists/{cpf}
沙盒环境POST https://api.id.uat.unico.app/lists/{cpf}
独立端点设计

该端点与标准流程创建接口(POST /processes/v1)相互独立。它返回的是一组数据列表,而非确定性的身份核查结果。

请求

请求头
请求头
AuthorizationBearer <access_token>(参见身份验证
路径参数
参数类型必填描述
cpfstring待查询人员的 CPF。
curl -X POST "https://api.id.uat.unico.app/lists/12345678909" \
-H "Authorization: Bearer $TOKEN"

响应

根层信封
{
"id": "41c24382-36ce-4bb4-8339-352114f71f78",
"status": 3,
"lists": { }
}
字段类型描述
idstring (UUID)请求的唯一标识符。
statusinteger处理状态。
listsobject包含查询数据的主载荷。

`lists.basicData` — 登记数据
{
"basicData": {
"name": "JOAO DA SILVA",
"birthCountry": "BRASILEIRA",
"birthDate": "1990-01-01T00:00:00Z",
"gender": "M",
"motherName": "MARIA DA SILVA",
"fatherName": "",
"maritalStatus": "",
"rgNumber": "",
"rgIssuingAgency": "",
"rgStateCode": "",
"financialData": {
"incomeEstimate": "...",
"totalAssets": "..."
},
"address": {
"addressMain": "AVENIDA DO ESTADO",
"number": "123",
"complement": "ANDAR 1",
"neighborhood": "CENTRO",
"zipCode": "12345678",
"city": "SAO PAULO",
"state": "SP",
"country": "BRASIL",
"type": "WORK"
},
"email": "...",
"phone": "+554799999999"
}
}
字段类型描述
namestring全名。
birthCountrystring出生国家。
birthDatestring (ISO 8601)出生日期。
genderstring性别。
motherNamestring母亲姓名。
fatherNamestring父亲姓名。
maritalStatusstring婚姻状况。
rgNumberstringRG 编号。
rgIssuingAgencystringRG 签发机构。
rgStateCodestringRG 州代码。
financialData.incomeEstimatestring收入估算。
financialData.totalAssetsstring总资产。
emailstring电子邮件。
phonestring电话号码。

basicData.address

字段类型描述
addressMainstring街道名称。
numberstring门牌号。
complementstring补充地址。
neighborhoodstring社区/街区。
zipCodestring邮政编码。
citystring城市。
statestring州代码。
countrystring国家。
typestring地址类型(例如 WORK)。

`lists.riskData.taxIdValidation` — CPF 验证
{
"taxIdValidation": {
"taxIdStatus": "REGULAR",
"taxIdStatusDate": "...",
"decease": false,
"under18": false
}
}
字段类型描述
taxIdStatusstringCPF 登记状态。
taxIdStatusDatestring登记状态的日期。
deceaseboolean是否已死亡。
under18boolean是否未满 18 岁。

`lists.riskData.pep` — 政治敏感人士
{
"pep": {
"isCurrentlyPep": true,
"records": [
{
"level": "1",
"jobTitle": "SENADOR",
"motive": "FEDERAL EMPLOYEE"
}
],
"hasRelatedPep": true,
"related": [
{
"taxId": "01253069891",
"level": "2",
"jobTitle": "FAMILIAR"
}
]
}
}
字段类型描述
isCurrentlyPepboolean当前是否为政治敏感人士(PEP)。
recordsarray自身的 PEP 记录。
records[].levelstring政治曝光等级。
records[].jobTitlestring职务。
records[].motivestring分类原因。
hasRelatedPepboolean是否有关联的 PEP 人员。
relatedarray关联 PEP 人员列表。
related[].taxIdstring关联人员的 CPF。
related[].levelstring曝光等级。
related[].jobTitlestring关联人员的职务。

`lists.riskData.aml` — 反洗钱(制裁)
{
"aml": {
"isSanctioned": true,
"records": [
{
"type": "Law Enforcement",
"source": "interpol",
"standardizedType": "ARREST WARRANTS",
"endDate": "..."
}
],
"hasRelatedSanctioned": false,
"relatedRecords": []
}
}
字段类型描述
isSanctionedboolean是否受到制裁。
recordsarray自身的制裁记录。
records[].typestring制裁类型。
records[].sourcestring制裁来源。
records[].standardizedTypestring标准化类型。
records[].endDatestring截止日期。
hasRelatedSanctionedboolean是否有受制裁的关联人员。
relatedRecordsarray关联人员的制裁记录。

`lists.riskData.sportsRelationship` — 体育博彩关系
{
"sportsRelationship": {
"hasSportsRelationship": false,
"isCurrentlyAthlete": false,
"isCurrentlySportsCoach": false,
"isCurrentlySportsClubDirector": false,
"isCurrentlyReferee": false,
"isCurrentlyRelatedToFinanceMinistry": false,
"isCurrentlyBettingCompanyOwner": false,
"sportsRelationshipMotive": "",
"sportExposures": []
}
}
字段类型描述
hasSportsRelationshipboolean是否具有体育关系。
isCurrentlyAthleteboolean是否为在役运动员。
isCurrentlySportsCoachboolean是否为在职教练。
isCurrentlySportsClubDirectorboolean是否为在职俱乐部总监。
isCurrentlyRefereeboolean是否为在职裁判员。
isCurrentlyRelatedToFinanceMinistryboolean是否与财政部存在关联。
isCurrentlyBettingCompanyOwnerboolean是否为博彩公司所有者。
sportsRelationshipMotivestring关联原因。
sportExposuresarray详细的体育曝光信息。

sportExposures[]

字段类型描述
sportNamestring运动项目名称。
regionstring活动地区。
totalRelatedEntitiesinteger关联实体总数。
relationshipLevelstring关联等级。
endDatestring截止日期。

错误代码

代码消息描述
99989The document is invalid.CPF 无效时返回。