身份核验
CPF 查询
按 CPF 与出生日期查询自然人官方登记信息。
GET
/openapi/v3/consultas/cpf/{cpf}/{nascimento}需要
token、timestamp、sign 三个签名头,参见认证与签名。按 11 位自然人税号 加出生日期查登记信息:姓名、登记状态、出生日期。上游按 CPF 与出生日期配对核验;配对不符与查无此人返回同一个错误码 10016003,刻意不作区分(见 身份核验)。
GET 请求:签名用的 body 为空字符串,两个路径变量都属于签名 path 的一部分。响应为无包装结构,不带平台统一响应体。
路径参数
cpf* | string | CPF |
nascimento* | string | 出生日期 |
* 必填字段
200
查询成功,持有人已成年。自然人登记信息。
ni | string | CPF |
nome | string | 姓名 |
| object | 登记状态 |
nascimento | string | 出生日期 |
上游数据源按持有人年龄分档应答,平台原状态码透传。拦截档的 message 是上游给定的法定文案(葡语原文),不随 Language 头翻译;程序判断请用 code。
计费口径:422、451 与查无 / 出生日期不配对(400 + 10016003)按次计费;428 与上游不可用(503)不计费。平台对拦截档不留存任何结果。格式与校验位错误由平台本地拦截,不计费。
成年(18 岁及以上):HTTP 200
正常返回姓名、登记状态、出生日期。
json
{ "ni": "40710536828", "nome": "DANILO HIDEO CORREA", "situacao": { "codigo": "0", "descricao": "REGULAR" }, "nascimento": "09011997" }
16 到 17 岁:HTTP 422
错误码 10016005,不含任何人员字段。勿重试:年龄不会因重试改变,每次调用都计费。
json
{ "code": 10016005, "message": "LGPD: menor de idade" }
小于 16 岁:HTTP 451
错误码 10016004,不含任何人员字段。勿重试。
json
{ "code": 10016004, "message": "LGPD: menor de 16 anos (Lei Felca)" }
年龄无法核实:HTTP 428
错误码 10016006,不含任何人员字段。上游库内缺少该持有人的出生日期;平台已在同一次调用内用你传入的出生日期补核验一次。仍返回 428 说明官方来源也无法核实,重试无意义。
json
{ "code": 10016006, "message": "LGPD: idade nao verificavel - informe a data de nascimento para completar a verificacao" }
situacao.codigoCPF 登记状态码
状态码非 0 时,是否继续业务由你决定;平台只如实透传,不代做判断。
| 取值 | 含义 |
|---|---|
| 0 | REGULAR,正常 |
| 2 | SUSPENSA,已暂停 |
| 3 | TITULAR FALECIDO,持证人已故 |
| 4 | PENDENTE DE REGULARIZACAO,待补正 |
| 5 | CANCELADA POR MULTIPLICIDADE,因重复登记注销 |
| 8 | NULA,无效 |
| 9 | CANCELADA DE OFICIO,依职权注销 |
| 错误码 | HTTP | |
|---|---|---|
| 10016000 | 400 | CPF 格式不合法(须 11 位数字)。检查是否误传格式符或位数不足。 |
| 10016001 | 400 | CPF 校验位不合法。本地先用 mod-11 算法校验,避免无效调用。 |
| 10016002 | 400 | 出生日期格式不合法(须 DDMMYYYY 有效日期)。注意是日月年顺序,且须为真实存在的日期。 |
| 10016003 | 400 | 未找到该 CPF 的信息:该 CPF 不存在,或 CPF 与出生日期不匹配(二者不作区分)。按次计费。 |
| 10016005 | 422 | LGPD: menor de idade:持有人 16 到 17 岁。上游依法不提供数据,不含任何人员字段;勿重试。按次计费。 |
| 10016004 | 451 | LGPD: menor de 16 anos (Lei Felca):持有人小于 16 岁。依法不提供数据,不含任何人员字段;勿重试。按次计费。 |
| 10016006 | 428 | LGPD: idade nao verificavel - informe a data de nascimento para completar a verificacao:年龄无法核实。平台已用你传入的出生日期补核验一次;勿重试。不计费。 |
| 10016020 | 503 | 上游数据源暂不可用。退避重试(初始 1 秒,倍增至 30 秒上限,加抖动);持续出现请联系平台。不计费。 |
