A aba Assinaturas expõe a assinatura eletrônica como serviço: você envia um PDF e a lista de signatários, a HubCred encaminha ao provedor configurado para a sua loja, avisa por webhook quando a assinatura termina e devolve o documento assinado. Não existe vínculo com operação de crédito. A solicitação é avulsa e endereçada pelo code público que devolvemos no envio.
Autentique-se antes (Autenticação) e revise os Conceitos da API (envelope __hcf, erros). O provedor precisa estar habilitado para a sua loja: sem isso o envio é recusado.

​
Fluxo

1

Enviar o documento

Enviar recebe o PDF em base64 e os signatários, e devolve o code da solicitação mais a URL de assinatura de cada signatário.
2

Acompanhar

Consultar devolve a situação atual. Use enquanto a assinatura estiver aberta: o webhook pode falhar, e sem consulta você fica sem informação.
3

Baixar o assinado

ObterDocumentoAssinado devolve o PDF assinado em base64, depois que a assinatura foi concluída.
4

Cancelar, quando aplicável

Cancelar encerra uma solicitação em aberto. Nem todo provedor suporta cancelamento, ver a observação abaixo.

​
Provedores e o que muda entre eles

O limite de signatários não é escolha nossa: o Unico ID assina uma pessoa por processo, então um envio com dois signatários é recusado antes de sair. Se você precisa de várias assinaturas no mesmo documento, use o ZapSign.

​
Situações

status na resposta, e o mesmo valor por signatário:

​
Webhooks

Quando a assinatura chega a um estado final, avisamos na URL de webhook da sua loja, ou na webhookUrl que você informar no envio. São três eventos:
  • signature.completed, quando a assinatura foi concluída
  • signature.refused, quando um signatário recusou
  • signature.inconclusive, quando a biometria B2E não confirmou a identidade (situação 7)
Hoje signature.refused é entregue apenas para solicitações do Unico ID. No ZapSign a recusa ainda não chega até nós, então trate a ausência do evento como inconclusiva e confirme por Consultar.
O corpo do webhook nunca traz o PDF. Ele traz o code, o status e os signatários, e o documento é buscado por ObterDocumentoAssinado.

​
Biometria B2E

Quando a sua loja contrata a assinatura com biometria B2E (no ZapSign ou no Unico ID), a selfie que o provedor capturou na assinatura é comparada com a base da B2E pelo CPF, nome e data de nascimento do signatário. A comparação é nossa e acontece depois que o signatário assina no provedor.
  • birthDate é obrigatório em todo signatário (formato AAAA-MM-DD), além do CPF com 11 dígitos. Sem ele o envio é recusado antes de sair. Fora da biometria B2E o campo é opcional e ignorado.
  • O signatário é aprovado quando a B2E devolve score maior que zero. Score zero, sem avaliação ou sem prova de vida, CPF sem face na base da B2E e menor de idade deixam a solicitação na situação 7, com o evento signature.inconclusive. Ela é final: reenviar com o mesmo partnerReference devolve a mesma solicitação.
  • Cada signatário traz o bloco biometry na resposta e no webhook:
Fora da biometria B2E, ou antes de a B2E ser consultada, biometry vem nulo.

​
Observações

  • A solicitação é sempre identificada pelo code público, nunca por id interno. Se a sua loja trocar de provedor, o code que você guardou continua valendo.
  • partnerReference é a sua chave de idempotência, opcional. Repetida no mesmo envio, ela devolve a solicitação já existente em vez de criar uma segunda e cobrar duas assinaturas.
  • Uma falha no provedor durante o envio deixa a solicitação em Falhou e não é reenviada por nós, porque um reenvio automático poderia produzir assinatura duplicada. Reenvie você, com o mesmo partnerReference.