Destinatários
Destinatários são as pessoas que devem assinar o documento. Eles são cadastrados na seção Destinatários da tela Detalhe do documento. Cada destinatário recebe o próprio link de assinatura quando o documento é enviado.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /digital-signature/documents/{document_uuid}/recipients | Lista os destinatários do documento |
| POST | /digital-signature/documents/{document_uuid}/recipients | Cadastra um destinatário |
| GET | /digital-signature/documents/{document_uuid}/recipients/{id} | Consulta um destinatário |
| PUT | /digital-signature/documents/{document_uuid}/recipients/{id} | Altera um destinatário |
| DELETE | /digital-signature/documents/{document_uuid}/recipients/{id} | Remove um destinatário |
| GET | /digital-signature/documents/recipients/search | Busca destinatários já usados em outros documentos |
GET /digital-signature/documents/{document_uuid}/recipients
Lista os destinatários do documento, na ordem de cadastro.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| 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 destinatários.
POST /digital-signature/documents/{document_uuid}/recipients
Cadastra um destinatário no documento. É obrigatório informar pelo menos um e-mail ou um celular, que são os canais de envio do link.
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | Texto | Nome do destinatário |
| Não | Texto | E-mail. Obrigatório se não houver celular | |
| cellphone | Não | Texto | Celular, para o envio do link por SMS e WhatsApp. Obrigatório se não houver e-mail |
| cpf | Não | Texto | CPF. Quando informado, é enviado ao provedor para conferência |
| birth_date | Não | Data | Data de nascimento (AAAA-MM-DD) |
Resposta (201): o destinatário cadastrado.
curl -X POST https://api.pedagogo.app/digital-signature/documents/<uuid-do-documento>/recipients \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"name": "Fulano exemplo", "email": "[email protected]"}'
GET, PUT e DELETE /digital-signature/documents/{document_uuid}/recipients/{id}
Consultar, alterar e apagar um destinatário.
- GET: devolve o destinatário (200).
- PUT: altera o destinatário. O corpo é o mesmo do cadastro (
nameobrigatório;emailoucellphone, pelo menos um;cpfebirth_dateopcionais). Resposta 200 com o destinatário alterado. - DELETE: remove o destinatário (200), sem dados úteis no corpo.
Cada destinatário traz, depois do envio, os campos url_signature (link de
assinatura, usado para copiar ou reenviar o link), opened_at (data em que abriu o
link) e signed_at (data em que assinou).
GET /digital-signature/documents/recipients/search
Busca destinatários já cadastrados em documentos da empresa, para reaproveitar os dados sem repetir a mesma pessoa. Cada pessoa aparece uma vez, com o cadastro mais recente.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| search | Não | Texto buscado em nome, e-mail, celular e CPF |
| per_page | Não | Quantidade por página. Padrão: 10 |
Resposta (200): paginação padrão, com data contendo id, name, email,
cellphone, cpf e birth_date.