Criar Envelope

Cria um novo envelope com documentos e signatários

post

Autorizações

Corpo

deadlinestring · dateOpcional

Data limite para assinatura (obrigatório se setReadyToSign = true)

notificationPeriodDeliveryinteger · enumOpcional

Intervalo, em dias, para lembretes de assinatura (obrigatório se setReadyToSign = true)

Valores possíveis:

setReadyToSignbooleanOpcional

Define se o envelope deve ser disponibilizado para assinatura

Default: false

Respostas

201

Envelope com documentos e signatários criados com sucesso

application/json

400

Erro na criação do envelope

post

HTTPcURLJavaScriptPython

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

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

{
  "uuid": "text",
  "documents": [
    {
      "uuid": "text",
      "name": "text",
      "externalIdentification": "text",
      "hashMD5": "text",
      "hashSha256": "text",
      "originalDocument": {
        "fileName": "text",
        "presignedUrl": "text"
      },
      "signedDocument": {
        "fileName": "text",
        "presignedUrl": "text"
      },
      "status": "WAITING_APPROVAL_TO_VALIDATE"
    }
  ],
  "signatures": [
    {
      "uuid": "text",
      "email": "text",
      "person": {
        "cpf": "text"
      }
    }
  ],
  "signatureMethods": [
    "TOKEN"
  ]
}

Central de Atendimento | Giro.TechGiro.Tech