Status
Os status são a situação de cada documento de assinatura. A lista de status é fixa do sistema. Os filtros e os totais da tela Documentos e do Dashboard usam os mesmos ids. Na tela, cada status tem um nome em português.
| Id | Nome interno (status) | Nome na tela |
|---|---|---|
| 1 | Waiting for sending | Aguardando envio |
| 2 | Waiting for signing | Aguardando assinatura |
| 3 | Opened | Aberto |
| 4 | Sign completed | Assinatura concluída |
| 5 | Declined | Recusado |
| 6 | Cancelled | Cancelado |
| 7 | Expired | Expirado |
| 8 | Partial Signed | Assinatura parcial |
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /digital-signature/documents/statuses | Lista os status |
| GET | /digital-signature/documents/statuses/{id} | Consulta um status |
GET /digital-signature/documents/statuses
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| search | Não | Trecho do nome interno do status |
| per_page | Não | Quantidade de registros por página. Sem ele, a resposta é a lista simples |
| page | Não | Número da página, quando per_page é informado |
Resposta (200): lista de status, com id e status (nome interno).
GET /digital-signature/documents/statuses/{id}
Resposta (200): o status com o id informado.