Coopanest API
  1. envelopes
Coopanest API
  • Coopanest GATEWAY
    • assinatura-digital
      • envelopes
        • Pegar envelope por id
          GET
        • Pegar assinaturas do envelope
          GET
        • Pegar dados externos do envelope
          GET
        • Pegar dados externos do envelope Options
          OPTIONS
        • Pegar assinaturas do envelope Options
          OPTIONS
        • Pegar envelope por Id Options
          OPTIONS
        • Criar assinatura digital
          POST
        • Criar assinatura digital Options
          OPTIONS
      • hello
        • Assinatura digital hello
        • Assinatura digital hello Options
      • webhook
        • autentique
          • Autentique webhook GET
          • Autentique webhook POST
          • Autentique webhook OPTIONS
      • health
        • Health
        • Health Options
    • email
      • Enviar email
      • Enviar email Options
    • pdf
      • Gerar pdf via template
      • Gerar pdf via template Options
    • aplicacao
      • coopaapi
        • cooperados
          • demonstrativo
            • Get Demonstrativos
            • Get Demonstrativos Options
          • perfil
            • foto
              • Atualizar perfil foto Options
              • Atualizar Foto Perfil
            • pj
              • Get Dados Perfil PJ
              • Atualizar dados perfil PJ
              • Perfil PJ Options
            • Get Dados Perfil
            • Atualizar Perfil
            • Perfil Options
        • registros
          • Registros
          • Registros Options
      • portal
        • auth
          • login
            • Login
            • Login Options
          • validate
            • Validar Conexão
            • Validar Conexão Options
        • guias
          • {id}
            • Get Guia por Id
            • Get Guia por Id Options
          • Get Guias
          • Get Guias Options
    • storage
      • presigned-url
        • Criar url pré assinada
        • Criar url pré assinada Notas fiscais PJ
    • Esquemas
      • Raiz
        • Empty Schema
  • Coopanest Processador Documentos
    • api
      • pdf
        • generate
          • Gerar Pdf Sincrono
  1. envelopes

Pegar envelope por id

Em teste
GET
/assinatura-digital/envelopes/{envelopeId}

Requisição

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200Sucesso
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.coopanestrio.dev.br/assinatura-digital/envelopes/1' \
--header 'x-api-key: joao'
Response Response Example
{
    "id": 20,
    "name": "Documento Portal",
    "deadlineAt": "2025-07-19T03:00:00.000Z",
    "serviceData": {
        "id": "a705b4c5c8daac2fcb7402ef03f9bdc86766796aa47d2ba5e",
        "name": "Documento Portal",
        "sortable": false,
        "refusable": false,
        "__typename": "Document",
        "created_at": "2025-07-09T17:58:37.000000Z",
        "signatures": [
            {
                "link": null,
                "name": null,
                "user": {
                    "id": "9fdb6a612145017c306336ca215a11ac3c4df710",
                    "name": "Coopanest Rio Dev",
                    "email": "dev1@coopanestrio.org.br",
                    "__typename": "User"
                },
                "email": "dev1@coopanestrio.org.br",
                "action": null,
                "public_id": "582ad9c75cee11f0bf9a42010a2b600c",
                "__typename": "Signature",
                "created_at": "2025-07-09T17:58:39.000000Z"
            },
            {
                "link": null,
                "name": "Joao Paulo 1",
                "user": {
                    "id": "af4839ce6eb1f23ac6c4dfa5a5792d5e258a7a7d",
                    "name": "João Paulo Ferreira Neto",
                    "email": "joaopauloneto3687@gmail.com",
                    "__typename": "User"
                },
                "email": "joaopauloneto3687@gmail.com",
                "action": {
                    "name": "SIGN",
                    "__typename": "Action"
                },
                "public_id": "583331495cee11f0bf9a42010a2b600c",
                "__typename": "Signature",
                "created_at": "2025-07-09T17:58:40.000000Z"
            },
            {
                "link": null,
                "name": "Joao Paulo 2",
                "user": {
                    "id": "e15329d5318ff9ba7cbf2fe6c6d2f7d494f90418",
                    "name": "João Paulo Ferreira Neto",
                    "email": "joaopauloneto3689@gmail.com",
                    "__typename": "User"
                },
                "email": "joaopauloneto3689@gmail.com",
                "action": {
                    "name": "SIGN",
                    "__typename": "Action"
                },
                "public_id": "583bbc465cee11f0bf9a42010a2b600c",
                "__typename": "Signature",
                "created_at": "2025-07-09T17:58:40.000000Z"
            }
        ]
    },
    "externalReference": {
        "tipo": "PF",
        "backend": "aplicacao",
        "conexao": "{94347CC4-366D-53C3-66A3-BE11725637FD}",
        "id_empresa": null,
        "id_cooperado": "1227",
        "tipo_contrato": "CONTRATO_PF"
    },
    "provider": "autentique",
    "providerId": "a705b4c5c8daac2fcb7402ef03f9bdc86766796aa47d2ba5e",
    "createdAt": "2025-07-09T17:57:58.692Z",
    "updatedAt": "2025-07-09T17:57:58.692Z",
    "status": "CREATED",
    "deletedAt": null,
    "documents": [
        {
            "id": 20,
            "name": "documento-2025-07-09.pdf",
            "url": "https://coopanest-uploads.s3.us-east-1.amazonaws.com/documents/8d955780-5e84-4759-9c75-1750358fe2cb.pdf",
            "signed_url": null,
            "signed": false,
            "externalReference": null,
            "envelopeId": 20,
            "serviceData": null,
            "providerId": null,
            "createdAt": "2025-07-09T17:57:58.716Z",
            "updatedAt": "2025-07-09T17:57:58.716Z",
            "deletedAt": null
        }
    ],
    "signatures": [
        {
            "id": 40,
            "providerId": "583331495cee11f0bf9a42010a2b600c",
            "envelopeId": 20,
            "signerId": 40,
            "hasSigned": false,
            "hasViewed": false,
            "viewedAt": null,
            "signedAt": null,
            "createdAt": "2025-07-09T17:57:58.728Z",
            "updatedAt": "2025-07-09T17:57:58.728Z",
            "deletedAt": null
        },
        {
            "id": 41,
            "providerId": "583bbc465cee11f0bf9a42010a2b600c",
            "envelopeId": 20,
            "signerId": 41,
            "hasSigned": false,
            "hasViewed": false,
            "viewedAt": null,
            "signedAt": null,
            "createdAt": "2025-07-09T17:57:58.737Z",
            "updatedAt": "2025-07-09T17:57:58.737Z",
            "deletedAt": null
        }
    ],
    "signers": [
        {
            "id": 40,
            "name": "Joao Paulo 1",
            "email": "joaopauloneto3687@gmail.com",
            "phone": null,
            "serviceData": null,
            "externalReference": null,
            "envelopeId": 20,
            "providerId": null,
            "birthday": null,
            "documentation": null,
            "createdAt": "2025-07-09T17:57:58.723Z",
            "updatedAt": "2025-07-09T17:57:58.723Z",
            "deletedAt": null
        },
        {
            "id": 41,
            "name": "Joao Paulo 2",
            "email": "joaopauloneto3689@gmail.com",
            "phone": null,
            "serviceData": null,
            "externalReference": null,
            "envelopeId": 20,
            "providerId": null,
            "birthday": null,
            "documentation": null,
            "createdAt": "2025-07-09T17:57:58.732Z",
            "updatedAt": "2025-07-09T17:57:58.732Z",
            "deletedAt": null
        }
    ]
}
Modificado em 2025-12-01 23:02:33
Próxima página
Pegar assinaturas do envelope
Built with