Fluxo de Assinaturas - Obter os documentos assinados

Modificado em Sáb, 16 Nov, 2024 na (o) 3:49 PM

HISTÓRICO

Versão	Data da Publicação	Alterações
v1	14/03/2023	- Primeira versão
v1.1	20/06/2024	Inclusão dos tipos de documento da AEDO - Autorização Eletrônica de Doação de Órgãos
v1.2	16/11/2024	Alterações na documentação para explicar como obter o traslado assinado.

ÍNDICE

Introdução

O Fluxo de Assinaturas é o módulo da plataforma e-Notariado para a orquestração dos atos notariais eletrônicos.

Integração por API

Para obter os documentos assinados correspondentes aos atos eletrônicos orquestrados no Fluxo de Assinaturas, a plataforma e-Notariado disponibiliza algumas APIs para essa finalidade.

Para executar as APIs, é necessário obter a API-KEY correspondente do cartório.

O Tabelião deverá solicitar a API-KEY do ambiente de produção do Fluxo de Assinaturas do e-Notariado, enviando e-mail para servicos@notariado.org.br. A equipe do CNB providenciará a chave e responderá em seguida.

A mesma API-KEY deverá ser utilizada para todas as APIs a serem consumidas do Fluxo de Assinaturas

Postman Authorization
Type: API Key

Key: X-Api-Key

Value: <informar a API-KEY obtida com o CNB>

url: https://assinatura.e-notariado.org.br

Etapa 1 - Obter a lista dos atos do cartório

GET https://assinatura.e-notariado.org.br/api/documents

Parâmetros:

Parâmetro	Descrição	Conteúdo
IsConcluded	Indicativo de fluxo concluído	true, false
IsCanceled	Indicativo de fluxo cancelado	true, false
DocumentType	Tipo do documento	"Deed" - Escritura "PowerOfAttorney" - Procuração "Testament" - Testamentos "NotarialMinutes" - Ata Notarial "TranscriptForPhysicalActs" - Traslado de ato físico "AcknowledgementForPhysicalActs" - Certidão de ato físico "AcknowledgmentForDigitalActs" - Certidão de ato eletrônico "PrivateDocument" - e-Not Assina "TravelPermit" - AEV "SignatureNotarizationTerm" - Termo do Reconhecimento de Firma por Autenticidade (TEC) "EnotAuto" - ATPV-e "OrganDonationPermit" - AEDO emissão "OrganDonationPermitRevocation" - AEDO revogação
Limit	Quantidade de resultados por execução	Ex.: 10
Offset	Offset do resultado	Ex.: 0
Order	Ordem do resultado	"asc" - ascedente "desc" - descendente

Exemplo: https://assinatura.e-notariado.org.br/api/documents?IsConcluded=true&DocumentType=OrganDonationPermit&Offset=0&Order=asc&Limit=100

Etapa 2 - Obter o detalhe de um determinado ato

GET https://assinatura.e-notariado.org.br/api/documents/{id}

sendo,

{id} - obtido no resultado da API da etapa 1

Neste endpoint é possível baixar o traslado assinado digitalmente, concatenando a url com o link apresentado em files / location.