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 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
| Campo | Tipo | Descrição |
|---|---|---|
id | uuid | Chave do signatário no QI Sign. |
signer_data | object | Os dados do signatário. Veja signer_data. |
images | object | As URLs da selfie, do documento e do dossiê em PDF. Veja images. |
biometry | object | O resultado da validação facial e da base de fraude. Veja biometry. |
document | object | O documento de identificação e a comparação com a selfie. Veja document. |
liveness | object | O resultado da prova de vida. Veja liveness. |
device_data | object | O dispositivo usado na jornada. Veja device_data. |
locations | array | Localizações registradas na jornada. Pode vir vazio. |
link_first_clicked_at | string | Data e hora em que o signatário abriu o link pela primeira vez, em UTC, no formato AAAA-MM-DDTHH:MM:SSZ. |
signed_at | string | Data e hora em que o signatário concluiu a jornada, em UTC, no formato AAAA-MM-DDTHH:MM:SSZ. |
ip_address | string | IP do signatário na assinatura. Presente no webhook de assinatura. |
similarity_score | number | biometry.face_validation.score em escala de 0 a 1. Presente no webhook de assinatura. |
biometry_analysis_reference | string | Quem fez a validação facial. Presente no webhook de assinatura. |
signer_data
| Campo | Tipo | Descrição |
|---|---|---|
id | uuid | Chave do signatário no QI Sign. |
name | string | Nome do signatário. |
document_number | string | CPF do signatário, com máscara. |
birthdate | string | Data de nascimento, no formato AAAA-MM-DD. |
email | string | E-mail do signatário. |
phone | object | Telefone: number (sem DDD), area_code e international_dial_code. |
address | object | Endereço informado na etapa enrich_personal_data: uf, city, street, number, complement, neighborhood, postal_code. |
pix_key | string | Chave Pix informada na etapa enrich_personal_data. |
submission_method | string | Canal pelo qual o link foi enviado: email, sms ou whatsapp. |
document_submission_method | string | Canal pelo qual o link foi enviado, nas jornadas com código de autenticação. Substitui submission_method. |
authentication_submission_method | string | Canal pelo qual o código de autenticação foi enviado. |
callback_url | string | URL de retorno configurada para o signatário, quando existe. |
images
| Campo | Tipo | Descrição |
|---|---|---|
face_image_url | string | A selfie da prova de vida. |
document_front_url | string | A foto da frente do documento físico. |
document_back_url | string | A foto do verso do documento físico. |
document_front_template | string | O tipo da frente do documento. Ex.: rg_front. |
document_back_template | string | O tipo do verso do documento. Ex.: rg_back. |
document_full_url | string | O documento digital enviado em arquivo, quando o signatário usou um. Substitui frente e verso. |
document_full_template | string | O tipo do documento digital. Ex.: cnh_digital. |
simplified_dossier | string | O dossiê da assinatura em PDF. Presente no webhook de assinatura. |
biometry
| Campo | Tipo | Descrição |
|---|---|---|
face_validation.score | integer | Pontuação da validação facial do signatário contra a base de referência, de 0 a 100. |
face_validation.recommendation | string | Recomendação da validação facial: approve ou reprove. |
face_validation.available | boolean | false quando a validação facial não pôde ser feita. Nesse caso a pontuação não indica divergência. |
face_validation.provider | string | Quem fez a validação facial. |
fraud_base_flag | boolean | true quando o signatário está na base de fraude. |
face_validation_score | integer | O mesmo valor de face_validation.score. |
face_validation_available | boolean | O mesmo valor de face_validation.available. |
document
| Campo | Tipo | Descrição |
|---|---|---|
template | string | O tipo do documento de identificação. Ex.: rg_front, cnh_digital. |
face_match_score | integer | Similaridade entre a selfie e a foto do documento, de 0 a 100. |
ocr | array | Dado 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).
| Campo | Tipo | Descrição |
|---|---|---|
file_type | string | O formato do arquivo: jpeg ou pdf. |
template_type | string | O tipo do arquivo. Ex.: rg_front, rg_back, cnh_digital. |
document_data | object | Os dados lidos e os indicadores de autenticidade. |
Os campos de document_data variam com o tipo do documento. Os grupos são:
| Grupo | Campos de exemplo |
|---|---|
| Dados lidos | name, cpf_number, birthdate, mother_name, father_name, place_of_birth, issuance_date, expiration_date, rg_number, cnh_number |
| Confer ência com a jornada | cpf_signer_mismatch: true quando o CPF do documento é diferente do CPF do signatário. |
| Autenticidade | is_copy, text_tampering_detected, face_tampering_detected, screen_display_detected, has_physical_damage, found_anomalous_pdf_creator_or_producer |
| Qualidade da imagem | all_edges_detected, has_missing_document_section, has_textual_legibility_issues |
liveness
| Campo | Tipo | Descrição |
|---|---|---|
result | string | O resultado da prova de vida. live quando aprovada. |
flags.multiple_people | boolean | Dado extra. true quando mais de uma pessoa apareceu na captura. |
flags.total_execution_time | number | Dado extra. Duração da prova de vida, em segundos. |
device_data
| Campo | Tipo | Descrição |
|---|---|---|
ip | string | IP do dispositivo. |
model | string | Modelo do dispositivo. Ex.: iPhone. |
user_agent | string | User agent do navegador. |
coordinates | array | Localizaçã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.