--- title: "(Antigo) POST Send request with document" method: POST path: "/api/requests/documents22" --- # (Antigo) POST Send request with document `POST /api/requests/documents22` ## Request - Base URL: `https://app.plugsign.com.br` - URL: `https://app.plugsign.com.br/api/requests/documents22` - Auth: API key in header `Authorization` **Solicitações de Assinatura de Documentos** -------------------------------------------- Este endpoint permite enviar solicitações de assinatura em documentos para múltiplos destinatários (e-mails ou telefones). Todos os signatários assinarão o mesmo documento. Abaixo, explicamos o processo e fornecemos detalhes sobre como configurar campos e dados necessários. **Como enviar solicitações e definir campos** --------------------------------------------- Confira o vídeo explicativo sobre os posicionamentos dos campos e dados necessários para solicitar assinaturas: [**Como enviar solicitações e definir campos**](https://youtu.be/GdUDlvXP4Uw?t=392). **Enviar solicitações sem local definido** ------------------------------------------ ### Primeira Forma Este recurso permite solicitar assinaturas sem definir explicitamente os campos de posição (eixos X e Y). É recomendável solicitar apenas a assinatura do destinatário sem incluir outros dados, pois o recurso está em fase beta. * **Observação**: Embora seja possível solicitar dados adicionais, é preferível limitar-se apenas à assinatura por se tratar de uma funcionalidade em beta. ### Segunda forma Outra forma de configurar uma solicitação sem local definido é atribuir os valores `-999` aos campos `xPos` e `yPos`. Veja o exemplo abaixo: `{ "page": 1, "type": "image", "width": 200, "height": 75, "xPos": -999, "yPos": -999 }` ### **Resultado Final** Quando você solicita uma assinatura sem especificar o local, a assinatura será inserida em uma página extra gerada após o documento. Nessa página, serão exibidos todos os dados do usuário e a assinatura gerada. ![Logo do R](https://content.pstmn.io/2a875214-0a66-445b-a54f-545445de280d/MlNlbSBUw610dWxvLTEucG5n) **Importante**: Quando se solicita assinaturas de convidados, o sistema não armazena os dados ou a assinatura do signatário. Portanto, será necessária uma página extra para cada signatário. Se houver 4 signatários, o documento terá 4 páginas extras, cada uma com a assinatura de um signatário. **Enviar documento com rubrica** -------------------------------- Para adicionar uma rubrica, defina o campo `type` como **rubric** dentro de `fields`. Essa configuração irá adicionar uma posição de assinatura em todas as páginas, conforme as posições definidas. Lembre-se de que cada signatário pode usar a rubrica apenas uma vez. O tipo `rubric` funciona de maneira semelhante ao **image**, com a diferença de que não é necessário fornecer o campo "page". **Enviar documento com texto** ------------------------------ Ao enviar um documento com o tipo **text** dentro de `fields`, é possível utilizar os campos **validateData** e **default**: * **default**: Define um valor padrão que será automaticamente preenchido no campo, desde que o **validateData** seja diferente de 1. * **validateData**: Não preenche automaticamente o campo com o valor do **default**, mas valida se o usuário inseriu o valor correspondente. Ambos os campos são opcionais. Se não forem definidos, o comportamento do sistema permanecerá o mesmo. ## Request body - object - `chain` boolean: Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempo. - `document_key` string, required: A document_key do documento que será enviado, necessário ser um documento, não um template. - `email` string[], required: E-mails e/ou Celulares com WhatsApp para envio, mínimo 1. - `sender` integer: O ID do colaborador que está enviando este documento, caso não seja passado, o documento será enviado pela conta do admin da empresa. - `subject` string - `message` string: Mensagem enviada para o destinatário. - `template_email` boolean - `expire_date` string: Deve ser uma data válida no formato Y-m-d H:i:s e posterior ao momento atual. - `width_page` number, double, required: Largura da página em pixels, este número será utilizado na hora de calcular as posições e campos de solicitação e/ou assinatura. - `due_months` integer: A validade do documento em meses, por exemplo, um contrato com 12 meses de validade. Nós iremos monitorar a data e avisaremos antes do vencimento, para que possam refazer a solicitação e reenviar para assinatura. - `image_selfie` boolean - `image_doc` boolean - `fields` string, json, required: Este campo deve ser um objeto de objetos, para cada e-mail passado no array emails, aqui deve ser passado um objeto com os campos de preenchimento e assinatura do usuário, na mesma ordem dos e-mails. - `observer` string[]: Os observadores irão receber comunicados referentes à situação da solicitação. Para isso, inclua uma lista de emails. - `signature_type` 'all' | 'draw' | 'text' | 'upload': Tipo da assinatura (all, draw, text, upload) - `send_finished` boolean[]: Opção para indicar se o usuário deve receber o documento após todas as assinaturas serem concluídas. O array deve seguir a mesma ordem e quantidade dos e-mails. Por padrão, o valor é true. Esse campo é válido apenas quando o valor de 'chain' for 0 (false). - `silent_mode` boolean: Quando ativado (True), o request não gera um e-mail para o cliente. Apenas o URL de assinatura e o e-mail serão retornados. - `reminders` string[]: E-mails e/ou Celulares para enviar lembrete. O array deve seguir a mesma ordem dos e-mails ou números de celular. O tamanho do array deve ser igual ou menor ao do array de e-mails/celulares. Este campo só funciona quando o valor de chain for 0 (false). - `doubleauth` boolean: Este campo especifica se será realizada uma autenticação adicional para confirmar a assinatura. Quando ativado, o sistema enviará um token de validação para o e-mail e/ou WhatsApp do usuário. O usuário deverá inserir o token recebido para concluir a assinatura. Este campo é válido apenas quando o valor de 'chain' for 0 (false) e se aplica a todos os assinantes da requisição. - `request_image` string, json: Com este campo, você pode solicitar uma selfie, a parte da frente do documento de identidade ou de trás no momento da assinatura. ## Response `200` 200 - object - `data` object - `id` integer - `signing_key` string - `document` string - `email` string - `message` string - `sender` object - `id` integer - `name` string - `last_name` string - `email` string - `permissions` string[] - `positions` string - `chain_emails` string - `chain_positions` string - `expire_date` string - `send_time` string - `update_time` string - `creted_at` string - `status` string - `message` string ## Other responses - `400`: 400 ## Changes - **2026-11-03** `3db1513040ea`: 1 info - endpoint added [Operation history](https://skmtc.dev/plugsign/apis/endpoints-manuais/changes/api/requests/documents22/post.md) --- [API](https://skmtc.dev/plugsign/apis/endpoints-manuais.md) - [All operations](https://skmtc.dev/plugsign/apis/endpoints-manuais/llms.txt) - [OpenAPI document](https://skmtc.dev/plugsign/apis/endpoints-manuais/revisions/3db1513040ea?raw)