Atendimento de solicitações de clientes por API

Modificado em Dom, 16 Ago na (o) 6:20 PM

ÍNDICE

Introdução
Autenticação
Fluxo de atendimento

Introdução

Este manual descreve como o sistema do cartório pode realizar o atendimento de solicitações do e-Notariado por meio de APIs:

listar solicitações do cartório
consultar detalhes
Informar o orçamento
aceitar a solicitação
rejeitar a solicitação

Autenticação

Todas as chamadas exigem uma API Key da aplicação, enviada no header X-API-Key:

1	x-Api-Key: your-app\|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Fluxo de atendimento

Listar as solicitações do cartório:
de forma paginada ( GET /api/document-requests/organizations/{id} ), podendo ser filtradas por Status , tipo de solicitação ( DocumentRequestType ) e nome ou CPF do solicitante ( SearchTerm ).
Obter os detalhes da solicitação:
( GET /{id} )
Ajustar o preço cobrado caso o preço definido para as solicitações seja variável:
( PUT /{id}/price )
Decidir o desfecho:
- Aceitar ( PUT /{id}/accept ) — gera o documento e coloca a solicitação em andamento; ou
- Rejeitar ( PUT /{id}/reject ).

Enums usados nos exemplos

Enum	Valores
DocumentRequestStatus	WaitingNotary: aguardando atendimento pelo cartório InProgress: em andamento Done: concluído Rejected: rejeitado Released: liberado Canceled: cancelado WaitingCustomer: aguardando retorno do cliente WaitingPayment: aguardando pagamento pelo cliente InBudgeting: aguardando cartório informar o valor para pagamento
DocumentRequestTypes	TravelPermit: AEV SignatureNotarization: Certificate: Certificado Digital Notarizado PrivateDocumentNotarization: e-Not Assina Acknowledgement: Certidão OrganDonationPermit: AEDO OrganDonationPermitRevocation: Revogação de AEDO PropertyRegistration: Registro de imóveis MinorHeirInventory: Inventário ao MP ENotProvas: e-Not Provas Liveness:

Listar solicitações do cartório

GET /api/document-requests/organizations/{id}

Parâmetros de rota

Nome	Tipo	Descrição
id	guid	Id do cartório (subscriptionId)

Parâmetros de query ( DocumentRequestPaginatedParams )

Nome	Tipo	Descrição
DocumentRequestType	enum (opcional)	Filtra por tipo (ver tabela de enums acima)
Status	lista de enum (opcional)	Filtra por um mais status
SearchTerm	string (opcional)	Busca livre (nome, CPF do solicitante, etc)
Limit	int (opcional, padrão 10)	Tamanho da página
Offset	int (opcional)	Registros a pular (página x tamanho)
Order	Asc \| Desc	Ordenação

Exemplo de resposta (200) — PaginatedSearchResponse<DocumentRequestSummary>

{

"items": [

{

"id": "b2c1a0d0-1234-4a5b-9c8d-1122334455aa",

"documentIds": null,

"status": "WaitingNotary",

"type": "Certificate",

"documentStorageId": null,

"documentContentType": null,

"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"organization": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name": "1º Tabelionato" },

"requesterSubscriptionId": null,

"requesterSubscription": null,

"requesterName": "João da Silva",

"requesterIdentifier": "12345678900",

"updateDate": "2026-07-08T20:56:26.0007919+00:00",

"creationDate": "2026-07-08T20:54:28.8331864+00:00",

"referenceNumber": null,

"protocol": null,

"note": null,

"isComplementaryRequest": false,

"originSystem": null

}

"totalCount": 1,

"nextCursor": null

}

Explicação dos campos

Campo	Descrição
id	Id da solicitação
documentIds	Id do fluxo de assinaturas criado
status	Status da solicitação (vide tabela enum)
type	Tipo da solicitação (vide tabela enum)
documentStorageId	Id de armazenamento no e-Notariado
documentContentType	Tipo do arquivo armazenado
organizationId	Id do cartório no Fluxo de Assinaturas
organization
. id	Id do cartório no fluxo de assinaturas do e-Notariado
. name	Denominação do cartório
requesterSubscriptionId	Id do solicitante
requesterSubscription	Nome do solicitante (podendo ser empresa ou pessoa física)
requesterName	Nome do usuário solicitante
requesterIdentifier	CPF do usuário solicitante
updateDate	Data da última atualização
creationDate	Data da criação da solicitação
referenceNumber	Número de referência informado pelo cartório
protocol	Número do protocolo informado pelo cartório
note	anotação
isComplementaryRequest	Indicativo de Requisição complementar (utilizado no registro de imóveis)
originSystem	Indicativo de sistema/módulo origem do e-Notariado
Totalcount	Quantidade de registros
Nextcursor	número do cursor

Obter detalhes da solicitação

GET /api/document-requests/{id}

Parâmetros de rota

Nome	Tipo	Descrição
id	guid	Id do cartório (subscriptionId)

Exemplo de resposta (200) — DocumentRequestModel

{

"id": "b2c1a0d0-1234-4a5b-9c8d-1122334455aa",

"status": "WaitingNotary",

"type": "Certificate",

"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"requesterName": "João da Silva",

"requesterIdentifier": "12345678900",

"requester": { "id": "9c8d1122-3344-5566-7788-99aabbccddee", "name":

"João da Silva", "email": "joao@email.com" },

"cancellationReasonTicket": null,

"permissions": {

"canManageDocumentRequest": true,

"canCancelDocumentRequest": true,

"canViewDocumentRequestMessages": true,

"canCreateDocumentRequestMessage": true,

"canHandleDocumentRequestInternalMessages": true,

"canHandleDocumentRequestMessageActions": true,

"canPayDocumentRequest": false,

"canPayDocumentRequestCard": false,

"canViewDocumentRequestSales": false,

"canViewDocumentRequestSaleDetails": false,

"canUpdateMinorHeirInventory": false,

"propertyRegistrationCancellation": false

"price": 150.00,

"customerPaysBillingFees": true,

"sale": null,

"orderNumber": "DCR000000067",

"isExemptFromPayment": false,

"creationDate": "2026-07-08T20:54:28.8331864+00:00",

"updateDate": "2026-07-08T20:56:26.0007919+00:00"

}

Explicação dos campos

Campo	Descrição
id	Id da solicitação
status	Status da solicitação (vide tabela enum)
type	Tipo da solicitação (vide tabela enum)
organizationId	Id do solicitante
requesterName	Nome do solicitante
requesterIdentifier	CPF do solicitante
requester	Dados do solicitante
. Id	Id do solicitante
. name	Nome do solicitante
cancellationReasonTicket	Motivo do cancelamento
permissions	desconsiderar
price	Valor da solicitação
customerPaysBillingFees	Indicativo que o cliente paga pela tarifa de cobrança
sale	Id da venda
orderNumber	Número do pedido (referência na Parcela Express também)
isExemptFromPayment	Indicativo de solicitação gratuita
creationDate	Data da criação da solicitação
updateDate	Data da última atualização da solicitação

Atualizar o preço da solicitação

PUT /api/document-requests/{id}/price

Corpo da requisição ( PriceVariableModel )

Nome	Tipo	Descrição
price	decimal	Novo valor da solicitação

Resposta: 200 sem corpo

Aceitar a solicitação

PUT /api/document-requests/{id}/accept

Ao aceitar, o sistema cria o documento associado a partir dos dados notariais informados
( NotaryDocumentRequestData ). O conteúdo exato varia conforme o type da
solicitação (ex.: TravelPermitData só é relevante para TravelPermit ).

Corpo da requisição ( NotaryDocumentRequestData )

Nome	Tipo	Descrição
notarySigner	objeto	Signatário do documento (tipo, ordem/step, usuário)
travelPermitData	objeto (opcional)	Dados específicos quando o tipo é Autorização de Viagem (AEV).
organDonationPermitData	objeto (opcional)	Dados específicos da AEDO
acknowledgementData	objeto (opcional)	Dados específicos de certidão
notarizationDate	datetime (opcional)	data do ato notarial
folderid	guid (opcional)	Pasta de destino do documento. Se omitido, pode ser criada uma nova em newFolderName.
newFolderName	string, máx. 200 (opcional)	Nome da nova pasta a ser criada
protocol	string, máx. 50 (opcional)	Número do protocolo do atendimento pelo cartório

Exemplo de resposta (200) - DocumentRequestModel com status: "InProgress" e documentIds preenchido.

Rejeitar a solicitação

PUT /api/document-requests/{id}/reject

Corpo da requisição (DocumentRequestRejectData , opcional — pode ser omitido/enviado vazio)

Nome	Tipo	Descrição
cancellationReasonId	guid (opcional)	Id de um motivo de cancelamento pré-cadastro
reason	string, máx 200 (opcional)	Motivo da rejeição (campo livre)

Exemplo de resposta (200) — DocumentRequestModel com status: "Rejected"

Nome	Host	Duração	Descrição
_fw_crm_v	colegionotarialdobrasil.freshdesk.com	1 ano	Cookie Freshchat/Freshworks (usado para rastrear a identidade do visitante/usuário e as sessões de bate-papo realizadas pelo usuário).
_x_w	colegionotarialdobrasil.freshdesk.com	Sessão	Contém o ID de fragmento no qual a conta é executada.
_x_m	colegionotarialdobrasil.freshdesk.com	Sessão	Contém o estado do fragmento.
_helpkit_session	colegionotarialdobrasil.freshdesk.com	Sessão	Sua chave secreta para verificar a integridade dos dados da sessão do cookie. Se você alterar esta chave, todas as sessões antigas se tornarão inválidas!
helpdesk_node_session	colegionotarialdobrasil.freshdesk.com	Sessão	Um hash criptografado que armazena a chave secreta e o id da tentativa de login.
user_credentials	colegionotarialdobrasil.freshdesk.com	2 meses	Usado para autenticação do usuário.
wf_order	colegionotarialdobrasil.freshdesk.com	Sessão	Usado para verificar a ordem em que os tickets são filtrados para filtros de tickets personalizados, por exemplo: vencimento em, agente respondeu em, solicitante respondeu em, etc.
wf_order_type	colegionotarialdobrasil.freshdesk.com	Sessão	Usado para verificar se a ordem é crescente ou decrescente para filtros de tickets personalizados.
wf_filter	colegionotarialdobrasil.freshdesk.com	Sessão	Indica qual filtro é aplicado para a lista de tickets.