Documentação
HomePainelChaves de API
API v2
API v2
  • Introdução
  • Sobre o GraphQL
  • Preços para uso via API
  • Integrando com a API
    • Usando o Altair
    • Sandbox/testes
    • Webhooks
    • Webhooks (deprecado)
    • Mensagens de erro
  • Queries
    • Buscar Usuário Atual
    • Resgatando Documentos
    • Listar Organizações
    • Listando Pastas
    • Listando Modelos de Email
  • Mutations
    • Criando um Documento
      • Assinando um Documento
    • Editando um Documento
    • Removendo um Documento
    • Transferindo um Documento
    • Adicionar Signatário
    • Remover Signatário
    • Criando Pastas
    • Removendo Pastas
    • Movendo Documento para Pasta
    • Reenviar Assinaturas
    • Criar Link de Assinatura
    • Aprovar Verificação Biométrica Pendente
    • Rejeitar Verificação Biométrica Pendente
Fornecido por GitBook
Nesta página

Isto foi útil?

  1. Mutations

Adicionar Signatário

Como adicionar um signatário em um documento já criado.

Para adicionar um signatário à um documento, você pode utilizar a seguinte mutation.

Definição da Mutation:

Aqui está a definição da mutation 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, é necessário atribuir os valores das variáveis declaradas na mutation, em um JSON :

{
  "document_id": "ID_DO_DOCUMENTO",
    "signer": { 
      "email": "troque-esse-email-que-tambem-e-publico@tuamaeaquelaursa.com",
      "action": "SIGN"
    }
}

Lembre-se de substituir os valores, passando o ID do documento e informações de signatário, que são os mesmos mencionados em: Criando um Documento.

Resposta esperada:

A resposta incluirá os detalhes sobre o signatário criado mencionados na definição da mutation. Aqui está um exemplo de resposta que você pode esperar:

{
  "data": {
    "createSigner": {
      "public_id": "434fcd4c6d0c11eea3c542010a2b60c6",
      "name": null,
      "email": "troque-esse-email-que-tambem-e-publico@tuamaeaquelaursa.com",
      "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".

AnteriorTransferindo um DocumentoPróximoRemover Signatário

Atualizado há 6 meses

Isto foi útil?

Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do . Se você não sabe como fazer isso, confira o nosso tutorial em .

Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma:

Altair
Usando o Altair
https://graphql.org/graphql-js/graphql-clients/