Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs-attestly.code4source.com/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint não-espacial: envie um único identificador tipado (CNPJ, EIN, OFAC SDN, etc.); receba quais subject registers contêm uma correspondência.

​
Request

{
  "input": {
    "scheme": { "type": "ofac:sdn", "value": "12345" }
  },
  "subject_source": "ofac_sdn",
  "match_op": "equals",
  "reference_id": "kyc-2026-05-001"
}
CampoObrigatórioNotas
input.schemesim{type, value}. type é o namespace do scheme, ex.: br:cnpj.
subject_sourcenãoRestringe o lookup a um único source. Omita para buscar em todos.
match_opnãoequals (default, exato canônico) ou ilike (curingas %).
reference_idnãoId de correlação fornecido pelo cliente, ecoado na resposta.
O value do identificador é canonicalizado no servidor: espaços, hífens, pontos, barras e parênteses são removidos, caixa é normalizada. Então "12.345.678/0001-90" e "12345678000190" são equivalentes.

​
Response

{
  "data": {
    "matches": [
      {
        "source_name": "ofac:sdn",
        "source_id": "sdn-12345",
        "value": "12345",
        "indexed_at": "2026-04-30T00:00:00Z",
        "properties": { "name": "...", "program": "..." }
      }
    ],
    "subject_check": "ok",
    "reference_id": "kyc-2026-05-001"
  }
}
Um array matches vazio significa que não houve match. subject_check vale "ok" quando todos os sources responderam, "failed" quando uma resposta parcial foi retornada.

​
Schemes

Schemes seguem <authority>:<name> (minúsculo, máx 65 chars). Alguns comuns:
SchemeDescrição
br:cnpjCNPJ
br:cpfCPF
us:einUS Employer Identification Number
ofac:sdnOFAC Specially Designated Nationals
Chame GET /v1/sources?kind=subject_register para ver quais schemes estão disponíveis para sua Organização.