V1

API de integração: Método GET api/v1/processo/{idProcesso}/status-do-processo

Descrição: Buscar status do processo de assinaturas V1.

Objetivo do Método: Este serviço permite aos Clientes, via API, buscar o status de um processo, não excluído logicamente.

Alteração:

• Retornar também o parâmetro `idStatus.`

V2

API de integração: Método GET api/v2/processo/{idProcesso}?arquivoTipo =1&retornarRegistroAssinatura=true

Descrição: Buscar informações completas do processo de assinaturas V2 (metadados, signatários e documentos).

Objetivo do Método: Este serviço permite aos Clientes, via API, buscar um processo (não excluído) com todos os seus dados, incluindo signatários e documentos associados.

Alterações:

• Adição do parâmetro ‘arquivoTipo’ (1=Base64, 2=link de download).
• Adição do parâmetro ‘retornarRegistroAssinatura’ (inclui ou não o registro de assinatura).
• Expansão do retorno com novos campos de processo, lembretes, dados completos de signatários e documentos.

V3

API de integração: Método POST /api/v3/processo/enviar-documento-para-assinar

Descrição: Enviar processo e documentos para assinatura V3.

Objetivo do Método: Este serviço permite aos Clientes, via API, enviar um ou mais documentos para assinatura, especificando responsáveis e destinatários.

Alteração única em relação à V2:

• Inclusão da opção `linkDocumento` — se informada, o documento será referenciado via link do repositório do cliente e não será enviado em Base64; caso não seja enviada essa tag, mantém-se o envio em Base64 como na V2.
  

O foco desta versão está no retorno de dados dos endpoints abaixo:

API de integração: Método GET api/v1/processo{idProcesso}/status-do-processo

Descrição: Buscar status do processo de assinaturas V1.

Objetivo do Método: Este serviço permite aos Clientes, via API, buscar o status de um processo, não excluído logicamente

Alteração: retornar também o parâmetro idStatus

API de integração: Método GET api /v1 /processo /{idProcesso}/dados-signatarios

Descrição: Buscar dados dos signatários V1.

Objetivo do Método: Este serviço permite aos Clientes, via API, buscar os dados dos signatários do processo, não excluído logicamente, com ação de Assinar Online (tipoAcao = 1)

Não deve retornar dados dos signatários com ação de Receber Cópia (tipoAcao = 2)

Alteração: Retornar também os parâmetros

“idStatus”

“dataConclusao”

“dataCancelamento”

“usuarioCancelamento”

“idTipoAcao”

“falhaEnvioCodigoSeguranca”

“dataAssinatura”

“assinaturaRecusada”

“motivoRecusa”

“anexos” [“id”, “anexoDocumentoNome”]

API de integração: Método GET api/v2/processo/{idProcesso}”

Alteração: Retornar também os parâmetros

idStatus

idTipoAcao

idTipoAssinatura

falhaEnvioCodigoSeguranca

LinkDocumentoCompartilhado

API de integração: Método: POST api/v1/conta/buscar-consumo-itens-assinatura

Descrição: Buscar o uso e consumo dos itens da assinatura da conta V1.

Objetivo do Método: Este serviço permite buscar a quantidade do item de envios (Envios, WhatsApp, SMS) que a conta usou em determinado período.

Alteração: Ajustado o retorno deste endpoint para não contabilizar itens de envios processos cancelados no período consultado.

• Ajuste da API enviar processo para assinar
  

• Ajuste da API buscar dados da assinatura da conta:
  • Alterado o serviço de buscar dados da assinatura da conta para retornar o idStatus da conta 1 – Ativo, 2 – Inativo, 3 – Bloqueado, 4 – Pendente.
• Melhorias nos parâmetros de retorno do Webhook