e-Not Assina - Obter os documentos reconhecidos

Modificado em Fri, 13 Jan 2023 na (o) 11:33 AM

HISTÓRICO


VersãoData da Publicação
Alterações
v1
13/01/2023

- Primeira versão


ÍNDICE


Introdução


O e-Not Assina é o módulo que permite aos clientes dos serviços notariais submeterem seus instrumentos particulares na plataforma e-Notariado, assinando digitalmente e essas assinaturas serem reconhecidas pelos tabeliães emissores dos certificados digitais notarizados.



Integração por API


Para obter os documentos do e-Not Assina reconhecidos pelo tabelião, deve-se utilizar as APIs abaixo. Para executar essas 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


Obter a lista de documentos reconhecidos do e-Not Assina


GET https://assinatura.e-notariado.org.br/api/reports/organizations/:organizationId/e-not-assina-recognitions?StartDateUtc=<data/hora>&EndDateUtc=<data/hora


sendo:

organizationId : obtido na url do fluxo de assinaturas do determinado cartório


    {

  "total": 0,

  "netTotal": 0,

  "cnbFee": 0,

  "items": [

    {

      "orderNumber": "string",

      "notarizationMne": "string",

      "documentName": "string",

      "authorName": "string",

      "authorEmail": "string",

      "authorCpf": "string",

      "signerName": "string",

      "signerCpf": "string",

      "signatureRecognitionDate": "2023-01-13T14:08:34.961Z",

      "signatureDate": "2023-01-13T14:08:34.961Z",

      "detranUf": "SP",

      "detranStatus": "Uploaded",

      "detranInconsistency": "string",

      "netTotal": 0,

      "total": 0,

      "gatewayFee": 0,

      "cnbFee": 0

    }

  ],

  "totalCount": 0,

  "nextCursor": "string"

}


Exemplo

Request:

GET https://assinatura.e-notariado.org.br/api/reports/organizations/:organizationId/e-not-assina-recognitions?StartDateUtc=2023-01-01T00:00:00.001Z &EndDateUtc=2023-01-02T00:00:00.001Z ' \

 

Response:

"total": 264.31,

    "netTotal": 255.64,

    "cnbFee": 2.80,

    "items": [

        {

            "orderNumber": "RAE000012320",

            "notarizationMne": "9999992023010108130000060106",

            "documentName": "Primeiras Declarações final",

            "authorName": "FULANO DE TAL",

            "authorEmail": "email@email.com",

            "authorCpf": "99999999999",

            "signerName": "FULANO DE TAL 2",

            "signerCpf": "88888888888",

            "signatureRecognitionDate": "2023-01-01T14:04:58.6447356+00:00",

            "signatureDate": "2023-01-01T14:04:38+00:00",

            "detranUf": null,

            "detranStatus": null,

            "detranInconsistency": null,

            "netTotal": 9.13,

            "total": 9.27,

            "gatewayFee": 0.04,

            "cnbFee": 0.10

        },

   ],

    "totalCount": 28,

    "nextCursor": null



Explicação dos campos


CampoTipoFormato
e-not-assina-recognitions

totalValor total dos pedidos do intervalo de datas informadovalue
netTotalValor líquido total que o tabelião receberávalue

cnbFee

Valor total pelo uso da plataforma e-Notariado direcionado ao CNB-CF

value
orderNumberNúmero do pedido do e-Not Assina RAE......string
notarizationMne Matrícula Notarial Eletrônicastring
documentNameNome do documento submetido pelo clientestring
authorNameNome do orquestrador do fluxo de pagamentos que fez o pagamentostring
authorEmaile-mail do orquestrador do fluxostring
authorCpfCPF do orquestradorstring
signerNameNome do signatáriostring
signerCpfCPF do signatáriostring
signatureRecognitionDateData do reconhecimento da assinatura eletrônica pelo tabeliãodatetime
signatureDateData da assinatura digital pelo signatáriodatetime
detranUfUF da ATPV-e Detran (se aplicável)string
detranStatusStatus do processamento do Detranstring
detranInconsistencyMotivo da inconsistência da ATPV-e (desativado)string
netTotalValor líquido do reconhecimento da assinatura eletrônico que o tabelião receberávalue
totalValor bruto do reconhecimento da assinatura eletrônicovalue
gatewayFeeValor da despesa de cobrança do Gateway de Pagamentos (Parcela Express)value
cnbFeeValor pelo uso da plataforma e-Notariado (CNB)value
totalCountTotal de reconhecimentos realizados no intervalo de datas informado na APIint
nextCursordesconsiderarstring



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