API v2
Search
K
Links
Comment on page

Adicionar Signatário

Como adicionar um signatário em um documento já criado.
Esta guia detalha como adicionar dinamicamente um signatário a um documento já existente utilizando nossa API. Esse processo é útil se você precisar incluir partes adicionais após a criação inicial do documento.
Definição da Mutation:
Aqui está a definição da mutation que você usará para adicionar um signatário:
mutation(
$document_id: UUID!,
$signer: SignerInput!,
){
createSigner(
document_id: $document_id
signer: $signer
){
public_id
name
email
delivery_method
action{ name }
link{
id
short_link
}
created_at
}
}
Parâmetros:
  • document_id: O identificador único do documento ao qual você deseja adicionar um signatário.
  • signer: Contém os detalhes do signatário que está sendo adicionado. Este objeto requer atenção especial para os campos obrigatórios e opcionais, conforme definido em nossa especificação de SignerInput.
Após, ainda precisamos atribuir os valores das variáveis declaradas na mutation, em um JSON :
{
"document_id":"ID_DO_DOCUMENTO",
"signer":{
"email": "t[email protected]",
"action": "SIGN"
}
}
Lembre-se de substituir os valores, passando o ID do documento e os campos do signatário . Os campos de signatário são os mesmos mencionados em: Criando um documento.

Resposta esperada:

A resposta incluirá vários detalhes sobre o signatário criado. Aqui está um exemplo de resposta que você pode esperar:
{
"data": {
"createSigner": {
"public_id": "434fcd4c6d0c11eea3c542010a2b60c6",
"name": null,
"email": "t[email protected]",
"delivery_method": "DELIVERY_METHOD_EMAIL",
"action": {
"name": "SIGN"
},
"link": null,
"created_at": "2023-10-17T16:43:13.000000Z"
}
}
}
O campo link informará o link de assinatura para o signatário caso o mesmo tenha sido adicionado usando o parâmetro "delivery_method": "DELIVERY_METHOD_LINK".
Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do Altair. Se você não sabe como fazer isso, confira o nosso tutorial em Usando o Altair.
Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma: https://graphql.org/graphql-js/graphql-clients/