API de importar sessão compartilhada: KYC e KYB

Lista dos recursos de verificação configurados para esta sessão, como nomes de exibição: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, PHONE, EMAIL_VERIFICATION, AML, IP_ANALYSIS, DATABASE_VALIDATION, QUESTIONNAIRE, AGE_ESTIMATION, FACE_SEARCH, GEOLOCATION (verificação de localização) (as sessões de Verificação de empresas usam o conjunto de recursos de KYB: KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, AML, PHONE, EMAIL_VERIFICATION, IP_ANALYSIS, QUESTIONNAIRE). Com include=events, cada entrada se torna um objeto {feature, node_id} em vez de uma string simples, e o recurso de e-mail é renomeado: ele aparece como EMAIL no modo de eventos em vez do EMAIL_VERIFICATION usado aqui.

Array de relatórios de verificação de identidade (OCR) produzidos pelas etapas de documento de identidade no grafo do fluxo. Sempre um array JSON: leia id_verifications[0] e itere se o seu fluxo puder executar mais de uma verificação de identidade (por exemplo, uma verificação principal mais uma verificação adicional). Fica null até que pelo menos uma etapa de identidade tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, os campos extraídos do documento, URLs das imagens, pontuações de qualidade, MRZ, análise do endereço, correspondências entre sessões e warnings[].

Array de relatórios de NFC / ePassport produzidos pelas etapas de NFC no grafo do fluxo. É sempre um array JSON, nunca um objeto nfc único: leia nfc_verifications[0] e itere se o seu fluxo puder executar NFC mais de uma vez. Fica null até que pelo menos uma etapa de NFC tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, chip_protocol, chip_data, authenticity (integridade de SOD + DG), certificate_summary e warnings[]. Um My Number Card do Japão é lido por meio de JPKI em vez de ICAO 9303: o item correspondente tem chip_protocol: "jpki", traz suas evidências em jpki e deixa os campos ICAO como null. Quando a etapa de NFC foi ignorada antes mesmo de poder ser oferecida (documento sem chip, certificado ausente, nenhuma capacidade de NFC informada, chave MRZ ilegível, JPKI indisponível para um My Number Card), este campo permanece null e nfc_skip_reason explica o motivo; um pulo na própria etapa (o usuário tocou em pular ou o leitor se mostrou indisponível no momento da leitura) ainda gera um relatório com is_nfc_skipped: true.

Array de relatórios de prova de vida produzidos pelas etapas de prova de vida no grafo do fluxo. Sempre um array JSON, nunca um objeto liveness único. Fica null até que pelo menos uma etapa de prova de vida tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, method, score, reference_image, video_url, age_estimation opcional, matches[] entre sessões e warnings[].

Array de relatórios de correspondência facial produzidos pelas etapas de correspondência facial no grafo do fluxo. Sempre um array JSON, nunca um objeto face_match único. Fica null até que pelo menos uma etapa de correspondência facial tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, a score de similaridade, source_image, target_image e warnings[].

Array de relatórios de verificação de telefone: sempre um array JSON, nunca um objeto phone único. Fica null até que pelo menos uma etapa de telefone tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, o número de telefone e os metadados do país, lifecycle[], matches[] e warnings[].

Array de relatórios de verificação de e-mail: sempre um array JSON, nunca um objeto email único. Fica null até que pelo menos uma etapa de e-mail tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, o endereço de e-mail, dados de vazamentos, lifecycle[], matches[] e warnings[].

Array de relatórios de Comprovante de endereço (POA): sempre um array JSON, nunca um objeto poa único. Fica null até que pelo menos uma etapa de POA tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, a URL do arquivo do documento, o emissor, as datas, o endereço analisado e warnings[].

Relatórios de Document AI agrupados por nó do fluxo — sempre um array JSON, nunca um objeto único. null até que pelo menos uma etapa de Document AI tenha produzido dados. Presente apenas quando session_kind = user. Cada item é um grupo de nó com um status agregado, o node_id, um array items[] com os resultados por documento (dados extraídos indexados pela chave de campo configurada) e warnings.

Array de relatórios de respostas de questionário: sempre um array JSON, nunca um objeto questionnaire único. Fica null até que pelo menos uma etapa de questionário tenha produzido dados. Cada item é o relatório completo, incluindo node_id, os metadados do questionário, as seções com elementos de formulário e as respostas do usuário.

Resultados da Verificação bancária, um item por etapa de Verificação bancária, para Verificação de usuários e Verificação de empresas. null até que uma etapa produza um. O method de cada item indica como a conta foi verificada: open_banking (login no banco) ou account_lookup (consulta da conta), ou um fallback por statement ou microdeposits, e none quando a pessoa continuou sem banco antes que qualquer tentativa fosse avaliada (continued_without_bank). Consulte Métodos de verificação bancária. A Verificação bancária ainda não está habilitada em produção, então este campo permanece null nas sessões de produção até que esteja.

Resultados de assinatura eletrônica, um item por signatário e etapa de assinatura, para Verificação de usuários e Verificação de empresas. Presente somente quando o fluxo tem uma etapa de Assinatura eletrônica; é um array vazio até que um signatário chegue a ela. Consulte o relatório de assinatura eletrônica.

Array de relatórios de análise AML: sempre um array JSON, nunca um objeto aml único. É null até que pelo menos uma etapa de AML tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, total_hits, entity_type, hits[], score, screened_data, is_ongoing_monitoring_enabled e warnings[].

Array de relatórios de Análise de dispositivo e IP: sempre um array JSON, nunca um objeto ip_analysis único. Fica null até que pelo menos uma etapa de análise de IP tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, dados de IP e geolocalização, a impressão digital do dispositivo e warnings[]. Entradas com (node_id, ip_address, device_fingerprint) duplicados são desduplicadas no servidor.

Array de resultados de verificação de localização, um por etapa de verificação de localização: a tentativa aceita dessa etapa. Fica null até que uma etapa de verificação de localização tenha produzido dados. As tentativas anteriores da mesma etapa estão em geolocation_attempts.

Todas as tentativas de todas as etapas de verificação de localização desta sessão, da mais antiga para a mais recente. Tentativas substituídas por um reenvio ficam de fora. Um fluxo que oculta geolocation_checks por meio dos seus atributos de resposta também oculta esta lista.

Array de relatórios de Validação de banco de dados — sempre um array JSON, nunca um objeto database_validation singular. null até que pelo menos uma etapa de validação de banco de dados tenha produzido dados. Cada item é o relatório completo, incluindo node_id, o status no nível do recurso, screened_data, as validations[] por serviço (cada uma com o source_data do respectivo registro) e warnings[]. Os campos screened_data e source_data variam por país:

ARG (Argentina): screened_data: {document_number, selfie, gender, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, date_of_death, tax_id, tax_id_type, face_match_score, sit_1_since, banks, last_position, highest_position, rejected_checks}. Usa a validação biométrica de correspondência facial do RENAPER. O gênero é inferido automaticamente a partir da análise facial ou do primeiro nome quando não consta no documento (por exemplo, carteiras de motorista)

BOL (Bolívia): screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender}

BRA (Brasil): screened_data: {tax_number, first_name, last_name, date_of_birth}. source_data sempre inclui {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} para correspondências de CPF bem-sucedidas. Consultas bem-sucedidas de adultos definem essas flags como false. O serviço Consulta CPF da Receita Federal pode retornar HTTP 422 (menor de 18 anos) ou 451 (menor de 16 anos) com dados retidos pela LGPD; nesses casos, source_data define as flags de menoridade como true conforme o caso, inclui o status HTTP retornado pela fonte e a validação no nível do campo é no_match. Consulte a seção Brasil da referência de códigos de resultado da Validação de banco de dados para ver a lista completa de códigos.

CHL (Chile): screened_data: {personal_number, first_name, last_name, date_of_birth}. source_data: {identification_number, first_name, last_name, date_of_birth, gender}

COL (Colômbia): screened_data: {document_number, document_type, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, document_type}

CRI (Costa Rica): screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

DOM (República Dominicana): screened_data: {personal_number}. source_data: {identification_number} (retorna apenas válido/inválido)

ECU (Equador): screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, street, formatted_address, gender, nationality, education, marital_status, spouse, mother_name, father_name, profession}

ESP (Espanha): screened_data: {personal_number, document_type, expiration_date, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, document_type, expiration_date}

GTM (Guatemala): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

HND (Honduras): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

MEX (México): screened_data: {personal_number (CURP), first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender, nationality, curp_status, state_of_birth, doc_probatorio, registration_year, registration_state, registration_municipality, num_acta, crip, issuing_state_code, foreign_registry_number, folio_carta, folio_certificado}. Usa o registro civil do RENAPO. Um serviço separado de verificação de validade do INE também está disponível para MEX como validação individual adicional.

PAN (Panamá): screened_data: {personal_number, selfie}. source_data: {identification_number}. Usa a validação biométrica do SIB

PER (Peru): screened_data: {personal_number (DNI), first_name, last_name}. source_data: {identification_number, first_name, last_name, paternal_name, maternal_name, verification_number, verification_letter}

PRY (Paraguai): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

SLV (El Salvador): screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

URY (Uruguai): screened_data: {personal_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

VEN (Venezuela): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, gender, date_of_birth, document_type}

Verificações no registro de empresas. Presente apenas quando session_kind = business. Cada item contém o payload completo do registro de empresas.

Verificações agregadas das pessoas-chave. Presente apenas quando session_kind = business. Cada item usa o formato de dois grupos (registry, submitted, ubo_kyc_summary).

Verificações de documentos agrupadas por nó do fluxo. Presente apenas quando session_kind = business.

Retornado apenas com include=resubmissions, para sessões de usuários e de empresas. Uma entrada por requisição de reenvio, da mais antiga para a mais recente. Cada entrada traz os resultados que as etapas reenviadas retornaram antes da requisição, para que os envios anteriores continuem legíveis. Excluir a sessão exclui todos os envios.