ORorq-ai

Get PII capabilities

Changed on

Reports the entity catalog, supported regions, and default thresholds the PII detection service currently exposes, including per-entity default thresholds.

get/v2/pii/capabilities

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/pii/capabilities
  • Auth
    HTTP bearer

Response

OK

languagesstring[]

Supported detector languages, e.g. "en", "nl". There is no "auto" value.

base_entitiesstring[]

Universal entity types available regardless of region, e.g. PASSPORT, LICENSE_PLATE, UUID, JWT, BIC.

all_entitiesstring[]

Every entity type the service can detect across all regions and the base catalog.

regionsstring[]

Region codes the service recognizes, e.g. "nl", "gb", "all".

region_entitiesobject

Maps each region code to the entity types it gates. Use this to find the type to name in entities when you need a per-entity threshold on a type a region gates.

entity_thresholdsobject

Sparse per-entity default thresholds; entities absent here fall back to default_threshold.

default_thresholdnumber double

Confidence cutoff applied when neither threshold nor an entity-specific override is supplied.

max_text_charsinteger

Maximum number of characters accepted per request.

Changes