> For the complete documentation index, see [llms.txt](https://docs.scorepositivo.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scorepositivo.com.br/pessoa-fisica/relatorios-para-cpf/cadastral-zip.md).

# Cadastral ZIP

<table><thead><tr><th width="297">Código</th><th>Tipo</th></tr></thead><tbody><tr><td><mark style="color:blue;">cpf-register-zip</mark></td><td>Síncrono</td></tr></tbody></table>

## Campos de Retorno

<table><thead><tr><th width="301">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>name</td><td>Nome.</td></tr></tbody></table>

#### 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

<table><thead><tr><th width="310">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>tp_logradouro</td><td>Tipo Logradouro.</td></tr><tr><td>nm_logradouro</td><td>Logradouro.</td></tr><tr><td>nr_logradouro</td><td>Número.</td></tr><tr><td>ds_complemento</td><td>Complemento</td></tr><tr><td>nm_bairro</td><td>Bairro.</td></tr><tr><td>nr_cep</td><td>CEP.</td></tr><tr><td>sg_estado</td><td>Estado.</td></tr><tr><td>nm_cidade</td><td>Cidade.</td></tr><tr><td>dt_recencia</td><td>Data captura.</td></tr><tr><td>dt_recencia_br</td><td>Data captura PT-BR (dd/mm/yyyy).</td></tr></tbody></table>

#### emails

<table><thead><tr><th width="316">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>ds_email</td><td>E-mail.</td></tr></tbody></table>

#### telefones

<table><thead><tr><th width="320">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>nr_ddd</td><td>DDD.</td></tr><tr><td>nr_telefone</td><td>Número do telefone.</td></tr><tr><td>fg_procon</td><td>Indicador de linha cadastrada no PROCON:<br>- true<br>- false</td></tr><tr><td>fg_assinante</td><td>Indicador assinante:<br>- true<br>- false</td></tr><tr><td>fg_celular</td><td>Indicador de número mobile:<br>- true<br>- false</td></tr></tbody></table>

#### 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

<table><thead><tr><th width="324">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>nm_razao_social</td><td>Razão Social</td></tr><tr><td>ds_qualificacao</td><td>Qualificação. Ex.: SOCIO-ADMINISTRADOR</td></tr><tr><td>dt_recencia</td><td>Data captura.</td></tr><tr><td>dt_recencia_br</td><td>Data captura PT-BR (dd/mm/yyyy).</td></tr><tr><td>nr_participacao</td><td>Participação em porcentagem.</td></tr><tr><td>id_aux_informacao</td><td><p>Informação sobre os dados QSA:<br>1 - NÃO FOI IDENTIFICADO MENSAGEM PARA ESTE REGISTRO;<br> 2 - NÃO HÁ INFORMAÇÃO DE QSA NA BASE DE DADOS DO CNPJ;<br> 3 - NATUREJA JURÍDICA NÃO PERMITE O PREENCHIMENTO DO QSA;</p><p>4 -  QSA INFORMADO.</p></td></tr><tr><td>nr_cnpj</td><td>CNPJ.</td></tr></tbody></table>

#### 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  |