2. Início
  4. Docs
  6. DaaS
  8. API Registro Civil
  10. Recursos e Operações

Recursos e Operações

A API de Registro Civil disponibiliza os seguintes recursos e operações:  

Registros de nascimento

Consulta de Registro de Nascimento pela Matrícula: Permite consultar os dados do registro de nascimento passando uma matrícula ou outros parâmetros

  • GET /nascimentos/{matricula} 
  • Escopo (OAuth 2.0): obter_nascimento 
  • Path Param: 
    • matricula – Matrícula do registro de nascimento. (Obrigatório)  
  • GET /nascimentos 
  • Escopo (OAuth 2.0): obter_nascimento 
  • Path Param: 
    • nomeNascido - Nome do nascido  
    • nomeFiliacao - Nome de um dos genitores  
    • dataNascimento  – Data de nascimento  
    • municipioNascimento - Código IBGE do município de nascimento  
    • cpfNascido - Número do CPF do nascido  
    • cpfFiliacao - Número do CPF de um dos genitores  
    • dnv - Número da Declaração de Nascido Vivo  
    • buscaNomeExato  – Se a busca pelos nomes é para ser pelo nome exatamente como informado nos parâmetros anteriores. Deve ser usado em conjunto com nomeNascido e/ou nomeFiliacao 

Response:  Caso seja encontrado um registro de nascimento a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:   

  • matricula – Matrícula do registro com a seguinte lei de formação: (SSSSSSACTP-AAAA-T-LLLLL-FFF-TTTTTTT-DD), onde:  
    • AC: Acervo
    • TP: Tipo de Serviço  
    • AAAA: Ano do Registro  
    • T: Tipo do Livro  
    • LLLLL: Número do livro  
    • FFF: Número da folha  
    • TTTTTTT: Número do termo  
    • DD: Dígito verificador da matrícula 
  • dataLavratura - Data da lavratura do registro  
  • dataInsercao  – Data de inclusão do registro no sistema  
  • nome – Nome do nascido  
  • dataNascimento   – Data de nascimento  
  • sexo – Sexo do nascido, podendo assumir os valores MASCULINO, FEMININO, IGNORADO  
  • naturalidade - Dados da naturalidade do nascido contendo:
    • uf – Estado de nascimento  
    • municipio  – Nome do município de nascimento  
    • codigoIBGE  – Código do município segundo IBGE  
  • possuiGemeos  – Indicador se possui irmão(s) gêmeo(s)  
  • filiacao - Dados da filiação do nascido contendo:  
    • nome  – Nome do(a) genitor(a)  
    • sexo  – Sexo do genitor, podendo assumir os valores MASCULINO, FEMININO, IGNORADO  
    • dataNascimento  – Data de nascimento do genitor  
    • naturalidade – Dados da naturalidade do(a) genitor(a) contendo:  
      • uf - Estado de nascimento do(a) genitor(a)  
      • municipio - Município de nascimento do(a) genitor(a)  
      • codigoIBGE - Código do município segundo IBGE  
    • documentos - Documentos do(a) genitor(a) contendo:  
      • tipo - Tipo do documento  
      • numero - Número do documento  
      • dataEmissao - Data de emissão do documento  
  • possuiRegistrosAnteriores - Indicador de existência de outros registros anteriores com os mesmos parâmetros de pesquisa informados.  

Caso seja identificado erro no processo de validação da matrícula a API retornará o código HTTP 400 e os dados descritos a seguir em formato JSON: 

  • codigo – Código da mensagem. 
  • erro – Breve descrição da mensagem. 
  • descricao – Descrição completa da mensagem com solução. 

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

  • 404 – Não foi encontrado um registro de nascimento para a matrícula informada  
  • 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, conforme descrito na seção 3  

Registros de Casamentos

Consulta de Registro de Casamento pela Matrícula: Permite consultar os dados do registro de casamento passando uma matrícula ou outros parâmetros.  

  • GET /casamento/{matricula} 
  • Escopo (OAuth 2.0): obter_casamento
  • Path Param: 
    • matricula – Matrícula do registro de casamento. (Obrigatório)  
  • GET /nascimentos 
  • Escopo (OAuth 2.0): obter_nascimento 
  • Path Param: 
    • nomeConjuge - Nome de um dos cônjunges
    • nomeFiliacao - Nome de um dos genitores  de um dos cônjuges
    • municipioNascimento - Código IBGE do município onde ocorreu o casamento
    • cpf - Número do CPF de um dos cônjuges
    • tipoDocumento - Tipo de Documento, podendo assumir os valores: RG, NIT, RIC, RNE, TITULO_DE_ELEITOR, PASSAPORTE, CNH, CTPS, CARTEIRA_DE_MARITIMO, DOC_ESTRANGEIRO, CERT_DE_NASCIMENTO, CERT_DE_RESERVISTA, NAO_IDENTIFICADO] 
    • numeroDocumento  – Número do documento. Uso em conjunto com o parâmetro tipoDocumento 
    • buscaNomeExato  – Se a busca pelos nomes é para ser pelo nome exatamente como informado nos parâmetros anteriores. Deve ser usado em conjunto com nomeConjuge e/ou nomeFiliacao 

Response:  Caso seja encontrado um registro de casamento a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:   

  • matricula – Matrícula do registro com a seguinte lei de formação: (SSSSSSACTP-AAAA-T-LLLLL-FFF-TTTTTTT-DD), onde:  
    • AC: Acervo
    • TP: Tipo de Serviço  
    • AAAA: Ano do Registro  
    • T: Tipo do Livro  
    • LLLLL: Número do livro  
    • FFF: Número da folha  
    • TTTTTTT: Número do termo  
    • DD: Dígito verificador da matrícula 
  • dataLavratura - Data da lavratura do registro  
  • dataInsercao  – Data de inclusão do registro no sistema  
  • dataCelebracao – Data da celebração do casamento
  • conjuges  – Dados dos cônjuges
    • nome – Nome do cônjuge 
    • sexo – Sexo do nascido, podendo assumir os valores MASCULINO, FEMININO, IGNORADO  
    • dataNascimento – Data de nascimento do cônjuge 
    • naturalidade - Dados da naturalidade do nascido contendo:
      • uf – Estado de nascimento  
      • municipio  – Nome do município de nascimento  
      • codigoIBGE  – Código do município segundo IBGE  
    • documentos – Documentos do cônjuge contendo: 
      • tipo - Tipo do documento  
      • numero - Número do documento  
      • dataEmissao - Data de emissão do documento  
    • filiacao - Documentos da filiação do cônjuge contendo:  
      • nome  – Nome do(a) genitor(a)  do cônjuge
      • sexo  – Sexo do genitor, podendo assumir os valores MASCULINO, FEMININO, IGNORADO  
  • dataNascimento  – Data de nascimento do genitor  
  • possuiRegistrosAnteriores - Indicador de existência de outros registros anteriores com os mesmos parâmetros de pesquisa informados.  

Caso seja identificado erro no processo de validação da matrícula a API retornará o código HTTP 400 e os dados descritos a seguir em formato JSON: 

  • codigo – Código da mensagem. 
  • erro – Breve descrição da mensagem. 
  • descricao – Descrição completa da mensagem com solução. 

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

  • 404 – Não foi encontrado um registro de casamento para a matrícula informada  
  • 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, conforme descrito na seção 3  

Registros de Óbito

Consulta de Registro de Óbito pela Matrícula: Permite consultar os dados do registro de óbito passando uma matrícula ou outros parâmetros.  

  • GET /obitos/{matricula} 
  • Escopo (OAuth 2.0): obter_obito
  • Path Param: 
    • matricula – Matrícula do registro de óbito. (Obrigatório)  
  • GET /obitos
  • Escopo (OAuth 2.0): obter_obito
  • Path Param: 
    • nomeFalecido - Nome do falecido
    • dataNascimentoFalecido - Data de nascimento do falecido  
    • nomeFiliacao - Nome de um dos genitores  do falecido
    • cpf - Número do CPF do falecido
    • tipoDocumento - Tipo de Documento, podendo assumir os valores: RG, NIT, RIC, RNE, TITULO_DE_ELEITOR, PASSAPORTE, CNH, CTPS, CARTEIRA_DE_MARITIMO, DOC_ESTRANGEIRO, CERT_DE_NASCIMENTO, CERT_DE_RESERVISTA, NAO_IDENTIFICADO] 
    • numeroDocumento  – Número do documento. Uso em conjunto com o parâmetro tipoDocumento 
    • buscaNomeExato  – Se a busca pelos nomes é para ser pelo nome exatamente como informado nos parâmetros anteriores. Deve ser usado em conjunto com nomeConjuge e/ou nomeFiliacao 

Response:  Caso seja encontrado um registro de casamento a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:   

  • matricula – Matrícula do registro com a seguinte lei de formação: (SSSSSSACTP-AAAA-T-LLLLL-FFF-TTTTTTT-DD), onde:  
    • AC: Acervo
    • TP: Tipo de Serviço  
    • AAAA: Ano do Registro  
    • T: Tipo do Livro  
    • LLLLL: Número do livro  
    • FFF: Número da folha  
    • TTTTTTT: Número do termo  
    • DD: Dígito verificador da matrícula 
  • dataLavratura - Data da lavratura do registro  
  • dataInsercao  – Data de inclusão do registro no sistema  
  • dataNascimento – Data de nascimento do falecido
  • nomeFalecido – Nome do falecido
  • sexoFalecido – Sexo do falecido, podendo assumir os valores MASCULINO, FEMININO, IGNORADO  
  • dataObito – Data do óbito
  • naturalidade - Dados da naturalidade do nascido contendo:
    • uf – Estado de nascimento  
    • municipio  – Nome do município de nascimento  
    • codigoIBGE  – Código do município segundo IBGE  
    • documentos – Documentos do cônjuge contendo: tipo - Tipo do documento  
      • tipo– Tipo do documento  
      • numero - Número do documento  
      • dataEmissao - Data de emissão do documento  
    • filiacao - Documentos da filiação do cônjuge contendo:
      • nome  – Nome do(a) genitor(a)  do falecido
      • sexo  – Sexo do genitor, podendo assumir os valores MASCULINO, FEMININO, IGNORADO  
    • cartorio  – Dados do cartório para registro oriundos do SISOBI contendo:
      • tipo – Tipo de identificador do cartório no SISOBI, podendo assumir os valores: [ID Provisório, CNPJ, CEI, CPF, CNS]  
      • identificador – Identificador do cartório no SISOBI  
    • livro – Traz o número do livro onde está assentado o registro, se este for oriundo do SISOBI. Este dado não retornará em registros oriundos do SIRC 
    • folha – Traz a folha do livro onde está assentado o registro, se este for oriundo do SISOBI. Este dado não retornará em registros oriundos do SIRC. 
    • termo – Traz o número do termo do registro, se este for oriundo do SISOBI. Este dado não retornará em registros oriundos do SIRC 
  • possuiRegistrosAnteriores - Indicador de existência de outros registros anteriores com os mesmos parâmetros de pesquisa informados.  

Caso seja identificado erro no processo de validação da matrícula a API retornará o código HTTP 400 e os dados descritos a seguir em formato JSON: 

  • codigo – Código da mensagem. 
  • erro – Breve descrição da mensagem. 
  • descricao – Descrição completa da mensagem com solução. 

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

  • 404 – Não foi encontrado um registro de casamento para a matrícula informada  
  • 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, conforme descrito na seção 3  
Este artigo foi útil para você? Não Sim

How can we help?

Tabela de Conteúdo