Pular para o conteúdo principal

Reprocessamento e Importação de Base Biométrica

Este guia aborda como realizar reprocessamento ou importação de base biométrica na plataforma Unico. Ele detalha os requisitos técnicos e operacionais para uma integração eficaz e segura, seguindo as melhores práticas da plataforma.

Escopo

Este material cobre dois tipos de processos:

  • Reprocessamento: reprocessamento de registros biométricos de usuários que já passaram pela base do cliente e da Unico para reavaliação ou migração entre sistemas.
  • Importação de Base Biométrica: upload inicial ou atualização de uma base contendo selfies para fins de verificação de identidade e/ou classificação de risco.
  • Importação de Base de Documentos: upload de uma base de documentos junto com selfies para fins de verificação por Facematch ou CPF Match (somente Brasil).

Pré-requisitos

  • O cliente deve ter um contrato ativo ou NDA assinado com a Unico e estar na fase de integração (exceção se aprovado pela equipe de governança).
  • O projeto seguirá acordos formais de TPS (transações por segundo). Veja Acordo de TPS abaixo.
  • Antes de obter credenciais de produção, a homologação completa da integração é obrigatória para garantir qualidade dos dados, conformidade do payload e desempenho estável.
  • Uma conta de serviço dedicada deve ser criada para o reprocessamento ou importação (ex.: "Reprocessamento" ou "Legacy_Import").
  • Uma API Key dedicada será criada especificamente para o reprocessamento/importação.
  • (Opcional) Uma subsidiária dedicada pode ser criada para o reprocessamento/importação. Este parâmetro é identificado no payload como subsidiaryId. Veja Parâmetros do payload abaixo.
  • A API Key e a conta de serviço serão desativadas após o período acordado ou conclusão do processamento.

Capacidades disponíveis

CapacidadeDescrição
Verificação de IdentidadeVerifica se a selfie enviada pertence ao real titular do identificador.
Classificação de risco de fraudeVerifica se há histórico de comportamento fraudulento associado àquele rosto.
FacematchVerifica se a foto do documento corresponde à selfie enviada.
CPF Match BrazilBrazil onlyVerifica se o CPF fornecido corresponde ao número de CPF impresso no documento. Observação: nem todos os RGs possuem o CPF impresso.

Requisitos da selfie

  • Deve ser enviada em formato base64.
  • A imagem deve seguir o padrão ICAO (fundo claro, rosto centralizado, sem acessórios que obstruam a identificação, iluminação adequada).
  • Dimensões recomendadas: proporção 1920x1080 ou 1080x1920.
  • Tamanho máximo: 800 KB (comprima com JPEG 92 se necessário).
  • Orientação: retrato.

Requisitos do documento

Acordo de TPS

  • O TPS máximo acordado para este projeto é de 10 TPS.
  • Distribua as requisições de forma uniforme ao longo do tempo em vez de enviá-las em grandes rajadas.
  • Este limite não deve ser excedido sem aprovação formal da equipe Unico.
  • Requisições acima do limite podem ser automaticamente descartadas ou bloqueadas.
  • Se um aumento temporário for necessário, é exigido um acordo formal prévio.

Integração

Endpoints

AmbienteURL BaseAcessoObservações
Staginghttps://api.id.uat.unico.appAbertoObrigatório para testes
Produçãohttps://api.id.unico.appSomente após homologação aprovadaRequer controle rigoroso de TPS

Headers obrigatórios

Authorization: Bearer {access_token}
APIKEY: {your_api_key}
Content-Type: application/json

Parâmetros do payload

{
"subject": {
"duiType": 1,
"code": "11032395702",
"name": "User Name",
"email": "[email protected]",
"phone": "21998571922",
"birthDate": "30/07/1989",
"gender": "M"
},
"useCase": "Reprocessamento/Importação",
"subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
"imageBase64": "/9j/4AAQSkZJR...",
"document": {
"purpose": "Reprocessamento",
"documentId": "doc-001",
"files": [
{
"data": "doc_base64_frente",
"faceDocumentMatch": true
},
{
"data": "doc_base64_verso"
}
]
}
}
CampoTipoObrigatórioDescrição
subjectobjectSimDados de identificação do usuário.
subject.duiTypeintegerSimIdentificador do tipo de documento. Veja os valores de duiType abaixo.
subject.codestringSimCPF ou outro identificador do usuário.
subject.namestringSimNome completo do usuário.
subject.emailstringNãoE-mail do usuário.
subject.phonestringNãoNúmero de telefone do usuário.
subject.birthDatestringNãoData de nascimento do usuário (DD/MM/YYYY).
subject.genderstringNãoGênero do usuário (M ou F).
useCasestringSimNome do caso de uso ("Reprocessamento" ou "Importação de base").
subsidiaryIdstringNãoUUID da subsidiária (fornecido pela Unico).
imageBase64base64SimImagem de selfie do usuário convertida em base64.
documentobjectNãoDados do documento associado ao processo.
document.purposestringNãoFinalidade do documento (ex.: "Reprocessamento").
document.documentIdstringNãoIdentificador do documento.
document.filesarrayNãoLista de arquivos de imagem do documento.
document.files[].database64NãoImagem do documento convertida em base64.
document.files[].faceDocumentMatchbooleanNãoIndica se o rosto no documento corresponde à selfie enviada.
Valores de duiType
ValorDescrição
0Não especificado
1Brasil — CPF
2México — CURP
3Identificador interno Unico
4Estados Unidos — SSN
5Brasil — Passaporte
6Argentina — Passaporte
7Argentina — DNI
8Nigéria — NIN
9Chile — RUN
10Equador — NI
11Estados Unidos — Passaporte
12Guatemala — CUI
13Uruguai — CI
15Endereço de e-mail
16Indonésia — NIK
17Número de telefone
18Estados Unidos — Carteira de motorista

Observações importantes

  • A selfie deve estar em conformidade com o padrão ICAO com qualidade e iluminação adequadas.
  • A selfie deve estar em formato base64.
  • Evite envios em massa sem controle de TPS — isso pode acionar limitação de taxa (veja Tratamento de erros abaixo).
  • Sempre teste dados e integração no ambiente de staging primeiro.

Respostas

Sucesso — 200 OK

{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": {
"result": "inconclusive"
},
"identityFraudsters": {
"result": "inconclusive"
}
}
CampoTipoDescrição
idstringIdentificador do processo. Armazene-o para consultas futuras ou caso implemente Validação 1:1 posteriormente.
statusintegerStatus da transação.
unicoId.resultstringResposta da capacidade Verificação de Identidade.
identityFraudsters.resultstringResposta da capacidade Classificação de risco de fraude.

Erro de processamento de imagem

{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 5
}

Erros comuns

Códigos na faixa 4xx indicam erros de validação nos dados fornecidos. Códigos na faixa 5xx indicam falhas no lado do servidor.

Código HTTPTipo de ErroCausa ProvávelAção Recomendada
400Bad RequestPayload inválidoValide a estrutura e o conteúdo.
401UnauthorizedToken expirado ou inválidoRegenere o token.
403ForbiddenAPI Key incorreta ou permissões insuficientesVerifique as credenciais.
429Too Many RequestsTaxa de requisições excedidaAguarde e respeite o limite de TPS.
500+Internal Server ErrorFalha internaTente novamente após alguns segundos; abra um ticket se persistir.

Tratamento de erros

  • Rate Limit (HTTP 429) deve ser monitorado com atenção. Sobrecarga de requisições pode bloquear o pipeline.
  • Sempre respeite o TPS acordado com a Unico (veja Acordo de TPS).
  • Para falhas persistentes (5xx), reprocesse com controle de retry/backoff.