Importar sessão partilhada API: KYC reutilizável e KYB

Lista de funcionalidades de verificação configuradas para esta sessão, como nomes de apresentaçã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 (KYB) utilizam o conjunto de funcionalidades de KYB: KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, AML, PHONE, EMAIL_VERIFICATION, IP_ANALYSIS, QUESTIONNAIRE). Com include=events, cada entrada torna-se um objeto {feature, node_id} em vez de uma string simples, e a funcionalidade de e-mail é renomeada: aparece como EMAIL no modo de eventos em vez do EMAIL_VERIFICATION aqui utilizado.

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

Array de relatórios de NFC / passaporte eletrónico produzidos por passos de NFC no grafo do fluxo. Isto é sempre um array JSON, nunca um objeto nfc singular — leia nfc_verifications[0] e itere se o seu fluxo puder executar NFC mais do que uma vez. null até que pelo menos um passo de NFC tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, chip_protocol, chip_data, authenticity (integridade de SOD + DG), certificate_summary e warnings[]. O cartão My Number do Japão é lido através de JPKI em vez do ICAO 9303: o seu item tem chip_protocol: "jpki", contém as suas evidências em jpki e deixa os campos ICAO a null. Quando o passo de NFC foi ignorado antes de poder ser oferecido (documento sem chip, certificado em falta, nenhuma capacidade NFC reportada, chave MRZ ilegível, JPKI indisponível para um cartão My Number), este permanece null e nfc_skip_reason explica o motivo; ignorar no próprio passo (o utilizador tocou em «Ignorar», ou o leitor revelou-se indisponível no momento da leitura) continua a produzir um relatório com is_nfc_skipped: true.

Array de relatórios de prova de vida produzidos por passos de prova de vida no grafo do fluxo. Sempre um array JSON — nunca um objeto liveness singular. null até que pelo menos um passo de prova de vida tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, method, score, reference_image, video_url, age_estimation opcional, matches[] entre sessões e warnings[].

Array de relatórios de correspondência facial produzidos por passos de correspondência facial no grafo do fluxo. Sempre um array JSON — nunca um objeto face_match singular. null até que pelo menos um passo de correspondência facial tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, 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 singular. null até que pelo menos um passo de telefone tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, o número de telefone e 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 singular. null até que pelo menos um passo de e-mail tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, o endereço de e-mail, dados de violações de segurança, lifecycle[], matches[] e warnings[].

Array de relatórios de Comprovativo de morada (POA) — sempre um array JSON, nunca um objeto poa singular. null até que pelo menos um passo de POA tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, o URL do ficheiro do documento, emissor, datas, morada analisada e warnings[].

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

Array de relatórios de respostas a questionários — sempre um array JSON, nunca um objeto questionnaire singular. null até que pelo menos um passo de questionário tenha produzido dados. Cada item é o relatório completo, incluindo node_id, os metadados do questionário, secções com elementos de formulário e as respostas do utilizador.

Resultados da Verificação bancária, um item por passo de Verificação bancária, para Verificação de utilizadores e Verificação de empresas (KYB). null até que um passo produza um. O method de cada item indica como a conta foi verificada: open_banking (início de sessão bancário) ou account_lookup (verificação de conta), ou uma alternativa por statement ou microdeposits, e none quando a pessoa continuou sem banco antes de qualquer tentativa ser avaliada (continued_without_bank). Consulte Métodos de verificação bancária.

Resultados da Assinatura eletrónica, um item por signatário e passo de assinatura, para Verificação de utilizadores e Verificação de empresas. Presente apenas quando o fluxo tem um passo de Assinatura eletrónica; uma matriz vazia até que um signatário o atinja. Consulte o Relatório de assinatura eletrónica.

Array de relatórios de triagem AML — sempre um array JSON, nunca um objeto aml no singular. null até que pelo menos um passo de AML tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, 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 singular. null até que pelo menos um passo de análise de IP tenha produzido dados. Cada item é o relatório completo, incluindo node_id, status ao nível da funcionalidade, dados de IP e geolocalização, impressão digital do dispositivo e warnings[]. As entradas com (node_id, ip_address, device_fingerprint) duplicados são deduplicadas no servidor.

Array de resultados de verificação de localização, um por passo de verificação de localização: a tentativa aceite desse passo. null até que um passo de verificação de localização tenha produzido dados. As tentativas anteriores do mesmo passo estão em geolocation_attempts.

Cada tentativa de cada passo de verificação de Localização desta sessão, da mais antiga para a mais recente. As tentativas substituídas por um novo envio são excluídas. Um fluxo que omita geolocation_checks através dos respetivos atributos de resposta também omite esta lista.

Array de relatórios de Validação de base de dados — sempre um array JSON, nunca um objeto database_validation singular. null até que pelo menos um passo de validação de base de dados tenha gerado dados. Cada item é o relatório completo, incluindo node_id, o status ao nível da funcionalidade, screened_data, as validations[] por serviço (cada uma com o seu source_data do registo) 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}. Utiliza a validação biométrica de correspondência facial do RENAPER. O género é inferido automaticamente a partir da análise facial ou do nome próprio quando não se encontra presente no documento (por exemplo, em cartas de condução)

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 inclui sempre {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} para correspondências bem-sucedidas de CPF. Consultas de adultos bem-sucedidas definem esses sinalizadores como false. O serviço Consulta CPF da Receita Federal pode devolver HTTP 422 (menor de 18 anos) ou 451 (menor de 16 anos) com dados retidos pela LGPD; nesses casos, source_data define os sinalizadores de menor como true conforme apropriado, inclui o código de estado HTTP do serviço a montante e a validação ao nível do campo é no_match. Consulte a secção do Brasil da referência de Códigos de Resultado de Validação de base de dados para 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} (devolve apenas valid/invalid)

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}. Utiliza o registo civil do RENAPO. Está também disponível um serviço independente de verificação de validade do INE para o MEX como uma validação adicional individual.

PAN (Panamá): screened_data: {personal_number, selfie}. source_data: {identification_number}. Utiliza 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 registo de empresas. Presente apenas quando session_kind = business. Cada item contém o payload completo do registo de empresas.

Verificações agregadas de pessoas-chave. Presente apenas quando session_kind = business. Cada item usa o formato de dois contentores (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 utilizador e de empresa. Uma entrada por pedido de nova submissão, da mais antiga para a mais recente. Cada entrada contém os resultados que os passos ressubmetidos retornaram antes do pedido, para que as submissões anteriores permaneçam legíveis. A eliminação da sessão elimina todas as submissões.