API reference OpenAPI 3.1
Integration guide Download YAML Console ↗
API reference

Every endpoint, in one place.

The complete Monichek API, grouped by capability. Every page is generated from the published OpenAPI contract, so the examples and the contract stay in step.

Live base URL https://api-monichek.paysorta.com/v1
Sandbox base URL https://sandbox-api-monichek.paysorta.com/v1
Authentication Authorization: Bearer wk_live_...
Versioning is the path

Use /v1 in the URL. There is no version header to send; responses include a Monichek-Version header for traceability.

219 endpoints

system

6 endpoints

Health and service info.

GET /health Health GET /status Status GET /ready Deep readiness (load-balancer + Tier-2) GET /me Me GET /audit-events List audit events GET /audit-events.csv Export filtered audit events as CSV

auth

17 endpoints

Identity, sessions and invites.

POST /auth/login Login POST /auth/mfa/verify Mfa verify POST /auth/password/set Password set POST /auth/refresh Refresh POST /auth/logout Logout GET /auth/me Staff identity POST /auth/password/forgot Password forgot POST /auth/password/reset Password reset POST /auth/password/change Change password POST /auth/mfa/enroll Mfa enroll POST /auth/mfa/confirm Mfa confirm GET /auth/sessions List sessions DELETE /auth/sessions/{id} Revoke session GET /auth/invites List invites POST /auth/invites Invite member POST /auth/bootstrap-admin Bootstrap admin POST /auth/invites/{id}:revoke Revoke invite

apikeys

1 endpoint

API key lifecycle (secret and Ed25519 schemes).

POST /api-keys Create api key

screening

16 endpoints

Sanctions/PEP screening, batch, profiles, whitelist, monitoring.

POST /screenings Create screening GET /screenings List screenings GET /screenings/{id} Get screening GET /screenings/{id}/replay Replay screening POST /screenings:batch Batch screening GET /batch-jobs/{id} Get batch job POST /match Yente match GET /search Yente search GET /entities/{id} Get entity GET /catalog Catalog GET /entities/{id}/linked Linked entities GET /screening-profiles List profiles POST /screening-profiles Create a screening profile GET /screening-profiles/{id} Read a screening profile PATCH /screening-profiles/{id} Update a profile (creates a new version) DELETE /screening-profiles/{id} Archive a screening profile

customers

10 endpoints

Customer profiles, accounts, import and network.

POST /customers Create customer GET /customers List customers GET /customers/{id} Get customer POST /customers/{id}/screenings Screen customer PUT /customers/{id}/monitoring Set monitoring POST /monitoring/sweep Monitoring sweep GET /customers/{id}/network Customer network GET /customers/{id}/accounts List accounts POST /customers/{id}/accounts Create account POST /customers:import Import customers

tm

9 endpoints

Transaction evaluation, holds and decisions.

POST /transactions Evaluate transaction GET /transactions List transactions GET /transactions/held Held queue GET /transactions/{id} Get transaction POST /transactions/{id}:release Release transaction POST /transactions/{id}:reject Reject transaction POST /transactions:import Import transactions GET /decisions/{id} Get decision GET /decisions/{id}/replay Replay decision

decide

6 endpoints

One-call decisions, budgets and replay simulation.

POST /decide One-call transaction decision GET /decide:metrics 24h decide latency and quality metrics GET /decide:config Get decide budget and fail mode PUT /decide:config Set decide budget and fail mode GET /decide:feed Recent decide feed for the console POST /decide:simulate Replay transactions through a candidate rule set

risk

6 endpoints

Risk model and peer baselines.

GET /risk-model Get risk model PUT /risk-model Put risk model GET /customers/{id}/risk Get risk POST /customers/{id}/risk:recalc Recalc risk POST /customers/{id}/risk:override Override risk GET /peer-baselines List peer baselines

score

2 endpoints

Customer and batch risk scores.

GET /scores/customers/{id} Explainable risk score for a customer POST /scores:batch Back-book scoring via batch job (CSV export)

rules

26 endpoints

Templates, features, experiments, backtests and simulation.

GET /rules List rules POST /rules Create a tenant rule with a draft v1 GET /rules/{id} Read a rule and one definition version for editing POST /rules:validate Validate rule POST /rules:simulate Simulate rule POST /rules/{id}/versions New rule version GET /rule-sets List rule sets GET /rule-sets/{id} Read a rule set and one definition version POST /rule-sets/{id}/versions New rule set version POST /rule-sets/{id}:activate Activate rule set POST /rule-sets/{id}:shadow Shadow rule set POST /rule-sets/{id}:rollback Rollback rule set GET /rule-templates List templates POST /rule-templates:install Install templates GET /features List features POST /features Create feature POST /backtests Create backtest GET /backtests List backtests GET /tm-scenario-runs List scenario runs GET /backtests/{id} Get backtest POST /experiments Create experiment GET /experiments List experiments GET /experiments/{id} Get experiment POST /experiments/{id}:stop Stop experiment POST /experiments/{id}:promote Promote experiment GET /rules/{id}/versions/{v1}:diff:{v2} Diff versions

cases

22 endpoints

Cases, notes, approvals, four-eyes workflow and case tasks.

GET /alerts List alerts GET /alerts/{id} Get alert POST /alerts/{id}:assign Assign alert POST /alerts/{id}:resolve Resolve alert POST /alerts/{id}:escalate Escalate alert POST /alerts/{id}:whitelist Whitelist from alert POST /cases Create case GET /cases List cases GET /cases/{id} Get case POST /cases/{id}/notes Add note POST /cases/{id}:close Close case POST /whitelist Create whitelist GET /whitelist List whitelist POST /whitelist/{id}:revoke Revoke whitelist POST /cases/{id}:summarize Summarize case POST /cases/summaries/{sid}:approve Approve summary GET /approvals List approvals GET /tasks Cross-case task board GET /cases/{id}/tasks Tasks for one case POST /cases/{id}/tasks Add a task to a case PATCH /tasks/{id} Update a task DELETE /tasks/{id} Delete a task

documents

7 endpoints

Evidence requests, uploads, verification and the document repository.

GET /documents List documents POST /documents Request a document GET /documents/{id} Read a document PATCH /documents/{id} Update a document DELETE /documents/{id} Archive a document (file and row retained) POST /documents/{id}:upload Upload or replace a document file GET /documents/{id}:download Download a document file

compliance

5 endpoints

Regulatory obligations, owners and deadlines.

GET /obligations List regulatory obligations POST /obligations Create an obligation GET /obligations/{id} Read an obligation PATCH /obligations/{id} Update an obligation DELETE /obligations/{id} Archive an obligation

reports

15 endpoints

Regulatory reports, MI pack and schedules.

POST /reports Create report GET /reports List reports POST /reports/nsc Create an NSC compliance report from a NIGSAC screening hit GET /reports/nsc/template Download the official blank NSC Compliance Reporting Form GET /reports/{id}/nsc-form.docx Download a generated NSC Compliance Reporting Form GET /reports/{id} Get report POST /reports/{id}:approve Approve report POST /reports/{id}:file File report GET /reports/{id}/xml Report xml GET /reports/ctr/preview Ctr preview POST /reports/sanctions-return Sanctions return GET /reports/xborder/preview Xborder preview GET /reports/{id}/evidence.zip Evidence zip POST /reports/{id}:email Email report POST /reports/{id}:acknowledge Acknowledge report

lists

9 endpoints

Watchlist sources, changes, runs and custom lists.

GET /lists List sources GET /lists/{key}/changes List changes GET /lists/{key}/runs List runs POST /custom-lists Create custom list GET /custom-lists List custom lists POST /custom-lists/{id}/entries Add custom entry GET /custom-lists/{id}/entries List custom entries POST /custom-lists/{id}:import Import custom list POST /custom-lists/{id}:approve Approve import

data

3 endpoints

Attribute dictionary and import ledger.

GET /attribute-defs List attribute defs POST /attribute-defs Create attribute def GET /imports List imports

developers

2 endpoints

Webhooks, connectors, API logs and integrations.

GET /api-logs List api logs GET /api-usage API usage and health

integrations

3 endpoints

PSP verification and KYC ingest.

POST /integrations/flutterwave:verify Flutterwave verify POST /integrations/interswitch:verify Interswitch verify POST /integrations/monnify:verify Monnify verify

verify

13 endpoints

Hosted identity + AML verification sessions (single-use consumer tokens).

POST /verify/sessions Mint a hosted verification session GET /verify/sessions List verify sessions GET /verify/sessions/{id} Read a verify session (integrator API key or X-Verify-Token) POST /verify/sessions/{id}:cancel Cancel an open session POST /verify/sessions/{id}:submit-identity Hosted identity step: run IDV and auto-screen (X-Verify-Token) POST /verify/sessions/{id}:lookup-identity ID-first pre-check: registry record by type + number (X-Verify-Token) POST /verify/sessions/{id}:acknowledge Record consent acknowledgment; parks in liveness (or address/completed per config) POST /verify/sessions/{id}:submit-liveness Guided face captures vs registry portrait (X-Verify-Token) POST /verify/sessions/{id}:submit-address Address leg (opt-in): postcode + free-text address vs the NG postcode registry (X-Verify-Token) POST /verify/sessions/{id}:skip-address Skip the address leg with a recorded reason (X-Verify-Token) GET /verify/journey Aggregate hosted-verification funnel GET /verify/settings Read tenant verification branding and session defaults PUT /verify/settings Update verification branding, session defaults and onboarding checks (admin)

lookup

5 endpoints

Normalized registry lookups (BVN, NIN, CAC) with match grades.

POST /customers/{id}/address:recheck Coverage-watcher: re-run free L1 for a declared-only postcode (no auth beyond tenant) POST /lookup One normalized registry lookup GET /lookups List lookup requests (PII-safe: hash + last4) GET /lookups/{id} Read one lookup request incl. stored request envelope GET /lookup:providers Provider registry for lookups (id types + configured?)

identity

4 endpoints

Document and biometric identity checks.

GET /idv/providers IDV provider catalog (native vendor capabilities + env names) POST /idv/verifications Run one identity verification (optionally with a face image) GET /idv/verifications List IDV verifications for the tenant GET /idv/verifications/{id} Read one IDV verification

kyb

4 endpoints

Business verification — CAC particulars, screened ownership graph, one verdict.

POST /kyb Start a KYB check (CAC sync, director screening async) GET /kyb List KYB checks GET /kyb/{id} Read one KYB check (verdict, signals, ownership/UBO graph) DELETE /kyb/{id} Soft-delete a KYB check (hidden from reads; retained for audit)

platform

9 endpoints

Exports and platform utilities.

POST /webhook-endpoints Create webhook GET /webhook-endpoints List webhooks POST /webhook-endpoints/{id}:rotate-secret Rotate webhook signing secret POST /webhook-endpoints/{id}:test Test webhook GET /webhook-deliveries List deliveries POST /webhook-deliveries/{id}:redeliver Redeliver GET /exports/audit Export audit POST /exports/s3 Export s3 POST /exports/warehouse Warehouse export

governance

1 endpoint

Audit ledger and verification.

GET /audit-events:verify-anchor Verify anchor

admin

18 endpoints

Staff administration (JWT staff session).

GET /admin/overview Deployment overview counts GET /admin/tenants Admin tenants GET /admin/tenants/{id} Read one tenant including routing settings GET /admin/tenants/{id}/members Tenant member roster with roles PUT /admin/list-sources/{key} Update list source POST /admin/quality:yente Run yente quality GET /admin/quality List quality reports GET /admin/snapshots Admin snapshots POST /admin/snapshots/{id}:rollback Rollback snapshot POST /admin/pii:backfill Pii backfill GET /admin/retention Retention policy PUT /admin/tenants/{id}/retention Set retention GET /admin/legal-holds List holds POST /admin/legal-holds Place hold POST /admin/legal-holds/{id}:release Release hold POST /admin/retention:purge Retention purge GET /admin/feature-flags List flags PUT /admin/feature-flags/{key} Set flag