Documentação de módulo
CPF Master
Veja abaixo a estrutura de resposta JSON retornada por este módulo. Os campos podem variar conforme a disponibilidade e atualizações do serviço.
RESPOSTA JSON / EXEMPLO
{
"data": {
"dadosBasicos": {
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXX XXXXXXX XX XXXXX",
"dataNasc": "xx/xx/xxxx",
"sexo": "X",
"estCivil": "",
"faixaScore": "XXXXX xxx X x.xxx",
"rendaAtual": "xxx.xx",
"salarioUltimo": "xxxx,xx",
"salarioAno": "xxxx",
"escolaridade": "",
"naturalidade": "XXXXXX - XX",
"nacionalidade": "XXXXXXXXX",
"desaparecido": false,
"servidor": "",
"biometria": [
{
"peleCor": "XXXXX",
"olhoCor": "Não Informado",
"olhoTipo": "Não Informado",
"cabeloCor": "Não Informado",
"cabeloTipo": "Não Informado",
"altura": "Não Informado",
"peso": "Não Informado",
"barba": "Não Informado"
}
],
"filiacao": {
"nomeMae": "XXXXX XXXXXXXX XX XXXXX",
"nomePai": "XXXXXX XXXXXXX XX XXXXX"
},
"situacaoCadastral": {
"descricaoSit": "XXXXXXX",
"dataSit": "xx/xx/xxxx",
"dataEnt": "xx/xx/xxxx"
},
"obito": []
},
"rgHistorico": [
{
"registroGeral": "xxxxxxxx",
"orgaoEmissor": "XXX",
"situacao": "XXXXXXXX e XXXXXXXXX",
"ufEmissao": "XX",
"dataEmissao": "xx/xx/xxxx",
"dataIdentificacao": "xx/xx/xxxx",
"dataUltimaEmissao": "xx/xx/xxxx"
}
],
"carteiraHabilitacao": [],
"tituloHistorico": [
{
"titulo": "xxxxxxxxxxx",
"zona": "xx",
"secao": "xx"
}
],
"cnsHistorico": [
{
"cns": "xxxxxxxxxxxxxxx",
"tipo": "XXXXXXXXXX",
"dataAtribuicao": "Não Informado",
"origem": "XXXXXX XXXXX XX XXXX"
},
{
"cns": "xxxxxxxxxxxxxxx",
"tipo": "XXXXXXXXXX",
"dataAtribuicao": "Não Informado",
"origem": "XXXXXX XXXXX XX XXXX"
}
],
"pisHistorico": [
{
"pisNis": "xxxxxxxxxxx",
"tipo": "XXX/XXX/XXX",
"dataAtribuicao": "xx/xx/xxxx",
"origem": "XXXXXXX XXXXXXXX xx XXX/XXX"
},
{
"pisNis": "xxxxxxxxxx",
"tipo": "XXX",
"dataAtribuicao": "Não Informado",
"origem": "XXXXXXX XXXXXXXX xx XXX/XXX"
}
],
"codigoCtps": {
"ctpsNumero": "xxxxxxxx",
"ctpsSerie": "xxxxx"
},
"alistamentoMilitar": [],
"doencasDeficiencias": [],
"opiniaoPolitica": {
"pctInfluenciaDireita": "xx",
"pctInfluenciaEsquerda": "xx",
"pctInfluenciaNeutra": "x"
},
"prontuario": [],
"poderAquisitivo": {
"codPoderAquisitivo": "x",
"poderAquisitivo": "XXXXX XXXXX",
"renda": "xxxx,xx",
"faixaRenda": "De R$ xxx até R$ xxx"
},
"serasaMosaic": {
"codMosaic": "Xxx",
"codMosaicSecundario": "Xxx",
"descMosaicSecundario": "XXXXXXXXXXXX XXXXXXXXXXXXX XX XXXXXXX",
"codMosaicNovo": "Xxx"
},
"certidoes": [],
"mandados": [],
"cat": [],
"farmaceutico": [],
"corretor": [],
"candidatura": [],
"antecedentes": [],
"residenteExterior": {
"residenteStatus": "XXX XXXXXXXX",
"nomePais": "Xxxxxx"
},
"telefonesHistorico": [
{
"ddd": "xx",
"telefone": "xxxxxxxxx",
"tipo": "Não Informado",
"prioridade": "Não Informado",
"data": "xx/xx/xxxx",
"operadora": "Não Informado",
"ano": "Não Informado"
},
{
"ddd": "xx",
"telefone": "xxxxxxxx",
"tipo": "Não Informado",
"prioridade": "Não Informado",
"data": "xx/xx/xxxx",
"operadora": "Não Informado",
"ano": "Não Informado"
},
"... (mais xx telefones)"
],
"emails": [],
"redesSociais": [
{
"twitter": []
},
{
"facebook": []
},
{
"linkedin": []
}
],
"enderecos": [
{
"logradouro": "XXX XXXXXX XX XXX",
"numero": "xxx",
"complemento": "Não Informado",
"bairro": "XX XXXXXX",
"cidade": "XXXXX XX",
"siglaUf": "XX",
"cep": "xxxxxxxx",
"vizinhos": [
{
"nome": "XXXXXX XXXXXXX XX XXXXX",
"cpf": "xxxxxxxxxxx",
"sexo": "M",
"nascimento": "xx/xx/xxxx",
"logradouroTipo": "X",
"logradouro": "XXXXXX",
"numero": "xxx",
"complemento": "",
"bairro": "XXXXXX",
"cidade": "XXXXX XX",
"siglaUf": "XX",
"cep": "xxxxxxxx",
"latitude": "-xx.xxxxxxxxxxxxxxx",
"longitude": "-xx.xxxxxxxxxxxxxxx",
"codSetor": "xxxxxxxxxxxxxxx",
"cartaDevolvida": "X",
"distanciaMetros": 8,
"proximidade": "imediato",
"referenciaCep": "xxxxxxxx",
"referenciaNumero": "xxx"
},
{
"nome": "XXXXX XXXXXXXXX XXXXXXX XXXXXX",
"cpf": "xxxxxxxxxxx",
"sexo": "F",
"nascimento": "xx/xx/xxxx",
"logradouroTipo": "X",
"logradouro": "XX XXXXX",
"numero": "xxx",
"complemento": "",
"bairro": "XXXXXX",
"cidade": "XXXXX XX",
"siglaUf": "XX",
"cep": "xxxxxxxx",
"latitude": "-xx.xxxxxxxxxxxxxxx",
"longitude": "-xx.xxxxxxxxxxxxxxx",
"codSetor": "xxxxxxxxxxxxxxx",
"cartaDevolvida": "X",
"distanciaMetros": 32,
"proximidade": "imediato",
"referenciaCep": "xxxxxxxx",
"referenciaNumero": "xxx"
},
"... (mais xx vizinhos)"
]
},
{
"logradouro": "XXXXX XXXXXXX XXXXXXXXX",
"numero": "Não Informado",
"complemento": "Não Informado",
"bairro": "XXXX XXXXXXXXX",
"cidade": "XXXXXX",
"siglaUf": "XX",
"cep": "xxxxxxxx",
"vizinhos": []
},
"... (mais x endereços)"
],
"curriculos": [],
"empregos": [],
"empresas": [],
"chavePix": [],
"contasBancarias": [],
"emprestimos": [],
"beneficios": {
"auxilioBrasil": {
"descricao": "XXXXXXX XXXXXX",
"tipoAcesso": "XXXXXXXX",
"parcelasRecebidas": []
},
"auxilioEmergencial": {
"descricao": "XXXXXXX XXXXXXXXXXXX",
"tipoAcesso": "XXXXXXXX",
"parcelasRecebidas": []
},
"auxilioBpc": {
"descricao": "XXXXXXXXX XX XXXXXXXXXX XXXXXXXXX",
"tipoAcesso": "XXXXXXXX",
"parcelasRecebidas": []
},
"bolsaFamilia": {
"descricao": "XXXXX XXXXXXX",
"tipoAcesso": "XXXXXXXX",
"parcelasRecebidas": []
},
"planoSaude": {
"descricao": "XXXXXX XX XXXXX XXXXXXXXX",
"tipoAcesso": "XXXXXXX",
"registroContratos": []
},
"histLoas": {
"descricao": "XXX XXXXXXXX XX XXXXXXXXXXX XXXXX",
"tipoAcesso": "XXXXXXXX",
"parcelasRecebidas": []
},
"histInss": {
"descricao": "XXXXXXXXX XXXXXXXX XX XXXXXX XXXXX",
"tipoAcesso": "XXXXXXXX",
"parcelasRecebidas": []
}
},
"dividas": {
"bacen": [],
"previdencias": [],
"fgts": []
},
"vacinas": [
{
"vacinaNome": "XXXXX-XX XXXXXXXXXXXX/XXXXXX - XXXXXXXXXX",
"descricaoDose": "xº XXXXXX",
"lote": "xxxxxxxxxxx",
"fabricante": "XXXXXXXXXXXX/XXXXXX",
"grupoAtendimento": "XXXXXXXX XX xx X xx XXXX",
"estabAplicacao": "XXXXXXXX XXXXXX XX XXXXX XX XXXX XXXXX XXXXXX XXXXXXX",
"profissionalAplic": "Não Informado",
"dataAplicacao": "xx/xx/xxxx"
},
{
"vacinaNome": "XXXXX-XX XXXXXXXXXXXX/XXXXXX - XXXXXXXXXX",
"descricaoDose": "xª XXXX",
"lote": "xxxxxxxxxxx",
"fabricante": "XXXXXXXXXXXX/XXXXXX",
"grupoAtendimento": "XXXXXXXX XX xx X xx XXXX",
"estabAplicacao": "XXXXXXXX XXXXXX XX XXXXX XX XXXX XXXXX XXXXXX XXXXXXX",
"profissionalAplic": "XXXXXX XXXXXXX XXXXXXX",
"dataAplicacao": "xx/xx/xxxx"
},
"... (mais x vacinas)"
],
"vacinasGerais": [],
"universitarios": [],
"sisu": [],
"parentes": [
{
"tipo": "pai",
"label": "Pai",
"relacaoCodigo": 12,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXXX XXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 84,
"sexo": "M",
"nomeMae": "XXXXXXXXXX XXXXXXX XX XXXXX",
"nomePai": "XXXXX XXXX XX XXXXX"
},
{
"tipo": "filho",
"label": "Filho",
"relacaoCodigo": 13,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXX XXXXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 31,
"sexo": "M",
"nomeMae": "XXXXXXXXX XX XXXXX XXXXX XX XXXXX",
"nomePai": "XXXXXX XXXXXXX XX XXXXX",
"OREI": "xxxxxxxxxxxxxxxx"
},
{
"tipo": "filho",
"label": "Filha",
"relacaoCodigo": 13,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXXXXXX XXXXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 35,
"sexo": "F",
"nomeMae": "XXXXXXXXX XX XXXXX XXXXX XX XXXXX",
"nomePai": "XXXXXX XXXXXXX XX XXXXX",
"OREI": "xxxxxxxxxxxxxxxx"
},
"... (mais xx parentes)"
],
"parentesNovos": [
{
"tipo": "pai",
"label": "Pai",
"relacaoCodigo": 12,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXXX XXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 84,
"sexo": "M",
"nomeMae": "XXXXXXXXXX XXXXXXX XX XXXXX",
"nomePai": "XXXXX XXXX XX XXXXX"
},
{
"tipo": "filho",
"label": "Filho",
"relacaoCodigo": 13,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXX XXXXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 31,
"sexo": "M",
"nomeMae": "XXXXXXXXX XX XXXXX XXXXX XX XXXXX",
"nomePai": "XXXXXX XXXXXXX XX XXXXX",
"OREI": "xxxxxxxxxxxxxxxx"
},
"... (mais xx parentes)"
],
"socios": [],
"colegasTrabalho": [],
"compras": [
{
"produtoNome": "XXXXXXX XXXXXXX",
"detalhes": "",
"preco": "x.x",
"quantidade": "x",
"data": "xx/xx/xxxx"
},
{
"produtoNome": "x/xx",
"detalhes": "",
"preco": "xxx",
"quantidade": "x",
"data": "xx/xx/xxxx"
},
"... (mais x compras)"
],
"cartoesUsados": [],
"internet": [],
"imoveis": [],
"imoveisRurais": [],
"nascimento": [],
"parto": [],
"viagens": [],
"veiculos": [],
"veiculosHistorico": [
{
"placa": "XXXxXxx",
"placaAntiga": "XXXXxxx",
"ano": "xxxx"
}
],
"irpf": [
{
"instituicao": "",
"codAgencia": "",
"lote": "",
"dataLote": "",
"anoReferencia": "xxxx",
"situacaoReceita": "XXX XXXXXXXXXXX XX XXXXXX XX XXXX XX XXXXX XX XXXXXXX XXXXXXX",
"dataConsulta": ""
}
],
"chequeSemFundo": [],
"conselhos": [],
"oab": [],
"crm": [],
"forcasArmadas": {
"PM": []
},
"presidiario": [],
"energia": [],
"consumos": [
{
"descricaoConsumo": "XXXXX xxxxxxxxxx",
"referenciaId": "x"
},
{
"descricaoConsumo": "XXXXx xxxx xxxxxxxxx",
"referenciaId": "x"
},
"... (mais x consumos)"
],
"processos": [],
"interesses": {
"possuiBancoDigital": false,
"possuiCartoes": true,
"possuiCartaoPrime": false,
"possuiCartaoAltoUso": false,
"possuiCartaoPl": false,
"possuiMultiplosCartoes": true,
"possuiResgateMilhas": false,
"possuiConsorcios": true,
"possuiCreditoImobiliario": true,
"possuiCreditoConsignado": false,
"possuiCreditoPessoal": true,
"possuiFinancasVeiculares": true,
"possuiAquisicaoVeicular": false,
"possuiLuxo": false,
"possuiSeguroAutomotivo": true,
"possuiSeguroResidencial": false,
"possuiSeguroSaude": true,
"possuiSeguroVida": true,
"possuiPerfilFitness": false,
"possuiPerfilInvestidor": false,
"possuiPerfilTomador": true,
"possuiFintechs": true,
"possuiPerfilClientePremuim": false,
"possuiJogosOnline": false,
"possuiPerfilComprasInternet": true,
"possuiPerfilLeitorDigital": true,
"possuiPerfilMobile": true,
"possuiCelularPrepago": false,
"possuiCelularPospago": false,
"possuiTransportePub": false,
"possuiPerfilProcuraDescontos": false,
"possuiPrevidenciaPriv": false,
"realizouViagens": true
},
"corretores": []
},
"parentes": [
{
"tipo": "pai",
"label": "Pai",
"relacaoCodigo": 12,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXXX XXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 84,
"sexo": "M",
"nomeMae": "XXXXXXXXXX XXXXXXX XX XXXXX",
"nomePai": "XXXXX XXXX XX XXXXX"
},
{
"tipo": "filho",
"label": "Filho",
"relacaoCodigo": 13,
"cpf": "xxxxxxxxxxx",
"tipoIrmao": null,
"validacao": "",
"nome": "XXXXX XXXXXXXXX XX XXXXX",
"nascimento": "xx/xx/xxxx",
"idade": 31,
"sexo": "M",
"nomeMae": "XXXXXXXXX XX XXXXX XXXXX XX XXXXX",
"nomePai": "XXXXXX XXXXXXX XX XXXXX",
"OREI": "xxxxxxxxxxxxxxxx"
},
"... (mais xx parentes)"
]
}