Assinando um Documento

Como assinar um documento.

Depois de criar um documento, você pode assiná-lo utilizando a mutation signDocument.

A assinatura será realizada em nome do titular da chave de API utilizada na requisição. Isso significa que essa mutation não deve ser usada para assinar o documento em nome de outras pessoas.

mutation SignDocument(
  $documentId: UUID!
  $organizationId: Int
) {
  signDocument(
    id: $documentId
    organization_id: $organizationId
  )
}

Variáveis:

{
  "documentId": "UUID_DO_DOCUMENTO",
  "organizationId": null
}

Caso a operação seja realizada no contexto de uma organização, envie seu identificador:

{
  "documentId": "UUID_DO_DOCUMENTO",
  "organizationId": 123
}

Parâmetro	Tipo	Obrigatório	Descrição
id	UUID!	Sim	UUID do documento que será assinado.
organization_id	Int	Não	Identificador da organização relacionada à assinatura. O valor padrão é null.

Retorno

A mutation retorna um valor do tipo Boolean:

{
  "data": {
    "signDocument": true
  }
}

O valor true indica que a assinatura foi concluída.

Antes de assinar

A conta vinculada à chave de API precisa estar incluída entre os signatários do documento. Caso contrário, a API retornará o erro signature_not_found.

Também não é possível utilizar essa mutation para permitir que outros signatários assinem diretamente dentro da sua aplicação. Ela assina exclusivamente com a conta do titular da chave de API. Para coletar assinaturas de outras pessoas, utilize o fluxo de solicitação ou link de assinatura.

---

Você pode testar a assinatura no Altair:

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/

Autentique v2.postman_collection.json

19KB

Abrir

Para importar e usar no Postman