Criando um Documento
Como criar um documento/enviar um documento para assinatura.
A criação de documentos difere um pouco das outras mutations por ter o upload de um arquivo. Primeiramente, vamos precisar escrever a mutation:
mutation CreateDocumentMutation(
$document: DocumentInput!, # Definição das variáveis $document,
$signers: [SignerInput!]!, # $signers e $file, com seus respectivos
$file: Upload! # tipos. (Os "!" indicam que são
) { # parâmetros obrigatórios)
createDocument(
document: $document, # Passa para os parâmetros da mutation o
signers: $signers, # valor das variáveis.
file: $file, #
organization_id: 123, # OPCIONAL: Cria em outras organizações do usuário, senão usa a atual
folder_id: "a1b2c3" # OPCIONAL: Cria arquivado em uma pasta
) {
id
name
refusable
sortable
created_at
signatures {
public_id
name
email
created_at
action { name }
link { short_link }
user { id name email }
}
}
}Após, precisamos dos valores das variáveis definidas na mutation em um JSON:
Percebeu que não foi colocado nenhum valor para a variável $file? Pois é, como é realizado o upload desse arquivo, a requisição precisa ser enviada como multipart/form-data, dessa forma o arquivo precisa ser um pouco diferente. Você pode fazer isso direto no Altair:

Criando documento em Sandbox
Nossa API também suporta o envio de documento de teste, que não consomem créditos de documentos, assim facilitando a integração para quem ainda não adquiriu um plano com documentos ilimitados. Para saber como faz acesse nossa página de sandbox.
Mais opções
Validações adicionais
Você pode implementar validações adicionais em seus documentos. Estas configurações devem ser inseridas na lista security_verifications do objeto do signatário, utilizando o campo type para definir a modalidade de desafio desejada. Além dos tipos, campos como verify_phone e cpf auxiliam na entrega dos códigos de segurança e na identificação precisa da parte.
verify_phone
O signatário precisará validar um número de celular através de um código enviado por SMS. Você pode preencher o número ou deixar em branco para que o próprio signatário informe
cpf
Configuração que garante que apenas o signatário com o CPF especificado possa assinar o documento. Se definido, o sistema obriga o preenchimento ou validação desse dado na conta do signatário.
MANUAL
O signatário anexará um documento de identificação com foto, e tirará uma selfie. Você ou algum membro da sua organização poderão aprovar ou rejeitar os documentos e selfie enviados.
UPLOAD
O signatário precisará anexar frente e verso de um documento de identificação com foto, com seu smartphone ou computador.
LIVE
O signatário precisará anexar um documento de identificação com foto, tirar uma selfie com seu smartphone e realizar uma prova de vida. A foto do documento será automaticamente comparada com a selfie para verificar o grau de semelhança
PF_FACIAL
O signatário tira uma selfie que é validada pelo SERPRO, comparando-a com as fotos de registro do governo brasileiro vinculadas ao CPF informado
BIOMETRIC_AND_TEXT_EXTRACTION
O signatário precisará fotografar um documento de identificação e tirar uma selfie, a foto do documento será comparada com a selfie para determinar o grau de semelhança.
LIVENESS_AND_TEXT_EXTRACTION
O signatário precisará realizar uma prova de vida e fotografar um documento de identificação com foto. As informações do documento serão extraídas automaticamente e comparadas para verificar o grau de semelhança.
Atualizado