Pacote de documentos

Para cada estado do pacote de documentos, é gerada uma requisição com o corpo a seguir, variando 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 retentados até 3 vezes antes de a notificação ser descartada. Retorne 200 imediatamente, processe em segundo plano e torne o seu handler idempotente. Veja Tempo de resposta e novas tentativas.

---

Estados notificados

Nome	Descrição
CREATE	Este estado é notificado quando um pacote de documentos é criado.
NOTIFICATION	Este estado é notificado quando um participante do pacote conclui sua assinatura.
SIGNED_PACKAGE	Este estado é notificado quando todas as partes assinaram o pacote de documentos.
DOCUMENT_REJECT	Este estado é notificado quando um dos documentos do pacote foi rejeitado.
REJECTED	Este estado é notificado com os detalhes do participante que rejeitou o pacote.
BLOCKED	Notificado quando um signatário excede as tentativas de validação de identidade (3), ou é interrompido pela proteção de identidade, exigindo validação manual.

---

🧪 Exemplos de notificações

dica

Você pode copiar qualquer um dos exemplos de acordo com a sua linguagem preferida.

Parâmetros da notificação

Nome	Tipo	Descrição
package	String	Identificador do pacote de documentos.
name	String	Nome do pacote de documentos.
status	String	Status atual do pacote (CREATE, NOTIFICATION, SIGNED_PACKAGE, DOCUMENT_REJECT, REJECTED ou BLOCKED).
signer	Object	Informações do signatário, presentes quando o status é NOTIFICATION, REJECTED ou BLOCKED.
message	String	Mensagem associada ao status do signatário. Se o status for REJECTED, contém a mensagem escrita pelo participante ao rejeitar; se BLOCKED, contém o motivo do bloqueio.
documents	Array	Lista de documentos que fazem parte do pacote (ausente nos estados NOTIFICATION e REJECTED).
documents.code	String	Código do documento.
documents.name	String	Nome do documento.
documents.status	String	Status individual do documento (CREATE, FINISH, REJECT ou EXPIRED).
documents.url	String	URL do documento.
signals	Array	Sinais da proteção de identidade ([{ code, severity }]), presentes em NOTIFICATION e BLOCKED quando a validação passou pela proteção. Veja Sinais da proteção de identidade.
tags	Array	Lista de tags ou campos personalizados atribuídos ao pacote, se definidos.

Criação do processo

JSON

{
  "package": "idPackage", //Package identifier
  "name": "API test documents", //Document package name
  "status": "CREATE", //Document package status
  "documents": [
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 1",
      "status": "CREATE",
      "url": "https://test.auco.ai/contrato-de-prueba1.pdf"
    },
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 2",
      "status": "CREATE",
      "url": "https://test.auco.ai/contrato-de-prueba2.pdf"
    }
  ]
}

Assinatura de um participante

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "NOTIFICATION",
  "signals": [{ "code": "ALERT_EMAIL_CHANGED", "severity": "INFO" }]
}

Conclusão do processo

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "status": "SIGNED_PACKAGE",
  "documents": [
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 1",
      "status": "FINISH",
      "url": "https://test.auco.ai/contrato-de-prueba1.pdf"
    },
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 2",
      "status": "FINISH",
      "url": "https://test.auco.ai/contrato-de-prueba2.pdf"
    }
  ]
}

Rejeição de um documento

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "status": "DOCUMENT_REJECT",
  "documents": [
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 1",
      "status": "REJECT",
      "url": "https://test.auco.ai/contrato-de-prueba1.pdf"
    },
    {
      "code": "DOCUMENTCODE",
      "name": "Test document 2",
      "status": "CREATE",
      "url": "https://test.auco.ai/contrato-de-prueba2.pdf"
    }
  ]
}

Rejeição por um participante

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "REJECTED",
  "message": "message"
}

Signatário bloqueado

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "OTP_CODE_INVALID"
}

Bloqueado pela proteção de identidade

JSON

{
  "package": "idPackage",
  "name": "API test documents",
  "signer": {
    "id": "participant_id",
    "name": "participant name",
    "email": "email",
    "phone": "phone"
  },
  "status": "BLOCKED",
  "message": "IDENTITY_GUARD_BLOCKED",
  "signals": [{ "code": "REPORT_PHONE", "severity": "REPORT" }]
}