Pular para o conteúdo principal

Dossiê do signatário

O dossiê é a lista signers dos webhooks de assinatura e de cancelamento. Cada item reúne as evidências que um signatário deixou na jornada do QI Sign. Esta página descreve os campos de um item.

As URLs das imagens expiram

As URLs de images são temporárias e expiram cerca de 24 horas depois do envio do webhook. Baixe e guarde os arquivos ao receber o webhook.

Os campos de um bloco só vêm quando a etapa correspondente faz parte da jornada. Por exemplo, sem a etapa personal_document não há imagens do documento nem document.ocr.

Atributos de um item de signers​

CampoTipoDescrição
iduuidChave do signatário no QI Sign.
signer_dataobjectOs dados do signatário. Veja signer_data.
imagesobjectAs URLs da selfie, do documento e do dossiê em PDF. Veja images.
biometryobjectO resultado da validação facial e da base de fraude. Veja biometry.
documentobjectO documento de identificação e a comparação com a selfie. Veja document.
livenessobjectO resultado da prova de vida. Veja liveness.
device_dataobjectO dispositivo usado na jornada. Veja device_data.
locationsarrayLocalizações registradas na jornada. Pode vir vazio.
link_first_clicked_atstringData e hora em que o signatário abriu o link pela primeira vez, em UTC, no formato AAAA-MM-DDTHH:MM:SSZ.
signed_atstringData e hora em que o signatário concluiu a jornada, em UTC, no formato AAAA-MM-DDTHH:MM:SSZ.
ip_addressstringIP do signatário na assinatura. Presente no webhook de assinatura.
similarity_scorenumberbiometry.face_validation.score em escala de 0 a 1. Presente no webhook de assinatura.
biometry_analysis_referencestringQuem fez a validação facial. Presente no webhook de assinatura.

signer_data​

CampoTipoDescrição
iduuidChave do signatário no QI Sign.
namestringNome do signatário.
document_numberstringCPF do signatário, com máscara.
birthdatestringData de nascimento, no formato AAAA-MM-DD.
emailstringE-mail do signatário.
phoneobjectTelefone: number (sem DDD), area_code e international_dial_code.
addressobjectEndereço informado na etapa enrich_personal_data: uf, city, street, number, complement, neighborhood, postal_code.
pix_keystringChave Pix informada na etapa enrich_personal_data.
submission_methodstringCanal pelo qual o link foi enviado: email, sms ou whatsapp.
document_submission_methodstringCanal pelo qual o link foi enviado, nas jornadas com código de autenticação. Substitui submission_method.
authentication_submission_methodstringCanal pelo qual o código de autenticação foi enviado.
callback_urlstringURL de retorno configurada para o signatário, quando existe.

images​

CampoTipoDescrição
face_image_urlstringA selfie da prova de vida.
document_front_urlstringA foto da frente do documento físico.
document_back_urlstringA foto do verso do documento físico.
document_front_templatestringO tipo da frente do documento. Ex.: rg_front.
document_back_templatestringO tipo do verso do documento. Ex.: rg_back.
document_full_urlstringO documento digital enviado em arquivo, quando o signatário usou um. Substitui frente e verso.
document_full_templatestringO tipo do documento digital. Ex.: cnh_digital.
simplified_dossierstringO dossiê da assinatura em PDF. Presente no webhook de assinatura.

biometry​

CampoTipoDescrição
face_validation.scoreintegerPontuação da validação facial do signatário contra a base de referência, de 0 a 100.
face_validation.recommendationstringRecomendação da validação facial: approve ou reprove.
face_validation.availablebooleanfalse quando a validação facial não pôde ser feita. Nesse caso a pontuação não indica divergência.
face_validation.providerstringQuem fez a validação facial.
fraud_base_flagbooleantrue quando o signatário está na base de fraude.
face_validation_scoreintegerO mesmo valor de face_validation.score.
face_validation_availablebooleanO mesmo valor de face_validation.available.

document​

CampoTipoDescrição
templatestringO tipo do documento de identificação. Ex.: rg_front, cnh_digital.
face_match_scoreintegerSimilaridade entre a selfie e a foto do documento, de 0 a 100.
ocrarrayDado extra. Os dados lidos de cada arquivo do documento. Veja document.ocr.

document.ocr​

Dado extra da jornada. Um item por arquivo do documento (frente, verso ou documento digital).

CampoTipoDescrição
file_typestringO formato do arquivo: jpeg ou pdf.
template_typestringO tipo do arquivo. Ex.: rg_front, rg_back, cnh_digital.
document_dataobjectOs dados lidos e os indicadores de autenticidade.

Os campos de document_data variam com o tipo do documento. Os grupos são:

GrupoCampos de exemplo
Dados lidosname, cpf_number, birthdate, mother_name, father_name, place_of_birth, issuance_date, expiration_date, rg_number, cnh_number
Conferência com a jornadacpf_signer_mismatch: true quando o CPF do documento é diferente do CPF do signatário.
Autenticidadeis_copy, text_tampering_detected, face_tampering_detected, screen_display_detected, has_physical_damage, found_anomalous_pdf_creator_or_producer
Qualidade da imagemall_edges_detected, has_missing_document_section, has_textual_legibility_issues

liveness​

CampoTipoDescrição
resultstringO resultado da prova de vida. live quando aprovada.
flags.multiple_peoplebooleanDado extra. true quando mais de uma pessoa apareceu na captura.
flags.total_execution_timenumberDado extra. Duração da prova de vida, em segundos.

device_data​

CampoTipoDescrição
ipstringIP do dispositivo.
modelstringModelo do dispositivo. Ex.: iPhone.
user_agentstringUser agent do navegador.
coordinatesarrayLocalização do dispositivo, na ordem [longitude, latitude].

Erros​

O dossiê é parte dos webhooks de assinatura e de cancelamento e não tem erros próprios. Veja a seção Erros de cada webhook.