Skip to main content
POST
/
v1
/
subjects
Look up an identifier across all subject-register sources
curl --request POST \
  --url https://api.example.com/v1/subjects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "scheme": {
      "type": "br:cnpj",
      "value": "12.345.678/0001-90"
    }
  },
  "match_op": "equals",
  "reference_id": "<string>",
  "subject_source": "<string>"
}
'
{
  "data": {
    "matches": [
      {
        "source_id": "<string>",
        "source_name": "<string>",
        "value": "<string>",
        "indexed_at": "2023-11-07T05:31:56Z",
        "properties": {}
      }
    ],
    "reference_id": "<string>",
    "subject_check": "ok"
  },
  "errors": [
    {
      "message": "<string>",
      "field": "<string>",
      "type": "<string>"
    }
  ],
  "meta": {
    "api_version": "v1",
    "lint": [
      {
        "code": "<string>",
        "message": "<string>",
        "severity": "warning",
        "path": "<string>"
      }
    ],
    "request_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://code4source.mintlify.app/llms.txt

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

accept
string | null
Idempotency-Key
string | null

Body

application/json
input
SubjectInput · object
required

User-supplied identifier for the lookup. Required.

match_op
enum<string>
default:equals

Matching operator applied against the identifier value. equals performs an exact case-insensitive match on the canonicalized value. ilike performs a SQL ILIKE pattern match (supports % wildcards).

Available options:
equals,
ilike
reference_id
string | null

Optional caller-provided reference identifier for audit/trace.

Maximum string length: 128
subject_source
string | null

Pin the lookup to a specific subject-register source name (e.g. 'ofac_sdn'). When absent, all registered subject_register sources are searched.

Maximum string length: 64

Response

Matches returned.

data
SubjectsResponse · object
required
errors
FieldWarning · object[]

Non-fatal warnings or field-level errors (empty on full success)

meta
Meta · object