For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cadastral ZIP

Código
Tipo

cpf-register-zip

Síncrono

Campos de Retorno

Campo
Descrição

name

Nome.

dados_principais

Campo
Descrição

nr_cpf

CPF.

nm_completo

Nome.

nm_social_completo

Nome Social.

ds_signo

Signo.

ds_sexo

Sexo.

dt_nascimento

Data Nascimento.

dt_nascimento_br

Data Nascimento PT-BR (dd/mm/yyyy)

nr_idade

Idade.

fg_obito

Flag Obito.

nr_ano_obito

Ano Óbito.

dados_complementares

Campo
Descrição

ds_profissao

Profissão.

ds_faixavalor

Faixa salarial.

ds_cargo

Cargo.

nr_rg

RG.

ds_estadocivil

Estado Civil.

ds_nacionalidade

Nacionalidade.

ds_escolaridade

Escolaridade.

nr_pis

PIS - Programa de Integração Social.

situacao_srf

Campo
Descrição

dt_consulta

Data consulta.

hr_consulta

Hora Consulta.

ds_srf_pf

Situação na Receita Federal.

ds_protocolo

Protocolo de consulta na Receita Federal.

id_digitoverificador

Dígito Verificador da Receita Federal.

nr_ano_obito

Ano Óbito.

ds_inscricao

Descrição sobre a data de inscrição.

nr_cpf

CPF.

nm_completo

Nome.

nm_social_completo

Nome social.

dt_nascimento

Data nascimento.

dt_nascimento_br

Data nascimento PT-BR (dd/mm/yyyy).

enderecos

Campo
Descrição

tp_logradouro

Tipo Logradouro.

nm_logradouro

Logradouro.

nr_logradouro

Número.

ds_complemento

Complemento

nm_bairro

Bairro.

nr_cep

CEP.

sg_estado

Estado.

nm_cidade

Cidade.

dt_recencia

Data captura.

dt_recencia_br

Data captura PT-BR (dd/mm/yyyy).

emails

Campo
Descrição

ds_email

E-mail.

telefones

Campo
Descrição

nr_ddd

DDD.

nr_telefone

Número do telefone.

fg_procon

Indicador de linha cadastrada no PROCON: - true - false

fg_assinante

Indicador assinante: - true - false

fg_celular

Indicador de número mobile: - true - false

pessoas_vinculadas

Campo
Descrição

nr_cpf

CPF.

nm_completo

Nome.

ds_aux_vinculo

Descrição do vínculo.

nr_ano_obito

Ano óbito.

qsa

Campo
Descrição

nm_razao_social

Razão Social

ds_qualificacao

Qualificação. Ex.: SOCIO-ADMINISTRADOR

dt_recencia

Data captura.

dt_recencia_br

Data captura PT-BR (dd/mm/yyyy).

nr_participacao

Participação em porcentagem.

id_aux_informacao

Informação sobre os dados QSA: 1 - NÃO FOI IDENTIFICADO MENSAGEM PARA ESTE REGISTRO; 2 - NÃO HÁ INFORMAÇÃO DE QSA NA BASE DE DADOS DO CNPJ; 3 - NATUREJA JURÍDICA NÃO PERMITE O PREENCHIMENTO DO QSA;

4 - QSA INFORMADO.

nr_cnpj

CNPJ.

bolsa_familia

Campo
Descrição

erro_codgio

Código do erro.

erro_mensagem

Mensagem do erro.

nr_nis

NIS.

fg_ativo

flag ativo.

nm_nome

Nome.

parcelas

Lista com parcelas

bolsa_familia.parcelas

Campo
Descrição

dt_recencia

Data captura.

dt_recencia_br

Data captura PT-BR.

dt_periodo

Data período.

dt_periodo_br

Data perído PT-BR.

vl_beneficio

Valor Benefício.

sg_estado

Estado.

nm_municipio

Cidade.

dt_saque

Data Saque.

dt_saque_br

Data Saque PT-BR.

cns

Campo
Descrição

nr_cns

Número CNS.

nm_completo

Nome.

dt_recencia

Data captura.

dt_recencia_br

Data captura PT-BR.

nr_cpf

CPF

quem_consultou

Campo
Descrição

retorno

Mensagem.

empresas

Lista com empresas que consultou o documento.

quem_consultou.empresas

Campo
Descrição

dt_consulta

Data Consulta.

dt_consult_br

Data Consulta PT-BR.

ds_segmento

Segmento.

nr_quantidade

Quantidade.

nr_tresmeses

Quantidade 3 meses.

nr_seismeses

Quantidade 6 meses.

nr_dozemeses

Quantidade 12 meses.

indice_segmentacao

Campo
Descrição

retorno

Mensagem.

segmentos

Lista com segmentos.

indice_segmentacao.segmentos

Campo
Descrição

ds_segmento

Segmento.

ds_03meses

3 meses

ds_06meses

6 meses

ds_12meses

12 meses

ds_24meses

24 meses

ds_36meses

36 meses

Last updated