Fluxo do documento

Para cada estado do documento, é gerada uma requisição com o corpo a seguir, variando apenas a descrição do status.

Você tem 10 segundos para responder

A Auco encerra a conexão se o seu endpoint não responder em até 10 segundos. Tanto um timeout quanto uma resposta 4xx ou 5xx são repetidos até 3 vezes antes de a notificação ser descartada. Retorne 200 imediatamente, processe em segundo plano e torne o seu manipulador idempotente. Veja Tempo de resposta e novas tentativas.

---

Estados notificados

Nome	Descrição
CREATE	Notificado quando um documento é criado ou um PDF é enviado para a plataforma.
FINISH	Notificado quando todas as partes assinaram o documento.
NOTIFICATION	Notificado quando um participante do documento concluiu o processo de assinatura.
REJECT	Notificado quando pelo menos um signatário rejeitou o documento.
REJECTED	Indica os detalhes do cancelamento do processo.
BLOCKED	Notificado quando um signatário excede as tentativas de validação de identidade (3), ou é detido pelo guardião de identidade, exigindo validação manual.
EXPIRED	Notificado quando um documento expira, somente se uma data de expiração tiver sido definida na criação.

---

🧪 Exemplos de notificação

dica

Você pode copiar qualquer um dos exemplos conforme a sua linguagem preferida.

Parâmetros da resposta

Nome	Tipo	Descrição
code	String	Código do documento.
name	String	Nome do documento.
signer	Object	Informações do signatário, presentes apenas quando o status é NOTIFICATION, BLOCKED ou REJECTED.
url	String	URL do documento.
status	String	Status atual do processo de assinatura (CREATE, FINISH, NOTIFICATION, REJECT, REJECTED, BLOCKED ou EXPIRED).
message	String	Conteúdo de texto associado ao status do signatário. Se o status for REJECTED, contém a mensagem individual escrita pelo participante. Para BLOCKED, veja a lista de estados de bloqueio.
similarity	Number	Porcentagem de similaridade da validação facial de identidade, presente quando aplicável.
scores	Object	Detalhe das pontuações da validação de identidade, presente quando aplicável.
signals	Array	Sinais do guardião de identidade ([{ code, severity }]), presentes em NOTIFICATION e BLOCKED quando a validação passou pelo guardião. Veja Sinais do guardião de identidade.
tags	Array	Lista de etiquetas atribuídas ao documento, se definidas na criação.
custom	Array	Lista de campos personalizados registrados no documento, se especificados.

Criação do processo

JSON

{
  "code": "DOCUMENTCODE", //Código del documento
  "name": "Contrato de prueba del API", //Nombre del documento
  "status": "CREATE", //Estado del documento
  "url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf" // url del documento
}

Conclusão do processo

JSON

{
  "code": "DOCUMENTCODE",
  "name": "Contrato de prueba del API",
  "status": "FINISH",
  "url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf" // url del documento
}

Assinatura de um participante

JSON

{
  "code": "DOCUMENTCODE",
  "name": "Contrato de prueba del API",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "NOTIFICATION",
  "signals": [{ "code": "ALERT_EMAIL_CHANGED", "severity": "INFO" }]
}

Signatário bloqueado

JSON

{
  "name": "document name",
  "signer": {
    "id": "participan_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "OTP_CODE_INVALID",
  "tags": ["document tag"],
  "custom": ["{'info':'required', 'definition': 'urgent'}"]
}

Bloqueado pelo guardião de identidade

JSON

{
  "code": "DOCUMENTCODE",
  "name": "document name",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "IDENTITY_GUARD_BLOCKED",
  "signals": [
    { "code": "ALERT_FACE", "severity": "ALERT" },
    { "code": "ALERT_EMAIL_CHANGED", "severity": "INFO" }
  ]
}

Detalhes da rejeição

JSON

{
  "name": "document name",
  "signer": {
    "id": "participan_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "REJECTED",
  "message": "message",
  "tags": ["document tags"]
}

Expiração do processo

JSON

{
  "code": "DOCUMENTCODE",
  "name": "Contrato de prueba del API",
  "status": "EXPIRED",
  "url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf",
  "tags": ["document tag"],
  "custom": ["{'info':'required', 'definition': 'urgent'}"]
}