Glossário

Glossário

Os termos de verificação de identidade e de empresa que aparecem no mercado, e o vocabulário da API UNIFOKAL: prefixos de id, estados da verificação e eventos de webhook. Os verbetes da API saem do mesmo contrato que a referência usa, então o que está aqui é o que a API devolve.

act.rejected

O titular recusou o ato que a sessão pedia para ele aprovar com a passkey.

Na documentação: Aprovação de ato com passkey. Veja também: Webhook, Titular.

Ambiente (sandbox e produção)

Sandbox é o ambiente de teste, gratuito e com desfechos simulados; produção verifica gente de verdade e é cobrado. O ambiente é definido pela chave usada.

Na documentação: Sandbox e produção: o que muda. Veja também: Chave secreta (sk_test_ e sk_live_), Flow.

approve (Aprovar)

Recomendação de aprovar, no campo recommendation do webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, review (Revisar).

approved (Aprovado)

A verificação foi aprovada. Libere o que dependia dela.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, verification.completed.

Assinatura eletrônica avançada

Assinatura de um documento ligada de forma única a quem assinou, com a identidade verificada e prova conferível fora da UNIFOKAL.

Na documentação: Assinatura eletrônica. Veja também: Dossiê, KYC (conheça o seu cliente).

Beneficiário final (UBO)

A pessoa natural que, no fim da cadeia societária, controla ou é dona de uma empresa, direta ou indiretamente.

Na documentação: Cadeia societária até o beneficiário final. Veja também: KYB (conheça a empresa), Screening.

blocked (Bloqueado)

A verificação bateu na sua lista de bloqueio. Não é cobrada.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Lista de bloqueio, verification.blocked.

Busca 1:N (múltiplas contas)

Comparação de um rosto com todos os rostos já verificados na sua base, para saber se a mesma pessoa já abriu outra conta com outro nome.

Na documentação: Detecção de múltiplas contas (1:N). Veja também: Face match 1:1, Lista de bloqueio.

Chave secreta (sk_test_ e sk_live_)

A credencial da sua integração, usada só no seu servidor. sk_test_ chama o sandbox e sk_live_ chama a produção.

Na documentação: Autenticação. Veja também: Ambiente (sandbox e produção), Credencial do painel (dsk_).

consent_declined (Consentimento recusado)

O titular recusou o consentimento na abertura da verificação. É um desfecho neutro e final, nunca reprovação.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, Titular, LGPD.

Credencial do painel (dsk_)

A credencial da sessão de um membro no painel. Não entra nas rotas da integração, que só aceitam a chave secreta.

Na documentação: Autenticação. Veja também: Chave secreta (sk_test_ e sk_live_).

decline (Recusar)

Recomendação de recusar, no campo recommendation do webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, review (Revisar).

denied (Recusado)

A verificação foi recusada. Não libere o acesso, e fale com o titular pelo texto de subject_message.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, verification.completed.

Desfecho

O estado final de uma verificação (aprovada, recusada, em revisão e os demais) e o que você faz com cada um.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: approved (Aprovado), denied (Recusado), review (Revisar), approve (Aprovar).

Dossiê

O registro completo de uma verificação ou de uma assinatura, com as evidências e os carimbos, para guardar e apresentar a quem precisar conferir.

Na documentação: Assinatura eletrônica. Veja também: Verificação, Assinatura eletrônica avançada.

Envelope de erro

A forma de toda resposta de erro da API: um código estável em error e um texto legível em message. Trate pelo código.

Na documentação: API REST (4 endpoints públicos). Veja também: Idempotência.

Face match 1:1

Comparação de um rosto com outro rosto específico: a selfie do titular contra a foto do documento dele. Responde se são a mesma pessoa.

Na documentação: Documento, face match e prova de vida. Veja também: Busca 1:N (múltiplas contas), Prova de vida (liveness), Reautenticação facial.

failed (Erro)

A análise não foi concluída do nosso lado. Não é cobrada e não é reprovação do titular: abra uma verificação nova para ele.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, verification.failed.

Flow

A receita da verificação: quais módulos rodam e em que ambiente. Você monta no painel, e cada sessão aponta um flow pelo flow_id.

Na documentação: Integração ponta a ponta. Veja também: Módulo, flow_ (flow), Ambiente (sandbox e produção).

flow_ (flow)

Prefixo do id de um flow. É o valor que vai em flow_id na criação da sessão.

Na documentação: POST /v1/verification-sessions. Veja também: Flow.

high (risco alto)

Nível de risco alto, no campo risk_level do webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho.

HMAC (assinatura do webhook)

O cabeçalho que prova que o webhook saiu da UNIFOKAL e não foi alterado. O seu servidor confere com o segredo que você cadastrou antes de confiar no corpo.

Na documentação: Valide a assinatura do webhook. Veja também: Webhook, Replay de webhook.

Idempotência

Repetir a mesma chamada não duplica o efeito. Na criação de sessão o reference_id é a chave: o retry recebe a mesma sessão, sem cobrança dupla.

Na documentação: Integração ponta a ponta. Veja também: reference_id, Sessão de verificação.

KYB (conheça a empresa)

Verificação de uma empresa: CNPJ, situação cadastral, quadro societário, representante e beneficiário final.

Na documentação: Consulta cadastral de CPF e de CNPJ. Veja também: KYC (conheça o seu cliente), Beneficiário final (UBO), Screening.

KYC (conheça o seu cliente)

Verificação de que uma pessoa é quem diz ser, antes de abrir conta ou liberar um serviço. Reúne documento, face match, prova de vida e consultas cadastrais e de listas.

Na documentação: Documento, face match e prova de vida. Veja também: KYB (conheça a empresa), Prova de vida (liveness), Face match 1:1, PEP (pessoa exposta politicamente).

LGPD

Lei Geral de Proteção de Dados Pessoais (Lei 13.709/2018), que rege o tratamento de dado pessoal no Brasil.

Na documentação: Privacidade e consentimento. Veja também: Titular, verification.subject_erased.

Link hospedado

Um endereço de verificação pronto para mandar ao titular por e-mail ou mensagem, sem integrar o widget na sua página.

Na documentação: Link de verificação hospedado. Veja também: Widget, Sessão de verificação.

Lista de bloqueio

A lista de documentos, rostos e referências que você mesmo barrou. Vale para a conta inteira ou só para um flow, e uma verificação que bate nela termina bloqueada.

Na documentação: Lista de bloqueio. Veja também: blocked (Bloqueado), verification.blocked, reference_id.

Listas restritivas e sanções

Listas oficiais de pessoas e empresas com restrição, como as de sanções internacionais. Conferir o titular contra elas é parte do screening.

Na documentação: PEP e listas restritivas. Veja também: PEP (pessoa exposta politicamente), Screening, Mídia adversa.

low (risco baixo)

Nível de risco baixo, no campo risk_level do webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho.

Matrícula biométrica

A referência facial de um titular, criada num onboarding aprovado e usada depois pela reautenticação facial. Existe uma por reference_id.

Na documentação: Reautenticação facial. Veja também: Reautenticação facial, reference_id.

medium (risco médio)

Nível de risco médio, no campo risk_level do webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho.

Mídia adversa

Notícia pública que associa o nome de uma pessoa a crime ou irregularidade, entregue como evidência para revisão.

Na documentação: Mídia adversa. Veja também: Screening, Listas restritivas e sanções.

Módulo

Uma capacidade que dá para ligar num flow, como documento, prova de vida, PEP ou consulta cadastral. Cada um tem seu resultado no webhook.

Na documentação: Catálogo de módulos. Veja também: Flow, Verificação.

Monitoramento contínuo

Vigilância do titular já aprovado nas listas de PEP e sanções, com aviso por webhook quando ele aparece numa delas depois do onboarding.

Na documentação: Monitoramento contínuo. Veja também: verification.monitoring, Screening.

MRZ (zona de leitura mecânica)

As linhas de caracteres padronizados no pé de passaportes e documentos de viagem, no padrão ICAO 9303.

Na documentação: Documento de viagem estrangeiro (MRZ). Veja também: OCR de documento.

OCR de documento

Leitura automática dos campos impressos num documento fotografado, como nome, CPF e data de nascimento.

Na documentação: Documento, face match e prova de vida. Veja também: MRZ (zona de leitura mecânica), KYC (conheça o seu cliente).

Onboarding

A entrada de um cliente novo no seu produto, o momento em que a verificação de identidade costuma acontecer.

Na documentação: Integração ponta a ponta. Veja também: KYC (conheça o seu cliente), Titular, Flow.

passkey.bound

A passkey do titular passou a valer na conta dele na sua base, com o modo do vínculo e a garantia (Identidade ou Presença). Quando o vínculo é uma recuperação, avise o titular.

Na documentação: Aprovação de ato com passkey. Veja também: Webhook, Titular.

passkey.revoked

Uma passkey do titular deixou de valer, revogada pelo painel ou pelo apagamento dos dados dele. Ela não aprova mais nenhum ato.

Na documentação: Aprovação de ato com passkey. Veja também: Webhook, Titular.

pending (Pendente)

A verificação ainda não tem decisão final. Espere o webhook antes de agir.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, verification.pending.

PEP (pessoa exposta politicamente)

Pessoa que ocupa ou ocupou cargo público relevante, e os familiares e próximos dela. A regulação pede atenção reforçada, não recusa automática.

Na documentação: PEP e listas restritivas. Veja também: Listas restritivas e sanções, PLD e AML, Screening.

pix_device.revoked

Aviso de que um dispositivo Pix cadastrado foi revogado pelo seu operador.

Na documentação: Cadastro de dispositivo Pix. Veja também: Webhook.

PLD e AML

Prevenção à lavagem de dinheiro. No onboarding, é conferir o cliente contra listas de PEP e de sanções e manter o registro do que foi conferido.

Na documentação: PEP e listas restritivas. Veja também: PEP (pessoa exposta politicamente), Listas restritivas e sanções, Monitoramento contínuo.

pld.alert.created

Aviso de que o monitoramento de PLD/FT selecionou uma operação ou situação para a sua análise. O corpo é mínimo e sigiloso, e o detalhe fica no painel.

Na documentação: PLD/FT pela regra da norma. Veja também: Webhook.

Prova de vida (liveness)

Confirmação de que a selfie é de uma pessoa presente diante da câmera naquele momento, e não de uma foto ou de uma tela apresentada à câmera.

Na documentação: Documento, face match e prova de vida. Veja também: Face match 1:1, KYC (conheça o seu cliente), Selfie.

Reautenticação facial

Nova confirmação, numa ação sensível, de que quem age agora é a mesma pessoa aprovada no onboarding, sem pedir documento de novo.

Na documentação: Reautenticação facial. Veja também: Face match 1:1, Matrícula biométrica.

reference_id

O identificador do titular no SEU sistema, obrigatório na criação da sessão. Volta no webhook, serve de chave de idempotência e pode entrar na lista de bloqueio.

Na documentação: POST /v1/verification-sessions. Veja também: Idempotência, Titular, Lista de bloqueio.

Replay de webhook

O reenvio, pedido por você, de entregas de webhook que o seu servidor perdeu, pela API ou pelo painel.

Na documentação: POST /v1/webhook-events/replay. Veja também: Webhook, HMAC (assinatura do webhook).

review (Revisar)

A verificação precisa de uma decisão humana. Ela aparece na fila de revisão do painel para o seu time decidir.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, review (Revisar).

review (Revisar)

Recomendação de revisar antes de decidir, no campo recommendation do webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: Desfecho, review (Revisar).

Screening

A conferência de uma pessoa ou empresa contra listas de PEP, sanções e outras restrições, com a evidência de cada achado no resultado.

Na documentação: Screening do quadro societário. Veja também: PEP (pessoa exposta politicamente), Listas restritivas e sanções, Monitoramento contínuo.

Selfie

A foto do rosto do titular capturada pelo widget durante a verificação.

Na documentação: O Widget. Veja também: Prova de vida (liveness), Face match 1:1, Busca 1:N (múltiplas contas).

Sessão de verificação

O que o seu servidor cria com a chave secreta para um titular fazer a verificação. Tem id com prefixo vs_, vale por tempo limitado e é o que o widget recebe para abrir.

Na documentação: POST /v1/verification-sessions. Veja também: vs_ (sessão de verificação), Widget, Verificação, reference_id.

Titular

A pessoa que está sendo verificada: o seu usuário final, dono dos dados que a verificação trata.

Na documentação: Privacidade e consentimento. Veja também: reference_id, Onboarding.

ver_ (verificação)

Prefixo do id de uma verificação. Chega no webhook em verification_id, e é por ele que você concilia.

Na documentação: Webhooks e eventos. Veja também: Verificação, Webhook.

Verificação

O resultado de uma sessão: a análise dos módulos do flow e o desfecho. Tem id com prefixo ver_ e chega ao seu servidor pelo webhook.

Na documentação: Os desfechos, e o que fazer com cada um. Veja também: ver_ (verificação), Desfecho, Webhook.

verification.blocked

A verificação terminou barrada pela sua lista de bloqueio. Não é cobrada.

Na documentação: Webhooks e eventos. Veja também: Lista de bloqueio, blocked (Bloqueado).

verification.completed

A verificação terminou com uma decisão. O status do corpo diz qual, e é por ele que você age.

Na documentação: Webhooks e eventos. Veja também: Webhook, approved (Aprovado), denied (Recusado).

verification.failed

A análise não foi concluída do nosso lado. A verificação não é cobrada: trate como inconclusiva e abra outra.

Na documentação: Webhooks e eventos. Veja também: failed (Erro).

verification.monitoring

Alerta do monitoramento contínuo: um titular aprovado apareceu numa lista de sanções ou de PEP depois do onboarding. Quem decide é você.

Na documentação: Webhooks e eventos. Veja também: Monitoramento contínuo, review (Revisar).

verification.pending

A verificação ficou aguardando uma decisão. Trate como pendente até o próximo evento dela.

Na documentação: Webhooks e eventos. Veja também: pending (Pendente), review (Revisar).

verification.subject_erased

Os dados pessoais do titular daquela verificação foram apagados do nosso lado. Repita o apagamento nos seus sistemas (LGPD, art. 18, § 6º).

Na documentação: Webhooks e eventos. Veja também: LGPD, Titular.

verification_link.claimed

Aviso de que a pessoa abriu o link de verificação que você emitiu e começou a jornada.

Na documentação: Assinatura eletrônica. Veja também: Webhook.

vs_ (sessão de verificação)

Prefixo do id de uma sessão de verificação. É o que o widget recebe para montar.

Na documentação: POST /v1/verification-sessions. Veja também: Sessão de verificação, Widget.

Webhook

O aviso que o nosso servidor manda ao seu quando algo acontece, como a verificação terminar. É a fonte oficial do resultado.

Na documentação: Webhooks e eventos. Veja também: HMAC (assinatura do webhook), Replay de webhook, verification.completed.

webhook.test

O evento de teste disparado pelo painel, para conferir endereço, assinatura e parser. Nunca representa uma verificação.

Na documentação: Webhooks e eventos. Veja também: Webhook, HMAC (assinatura do webhook).

whe_ (destino de webhook)

Prefixo do id de um destino de webhook cadastrado no painel.

Na documentação: Webhooks e eventos. Veja também: Webhook.

whk_ (chave pública de cifra)

Prefixo do id da chave pública que cifra a carga do webhook. Vem no campo kid do envelope cifrado e diz qual chave privada abre a entrega.

Na documentação: Webhooks e eventos. Veja também: Webhook.

Widget

A tela de verificação que você embute no seu site com uma linha. Monta com o id da sessão e nunca recebe a chave secreta.

Na documentação: O Widget. Veja também: Sessão de verificação, Link hospedado.