Criar documento e Signatários

Nesta página, você irá aprender como criar documentos e Signatários. O processo é bem simples.

Passo a passo

Cria um novo documento com status WAITING_APPROVAL_TO_VALIDATE, e os signatários (opcional).

Esse processo não dispara e-mails de notificações para os signatários. Para ativar, é necessário alterar o status do documento para VALID. Esse processo pode ser realizado na chamada de Alterar documento para Pronto para Assinar.

A API permite dois canais de notificação para os signatários. São eles:

• EMAIL: Notificações serão enviadas para o endereço de e-mail do signatário

• WHATSAPP: Notificações serão enviadas para o número de WhatsApp do signatário

O canal escolhido determina qual campo de contato é obrigatório:

• Para EMAIL: campo email é obrigatório

• Para WHATSAPP: campo phone é obrigatório (formato E.164, exemplo: [phone])

Cria um novo documento e signatários

post

Autorizações

Corpo

Respostas

201

Documento e signatários criados com sucesso

application/json

400

Erro na criação do documento ou signatários

post

HTTPcURLJavaScriptPython

POST /api/documents HTTP/1.1
Host: app.staging.gtsign.giro.tech
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 463

{
  "document": {
    "name": "text",
    "originalDocument": {
      "file": "text"
    },
    "externalIdentification": "text",
    "notificationType": "NOTIFY",
    "deadline": "2025-06-09",
    "notificationPeriodDelivery": 3,
    "signatureMethods": [
      "TOKEN"
    ],
    "setReadyToSign": false,
    "minimumSignatureRequirements": [
      {
        "signatureType": "PART",
        "minimumSignatureNumber": 1
      }
    ]
  },
  "signatures": [
    {
      "email": "text",
      "phone": "[phone]",
      "signatureType": "PART",
      "notificationChannel": "EMAIL",
      "name": "text",
      "person": {
        "cpf": "text"
      }
    }
  ]
}

{
  "document": {
    "uuid": "text"
  },
  "signatures": [
    {
      "uuid": "text",
      "email": "text",
      "person": {
        "cpf": "text"
      }
    }
  ]
}

Central de Atendimento | Giro.TechGiro.Tech