Fluxo de Assinaturas - Criação automática pelo sistema do cartório

Modificado em Sat, 02 Dec 2023 na (o) 11:54 AM

HISTÓRICO


VersãoData da Publicação
Alterações
v1
15/07/2020
. Primeira versão do documento
v2
02/12/2023

- Detalhamento dos campos das APIs


ÍNDICE


Introdução


O módulo de Fluxo de Assinaturas da plataforma e-Notariado é responsável pela realização dos atos notariais eletrônicos, conforme previsto no provimento CNJ nº 100/2020.   


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



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


A integração com os sistemas de gestão de cartórios é realizada através de APIs desenvolvidas pelo CNB-CF.


Em linhas gerais, com essa integração, o sistema de gestão de cartórios poderá criar e disparar automaticamente fluxos de assinaturas na plataforma e-notariado, anexando o PDF/A do ato notarial (versão do livro) e definindo os participantes deste fluxo. Como retorno, poderá acompanhar o status do andamento do fluxo e baixar os arquivos assinados, com a informação da MNE - Matrícula Notarial Eletrônica. 


Deve-se subir dois PDFs para assinaturas, o ato do livro e o traslado, os quais serão realizados em momentos distintos:


1. O ato do livro pode ser híbrido ou totalmente digital, por opção do tabelião. Deve-se indicar no sistema de gestão de cartórios quais partes e colaboradores do cartório irão assinar digitalmente para criar o fluxo. 

 

2. O traslado é obrigatório para concluir o fluxo e só é possível subir após as assinaturas do ato do livro. Deve ser assinado por apenas um notário detentor de um certificado digital ICP-Brasil, indicado por opção do tabelião.


Para realizar testes no ambiente de homologação do e-notariado, a empresa responsável pelo desenvolvimento do sistema do cartório deverá previamente firmar um ACT - Acordo de Cooperação Técnica com o CNB-CF. Para isto, preencha o formulário desse link AQUI.


Após o ACT enviado, a equipe do CNB criará o ambiente de homologação e concederá os acessos às pessoas informadas no formulário do ACT. Vale ressaltar que o acesso ao ambiente de homologação deve ser realizado com certificado digital notarizado ou ICP-Brasil.



Integração por API


A documentação da API do Identificação de pessoas está disponível no endereço https://assinatura-hml.e-notariado.org.br/swagger/index.html 


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

 

Para obter a API KEY do ambiente de produção, o responsável do cartório deverá efetuar os procedimentos desse link AQUI.


Procedimento básico para a criação e acompanhamento do fluxo:
1. Dispare a API POST /api/uploads para efetuar o upload do arquivo PDF/A correspondente ao ato do livro;

2. Obtenha o ID deste documento no retorno da API POST /api/uploads;

2. Dispare a API POST /api/documents para criar o fluxo de assinaturas no e-Notariado;

3. Obtenha o status do fluxo com GET /api/documents

4. Efetue o download do documento assinado com GET /api/documents/{id}/ticket

5. Para fazer a videoconferência, redirecionar o usuário para http://assinatura.e-notariado.org.br/private/documents/{id}

6. Para subir o traslado, redirecionar: https://assinatura.e-notariado.org.br/private/documents/{id}/upload-files 

 

Considerações:

A versão atual das APIs ainda não contempla a possibilidade de baixar o traslado assinado e os arquivos das videoconferências.

No caso dos traslados, a orientação é que os cartórios baixem manualmente pelo e-notariado e anexem no sistema de gestão de cartórios.


EXEMPLOS DE FORMATAÇÃO DAS APIS

{

  "files": [

    {

      "displayName": "Escritura",

      "id": "0429c723-a66d-4e55-a912-ff636d1b2745",

      "name": "Escritura.pdf",

      "contentType": "application/pdf"

    }

  ],

  "flowActions": [

    {

      "type": "Signer",

      "step": 1,

      "user": {

        "name": "John Wick",

        "identifier": "81976153069",

        "email": "john.wick@mailinator.com"

      }

    }

  ],

  "type": "Deed",

  "notarizationDate": "2020-07-22T21:11:13.846Z"

}


Explicação dos campos


CampoTipoObrigatórioFormato
files


. displayNameDenominação do fluxo a ser criado que aparecerá em tela para o usuário
Ex.: Escritura livro 10 folha 15 
Simstring
. idId do arquivo obtido no resultado do endpoint api/uploadsSimstring
. nameNome do arquivo com extensão .pdfSimstring
. contetTypeFormatar como "application/pdf"Simstring
folderIdId da pasta criada no endpoint /api/foldersNão
typeTipo do ato (vide tabela domínio TypeOfAct)Simstring
FlowActions

1 a n
. typeTipo do participante (vide tabela domínio TypeOfParticipant)Simstring
. stepNúmero da etapa da ordem das ações (1, 2, 3 ... n)
Se desejar que todos assinem ao mesmo tempo, informe o mesmo número para todos
Simnumeric
. userdados do participante
.. idId do participante
=> não utilizar
Nãostring
.. nameNome completo do participanteSimstring
.. identifierCPF do participante
=> formatar com somente números, sem pontuações
Simstring
.. emaile-mail do participanteSimstring
. numberRequiredSignatures=> não utilizarNãonumeric
. ruleName=> não utilizarNãostring
. titleIdentificação do participante
ex.: Vendedor, Comprador, Advogado, Procurador, Tabelião, Escrevente
Nãostring
. signRuleUsers=> não utilizarNão
. prePositionedMarksDados de posicionamento da representação da assinatura digital no documentoNão
.. typeformatar com "SignatureVisualRepresentation"Simstring
.. marks
Sim
... idId do documento que a assinatura é posicionadaSimstring
... topLeftXcoordenada do eixo XSimnumeric
... topLeftYcoordenada do eixo YSimnumeric
... widthlargura da representação da assinatura digitalSimnumeric
... heightaltura da representação da assinatura digitalSimnumeric
... pageNumbernúmero da página do documento que a representação da assinatura digital será posicionadaSimnumeric
. observersDados do observador do fluxoNão
.. user
Sim
... id
Sim
... name


... identifier


... email


. disablePendingActionNotifications=> não utilizarNãotrue/false
. newFolderNameNome da pasta para armazenar o fluxo a ser criadoNãostring
. notarizationDate=> não utilizarNãodatetime
. referenceDocumentId=> não utilizarNão
. bookNúmero do livro notarial
=> obrigatório se o ato for traslado ou certidão de ato físico
Dependestring
. pageNúmero da folha do livro notarial
=> obrigatório se o ato for traslado ou certidão de ato físico
Dependestring
. protocolprotocolo do ato notarial gerado pelo sistema do cartórioNãostring
. isHybridActIndicativo se o ato é híbrido, ou seja, se haverá tanto assinaturas físicas quanto digitaisSimtrue/false
. realEstatesDados referentes a imóveis, caso for objeto da escritura ou procuraçãoNão1 a n
.. quantityQuantidade de imóveisSimnumeric
.. cityIdId do município (base e-Notariado)Simstring
. residenceslocais de residência das partes do ato da escritura, procuração ou ata notarialSim1 a n
.. isForeignIndicativo de residência no exteriorSimtrue/false
.. quantityQuantidade de imóveisSim
.. cityIdId do município (base e-Notariado)Sim
. findingsLocal da constatação do fato
=> somente para Atas Notariais
Depende
.. isDigitalIndicativo de mídia social ou origem digitalSimtrue/false
.. cityIdId do município (base e-Notariado)Sim

Tabelas Domínio


TypeOfAct

TypeDescrição do atoConsiderações
DeedEscritura
PowerOfAttorneyProcuração
AcknowledgmentForPhysicalActsCertidão de ato notarial físicoDeve-se informar o livro e folha do ato origem
book - livro
page - folha
TranscriptForPhysicalActsTraslado de ato notarial físicoÉ obrigatório informar o livro e folha do ato origem


TypeOfParticipant

TypeDescrição do atoConsiderações
SignerSignatário: que irá assinar digitalmente o documento
ApproverAprovador: apenas aprova o documento



Posicionamento das marcas de assinaturas


Para posicionar as marcas de assinaturas no documento, proceda conforme exemplo abaixo. Vide também arquivo anexo "signer-cnb.postman_collection.json".



Segue exemplo com dois assinantes e dois documentos:



Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo