HISTÓRICO

ÍNDICE

• Introdução
• Processo de Integração com os sistemas de gestão de cartórios
• Integração por API
• Considerações para as cargas
• Obter os erros de importação
• Explicação dos campos
• Anexo de documentos pessoais
• ALTERNATIVA: Importação do XML diretamente no sistema

Introdução

O CCN - Cadastro Único de Clientes do Notariado da plataforma e-notariado é a base nacional de pessoas prevista no Provimento CNJ nº 149/2023. Contempla os dados biográficos e biométricos de pessoas físicas, além de seus documentos pessoais, a saber, documento de identidade, CNH, ficha de assinatura do cartório, dentre outros. 

Para conhecimento das funcionalidades deste módulo, acesse AQUI.

Acesse no link aqui para conhecer as orientações gerais do CCN.

Processo de Integração com os sistemas de gestão de cartórios

A integração com os sistemas de gestão de cartórios é realizada através da formatação de arquivos XML, conforme modelos anexos (XSD e XML), sendo que as transmissões deverão ser realizadas pelas APIs desenvolvidas pelo CNB-CF.

Também há a possibilidade de carregar os arquivos diretamente na plataforma e-notariado, por upload em tela específica do sistema, sendo este processo mais direcionado para cargas iniciais apenas, embora a API seja ainda mais recomendável.

A cada nova atualização no cadastro de uma determinada pessoa, é gerada uma nova versão do cadastro do CCN. O sistema trata duplicidade de envio de arquivos, caso todos os dados da pessoa sejam idênticos.

O ideal é que a periodicidade de transmissão seja realizada a cada atualização do cadastro de pessoas do sistema de gestão de cartórios, não excedendo a 15 (quinze) dias da data do cadastro, conforme previsto no Provimento CNJ n 149/2023.

Para acessar o sistema no ambiente de homologação e obter a chave da API, envie um e-mail para servicos@notariado.org.br informando o CPF, Nome e e-mail de quem deverá acessar.

Integração por API

A documentação da API do Identificação de pessoas está disponível no endereço https://pessoas-hml.e-notariado.org.br/swagger/index.html. A parte referente à importação está na seção Imports.

Atentem-se que as urls dos ambientes de homologação e produção são diferentes e, portanto, devem ser tratadas pela aplicação.

• Homologação: https://pessoas-hml.e-notariado.org.br
• Produção: https://pessoas.e-notariado.org.br

Segue abaixo um exemplo de uso das APIs para realização de uma importação. Há também um arquivo anexo para .Net (ccnexample.zip) como referência.

Os valores informados nos headers X-Subscription e X-Api-Key dependem dos cartórios que enviarão as requisições.

O primeiro passo após gerar o arquivo XML é fazer o seu upload (segue exemplo usando o arquivo CCN27052020-10.xml):

Importante: deve-se fazer um request multipart e não application/xml

Exemplo com url de homologação

Request:

curl --location --request POST 'https://pessoas-hml.e-notariado.org.br/api/uploads' \

--header 'X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \

--form 'file=@/C:/CCN27052020-10.xml' \

--form 'name=CCN27052020-10.xml' \

--form 'contentType=text/xml'

Response:

{

    "location": "/api/uploads/6ba5fc64-a747-41d0-86f5-ed9d6f046fad?access_ticket=CfDJ8HUKpopGElVMr9z4pVGvFUJiw40wOJG-ml-c31lE4WptJ8sey0hzCxGPKSexhEhyQY7PLnLxhvf-owz66sUPbMU7N5IA5SQd0yIh3Rrw9RFcYucRwigEsJiJ2EySqw_5T749YsCXQUsfKbsLMWNuBrNZMWtoJ1E2oTVz22kvheeMsgXJ-ZJS2KiifAtBk2tBSw&culture=en&contentType=text%2Fxml",

    "id": "6ba5fc64-a747-41d0-86f5-ed9d6f046fad",

    "name": "CCN27052020-10.xml",

    "contentType": "text/xml"

}

Em seguida é criada a importação, usando a resposta obtida anteriormente no campo "upload" da próxima requisição.

Também é necessário especificar o id do cartório no header X-Subscription.

Request:

curl --location --request POST 'https://pessoas-hml.e-notariado.org.br/api/imports' \

--header 'X-Subscription: adb07367-c4f2-4f79-b388-156a071b8af2' \

--header 'X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \

--header 'Content-Type: application/json' \

--data-raw '{

"type": "CcnPessoaFisica",

"upload": {

   "location": "/api/uploads/6ba5fc64-a747-41d0-86f5-ed9d6f046fad?access_ticket=CfDJ8HUKpopGElVMr9z4pVGvFUJiw40wOJG-ml-c31lE4WptJ8sey0hzCxGPKSexhEhyQY7PLnLxhvf-owz66sUPbMU7N5IA5SQd0yIh3Rrw9RFcYucRwigEsJiJ2EySqw_5T749YsCXQUsfKbsLMWNuBrNZMWtoJ1E2oTVz22kvheeMsgXJ-ZJS2KiifAtBk2tBSw&culture=en&contentType=text%2Fxml",

   "id": "6ba5fc64-a747-41d0-86f5-ed9d6f046fad",

   "name": "CCN27052020-10.xml",

   "contentType": "text/xml"

}

}'

Response:

{

    "id": "e99065b2-77e7-4a7b-9f51-776f0e78b063",

    "agentId": "b1f1a709-6299-446b-b72f-8d347467a0ad",

    "subscriptionId": "adb07367-c4f2-4f79-b388-156a071b8af2",

    "dateCreated": "2020-06-04T00:33:44.285868+00:00",

    "type": "CcnPessoaFisica",

    "status": "Pending",

    "processedRecords": 0,

    "failedRecords": 0,

    "totalRecords": 0,

    "fileName": "CCN27052020-10.xml",

    "uploadId": "6ba5fc64-a747-41d0-86f5-ed9d6f046fad",

    "errorCode": null,

    "duplicateRecords": null

}

Pode-se usar o "id" da resposta recebida na criação da importação para acompanhar o progresso da importação fazendo uma requisição GET para a URL https://pessoas-hml.e-notariado.org.br/api/imports/{id}:

Request:

curl --location --request GET 'https://pessoas-hml.e-notariado.org.br/api/imports/e99065b2-77e7-4a7b-9f51-776f0e78b063' \
 --header 'X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Response:

{

    "id": "e99065b2-77e7-4a7b-9f51-776f0e78b063",

    "agentId": "b1f1a709-6299-446b-b72f-8d347467a0ad",

    "subscriptionId": "adb07367-c4f2-4f79-b388-156a071b8af2",

    "dateCreated": "2020-06-04T00:33:44.285868+00:00",

    "type": "CcnPessoaFisica",

    "status": "Successful",

    "processedRecords": 8,

    "failedRecords": 0,

    "totalRecords": 8,

    "fileName": "CCN27052020-10.xml",

    "uploadId": "6ba5fc64-a747-41d0-86f5-ed9d6f046fad",

    "errorCode": null,

    "duplicateRecords": null

}

Considerações para testes no Postman
Se desejar efetuar um teste inicial no Postman, faça um request multipart usando a opção "form-data", trocando "Text" no tipo da chave para "File". Se fizer com request application/xml não funcionará.

Considerações para as cargas

Confira o resultado das cargas conforme procedimentos descritos no link aqui.

Obter os erros de importação

Para obter os erros de importação, utilize a  api/imports/{importId}/errors que retorna o modelo completo dos erros de uma importação com id específico

Explicação dos campos

Obs.: para facilitar o processo de carga de todos os cartórios, o sistema atualmente apenas obriga o preenchimento do CPF e Nome, devendo o cartório enviar os outros dados existentes em sua base cadastral. 

Anexo de documentos pessoais

Todas as imagens de documentos pessoais existentes na base do cartório devem ser transmitidas, por exemplo, enviar as imagens do RG e Passaporte da pessoa.

Regras:

Tag <Documentos>: informar um número de documento de identificação da pessoa e uma imagem apenas.

Tag <Anexos>: informar as outras imagens dos documentos pessoais da pessoa, caso existam

Exemplo: 

Situação: o cadastro do cartório contém duas imagens do RG, correspondendo a frente e verso, além de uma imagem do passaporte e uma imagem da carteira profissional.

Como formatar o XML: 

Na tag documento, informar os dados do RG, além da imagem da frente desse documento. Já na tag anexo, enviar o base64 das imagens do verso do RG, do passaporte e da carteira profissional.

<documento>

        <tipo>RG</tipo>

        <docIdentidade>27610007</docIdentidade>

        <orgaoEmissor>SSP</orgaoEmissor>

        <ufOrgaoEmissor>MG</ufOrgaoEmissor>

        <dataEmissao>2009-05-18</dataEmissao>

        <imagemDocumento>Base64dafrentedoRG</imagemDocumento>

</documento>

...

<anexo>Base64doversodoRG</anexo>

<anexo>Base64dopassaporte</anexo>

<anexo>Base64dacarteiraprofissional</anexo>

Vide exemplo anexo - CCN16052023-1.xml

Tabelas Domínio

sexo

EstadoCivil

dedo (Biometria)

TipoDocumento

TipoNacionalidade

RegimeBem

ALTERNATIVA: Importação do XML diretamente no sistema

1. Acessar a plataforma e-notariado (www.e-notariado.org.br) e efetuar login no sistema

2. Acessar o módulo CCN, clicar sobre o nome e selecionar a opção Importações.

3. Efetuar o upload do XML para efetuar a importação do cadastro de pessoas