SuperSign API
  1. Envelopes
SuperSign API
  • Criar Envelope
  • Webhooks
  • Reference
    • Envelopes
      • Create envelope
        POST
      • Void envelope
        POST
      • Edit envelope title
        PATCH
      • Edit envelope deadline
        PATCH
      • Move envelope to folder
        PATCH
      • List envelopes
        GET
      • Get envelope details
        GET
    • Signatários
      • Send signature request reminder
        POST
      • Edit signatory
        PATCH
    • Documentos
      • Get document download url
        GET
    • Pastas
      • Create folder
        POST
    • Webhooks
      • Create webhook endpoint
        POST
      • List webhook endpoints
        GET
      • Delete webhook endpoint
        DELETE
      • Edit webhook endpoint
        PATCH
  1. Envelopes

Get envelope details

GET
/v2/envelopes/{envelopeId}

Requisição

Authorization
JWT Bearer
Adicionar o parâmetro
Authorization
a Cabeçalhos
Exemplo:
Authorization: ********************
or
Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200OK
application/json
Success
Body

🟠403Proibido
🟠404Registro Não Encontrado
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/envelopes/' \
--header 'x-account-id;' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Exemplo 1
{
    "id": "string",
    "title": "string",
    "status": "DRAFT",
    "deadline": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "hasSigningOrder": true,
    "documents": [
        {
            "id": "string",
            "name": "string",
            "originalFileKey": "string",
            "signedFileKey": "string"
        }
    ],
    "signatories": [
        {
            "id": "string",
            "name": "string",
            "email": "string",
            "phoneNumber": "string",
            "signatureToken": "string",
            "status": "PENDING",
            "qualification": "string",
            "authenticationMethod": "EMAIL",
            "signingOrder": 0
        }
    ],
    "observers": [
        {
            "email": "user@example.com"
        }
    ],
    "logs": [
        {
            "id": "string",
            "actorName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "eventType": "ENVELOPE_CREATED",
            "details": null
        }
    ]
}
Modificado em 2025-11-21 19:52:25
Página anterior
List envelopes
Próxima página
Send signature request reminder
Built with