GET All requests

Através deste endpoint você pode obter os dados das solicitações já enviadas para assinatura, vamos destacar aqui alguns campos importantes para análise:

  • positions: Este campo retorna todos os dados solicitados no momento do envio e suas posições, caso tenha enviado uma solicitação para mais de uma pessoa, estes são os campos da pessoa atual.
  • chain_positions: Estes são os campos de solicitação dos signatários seguintes, caso envie uma solicitação para mais de uma pessoa (3 por exemplo), o campo positions vai ter as posições da primeira pessoa e este campo das duas seguintes. Após a assinatura da primeira pessoa, uma nova solicitação vai ser gerada, onde o campo positions vai ter os campos da segunda pessoa e o chain_positions os da terceira e assim por diante.
  • chain_emails: Funciona de forma similar ao chain_positions, porém com os e-mails seguintes, estes dois campos estão atrelados, portanto se o campo chain_emails tiver 2 e-mails, o campo chain_positions vai ter 2 objetos de campos para as duas pessoas.
  • update_time: Esta é a data e hora da última atualização da solicitação, ou seja, quando o signatário interagiu com ela pela última vez, seja abrindo a solicitação, assinando ou recusando a mesma.
  • status: Este campo diz o status da solicitação, que pode ser um de 4:
  • Signed: A solicitação foi assinada e concluída.
  • Cancelled: A solicitação foi cancelada pelo remetente (Ou pela API).
  • Declined: A solicitação foi recusada pelo signatário, ou seja, o mesmo abriu ela e recusou por algum motivo (A mensagem pode ser recuperada no endpoint history).
  • Pending: A solicitação está pendente, este é o status que é gerado quando ela é enviada, portanto está aguardando resposta do signatário.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

ID da solicitação de assinatura.

string
enum

Status da solicitação de assinatura.

Allowed:
string

Chave da solicitação de assinatura, para filtrar e obter apenas uma solicitação específica.

string

Document Key do documento, para obter todas as solicitações feitas para um doc específico.

documents
array of strings

Array contendo Documents Keys dos documentos, para obter todas as solicitações relacionadas a eles.

documents
string

Endereço de e-mail do signatário, para obter todos os envios para uma pessoa específica.

string

17-12-2023

string

18-12-2023

string

Nome da pasta em que o documento do request está presente.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json