# Shift4 — API Agent Score

> Score: 78/100 (Grade: B) | Domain: shift4.com | Rubric: 1.0.0 | Checked: August 19, 2026

Shift4 scored 78/100 (B), classified "partially-ready".

[View full report](https://www.postman.com/ai/ai-ready-apis/company/shift4)
[All organizations](https://www.postman.com/ai/ai-ready-apis/llms.txt)

## Summary

- Overall: 78/100 (B)
- Classification: partially-ready

## Category Scores

- API Design: 96/100 (A+)
- Developer Experience: 100/100 (A+)
- Agent Discovery: 74/100 (B)
- Agent Understanding: 80/100 (A)
- Agent Usability: 54/100 (D)

## Check Results

### API Design

- [pass] Machine-readable, versioned contract — 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%.
- [pass] Auth declared & discoverable — Authentication is required across the API (declared globally or on every operation), so an agent knows credentials are needed. Investigated: spec 100%, docs 100%.
- [warn] Schema coverage & depth — 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%.
- [pass] Security & governance hygiene — No credential-shaped strings detected in spec. Investigated: spec 100%, sdk 100%, wellknown 0%.
- [pass] Example coverage — 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%.

### Developer Experience

- [pass] Self-service developer portal — 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%.
- [pass] Quickstart present — 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%.
- [pass] Code samples in docs — Code samples appear on 2 of 20 sampled docs pages across 1 language(s), but broader multi-language coverage is missing. Investigated: docs 100%.
- [pass] Description completeness — Only 76% of operations and parameters have substantive descriptions (38 of 72 ops, 320 of 322 params; target 90%+). Investigated: spec 100%, sdk 16%.
- [pass] Changelog published — 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%.

### Agent Discovery

- [warn] Docs reachable, not hard auth-gated — Server ignores Accept: text/markdown header (0/50 sampled pages return markdown). Investigated: docs 75%.
- [warn] llms.txt present, valid & comprehensive — No llms.txt directive found in HTML of any of 50 sampled pages. Investigated: docs 71%, sdk 0%.
- [warn] Registry & SDK presence — 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%.
- [warn] Crawlable / AEO — 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%.

### Agent Understanding

- [pass] Machine-readable errors (RFC 9457) — 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%.
- [warn] Operation purpose clarity — Surface uses a single dominant casing convention (PascalCase). Investigated: sdk 96%, spec 50%.
- [warn] Agent-navigable, token-efficient docs — 11 of 50 pages have substantive content differences between markdown and HTML (avg 15% missing). Investigated: docs 67%.
- [warn] Agent instructions file (AGENTS.md) — No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, wellknown 0%.
- [fail] Docs structured data — 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%.
- [skip] Description consistency across surfaces — Only 1 surface description(s) with ≥6 tokens available; need at least 2 to compare.

### Agent Usability

- [pass] Sandbox separation — 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%.
- [pass] Runnable collection with test scripts — README is present and includes a runnable quickstart. Investigated: sdk 100%, platform 0%.
- [fail] Idempotency documented — 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%.
- [fail] Rate-limit signaling — 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%.
- [skip] Pagination documented & consistent — No surface produced evidence for this capability in this run.

## Executive Summary

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. Separately, docs pages lack the structured metadata answer engines need to surface Shift4 as a credible source. Prioritize closing the operational reliability gaps first — they directly threaten the correctness of partner integrations — then layer in structured discoverability to expand self-serve reach for both humans and AI agents.