Homepage

Listar documentos

Sobre este guia​

Através deste guia, demonstraremos como listar os documentos pertencentes a um envelope através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter todos os documentos de um envelope (assim como alguns de seus detalhes), de forma estruturada em uma resposta JSON.

O que você vai precisar​

Antes de iniciar sua integração:

  1. Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.

  2. Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.

Funcionamento básico​

Como explicamos em nosso guia de conceitos básicos, nossa entidade Envelope (envelope) é a representação virtual de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos (document) e seus assinantes (subscriber), sendo que um envelope pode conter mais de documento, que por sua vez pode conter um ou mais assinantes.

Entenda, a seguir, como chamar nossa API REST para obter todos os documentos de um envelope.

1

Obtenha um token OAuth válido

Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.

Ambientes

Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.

Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:

  • Ambiente de homologação: https://signhom.acesso.io;

  • Ambiente de produção: https://sign.acesso.io.

2

Configure os filtros de sua pesquisa

Opcionalmente, você pode configurar alguns critérios para sua busca. Para isto, os campos de filtro devem ser enviados no body de sua requisição.

Obrigatoriedade dos filtros

Nenhum dos filtros é obrigatório. Caso não informados, por padrão, retornaremos 30 envelopes em nossa resposta JSON.

O schema abaixo contêm os parâmetros e domínios permitidos para a configuração dos filtros:

CPF

string or null

Default: null

Número de cadastro de pessoa física do assinante.

Se fornecido valor para EnvelopeUUID o valor de CPF será ignorado

  • sem formatação, apenas os 11 números

EnvelopeUUID

string or null <uuid>

Default: null

Identificador único do envelope

Status

integer <int32>

(EnvelopeStatusEnum)

Enum: 0 1 2 3 4 5 6

Estado do envelope, que pode ser:

  • 0 - Expirado

  • 1 - Pendente

  • 2 - Concluído

  • 3 - Cancelado

  • 4 - Processando

  • 5 - Recusado

  • 6 - Agendado

Page

integer or null <int32>

Default: 1

Número da página da busca Ops, estamos corrigindo! Paginação não suportada da página 334 em diante. Por favor utilizar mais filtros para fazer uma busca mais precisa de acordo com seu objetivo

StartDate

string or null <date>

Data inicial para busca sob a data de criação do envelope

  • Se esta data for definida, também deve ser definida a data em EndDate

  • A data deve ser após 01/01/2018

  • A data deve ser anterior a data definida em EndDate

EndDate

string or null <date>

Data final para busca sob a data de criação do envelope

  • Se esta data for definida, também deve ser definida a data em StartDate

  • A data deve ser após 01/01/2018

Order

string (Orders)

Enum: "ASC" "DESC"

Ordenação dos elementos da lista, que pode ser:

  • ASC - Crescente

  • DESC - Decrescente

EnvelopeTags

Array of strings or null

Lista de tags do envelope Ao passar mais de uma tag, a busca retornará apenas envelope que contenha todas as tags informadas

O exemplo abaixo solicita em ordem ascendente, envelopes cujos assinantes possuam o CPF 100.000.000-19, criados de 01/08/2022 a 31/08/2022, com status pendente.

{
  "CPF": "10000000019",  
  "StartDate": "01/08/2022",
  "EndDate": "31/08/2022",
  "Status": 1,
  "Order": "ASC"
}

3

Faça uma requisição POST para o endpoint /envelopes/

Após gerar um token de acesso válido e, opcionalmente, montar o body com os filtros, faça uma requisição para o endpoint de obtenção de lista de documentos da nossa API REST (POST/service/envelopes). Serão obtidos os dados de todos envelopes atrelados ao usuário do token utilizado.

Permissão para Visualizar Documentos

Para utilizar esta rota é necessário que o usuário tenha permissão de Visualizar Documentos.

Exemplo solicitando em ordem ascendente, envelopes cujos assinantes possuam o CPF 100.000.000-19, criados de 01/08/2022 a 31/08/2022, com status pendente:

curl -X 'POST' \
  'https://sign-core-uat.acesso.io/api/v1/service/envelopes' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{ACCESS_TOKEN}}'
  -d '{
  "CPF": "10000000019",  
  "StartDate": "01/08/2022",
  "EndDate": "31/08/2022",
  "Status": 1,
  "Order": "ASC"
}'

Se tudo der certo em sua requisição, você receberá como resposta um JSON contendo uma lista todos os envelopes associados a sua consulta:

Limite de páginas

Atualmente não é possível listar documentos da página 334 em diante. Caso seja necessário acessar uma dessas páginas, recomendamos utilizar os filtros para uma busca mais precisa.

{
  "Success": true,
  "Message": "",
  "Data": {
    "Page": 1,
    "MaxPage": 5,
    "Count": 50,
    "Envelopes": [
      {
        "CreatedDate": "09/04/2022 20:09",
        "ID_EnvelopeStatus": 2,
        "EnvelopeStatus": "Concluído",
        "UUID": "00000000-0000-0000-0000-000000000000",
        "HasFrame": false,
        "Documents": [
          {
            "Url": "https://sign.unico.io/path",
            "UrlVoucher": "https://sign.unico.io/path",
            "DocumentType": "admissao",
            "CreatedDate": "09/04/2022 20:09",
            "EmitterUserName": "Carlos Eduardo",
            "EmitterUserUUID": "00000000-0000-0000-0000-000000000000",
            "EmitterUserEmail": "test@test.com",
            "CompanySocialName": "unico",
            "UUID": "00000000-0000-0000-0000-000000000000",
            "HasFile": false,
            "Subscribers": [
              {
                "SubscriberName": "Flavia dos Santos",
                "SubscriberCPF": "10000000019",
                "SubscriberEmail": "test@test.com",
                "SubscriberPhone": "551192345678",
                "SubscriberOrder": 1,
                "SubscriberRole": 1,
                "URLFrameFull": "https://unico.io/path",
                "IsUser": false
              }
            ],
            "IsTemplate": false,
            "DocumentSubcategoryUUID": "00000000-0000-0000-0000-000000000000",
            "DocumentSubcategoryName": "Abertura de conta bancária",
            "DocumentCategoryUUID": "00000000-0000-0000-0000-000000000000",
            "DocumentCategoryName": "Admissão"
          }
        ]
      }
    ],
    "Rows": 0
  }
}

Cada elemento do objeto Envelopes representa um envelope com seus respectivos documentos, contidos no objeto Documents.

Próximos passos​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

AnteriorCancelar envelopesPróximoReenviar envelopes

Atualizado