Public customer-facing v1 API inventory. Use this for route discovery, auth model selection, and operational planning before implementation.
This public catalog excludes internal operational routes. For full technical and operational endpoint documentation, use Operations Docs.
| Endpoint | Methods | Auth | Purpose |
|---|---|---|---|
| /api/v1/ping | GET | API key | Health check for authenticated API integrations. |
| /api/v1/screen | POST | API key | Sanctions screening with optional country/location/IP context and a combined decision summary. |
| /api/v1/integrations/salesforce/screen | POST | API key | Screen one Salesforce Contact, Account, or Lead and return a structured compliance answer plus audit evidence links. |
| /api/v1/integrations/sap-gts/sync | POST | API key | Send SAP GTS export rows into MatchAudit for screening, case creation, and sync-run tracking. |
| /api/v1/integrations/sap-gts | GET | API key | Read back reviewed SAP GTS decisions for middleware reconciliation, fallback polling, or SAP write-back. |
| /api/v1/cross-border-risk | POST | API key | Country/region/IP risk triage with BLOCK/CAUTION/ALLOW recommendation. |
| /api/v1/usage/summary | GET | API_AUTH_SECRET or API key | Current-period usage and remaining allowance. |
| /api/v1/datasets | GET | API key | Tenant-aware enabled dataset list and dataset metadata. |
| /api/v1/settings | GET, PUT | API key | Get/update screening settings and source preferences. Review this before production screening; global defaults apply until changed. |
| /api/v1/analytics | GET | API key | Decisioning analytics summary windowed from audit trail. |
| /api/v1/audit/list | GET | API key | List and filter audit records. |
| /api/v1/billing/summary | GET | API key | Billing-facing usage summary and entitlement status. |
| /api/v1/billing/usage | GET | API key | Detailed usage totals by event type for current period. |
| /api/v1/cases | GET, POST | API key | List cases and create new cases. |
| /api/v1/cases/[id] | GET, PATCH | API key | Fetch or update a single case. |
| /api/v1/cases/analytics | GET | API key | Case funnel and status analytics. |
| /api/v1/cases/status-by-audit | POST | API key | Bulk map audit IDs to linked case status. |
| /api/v1/export | GET | API key | Export JSON/ZIP evidence packs and audit extracts. |
| /api/v1/ownership/check | GET | API key | Ownership/UBO risk checks against configured rules. |
| /api/v1/keys | GET, POST, DELETE | API key | Manage API keys for the current authenticated user scope. |
| /api/v1/keys/[id]/revoke | POST, DELETE | API key | Revoke an API key by ID. |
| /api/v1/team | GET, POST | API key | List teams or create a team in the tenant. |
| /api/v1/team/[teamId]/members | GET, PUT, DELETE | API key | List/add/update/remove team members and roles. |
| /api/v1/directory/teams | GET | API key | Directory sharing-ready teams list. |
| /api/v1/directory/entities | GET, POST, PATCH, DELETE | API key | Directory entity CRUD for monitored subjects. |
| /api/v1/directory/rescreen | POST | API key | Trigger rescreening for directory entities. |
| /api/v1/rescreen/cohorts | GET, POST, DELETE | API key | Manage rescreen cohorts. |
| /api/v1/rescreen/jobs | GET, POST, PATCH, DELETE | API key | Manage rescreen jobs. |
| /api/v1/rescreen/runs | GET, POST | API key | List or trigger rescreen runs. |
| /api/v1/webhooks/endpoints | GET, POST, PATCH, DELETE | API key or dashboard session | Webhook endpoint CRUD and secret rotation. |
| /api/v1/webhooks/deliveries | GET | API key or dashboard session | Read webhook delivery history. |
| /api/v1/webhooks/test-fire | GET, POST | API key or dashboard session | Send test webhook events. |
limit, others use page + pageSize.from, to).Authorization: Bearer <API_KEY> or x-api-key.API_AUTH_SECRET for server-to-server integrations.