Compliance Assessment Tool

CAT White-Label Compliance API

Multi-tenant PCI DSS v4.0.1 compliance assessment platform for ISOs, banks, and MSPs. Three integration shapes, all backed by the same engine: REST API (this…

Identity & security#security

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Multi-tenant PCI DSS v4.0.1 compliance assessment platform for ISOs, banks, and MSPs.

Three integration shapes, all backed by the same engine:

  • REST API (this spec) — server-side from your CRM
  • MCP server at POST /mcp — for AI agents (Claude, ChatGPT)
  • Iframe embed at GET /portal/embed — drop into your customer portal

Async pattern. AI calls (determine, combined-question, analyze) take 8–60s.
By default they return 202 { jobId, pollUrl } immediately; the client polls
GET /v1/jobs/.../{jobId} every 2–3s until status === "COMPLETED".
Pass ?wait=1 for a synchronous wrapper bounded at 27s (works for fast cases).

Tenant isolation. Every record carries a partnerId enforced server-side.
Cross-partner reads return 404, never the other partner's data.

Endpoints 51

  • GETHealth check (public, no auth)/health
  • GETList merchants under your partner account/v1/merchants
  • POSTCreate a merchant/v1/merchants
  • GETGet merchant/v1/merchants/:merchantId
  • PUTUpdate merchant/v1/merchants/:merchantId
  • DELETEDelete a merchant (sandbox tenants only)/v1/merchants/:merchantIdRemoves the merchant along with its payment methods and attempts, freeing a slot against the sandbox 5-merchant cap so throwaway test records do not…
  • GETList merchant's payment methods/v1/merchants/:merchantId/payment-methods
  • POSTAdd payment method/v1/merchants/:merchantId/payment-methodsEach merchant can have multiple payment methods; each gets its own SAQ.
  • POSTDescribe payment methods from the merchant's Authorize.Net account/v1/merchants/:merchantId/integrations/authorize-netReads the merchant's Authorize.Net account (market types, card-present vs card-not-present, Tap to Phone, recurring billing, from settings and up to 50 recent…
  • GETNMI connection status/v1/integrations/nmiWhether this partner has connected an NMI Partner Portal, with host, environment, last 4 of the key, connection date, settings and the last daily sync. Never…
  • DELETEDisconnect NMI/v1/integrations/nmiDeletes the stored NMI key and stops the daily sync. Merchants already imported stay. Admin role required for staff sessions.
  • POSTConnect an NMI Partner Portal (ISOs on NMI)/v1/integrations/nmi/connectStores an NMI Partner Portal "v4 API" key (Settings → Security Keys) after checking it with one merchant-list read. CAT only calls NMI's read-only reports…
  • POSTChange NMI sync settings/v1/integrations/nmi/settings
  • GETList the NMI merchant book, marked with what is already in CAT/v1/integrations/nmi/merchantsEvery merchant under the connected NMI partner account (test accounts excluded). catMerchantId is set when the merchant already exists in CAT (same NMI ID or…
  • POSTImport NMI merchants (up to 10 created per call)/v1/integrations/nmi/importCreates CAT merchants for the given NMI gateway IDs (externalMerchantId nmi:<gatewayId>), drafts their payment methods from NMI activity (one per setup; every…
  • POSTMint portal URLs for this merchant (iframe embed, standalone, platform redirect)/v1/merchants/:merchantId/portal-linkReturns three URLs: embedUrl (drop into an iframe), standalonePortalUrl (open in a new tab), and handoffUrl (full-page platform redirect — we send the…
  • POSTMint a merchant-scoped session token (raw token control)/v1/merchants/:merchantId/session-tokenFor custom UIs and mobile SDKs that want the token without pre-built portal URLs. The token authenticates as X-Session-Token and can only access this one…
  • GETFetch one payment method/v1/merchants/:merchantId/payment-methods/:pmId
  • PUTUpdate a payment method/v1/merchants/:merchantId/payment-methods/:pmIdPatch-style: send only the fields you are changing. Updating description is the normal way to re-run a determination against better wording.
  • POSTAI determines SAQ type from natural-language description/v1/merchants/:merchantId/payment-methods/:pmId/determineDefault mode is async — returns a 202 with jobId + pollUrl. Polls take 8–60s typically. Pass ?wait=1 for synchronous (bounded at 27s).
  • POSTAnswer the AI's follow-up question for SAQ determination/v1/merchants/:merchantId/payment-methods/:pmId/followup
  • GETPoll a determination job/v1/jobs/determine/:jobId
  • GETList attempts for a merchant (each item carries `renewable`)/v1/merchants/:merchantId/attempts
  • POSTOpen a new SAQ attempt (returns applicable section list)/v1/merchants/:merchantId/attemptsOpens a new attempt for a payment method and preloads the list of PCI DSS top-level requirements that apply to the determined SAQ type. SAQ A typically has 7…
  • POSTAnnual renewal: new attempt with last year's answers carried forward/v1/merchants/:merchantId/attempts/:attemptId/renewCreates a fresh attempt for the same payment method + SAQ type, copying last year's answers as pre-filled (flagged carriedForward) responses. Returns a…
  • GETOwn partner profile (tier, test-mode, webhook config, billing summary)/v1/partner
  • PUTSet or clear your webhook receive URL/v1/partner/webhook
  • POSTSend a signed `ping` webhook to your configured URL and return the delivery result/v1/partner/webhook-test
  • POSTRotate the webhook HMAC secret (returned once; also invalidates outstanding session tokens)/v1/partner/webhook/rotate-secret
  • POSTRotate your API key (returned once; old key stays valid 24 h for zero-downtime rollover)/v1/partner/rotate-key
  • GETOwn billing state: status, pending usage this cycle, recent invoices, Stripe portal link/v1/partner/billing
  • GETList section-level (parent) groupings + child progress/v1/merchants/:merchantId/attempts/:attemptId/sectionsReturns one entry per applicable PCI DSS top-level requirement with the leaf children grouped under it. Use this for the parent-flow Step 2 UX.
  • POSTGenerate ONE combined AI question for an entire requirement (async)/v1/merchants/:merchantId/attempts/:attemptId/sections/:topLevel/combinedReturns a 202 jobAck. Poll /v1/jobs/section/:jobId?kind=combined for the combined question + 3 typed suggested answers (In Place / In Place with Compensating…
  • POSTSubmit ONE combined answer for an entire requirement (async)/v1/merchants/:merchantId/attempts/:attemptId/sections/:topLevel/analyzeThe AI distributes the merchant's combined answer across every leaf control under this topLevel and returns per-child compliance status, reason, and suggestion.
  • GETPoll a section combined-question or analyze job/v1/jobs/section/:jobId
  • GETList AoC review groups + signature state/v1/merchants/:merchantId/attempts/:attemptId/reviewReturns the consolidated review questions (company info, business address, acquirer, locations, business description; plus an optional remediation group when…
  • POSTRecord one review-group answer/v1/merchants/:merchantId/attempts/:attemptId/review
  • POSTCapture digital signature on the SAQ + AoC/v1/merchants/:merchantId/attempts/:attemptId/signRecords signatoryName, signatoryTitle, acknowledgement text, and signedAt timestamp. Required before /finalize. The signature is rendered in cursive (Caveat)…
  • POSTFinalize: gate-check, seal, generate official PCI form-filled SAQ + AoC PDFs, email/v1/merchants/:merchantId/attempts/:attemptId/finalizeThree gates: (1) signature exists, (2) all required review groups answered, (3) section completeness. If any leaf control was missed by the parent-flow…
  • GETDownload the sealed SAQ or AoC PDF (permanent, auth-gated)/v1/merchants/:merchantId/attempts/:attemptId/documents/:kind.pdfStreams the finalized PDF straight from S3. The URL does not expire — auth is checked on every request. Works with either a partner API key (server-side) or a…
  • GETFetch one SAQ attempt/v1/merchants/:merchantId/attempts/:attemptIdIncludes status, saqType, and — once finalize has sealed the documents — documentKeys. Polling this is how you learn a long-running finalize has completed.
  • GETGet all questions + section progress for an attempt/v1/merchants/:merchantId/attempts/:attemptId/questionsReturns leaf controls only (parents with descendants are filtered). Each question carries topLevel + sectionTitle for client-side grouping.
  • POSTGenerate AI combined question + suggested answers (async)/v1/merchants/:merchantId/attempts/:attemptId/questions/:controlId/combined
  • POSTSubmit answer and get AI compliance analysis (async)/v1/merchants/:merchantId/attempts/:attemptId/questions/:controlId/analyze
  • GETPoll a combined-question or analyze job/v1/jobs/saq-control/:jobId
  • POSTSubmit completed SAQ to bank, seal attempt, kick off PDF + email/v1/merchants/:merchantId/attempts/:attemptId/submit
  • POSTTrigger PDF generation + email delivery (without re-sealing)/v1/merchants/:merchantId/attempts/:attemptId/seal
  • GETPartner-wide compliance rollup for the bank/ISO/PayFac dashboard/v1/portfolioOne partner-scoped snapshot: totals by effective status, a complianceRate (0–1, compliant & current over the whole book), a funnel of mutually-exclusive…
  • GETDownload the full merchant book as CSV (Excel / examiner export)/v1/portfolio/export.csvStreams one row per merchant with columns: merchantId, externalMerchantId, name, email, effectiveStatus, lastSaqType, compliantAt, expiresAt, daysUntilExpiry,…
  • GETQuery your audit trail (SOC 2 / SOX / dispute evidence)/v1/auditNewest-first, partition-scoped to your partner so you can never see another tenant's events. Filter by merchantId (served from the byMerchant index, then…
  • POSTMCP JSON-RPC endpoint (initialize, tools/list, tools/call, resources/read, prompts/get)/mcpStandard Model Context Protocol — see /docs#mcp for the tool catalog.

API details

Base URL
https://api.complianceassessmenttool.com
Authentication
An API key in the X-API-Key header
Operations
51 operations on 43 pathsPOST 25GET 21PUT 3DELETE 2
Response formats
application/json application/pdf text/csv
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the CAT White-Label Compliance API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CAT White-Label Compliance API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Health check (public, no auth)” (GET /health), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CAT White-Label Compliance API?

Multi-tenant PCI DSS v4.0.1 compliance assessment platform for ISOs, banks, and MSPs. Three integration shapes, all backed by the same engine: REST API (this… It is listed under Identity & security and has 51 endpoints.

Who publishes the CAT White-Label Compliance API?

It is listed from Compliance Assessment Tool's public API description (an OpenAPI document), not published by Compliance Assessment Tool on Swastik Codes. Anyone who controls banks.complianceassessmenttool.com can claim the profile by adding a DNS TXT record.

What is the base URL of the CAT White-Label Compliance API?

Requests go to https://api.complianceassessmenttool.com. Endpoint paths are added to this base URL.

How do I authenticate with the CAT White-Label Compliance API?

With an API key in the X-API-Key header.

How many endpoints does the CAT White-Label Compliance API have?

51 operations on 43 paths (25 POST, 21 GET, 3 PUT, 2 DELETE).

Is forking the CAT White-Label Compliance API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.