POST Send request with document

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.

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

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.

Quando um documento é assinado e uma solicitação em cadeia é gerada, um webhook será enviado com a seguinte estrutura:

{
    "data": {
        "document_key": "AQy1ExOCuXfEiR4FNRMp3IL2K4R8IyYF",
        "signing_key": "OxIzKd2wHnOEdh5xVJ1b4H31G3zhMj2d",
        "email": "[email protected]",
        "status": "Created",
        "data": {
            "reciever": "[email protected]",
            "date": "2024-12-10 14:30:45"
        }
    },
    "type": "REQUESTS_UPDATED",
    "company_id": 1
}

Exemplos para o campo fields:


"fields": [  
        [  
            {  
                "page": 1,  
                "type": "image",  
                "width": 200,  
                "height": 75,  
                "xPos": 100,  
                "yPos": 100  
            },  
            {  
                "page": 1,  
                "type": "text",  
                "width": 200,  
                "height": 120,  
                "xPos": 200,  
                "yPos": 120,  
                "text": "Nome completo",
                "default": "Felipe Santos", 
                "validateData": 1,
                "color": "#000000",  
                "fontsize": 14,  
                "bold": "bold",  
                "align": "left",  
                "italic": "italic",  
                "underline": "underline",  
                "strikethrough": "strikethrough"  
            }  
        ],  
        [  
            {  
                "type": "rubric",  
                "width": 300,  
                "height": 75,  
                "xPos": 100,  
                "yPos": 100  
            }  
        ]  
    ]

Exemplo para o campo request_image

"request_image": [
    [1,1]
 ]

O primeiro índice do request_image é utilizado para solicitar uma selfie no momento da assinatura, e o segundo, um documento de identidade.

Language
Credentials
Header
Click Try It! to start a request and see the response here!