Quando um documento é cadastrado no LetsSign, seja via Upload ou via Automação, é possível enviá-lo para assinatura seguindo os passos abaixo:
Para enviar o documento para assinatura será necessário ter em mãos o ID do documento em questão.
Esse ID pode ser obtido das seguintes formas:
Após a geração do documento, na resposta da API de criação do documento à partir de um modelo
Criando um novo documento a partir de um modelo (deprecated)
Pesquisando os documentos cadastrados na conta utilizando o endpoint abaixo: https://api.letssign.com.br/docs/index.html?urls.primaryName=V1 Partners API#/Documents/get_partners_v1_accounts__accountId__documents
Deve-se utilizar o endpoint abaixo:
https://api.letssign.com.br/docs/index.html?urls.primaryName=V1 Partners API#/Documents/post_partners_v1_accounts__accountId__documents__id__request_signatures
A estrutura do payload é a seguinte:
{
"customMessage": "string",
"signers": [
{
"role": "string",
"email": "string",
"authenticationMethod": "Email",
"telephoneCountryCode": "string",
"telephone": "string",
"signatureLinkMethod": "Email",
"signatureLinkTelephoneCountryCode": "string",
"signatureLinkTelephone": "string",
"order": 0
}
],
"observers": [
"string"
],
"signatureAreas": [
{
"email": "string",
"role": "string",
"authenticationMethod": "Email",
"type": "Signature",
"x": 0,
"y": 0,
"page": 0
}
]
}
Onde:
customMessage - opcional - mensagem customizada a ser enviada aos signatários do documento.signers - obrigatório - lista de signatários do documento
role - obrigatório - papel do signatário no processo de assinatura. Ex: Parte, Contratante, etc.
A lista de papéis disponíveis na conta pode ser obtida no endpoint abaixo:
https://api.letssign.com.br/docs/index.html?urls.primaryName=V1 Partners API#/DocumentSignatureRoles/get_partners_v1_accounts__accountId__document_signature_rolesemail - obrigatório - e-mail do signatárioauthenticationMethod - obrigatório - é o método em que o signatário irá se autenticar no momento de realizar a assinatura. Possui as seguintes opções:
telephoneCountryCode - código do país do telefone do signatário por onde ele receberá o token de autenticação
telephone - telefone (com DDD) do signatário por onde ele receberá o token de autenticação
signatureLinkMethod - obrigatório - é o método em que o signatário irá receber o link para realizar a assinatura. Possui as seguintes opções:
signatureLinkTelephoneCountryCode - código do país do telefone do signatário por onde ele receberá o link para realizar a assinatura.
signatureLinkTelephone - telefone (com DDD) do signatário por onde ele receberá o o link para realizar a assinatura.
order - opcional - define a ordem em que os signatários assinarão o documento.
observers - lista de e-mails de pessoas que não fazem parte da lista de signatários mas que receberão o documento assinado ao final do processo de assinatura.signatureAreas - opcional - define a posição dos desenhos das assinaturas e rubricas no documento
role - obrigatório - papel do signatário no processo de assinatura. Ex: Parte, Contratante, etc.
A lista de papéis disponíveis na conta pode ser obtida no endpoint abaixo:
https://api.letssign.com.br/docs/index.html?urls.primaryName=V1 Partners API#/DocumentSignatureRoles/get_partners_v1_accounts__accountId__document_signature_rolesemail - obrigatório - e-mail do signatárioauthenticationMethod - obrigatório - é o método em que o signatário irá se autenticar no momento de realizar a assinatura. Possui as seguintes opções:
type - obrigatório - define se a posição é de uma assinatura (Signature) ou de uma rubrica (Initials)x - posição da assinatura no eixo x (horizontal), em percentual relativo à largura da páginay - posição da assinatura no eixo y (vertical), em percentual relativo à altura da páginapage - número da página onde a assinatura/rubrica deve ser posicionada