API Reference

Triagem avulsa de PEP e sanções por documento (CPF com o nome ou CNPJ com a razão social)

Triagem de UM documento nas listas de PEP (CGU) e de sanções (CGU, OFAC, ONU, Reino Unido), sem sessão de verificação. Exige uma chave secreta criada COM o escopo screening:write (chaves sem restrição não o têm) e com lista de IPs permitidos. Preço: o da linha pep_sanctions. A chave unifokal_test_ responde pelo simulador determinístico e nunca lê lista real. Idempotency-Key opcional: a repetição com o mesmo corpo em 24 horas devolve o mesmo query.id, reavalia as listas e não cobra de novo; com outro corpo é 422 idempotency_key_reuse.

curl --request POST \
  --url https://api.unifokal.com/v1/screening-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "<string>",
  "name": "<string>",
  "birth_date": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: '<string>', name: '<string>', birth_date: '<string>'})
};

fetch('https://api.unifokal.com/v1/screening-checks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.unifokal.com/v1/screening-checks"

payload = {
    "document": "<string>",
    "name": "<string>",
    "birth_date": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "query": {
    "id": "<string>",
    "module": "pep_sanctions",
    "environment": "sandbox",
    "document_kind": "cpf",
    "purpose": "<string>",
    "channel": "api",
    "status": "delivered",
    "screening_result": "match",
    "price_cents": 123,
    "billed": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "screening": {
    "result": "match",
    "pep": true,
    "hits": [
      {}
    ],
    "hits_truncated": true,
    "aggregates": {},
    "dataset_versions": {},
    "pep_status": {},
    "coverage": {
      "band": "complete",
      "unavailable_sources": [
        "<string>"
      ]
    }
  },
  "billing": {},
  "replayed": true
}

{
  "query": {
    "id": "<string>",
    "module": "pep_sanctions",
    "environment": "sandbox",
    "document_kind": "cpf",
    "purpose": "<string>",
    "channel": "api",
    "status": "delivered",
    "screening_result": "match",
    "price_cents": 123,
    "billed": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "screening": {
    "result": "match",
    "pep": true,
    "hits": [
      {}
    ],
    "hits_truncated": true,
    "aggregates": {},
    "dataset_versions": {},
    "pep_status": {},
    "coverage": {
      "band": "complete",
      "unavailable_sources": [
        "<string>"
      ]
    }
  },
  "billing": {},
  "replayed": true
}

{
  "error": "invalid_json",
  "message": "<string>"
}

{
  "error": "invalid_api_key",
  "message": "<string>"
}

{
  "error": "insufficient_credit",
  "message": "<string>"
}

{
  "error": "credential_type_not_allowed",
  "message": "<string>"
}

{
  "error": "lookup_in_progress",
  "message": "<string>"
}

{
  "error": "payload_too_large",
  "message": "<string>"
}

{
  "error": "idempotency_key_reuse",
  "message": "<string>"
}

{
  "error": "lookup_daily_cap",
  "message": "<string>"
}

Autorizações

Authorization

string

header

obrigatório

Chave secreta (unifokal_live_ em produção, unifokal_test_ no sandbox: 64 hex mais CRC-32) no Authorization: Bearer. Só no seu servidor: nunca no browser ou app (o widget monta apenas com o id vs_ da sessão). Não existe chave publishable.

Cabeçalhos

Idempotency-Key

string

Required string length: 1 - 255

Corpo

application/json

document

string

obrigatório

CPF (11 dígitos) ou CNPJ (14 caracteres), com ou sem pontuação. O dígito verificador é conferido antes de qualquer custo (400 invalid_cpf ou invalid_cnpj). Nunca é gravado: a linha guarda uma impressão com pimenta, apagada em 24 horas.

Required string length: 11 - 24

name

string

obrigatório

Obrigatório: o nome como está no documento (pessoa) ou a razão social (empresa). A triagem é por documento, nunca por nome solto. Na lista de PEP o nome confirma a máscara do CPF; nas listas internacionais é o nome que busca.

Required string length: 1 - 300

purpose

enum<string>

obrigatório

Finalidade de vocabulário fechado, que diz a sua relação com a pessoa: customer_onboarding, customer_review, customer_related_party, employee_partner_or_supplier ou transaction_counterparty. Fica na trilha da consulta.

Opções disponíveis:

customer_onboarding,

customer_review,

customer_related_party,

employee_partner_or_supplier,

transaction_counterparty

birth_date

string

Opcional e só para CPF (AAAA-MM-DD, no passado): desempata homônimos nas listas internacionais. Com CNPJ é 422 screening_birth_date_not_supported.

Maximum string length: 10

Resposta

Repetição da mesma Idempotency-Key: o mesmo query.id, replayed true, sem novo débito.

A resposta volta UMA vez e não é gravada: não existe GET que a devolva. Hit por nome sai sem nome, documento, cargo ou texto do terceiro; o registro público só vem no hit forte por documento.

query

object

obrigatório

A linha da trilha da consulta (sem documento e sem o resultado detalhado).

Show child attributes

screening

object

obrigatório

Show child attributes

billing

object

obrigatório

replayed

boolean

obrigatório

true quando a resposta é a repetição da mesma Idempotency-Key (reavaliada, sem novo débito).

Triagem avulsa de PEP e sanções por documento (CPF com o nome ou CNPJ com a razão social)

curl --request POST \
  --url https://api.unifokal.com/v1/screening-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "<string>",
  "name": "<string>",
  "birth_date": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: '<string>', name: '<string>', birth_date: '<string>'})
};

fetch('https://api.unifokal.com/v1/screening-checks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.unifokal.com/v1/screening-checks"

payload = {
    "document": "<string>",
    "name": "<string>",
    "birth_date": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "query": {
    "id": "<string>",
    "module": "pep_sanctions",
    "environment": "sandbox",
    "document_kind": "cpf",
    "purpose": "<string>",
    "channel": "api",
    "status": "delivered",
    "screening_result": "match",
    "price_cents": 123,
    "billed": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "screening": {
    "result": "match",
    "pep": true,
    "hits": [
      {}
    ],
    "hits_truncated": true,
    "aggregates": {},
    "dataset_versions": {},
    "pep_status": {},
    "coverage": {
      "band": "complete",
      "unavailable_sources": [
        "<string>"
      ]
    }
  },
  "billing": {},
  "replayed": true
}

{
  "query": {
    "id": "<string>",
    "module": "pep_sanctions",
    "environment": "sandbox",
    "document_kind": "cpf",
    "purpose": "<string>",
    "channel": "api",
    "status": "delivered",
    "screening_result": "match",
    "price_cents": 123,
    "billed": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "screening": {
    "result": "match",
    "pep": true,
    "hits": [
      {}
    ],
    "hits_truncated": true,
    "aggregates": {},
    "dataset_versions": {},
    "pep_status": {},
    "coverage": {
      "band": "complete",
      "unavailable_sources": [
        "<string>"
      ]
    }
  },
  "billing": {},
  "replayed": true
}

{
  "error": "invalid_json",
  "message": "<string>"
}

{
  "error": "invalid_api_key",
  "message": "<string>"
}

{
  "error": "insufficient_credit",
  "message": "<string>"
}

{
  "error": "credential_type_not_allowed",
  "message": "<string>"
}

{
  "error": "lookup_in_progress",
  "message": "<string>"
}

{
  "error": "payload_too_large",
  "message": "<string>"
}

{
  "error": "idempotency_key_reuse",
  "message": "<string>"
}

{
  "error": "lookup_daily_cap",
  "message": "<string>"
}