Developer API
Integre a triagem de sanções, PEP, listas de vigilância criminal, notícias adversas e KYB/UBO diretamente nos seus fluxos de onboarding, monitorização e transações. A API está em produção: autentique-se com uma chave de API e chame o mesmo motor de triagem utilizado no portal.
A API v1 está em produção
Os endpoints estão disponíveis de forma geral, com autenticação por chave de API e limites de taxa por plano. Explore todos os endpoints na documentação OpenAPI interativa em /api/v1/docs.
Crie uma chave de API com âmbito definido no seu painel, ou gere uma programaticamente com o token bearer da sua conta para pedidos servidor-a-servidor.
curl -X POST https://screenveritai.com/api/v1/keys \
-H "Authorization: Bearer <SUPABASE_JWT>" \
-H "Content-Type: application/json" \
-d '{"name":"server-key","permissions":["search:read","search:write"]}'Submeta uma entidade com o cabeçalho X-API-Key. A API devolve um id de pesquisa que pode consultar quando o processamento terminar.
curl -X POST https://screenveritai.com/api/v1/search \
-H "X-API-Key: <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"full_search"}'Envie um ficheiro CSV/XLSX para analisar várias entidades numa única tarefa e depois consulte as linhas ou exportações quando o lote terminar.
curl -X POST https://screenveritai.com/api/v1/batch \
-H "X-API-Key: <YOUR_API_KEY>" \
-F "file=@entities.csv"POST /api/v1/search
Cria um pedido de triagem para uma entidade. Devolve um id de pesquisa e o estado do processamento. Os endpoints de conta, cobertura e estado do serviço também estão disponíveis em /api/v1.
Autenticação: X-API-Key (search:write)
POST /api/v1/batch
Submeta ficheiros CSV/XLSX para triagem de alto volume e depois consulte as linhas ou exportações quando as tarefas terminarem.
Autenticação: X-API-Key (batch:write)
POST /api/v1/keys
Crie e faça a gestão de credenciais de API com permissões delimitadas, limites de taxa por plano e registo de utilização.
Autenticação: token Bearer (conta)
Implementation patterns for API-key auth, async jobs, and audit logs.
ANNEX BConnect API and file-based flows for high-volume operations.
ANNEX CMap API responses into deterministic screening and escalation decisions.
ANNEX DRe-screen inherited counterparties before systems, payments, and controls are merged.
Os pedidos de triagem para /api/v1/search e /api/v1/batch autenticam-se com uma chave de API enviada no cabeçalho X-API-Key. Crie chaves no seu painel ou programaticamente através de /api/v1/keys, após autenticação com o token bearer da sua conta.
Sim. A API v1 está em produção e disponível de forma geral. Autentique-se com uma chave de API, chame os endpoints de pesquisa, lote e gestão de chaves, e explore tudo na documentação OpenAPI interativa em /api/v1/docs.
Sim. As chaves suportam permissões como search:read, search:write, batch:read e batch:write, permitindo aplicar acesso de privilégio mínimo por integração.
Os limites de taxa são atribuídos por nível de API e aplicados por chave de API — o nível rege o débito de pedidos, não a faturação. Os cabeçalhos de resposta incluem o limite, a quota restante e os carimbos de hora de reposição, para que possa gerir os pedidos de forma controlada.
Utilize a documentação interativa em /api/v1/docs para testes com Swagger e /api/v1/redoc para documentação de referência. O esquema OpenAPI está disponível em /api/v1/openapi.json.