Shift4shift4.com
Shift4's API program shows real strengths in API design, schema quality, and overall documentation structure — areas where partners and their agents can build with confidence. The two weakest spots are operational reliability and structured discoverability: agents attempting to retry failed payment mutations risk creating duplicate writes because idempotency is undocumented across all 63 mutating operations, and there is no documented rate-limit signaling to prevent throttling.
API DesignA clean, typed, well-governed API contract agents can reason about4 pass1 warn0 fail96A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable, versioned contractvia spec | 25/25 | The API declares version "1.7.60" and uses url-based versioning, so an agent can pin to a stable contract. Investigated: spec 100%, docs 100%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Auth declared & discoverablevia spec | 25/25 | Authentication is required across the API (declared globally or on every operation), so an agent knows credentials are needed. Investigated: spec 100%, docs 100%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| warn | Schema coverage & depthvia spec | 20.8/25 | Operations take 4.5 parameters each on average and some use nested-object or request-body schemas, which are harder for an agent to fill correctly. Investigated: spec 83%, sdk 77%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, sdk 100%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| pass | Example coveragevia spec | 10/10 | 89% of parameters and responses (473 of 532) include example values, grounding an agent in real payload shapes. Investigated: spec 100%, docs 100%, sdk 100%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples5 pass0 warn0 fail100A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page found at https://docs.shift4.com/guides/quickstart, but no free tier or sandbox is documented in docs/pricing, so an agent may hit a paywall. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://docs.shift4.com/guides/core-concepts/payment-links/use-case-playbooks has a runnable code sample in its plain-text .md variant (https://docs.shift4.com/guides/core-concepts/payment-links/use-case-playbooks.md). Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Code samples in docsvia docs | 18/18 | Code samples appear on 2 of 20 sampled docs pages across 1 language(s), but broader multi-language coverage is missing. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | Only 76% of operations and parameters have substantive descriptions (38 of 72 ops, 320 of 322 params; target 90%+). Investigated: spec 100%, sdk 16%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog is documented on the docs site at https://docs.shift4.com/changelog, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%, sdk 100%. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs0 pass4 warn0 fail74B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/50 sampled pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | llms.txt present, valid & comprehensivevia docs | 21.4/30 | No llms.txt directive found in HTML of any of 50 sampled pages. Investigated: docs 71%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Registry & SDK presencevia sdk | 18.7/28 | No MCP server, tool manifest, or list-tools capability is discoverable (server entrypoint: absent, tool manifest: unknown, list-tools: unknown). Investigated: sdk 67%, docs 0%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Crawlable / AEOvia wellknown | 6/12 | No sitemap found via robots.txt or /sitemap.xml on the docs host, so AI search engines have no crawl map for your docs. Investigated: wellknown 50%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs1 pass3 warn1 fail80A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | error codes is documented on the docs site at https://docs.shift4.com/guides/appendices/error-codes, even though it isn't declared in the API spec. Investigated: docs 100%, sdk 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Operation purpose clarityvia sdk | 23.9/25 | Surface uses a single dominant casing convention (PascalCase). Investigated: sdk 96%, spec 50%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent-navigable, token-efficient docsvia docs | 14.7/22 | 11 of 50 pages have substantive content differences between markdown and HTML (avg 15% missing). Investigated: docs 67%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Agent instructions file (AGENTS.md)via sdk | 5/10 | No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| fail | Docs structured datavia docs | 0/8 | No JSON-LD or OpenGraph/meta tags found across 1 assessed pages (1 JS-rendered), so answer engines have nothing to cite. Investigated: docs 0%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| na | Description consistency across surfaces | —/7 | Only 1 surface description(s) with ≥6 tokens available; need at least 2 to compare. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them2 pass0 warn2 fail54D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Sandbox separationvia spec | 20/20 | Spec declares a sandbox server but no distinguishable test credentials, so agents can't tell test calls from live ones. Investigated: spec 100%, docs 100%, sdk 50%. | An isolated environment lets agents exercise destructive operations safely. |
| pass | Runnable collection with test scriptsvia sdk | 9/9 | README is present and includes a runnable quickstart. Investigated: sdk 100%, platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| fail | Idempotency documentedvia spec | 0/27 | Only 0% of mutating operations (0 of 63) document idempotency, so an agent's retries can create duplicate writes. Investigated: spec 0%, docs 0%, sdk 0%. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/22 | No rate-limit response headers are documented, so an agent can't tell when it is approaching a limit and will get throttled. Investigated: spec 0%, docs 0%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |
Resources Discovered
The public resources we found for Shift4 — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| APIs analyzed | 1 — Shift4 Payment API |
|---|