Recursos e Operações | Dataprev DOCs

A API CadÚnico disponibiliza os seguintes recursos e operações: 

Consultar Situação Cadastral por CPF
Consultar Situação Cadastral por NIS
Consultar Situação Cadastral e Indicadores Familiares por CPF (uso restrito)
Consultar Situação Cadastral e Indicadores Familiares por NIS (uso restrito)
Consultar Situação Cadastral e Dados Familiares por CPF (uso restrito)
Consultar Situação Cadastral e Dados Familiares por NIS (uso restrito)
Consultar dados de Pessoas (uso restrito)
Consultar dados de Famílias (uso restrito)

Consultar Situação Cadastral por CPF

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma determinada pessoa:

se o CPF está na base do Cadastro, e com status cadastrado;
se o CPF cadastrado faz parte de grupo familiar considerado baixa renda; e
se o cadastro está atualizado na base de dados.

GET /v1/situacaoCadastral/{cpf}:
  
summary: Dado o CPF, informa sim/não para a) se pessoa está cadastrada; b) se família é de baixa renda e c) se cadastro está atualizado

parameters:
   - name: cpf
   - required: true
   - type: string

Response:
{
  "pessoaCadastrada": "Sim",
  "familiaBaixaRenda": "Sim",
  "cadastroAtualizado": "Sim"
}

Path Param:

cpf	CPF da pessoa a ser consultada (obrigatório)

Response:  Caso a consulta seja realizada com sucesso, a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:  

pessoaCadastrada	Indica se o CPF consultado está presente no CadÚnico com situação “Cadastrada”. Valores possíveis: “Sim”: Consta no CadÚnico com situação “cadastrado“. “Não”: Não consta no CadÚnico com situação “cadastrado“.
familiaBaixaRenda	O atributo é retornado apenas se Pessoa Cadastrada = “Sim”. Indica se o CPF consultado está presente no CadÚnico com situação “Cadastrada” e se a pessoa faz parte de um grupo familiar considerado de baixa renda conforme os critérios do CadÚnico. Valores possíveis: “Sim”: Consta no CadÚnico com situação “cadastrado“ e em grupo familiar de baixa renda. “Não”: Consta no CadÚnico com situação “cadastrado“ mas não pertence a um grupo familiar de baixa renda.
cadastroAtualizado	O atributo é retornado apenas se Pessoa Cadastrada = “Sim”. Indica se o CPF consultado está presente no CadÚnico com situação “Cadastrada” e se o cadastro está atualizado no CadÚnico. Valores possíveis: “Sim”: Consta no CadÚnico com situação “cadastrado“ e está com o cadastro atualizado. “Não”: Consta no CadÚnico com situação “cadastrado“ e não está com o cadastro atualizado.

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

400	CPF invalido: {cpf}. O CPF informado no parâmetro de entrada é inválido.
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora  .
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Consultar Situação Cadastral por NIS

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma determinada pessoa:

se o NIS está na base do Cadastro, e com status cadastrado;
se o NIS cadastrado faz parte de grupo familiar considerado baixa renda; e
se o cadastro está atualizado na base de dados.

GET /v1/situacaoCadastral/nis/{nis}:
  
summary: Dado o NIS, informa sim/não para a) se pessoa está cadastrada; b) se família é de baixa renda e c) se cadastro está atualizado

parameters:
   - name: nis
   - required: true
   - type: string

Response:
{
  "pessoaCadastrada": "Sim",
  "familiaBaixaRenda": "Sim",
  "cadastroAtualizado": "Sim"
}

Path Param:

nis	NIS da pessoa a ser consultada (obrigatório)

Response:  Caso a consulta seja realizada com sucesso, a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:  

pessoaCadastrada	Indica se o NIS consultado está presente no CadÚnico com situação “Cadastrada”. Valores possíveis: “Sim”: Consta no CadÚnico com situação “cadastrado“. “Não”: Não consta no CadÚnico com situação “cadastrado“.
familiaBaixaRenda	O atributo é retornado apenas se Pessoa Cadastrada = “Sim”. Indica se o NIS consultado está presente no CadÚnico com situação “Cadastrada” e se a pessoa faz parte de um grupo familiar considerado de baixa renda conforme os critérios do CadÚnico. Valores possíveis: “Sim”: Consta no CadÚnico com situação “cadastrado“ e em grupo familiar de baixa renda. “Não”: Consta no CadÚnico com situação “cadastrado“ mas não pertence a um grupo familiar de baixa renda.
cadastroAtualizado	O atributo é retornado apenas se Pessoa Cadastrada = “Sim”. Indica se o NIS consultado está presente no CadÚnico com situação “Cadastrada” e se o cadastro está atualizado no CadÚnico. Valores possíveis: “Sim”: Consta no CadÚnico com situação “cadastrado“ e está com o cadastro atualizado. “Não”: Consta no CadÚnico com situação “cadastrado“ e não está com o cadastro atualizado.

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora  .
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Consultar Situação Cadastral e Indicadores Familiares por CPF (uso restrito)

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma determinada pessoa:

se o CPF está na base do Cadastro, e com status cadastrado;
se o cadastro está atualizado na base de dados;
faixas de renda familiar/per capita;
município (Código IBGE, Nome e UF);
características do local de domicílio;
Idade;
se a família é beneficiária do programa Bolsa Família.

GET /v1/dp/indicadoresFamiliar/{cpf}:
  
summary: Dado o CPF, retorna as seguintes informações: se a pessoa está cadastrada, se o cadastro está atualizado, faixas de renda familiar/per capita, idade, município, características do local de domicílio e se a família é beneficiária do programa Bolsa Família.

parameters:
        - name: cpf
          in: path
          required: true
          schema:
            type: string
        - name: X-Consumer-Id
          in: header
          description: 'Chave de identificação do consumidor: Sigla do orgão (ex. AGU), CPF, CNPJ, outra chave'
          required: true
          schema:
            type: string
          example: AGU
        - name: X-Consumer-Id-Type
          in: header
          description: 'Tipo da chave de identificação do consumidor: 'Sigla', 'CPF', 'CNPJ', 'tipo_da_chave (livre)''
          required: true
          schema:
            type: string
          example: Sigla
        - name: X-Authorization-Id
          in: header
          description: 'Chave de identificação da autorização na origem: processo judicial, contrato registrado, consentimento registrado'
          required: true
          schema:
            type: string
          example: 0002452-51.2016.2.00.0001
        - name: X-Authorization-Id-Type
          in: header
          description: 'Tipo da Chave de identificação da autorização na origem: 'Processo', 'Contrato', 'Consentimento''
          required: true
          schema:
            type: string
          example: Processo
        - name: X-Subject-Id
          in: header
          description: 'Chave de identificação do sujeito consultado: CPF, NIT '
          required: false
          schema:
            type: string
        - name: X-Subject-Id-Type
          in: header
          description: 'Tipo da chave de identificação do sujeito consultado: 'CPF', 'NIT''
          required: false
          schema:
            type: string

Response:
{
  "dataUltimaAtualizacao": "string",
  "pessoaCadastrada": true,
  "cadastroAtualizado": true,
  "faixaRendaFamiliarPerCapita": {
    "codigo": 0,
    "descricao": "string"
  },
  "faixaRendaFamiliarTotal": {
    "codigo": 0,
    "descricao": "string"
  },
  "municipio": {
    "codigoMunicipioIbge": "string",
    "nomeMunicipio": "string",
    "siglaUf": "string"
  },
  "caracteristicasLocalDomicilio": {
    "codigo": 0,
    "descricao": "string"
  },
  "idade": 0,
  "familiaBeneficiariaPBF": true
}

Path Param:

cpf	CPF da pessoa a ser consultada (obrigatório)

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

200	Ok (pessoa cadastrada ou não)
400	CPF invalido: {cpf}. O CPF informado no parâmetro de entrada é inválido.
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora  .
406	Parâmetros de cabeçalho inválidos
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Observação: as colunas abaixo retornam ID das tabelas de domínio descritas aqui.

Atributo	Domínio
`caracteristicasLocalDomicilio`	Características do local de domicílio
`faixaRendaFamiliarPerCapita`	Faixa de renda percapita
`faixaRendaFamiliarTotal`	Faixa de renda familiar

Consultar Situação Cadastral e Indicadores Familiares por NIS (uso restrito)

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma determinada pessoa:

se o NIS está na base do Cadastro, e com status cadastrado;
se o cadastro está atualizado na base de dados;
faixas de renda familiar/per capita;
município (Código IBGE, Nome e UF);
características do local de domicílio;
Idade;
se a família é beneficiária do programa Bolsa Família.

GET /v1/dp/indicadoresFamiliar/nis/{nis}:
  
summary: Dado o NIS, retorna as seguintes informações: se a pessoa está cadastrada, se o cadastro está atualizado, faixas de renda familiar/per capita, idade, município, características do local de domicílio e se a família é beneficiária do programa Bolsa Família.

parameters:
        - name: nis
          in: path
          required: true
          schema:
            type: string
        - name: X-Consumer-Id
          in: header
          description: 'Chave de identificação do consumidor: Sigla do orgão (ex. AGU), CPF, CNPJ, outra chave'
          required: true
          schema:
            type: string
          example: AGU
        - name: X-Consumer-Id-Type
          in: header
          description: 'Tipo da chave de identificação do consumidor: 'Sigla', 'CPF', 'CNPJ', 'tipo_da_chave (livre)''
          required: true
          schema:
            type: string
          example: Sigla
        - name: X-Authorization-Id
          in: header
          description: 'Chave de identificação da autorização na origem: processo judicial, contrato registrado, consentimento registrado'
          required: true
          schema:
            type: string
          example: 0002452-51.2016.2.00.0001
        - name: X-Authorization-Id-Type
          in: header
          description: 'Tipo da Chave de identificação da autorização na origem: 'Processo', 'Contrato', 'Consentimento''
          required: true
          schema:
            type: string
          example: Processo
        - name: X-Subject-Id
          in: header
          description: 'Chave de identificação do sujeito consultado: CPF, NIT '
          required: false
          schema:
            type: string
        - name: X-Subject-Id-Type
          in: header
          description: 'Tipo da chave de identificação do sujeito consultado: 'CPF', 'NIT''
          required: false
          schema:
            type: string

Response:
{
  "dataUltimaAtualizacao": "string",
  "pessoaCadastrada": true,
  "cadastroAtualizado": true,
  "faixaRendaFamiliarPerCapita": {
    "codigo": 0,
    "descricao": "string"
  },
  "faixaRendaFamiliarTotal": {
    "codigo": 0,
    "descricao": "string"
  },
  "municipio": {
    "codigoMunicipioIbge": "string",
    "nomeMunicipio": "string",
    "siglaUf": "string"
  },
  "caracteristicasLocalDomicilio": {
    "codigo": 0,
    "descricao": "string"
  },
  "idade": 0,
  "familiaBeneficiariaPBF": true
}

Path Param:

nis	NIS da pessoa a ser consultada (obrigatório)

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

200	Ok (pessoa cadastrada ou não)
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora  .
406	Parâmetros de cabeçalho inválidos
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Observação: as colunas abaixo retornam ID das tabelas de domínio descritas aqui.

Atributo	Domínio
`caracteristicasLocalDomicilio`	Características do local de domicílio
`faixaRendaFamiliarPerCapita`	Faixa de renda per capita
`faixaRendaFamiliarTotal`	Faixa de renda familiar

Consultar Situação Cadastral e Dados Familiares por CPF (uso restrito)

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma determinada pessoa:

se o CPF está na base do Cadastro, e com status cadastrado;
se o cadastro está atualizado na base de dados;
faixas de renda familiar/per capita;
município (Código IBGE, Nome e UF);
características do local de domicílio;
idade;
se a família é beneficiária do programa Bolsa Família;
sexo;
raça/cor;
pertencimento a Grupos Populacionais Tradicionais e Específicos (gpte);
e quantidade de pessoas na família;

GET /v1/dp/dadosFamiliar/{cpf}:
  
summary: Dado o CPF, retorna as seguintes informações: se a pessoa está cadastrada, se o cadastro está atualizado, faixas de renda familiar/per capita, idade, sexo, raça/cor, município, características do local de domicílio, se pertence a Grupos Populacionais Tradicionais e Específicos (gpte), quantidade de pessoas na família e se a família é beneficiária do programa Bolsa Família.

parameters:
        - name: cpf
          in: path
          required: true
          schema:
            type: string
        - name: X-Consumer-Id
          in: header
          description: 'Chave de identificação do consumidor: Sigla do orgão (ex. AGU), CPF, CNPJ, outra chave'
          required: true
          schema:
            type: string
          example: AGU
        - name: X-Consumer-Id-Type
          in: header
          description: 'Tipo da chave de identificação do consumidor: 'Sigla', 'CPF', 'CNPJ', 'tipo_da_chave (livre)''
          required: true
          schema:
            type: string
          example: Sigla
        - name: X-Authorization-Id
          in: header
          description: 'Chave de identificação da autorização na origem: processo judicial, contrato registrado, consentimento registrado'
          required: true
          schema:
            type: string
          example: 0002452-51.2016.2.00.0001
        - name: X-Authorization-Id-Type
          in: header
          description: 'Tipo da Chave de identificação da autorização na origem: 'Processo', 'Contrato', 'Consentimento''
          required: true
          schema:
            type: string
          example: Processo
        - name: X-Subject-Id
          in: header
          description: 'Chave de identificação do sujeito consultado: CPF, NIT '
          required: false
          schema:
            type: string
        - name: X-Subject-Id-Type
          in: header
          description: 'Tipo da chave de identificação do sujeito consultado: 'CPF', 'NIT''
          required: false
          schema:
            type: string

Response:
{
  "dataUltimaAtualizacao": "string",
  "pessoaCadastrada": true,
  "cadastroAtualizado": true,
  "faixaRendaFamiliarPerCapita": {
    "codigo": 0,
    "descricao": "string"
  },
  "faixaRendaFamiliarTotal": {
    "codigo": 0,
    "descricao": "string"
  },
  "municipio": {
    "codigoMunicipioIbge": "string",
    "nomeMunicipio": "string",
    "siglaUf": "string"
  },
  "caracteristicasLocalDomicilio": {
    "codigo": 0,
    "descricao": "string"
  },
  "idade": 0,
  "familiaBeneficiariaPBF": true
  "sexo": {
    "codigo": 0,
    "descricao": "string"
  },
  "racaCor": {
    "codigo": 0,
    "descricao": "string"
  },
  "gpte": [
    {
      "codigo": 0,
      "descricao": "string"
    }
  ],
  "quantidadePessoasFamilia": 0
}

Path Param:

cpf	CPF da pessoa a ser consultada (obrigatório)

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

200	Ok (pessoa cadastrada ou não)
400	CPF invalido: {cpf}. O CPF informado no parâmetro de entrada é inválido.
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora.
406	Parâmetros de cabeçalho inválidos
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Observação: as colunas abaixo retornam ID das tabelas de domínio descritas aqui.

Atributo	Domínio
`sexo`	Sexo da Pessoa
`racaCor`	Cor/raça da pessoa
`caracteristicasLocalDomicilio`	Características do local de domicílio
`gpte`	Pertencimento a Grupos Populacionais Tradicionais e Específicos (GPTE)
`faixaRendaFamiliarPerCapita`	Faixa de renda per capita
`faixaRendaFamiliarTotal`	Faixa de renda familiar

Consultar Situação Cadastral e Dados Familiares por NIS (uso restrito)

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma determinada pessoa:

se o NIS está na base do Cadastro, e com status cadastrado;
se o cadastro está atualizado na base de dados;
faixas de renda familiar/per capita;
município (Código IBGE, Nome e UF);
características do local de domicílio;
idade;
se a família é beneficiária do programa Bolsa Família;
sexo;
raça/cor;
pertencimento a Grupos Populacionais Tradicionais e Específicos (gpte);
e quantidade de pessoas na família;

GET /v1/dp/dadosFamiliar/nis/{nis}:
  
summary: Dado o NIS, retorna as seguintes informações: se a pessoa está cadastrada, se o cadastro está atualizado, faixas de renda familiar/per capita, idade, sexo, raça/cor, município, características do local de domicílio, se pertence a Grupos Populacionais Tradicionais e Específicos (gpte), quantidade de pessoas na família e se a família é beneficiária do programa Bolsa Família.

parameters:
        - name: nis
          in: path
          required: true
          schema:
            type: string
        - name: X-Consumer-Id
          in: header
          description: 'Chave de identificação do consumidor: Sigla do orgão (ex. AGU), CPF, CNPJ, outra chave'
          required: true
          schema:
            type: string
          example: AGU
        - name: X-Consumer-Id-Type
          in: header
          description: 'Tipo da chave de identificação do consumidor: 'Sigla', 'CPF', 'CNPJ', 'tipo_da_chave (livre)''
          required: true
          schema:
            type: string
          example: Sigla
        - name: X-Authorization-Id
          in: header
          description: 'Chave de identificação da autorização na origem: processo judicial, contrato registrado, consentimento registrado'
          required: true
          schema:
            type: string
          example: 0002452-51.2016.2.00.0001
        - name: X-Authorization-Id-Type
          in: header
          description: 'Tipo da Chave de identificação da autorização na origem: 'Processo', 'Contrato', 'Consentimento''
          required: true
          schema:
            type: string
          example: Processo
        - name: X-Subject-Id
          in: header
          description: 'Chave de identificação do sujeito consultado: CPF, NIT '
          required: false
          schema:
            type: string
        - name: X-Subject-Id-Type
          in: header
          description: 'Tipo da chave de identificação do sujeito consultado: 'CPF', 'NIT''
          required: false
          schema:
            type: string

Response:
{
  "dataUltimaAtualizacao": "string",
  "pessoaCadastrada": true,
  "cadastroAtualizado": true,
  "faixaRendaFamiliarPerCapita": {
    "codigo": 0,
    "descricao": "string"
  },
  "faixaRendaFamiliarTotal": {
    "codigo": 0,
    "descricao": "string"
  },
  "municipio": {
    "codigoMunicipioIbge": "string",
    "nomeMunicipio": "string",
    "siglaUf": "string"
  },
  "caracteristicasLocalDomicilio": {
    "codigo": 0,
    "descricao": "string"
  },
  "idade": 0,
  "familiaBeneficiariaPBF": true
  "sexo": {
    "codigo": 0,
    "descricao": "string"
  },
  "racaCor": {
    "codigo": 0,
    "descricao": "string"
  },
  "gpte": [
    {
      "codigo": 0,
      "descricao": "string"
    }
  ],
  "quantidadePessoasFamilia": 0
}

Path Param:

nis	NIS da pessoa a ser consultada (obrigatório)

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

200	Ok (pessoa cadastrada ou não)
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora.
406	Parâmetros de cabeçalho inválidos
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Observação: as colunas abaixo retornam ID das tabelas de domínio descritas aqui.

Atributo	Domínio
`sexo`	Sexo da Pessoa
`racaCor`	Cor/raça da pessoa
`caracteristicasLocalDomicilio`	Características do local de domicílio
`gpte`	Pertencimento a Grupos Populacionais Tradicionais e Específicos (GPTE)
`faixaRendaFamiliarPerCapita`	Faixa de renda per capita
`faixaRendaFamiliarTotal`	Faixa de renda familiar

***Consultar Dados de Pessoas* *(uso restrito)***

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma informações cadastrais de uma determinada pessoa:

GET v1/pessoas/{cpf}:
  
summary: Retorna as informações de uma pessoa a partir de seu CPF.

parameters:
   - name: cpf
   - required: true
   - type: string

Response:
{
  "codigo": "string",
  "mensagem": "string",
  "object": {
    "codigoFamiliar": "string",
    "nis": "string",
    "nomePessoa": "string",
    "dataNascimento": "string",
    "dataCadastroMembro": "string",
    "sexo": "string",
    "cpf": "string",
    "tituloEleitor": "string",
    "nomeMae": "string",
    "estadoCadastral": "string",
    "grauParentesco": "string",
    "renda": {
      "remuneracaoBrutaUltimoMes": "string",
      "ajudaDoacaoRegularNaoMorador": "string",
      "aposentadoriaPensao": "string",
      "seguroDesemprego": "string",
      "pensaoAlimenticia": "string",
      "outrasFontes": "string"
    },
    "endereco": {
      "localidade": "string",
      "tipoLogradouro": "string",
      "tituloLogradouro": "string",
      "nomeLogradouro": "string",
      "numeroLogradouro": "string",
      "complementoNumero": "string",
      "complementoAdicional": "string",
      "cep": "string"
    }
  }
}

Path Param:

cpf	CPF da pessoa a ser consultada (obrigatório)

Response:  Caso a consulta seja realizada com sucesso, a API retornará o código HTTP 200 e os dados descritos acima em formato JSON.  

Observação: as colunas abaixo retornam ID das tabelas de domínio descritas aqui.

Atributo	Domínio
estadoCadastral	Estado Cadastral Pessoa
grauParentesco	Grau Parentesco

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

204	Não foram encontrados dados para o CPF informado
400	CPF invalido: {cpf}. O CPF informado no parâmetro de entrada é inválido.
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora  .
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Voltar

Consultar dados de Famílias (uso restrito)

Utilizando como base as informações contidas no Cadastro Único, esta operação tem como finalidade retornar para uma informações cadastrais de um determinado grupo familiar:

GET v1/familias/{numeroFamiliar}:
  
summary: Retorna as informações de uma família a partir de seu número familiar.

parameters:
   - name: numeroFamiliar 
   - required: true
   - type: string

Response:
{
  "codigo": "string",
  "mensagem": "string",
  "object": {
    "codigoFamilia": "string",
    "dataAtualizacaoFamilia": "string",
    "dataInclusaoFamilia": "string",
    "estadoCadastralFamilia": "string",
    "valorRendaMediaFamiliar": "string",
    "municipioCadastro": "string",
    "ufCadastro": "string",
    "condicaoCadastro": "string",
    "listaMembros": [
      {
        "cpf": "string",
        "nis": "string",
        "nomePessoa": "string",
        "grauParentesco": "string",
        "estadoCadastral": "string"
      }
    ]
  }
}

Path Param:

numeroFamiliar

Número Familiar da familia a ser consultada (obrigatório)

Response:  Caso a consulta seja realizada com sucesso, a API retornará o código HTTP 200 e os dados descritos acima em formato JSON.  

Observação: as colunas abaixo retornam ID das tabelas de domínio descritas aqui.

Atributo	Domínio
estadoCadastralFamilia	Estado Cadastral Família
condiçãoCadastro	Condição Cadastro Família
grauParentesco	Grau Parentesto
estadoCadastral	Estado Cadastral Pessoa

A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:  

204	Não foram encontrados dados para o número familiar informado.
401	O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora  .
500	Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev.

Voltar

Consultar Situação Cadastral por CPF

Consultar Situação Cadastral por NIS

Consultar Situação Cadastral e Indicadores Familiares por CPF (uso restrito)

Consultar Situação Cadastral e Indicadores Familiares por NIS (uso restrito)

Consultar Situação Cadastral e Dados Familiares por CPF (uso restrito)

Consultar Situação Cadastral e Dados Familiares por NIS (uso restrito)

Consultar Dados de Pessoas (uso restrito)

Consultar dados de Famílias (uso restrito)

How can we help?

Tabela de Conteúdo

***Consultar Dados de Pessoas* *(uso restrito)***