{ "name": "Checkout.com", "slug": "checkout-com", "website_url": "https://www.checkout.com", "vendor_description": "\"Payment services to power your performance\"", "categories": [ "payouts", "card-acquiring" ], "summary": "Checkout.com is a REST payment processing platform launched in 2012, serving ecommerce, marketplace, subscription, in-person, and fintech use cases across 57 domestic processing countries. It supports tokenization, network tokenization, 3DS authentication, recurring payments, and hosted checkout, with SDKs for seven languages and both API key and OAuth2 authentication. Pricing is negotiated through sales, though self-serve signup is available. The platform holds PCI DSS Level 1, SOC 2 Type II, ISO 27001, and GDPR certifications, and counts Netflix, Spotify, Uber, and eBay among its customers.", "capabilities": { "supported_actions": [ "create_charge", "capture_payment", "void_payment", "refunds", "partial_capture", "hosted_checkout", "payment_links", "tokenization", "network_tokenization", "3ds_authentication", "recurring_payments", "stored_credentials", "payouts_to_cards", "payouts_to_bank_accounts", "dispute_management", "fraud_screening", "multicurrency", "apple_pay", "google_pay", "real_time_account_updater", "card_issuing", "virtual_cards", "physical_cards", "identity_verification", "reporting", "webhooks", "sub_entity_onboarding", "split_payments", "in_person_terminal" ], "supported_regions": [ "United Kingdom", "European Economic Area", "United States", "Australia", "Singapore", "New Zealand", "Hong Kong", "Japan", "United Arab Emirates", "Brazil", "Middle East and North Africa", "Asia-Pacific", "57 domestic processing countries globally" ], "supported_languages": [], "input_types": [ "Visa", "Mastercard", "American Express", "Diners Club", "Discover", "JCB", "UnionPay International", "Maestro", "Cartes Bancaires", "Bancontact", "KNET", "Mada", "Apple Pay", "Google Pay", "PayPal", "Alipay", "WeChat Pay", "Kakao Pay", "Dana", "GCash", "Touch 'n Go", "TrueMoney", "MB WAY", "Octopus", "PayNow", "stc pay", "Swish", "Vipps MobilePay", "TWINT", "Venmo", "SEPA Direct Debit", "ACH", "iDEAL", "Przelewy24", "EPS", "Bizum", "BLIK", "Klarna", "Alma", "seQura", "Tabby", "Tamara", "Multibanco", "Omannet", "QPAY", "Benefit Payment Gateway", "PINless Debit" ], "output_types": [ "JSON", "webhook events", "hosted checkout page", "payment links", "settlement reports", "fee summary reports", "financial actions reports", "dispute reports", "network tokens" ], "webhooks_supported": true, "sandbox_available": true, "sdk_languages": [ "Node.js", "Python", "Java", ".NET", "PHP", "Go", "Ruby" ], "mcp_server_available": false }, "integration": { "api_style": "rest", "base_url": "https://{prefix}.api.checkout.com", "api_version": "1.0.0", "versioning_scheme": "none", "stability": "ga", "deprecation_policy_url": "https://www.checkout.com/docs/resources/api-changes", "auth_methods": [ "api_key", "oauth2" ], "auth_docs_url": "https://www.checkout.com/docs/developer-resources/api/manage-api-keys", "idempotency_supported": true, "error_format": "vendor-specific", "webhook_signing": "hmac_sha256", "webhook_events_url": "https://www.checkout.com/docs/developer-resources/event-notifications/event-types", "rate_limit_requests": 100, "rate_limit_window": "second", "sdk_packages": [ { "package": "checkout-sdk-node", "language": "Node.js", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-node" }, { "package": "checkout-sdk", "language": "Python", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-python" }, { "package": "com.checkout:checkout-sdk-java", "language": "Java", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-java" }, { "package": "CheckoutSDK", "language": ".NET", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-net" }, { "package": "checkout/checkout-sdk-php", "language": "PHP", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-php" }, { "package": "github.com/checkout/checkout-sdk-go/v2", "language": "Go", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-go" }, { "package": "checkout_sdk", "language": "Ruby", "official": true, "repo_url": "https://github.com/checkout/checkout-sdk-ruby" } ], "mcp_url": null, "quickstart_url": "https://www.checkout.com/docs/get-started" }, "pricing": { "pricing_model": "contact_sales", "has_published_pricing": false, "starting_price_usd": null, "price_basis": null, "free_tier_available": false, "free_tier_limit": null, "free_tier_details": null, "minimum_commitment": null, "self_serve_signup": true, "requires_sales_call": true, "requires_verification": true, "enterprise_plan_available": null, "price_points": [] }, "compliance": { "soc2": "type_2", "hipaa": null, "gdpr": true, "iso_27001": true, "pci_dss": true, "sla_published": false, "sla_url": null, "data_retention_policy_url": "https://www.checkout.com/legal/privacy-policy", "documented_rate_limits": "100 requests per second (RPS) total for GET operations and 100 RPS total for POST, PUT, and DELETE operations. Lower rate limits apply in the sandbox environment.", "known_restrictions": [ "PCI DSS Level 1 Service Provider (highest level)", "Live account requires underwriting/KYB review of business and UBOs", "Card Payouts available from US, UK, Singapore, UAE, and EEA only as originating regions", "Bank Payouts domestically available in US, UK, and Europe", "Frames SDK deprecated June 30 2026; replaced by Flow", "SOC 2 Type II report provided under NDA on request", "ISO 27001 and PCI DSS certificate available from Trust Center on request" ] }, "developer": { "docs_url": "https://www.checkout.com/docs", "api_reference_url": "https://api-reference.checkout.com/", "openapi_spec_url": null, "postman_collection_url": null, "changelog_url": null, "status_page_url": "https://status.checkout.com", "llms_txt_url": "https://www.checkout.com/llms.txt", "markdown_docs_url": null, "rendering": "static" }, "adoption": { "launched_at": "2012-01-01", "ga_date": null, "github_stars": null, "github_stars_at": null, "notable_customers": [ "Netflix", "eBay", "Spotify", "Uber", "Microsoft", "Pinterest", "Temu", "ASOS", "Vinted", "Grab", "Shein", "Farfetch", "Klarna" ] }, "scores": { "agent_friendliness": 55, "pricing_transparency": 0, "setup_speed": 75, "docs_quality": 45, "procurement_friction": 25, "trust_readiness": 65, "best_for": [ "AI agents and automation - an agent-ready surface (MCP / llms.txt)", "Teams needing broad API coverage out of the box" ], "avoid_if": [ "You need transparent pricing up front", "You want to try it free before paying" ] }, "sources": [ { "field": "categories", "url": "https://www.checkout.com/technology/payouts", "excerpt": "Payouts is also built into our single, scalable Unified Payments API, which means that you can use the same integration for both your payments and payouts needs.", "confidence": "high" }, { "field": "categories", "url": "https://www.checkout.com/products/fraud-detection", "excerpt": "We offer both a free and a paid fraud management solution.", "confidence": "high" }, { "field": "supported_regions", "url": "https://www.checkout.com/products/acquiring", "excerpt": "Direct acquiring licenses in APAC, MENAP, UK and EEA, and the US", "confidence": "high" }, { "field": "self_serve_signup", "url": "https://www.checkout.com/get-test-account", "excerpt": "Get started in minutes with a test account and access the Dashboard right away.", "confidence": "medium" }, { "field": "vendor_description", "url": "https://www.checkout.com/", "excerpt": "Payment services to power your performance", "confidence": "high" }, { "field": "categories", "url": "https://www.checkout.com/products/issuing", "excerpt": "Bundle Payments and Issuing to move money within Checkout.com, helping finance teams improve cash flow management", "confidence": "high" }, { "field": "primary_use_cases", "url": "https://www.checkout.com/", "excerpt": "Ecommerce, Gaming, Marketplaces, Travel, Fintech, Crypto, Payment Facilitators", "confidence": "high" }, { "field": "supported_regions", "url": "https://www.checkout.com/products/acquiring", "excerpt": "57 domestic processing countries", "confidence": "high" }, { "field": "input_types", "url": "https://www.checkout.com/payment-method/accept", "excerpt": "SEPA direct debit, ACH (US), Przelewy24 (Poland), EPS (Austria), iDEAL (Netherlands), Bizum (Spain), and Swish (Sweden)", "confidence": "high" }, { "field": "sandbox_available", "url": "https://www.checkout.com/get-test-account", "excerpt": "You can sign up for a test account to gain access to the sandbox environment, where you can test API calls without affecting live data.", "confidence": "high" }, { "field": "pricing_model", "url": "https://www.checkout.com/pricing", "excerpt": "Your business deserves tailored pricing based on your needs. Create a plan by getting in touch with our team today.", "confidence": "high" }, { "field": "has_published_pricing", "url": "https://www.checkout.com/pricing", "excerpt": "Your business deserves tailored pricing based on your needs. Create a plan by getting in touch with our team today.", "confidence": "high" }, { "field": "input_types", "url": "https://www.checkout.com/payment-method/accept", "excerpt": "Apple Pay, Google Pay, PayPal, Alipay, WeChat Pay, and region-specific options including Kakao Pay, Dana, GCash, Touch 'n Go, TrueMoney, MB WAY, Octopus, PayNow, stc pay, Swish, Vipps MobilePay, TWINT, and Venmo", "confidence": "high" }, { "field": "webhooks_supported", "url": "https://www.checkout.com/docs/developer-resources/event-notifications/receive-webhooks/configure-your-webhook-server", "excerpt": "Checkout.com guarantees to send webhooks at least once, but the sequence may vary", "confidence": "high" }, { "field": "sdk_languages", "url": "https://github.com/checkout", "excerpt": "checkout-sdk-node, checkout-sdk-php, checkout-sdk-python, checkout-sdk-java, checkout-sdk-net, checkout-sdk-ruby, checkout-sdk-go", "confidence": "high" }, { "field": "pricing_model", "url": "https://www.checkout.com/pricing", "excerpt": "We price based on your business profile and risk category, nothing else.", "confidence": "high" }, { "field": "has_published_pricing", "url": "https://www.checkout.com/pricing", "excerpt": "Simple interchange++ fees — Transparent card association, processor, and interchange fees.", "confidence": "high" }, { "field": "requires_sales_call", "url": "https://www.checkout.com/pricing", "excerpt": "Your business deserves tailored pricing based on your needs. Create a plan by getting in touch with our team today.", "confidence": "high" }, { "field": "pci_dss", "url": "https://www.checkout.com/legal/certificates", "excerpt": "CKO Technology Services Ltd, a company within the Checkout.com group, is certified for Payment Card Industry Data Security Standards (PCI – DSS) as a Level 1 Service Provider.", "confidence": "high" }, { "field": "iso_27001", "url": "https://www.checkout.com/legal/privacy-policy", "excerpt": "Checkout's systems are also ISO27001 certified.", "confidence": "high" }, { "field": "soc2", "url": "https://www.checkout.com/legal/service-terms", "excerpt": "obtain the System and Organization Controls (SOC) 2 Report (or the report or other documentation describing the controls implemented by Checkout.com that replace or are substantially equivalent to SOC 2)", "confidence": "high" }, { "field": "gdpr", "url": "https://www.checkout.com/legal/privacy-policy", "excerpt": "reliance on EU Standard Contractual Clauses (SCCs) and UK Addendum to the EU SCCs for international data transfers from UK/EEA regions", "confidence": "high" }, { "field": "hipaa", "url": "https://www.checkout.com/legal/service-terms", "excerpt": null, "confidence": "low" }, { "field": "sla_published", "url": "https://www.checkout.com/blog/uptime-peak-season", "excerpt": "maintain an average uptime of 99.999% – and many merchants achieve 100% uptime", "confidence": "high" }, { "field": "supported_actions", "url": "https://api-reference.checkout.com/", "excerpt": "Payments: Create, list, capture, refund, void, reverse payments; Payment Sessions & Links: Hosted payment pages, payment links; Tokenization: Tokens, instruments, customers; Card Issuing: Cardholders, cards, controls, transactions, disputes", "confidence": "high" }, { "field": "free_tier_available", "url": "https://www.checkout.com/pricing", "excerpt": "Free for charities: Processing is complimentary for registered charities in operational countries.", "confidence": "high" }, { "field": "mcp_server_available", "url": "https://github.com/checkout", "excerpt": null, "confidence": "high" }, { "field": "known_restrictions", "url": "https://www.checkout.com/docs/developer-resources/sdks", "excerpt": "Frames will be deprecated on June 30, 2026, and users should upgrade to Flow", "confidence": "high" }, { "field": "auth_methods", "url": "https://www.checkout.com/docs/developer-resources/api/manage-api-keys/api-keys", "excerpt": "You can authenticate your calls to the Checkout.com API using public and secret API keys.", "confidence": "high" }, { "field": "base_url", "url": "https://api-reference.checkout.com/", "excerpt": "The base URLs you must use for your API calls to the sandbox and production environments are unique to you. Production: https://{prefix}.api.checkout.com/{path}", "confidence": "high" }, { "field": "api_version", "url": "https://api-reference.checkout.com/", "excerpt": "The API reference is v1.0.0", "confidence": "medium" }, { "field": "deprecation_policy_url", "url": "https://www.checkout.com/docs/resources/api-changes", "excerpt": "Checkout.com takes the utmost care in ensuring that changes to their APIs do not break integrations. In the event that a breaking change is unavoidable, they will contact you in advance.", "confidence": "medium" }, { "field": "sdk_packages", "url": "https://pypi.org/project/checkout-sdk/", "excerpt": "Checkout.com Python SDK. Install via: pip install checkout-sdk", "confidence": "high" }, { "field": "idempotency_supported", "url": "https://www.checkout.com/docs/developer-resources/api/idempotency", "excerpt": "To perform an idempotent payment or payment action request, provide a unique key in the Cko-Idempotency-Key HTTP header. By default, keys expire after 24 hours.", "confidence": "high" }, { "field": "error_format", "url": "https://www.checkout.com/docs/developer-resources/codes/error-codes", "excerpt": "The standard error response structure: {\"request_id\": \"0HL80RJLS76I7\", \"error_type\": \"request_invalid\", \"error_codes\": [\"payment_source_required\"]}", "confidence": "high" }, { "field": "webhook_signing", "url": "https://www.checkout.com/docs/developer-resources/event-notifications/receive-webhooks/configure-your-webhook-server", "excerpt": "Hash the payload with the SHA-256 hash function, using your webhook signature key as the hash key, then compare the resulting HMAC with the one received in the Cko-Signature header.", "confidence": "high" }, { "field": "webhook_events_url", "url": "https://www.checkout.com/docs/developer-resources/event-notifications/event-types", "excerpt": "Event types - Docs. This documentation lists the events related to your account for which Checkout.com can send you notifications.", "confidence": "high" }, { "field": "rate_limit_requests", "url": "https://support.checkout.com/hc/en-us/articles/25928089023378-What-is-the-API-rate-limit", "excerpt": "100 requests per second (RPS) total for GET operations – Used to retrieve data or resources. 100 RPS total for POST, PUT, and DELETE operations.", "confidence": "high" }, { "field": "requires_verification", "url": "https://support.checkout.com/hc/en-us/articles/15251090612882-Onboarding-overview", "excerpt": "Checkout.com conducts Know Your Customer (KYC) checks that identify and verify individuals who own and are responsible for running a business, with checks done to comply with regulations.", "confidence": "high" }, { "field": "data_retention_policy_url", "url": "https://www.checkout.com/legal/privacy-policy", "excerpt": "When deciding how long to keep your personal data, we think about how much and what kind of personal data we have, how sensitive it is, the risk of unauthorized use or disclosure.", "confidence": "high" }, { "field": "requires_sales_call", "url": "https://support.checkout.com/hc/en-us/articles/15251090612882-Onboarding-overview", "excerpt": "As an acquirer and merchant account provider, Checkout.com operates in compliance with published card schemes, government and other local rules, requiring thorough checks on all businesses", "confidence": "high" }, { "field": "pci_dss", "url": "https://www.checkout.com/legal/privacy-policy", "excerpt": "We are PCI DSS (Payment Card Industry Data Security Standard) Level 1 compliant, which is the highest standard set by the payment card industry", "confidence": "high" }, { "field": "iso_27001", "url": "https://www.checkout.com/legal/service-terms", "excerpt": "maintain (A) ISO 27001 certification (or such alternative certification standard as is materially equivalent to ISO 27001)", "confidence": "high" }, { "field": "soc2", "url": "https://www.checkout.com/legal/service-terms", "excerpt": "Checkout.com makes available a copy of its ISO 27001 certification and, subject to NDA, SOC 2 Type II report upon written request from customers to verify compliance with Data Protection Law.", "confidence": "high" }, { "field": "gdpr", "url": "https://www.checkout.com/blog/gdpr-and-payments", "excerpt": "We mapped our data processing activities, including the purpose for processing personal data and detailed descriptions of the activities data processors are conducting on our behalf.", "confidence": "high" }, { "field": "sla_published", "url": "https://www.checkout.com/legal/service-terms", "excerpt": "Beta Services explicitly state: will not be subject to any service levels or credits agreed in respect of any other Services.", "confidence": "high" }, { "field": "documented_rate_limits", "url": "https://www.checkout.com/docs/developer-resources/api/api-rate-limits", "excerpt": "100 requests per second (RPS) total for GET operations and 100 RPS total for POST, PUT, and DELETE operations. Lower rate limits are applied to the sandbox environment.", "confidence": "high" }, { "field": "supported_actions", "url": "https://www.checkout.com/products/authentication-3ds", "excerpt": "Supports PAN, Tokens, and Network Tokens; Device biometrics: fingerprinting and facial recognition; Browser-based authentication", "confidence": "high" }, { "field": "free_tier_available", "url": "https://www.checkout.com/products/fraud-detection", "excerpt": "Fraud Detection, the free version, comes with preset configurations, so you can go live immediately.", "confidence": "high" }, { "field": "known_restrictions", "url": "https://www.checkout.com/legal/certificates", "excerpt": "CKO Technology Services Ltd, a company within the Checkout.com group, is certified for Payment Card Industry Data Security Standards (PCI – DSS) as a Level 1 Service Provider.", "confidence": "high" }, { "field": "auth_methods", "url": "https://api-reference.checkout.com/", "excerpt": "The API supports four distinct approaches: Public Keys (client-side), Secret API Keys (server-to-server), OAuth 2.0 (client credentials flow), and Session Secrets.", "confidence": "high" }, { "field": "auth_docs_url", "url": "https://www.checkout.com/docs/developer-resources/api/manage-api-keys", "excerpt": "Manage API keys - Docs", "confidence": "high" }, { "field": "base_url", "url": "https://github.com/checkout/checkout-sdk-node", "excerpt": "Sandbox: https://{prefix}.api.sandbox.checkout.com — Production: https://{prefix}.api.checkout.com. The {prefix} is a unique alphanumeric identifier specific to each Checkout.com account.", "confidence": "high" }, { "field": "versioning_scheme", "url": "https://www.checkout.com/docs/developer-resources/api/api-endpoints", "excerpt": "Rather than using explicit versioning in the URL path (like /v1/ or /v2/), Checkout.com takes a different approach. The platform takes care to ensure changes to APIs don't break integrations.", "confidence": "medium" }, { "field": "sdk_packages", "url": "https://github.com/checkout", "excerpt": "Official SDKs: checkout-sdk-node, checkout-sdk-python, checkout-sdk-java, checkout-sdk-net, checkout-sdk-php, checkout-sdk-go, checkout-sdk-ruby — all under the checkout GitHub organization.", "confidence": "high" }, { "field": "quickstart_url", "url": "https://www.checkout.com/docs/get-started", "excerpt": "Get started - Docs. Checkout.com's getting started documentation covers Payments, Developer resources, Funds management, Business operations, Card issuing, and Platforms.", "confidence": "high" }, { "field": "idempotency_supported", "url": "https://www.checkout.com/docs/developer-resources/api/idempotency", "excerpt": "Subsequent requests with the same key will return the same HTTP status code and response body as the original request, providing that it was processed successfully.", "confidence": "high" }, { "field": "error_format", "url": "https://www.checkout.com/docs/developer-resources/codes/api-response-codes", "excerpt": "If you receive an unsuccessful 4xx HTTP response, the response body may contain an error_codes field that specifies the reason why the request failed.", "confidence": "high" }, { "field": "webhook_signing", "url": "https://www.checkout.com/docs/developer-resources/event-notifications/receive-webhooks/configure-your-webhook-server", "excerpt": "The HMAC is sent in the hex-encoded (Base16) Cko-Signature header. Checkout.com generates a unique HMAC signature, using the SHA-256 algorithm and the secret key.", "confidence": "high" }, { "field": "rate_limit_requests", "url": "https://www.checkout.com/docs/developer-resources/api/api-rate-limits", "excerpt": "The API applies a default rate limit of 100 requests per second (RPS) total for GET operations, and 100 RPS total for POST, PUT, and DELETE operations.", "confidence": "high" }, { "field": "rate_limit_window", "url": "https://www.checkout.com/docs/developer-resources/api/api-rate-limits", "excerpt": "The API applies a default rate limit of 100 requests per second (RPS) total for GET operations, and 100 RPS total for POST, PUT, and DELETE operations.", "confidence": "high" }, { "field": "requires_verification", "url": "https://www.checkout.com/blog/kyc-verification-explained", "excerpt": "During onboarding, Checkout.com conducts financial crime compliance and anti-money laundering checks such as KYC, know your business (KYB), PEPs, and sanctions, and if successful, payment capabilities are enabled.", "confidence": "high" }, { "field": "starting_price_usd", "url": "https://www.checkout.com/pricing", "excerpt": "Your business deserves tailored pricing based on your needs. Create a plan by getting in touch with our team today.", "confidence": "high" }, { "field": "launched_at", "url": "https://en.wikipedia.org/wiki/Checkout.com", "excerpt": "Checkout.com was established in 2009 as Opus Payments by Swiss founder Guillaume Pousaz in Singapore. The company rebranded to its current name in 2012.", "confidence": "high" }, { "field": "notable_customers", "url": "https://www.checkout.com/newsroom/checkout-com-returns-to-full-year-profitability-and-surpasses-300b-in-volume-as-it-positions-for-the-era-of-agentic-commerce", "excerpt": "Checkout.com now partners with over 1,000 enterprise merchants, including Uber, eBay, Spotify, Temu, Pinterest, HelloFresh, ASOS, and Vinted.", "confidence": "high" }, { "field": "launched_at", "url": "https://www.checkout.com/newsroom/checkout-com-raises-1-billion-in-series-d-amid-major-us-market-push", "excerpt": "Checkout.com launched in 2012 and now has a team of 750 people across 13 offices worldwide, offering local expertise where it's needed.", "confidence": "high" }, { "field": "notable_customers", "url": "https://www.checkout.com/newsroom/checkout-com-raises-1-billion-in-series-d-amid-major-us-market-push", "excerpt": "Checkout.com serves large-scale ecommerce and services merchants like Netflix, Farfetch, Grab, NetEase, Pizza Hut, Shein, Siemens and Sony.", "confidence": "high" }, { "field": "notable_customers", "url": "https://www.checkout.com/", "excerpt": "Homepage showcases logos for: Microsoft, Spotify, eBay, Uber, Adidas, IKEA, Klarna, Samsung, Alibaba, Farfetch, Wise, Vinted, Shein, Grab.", "confidence": "high" } ], "fields_not_found": [ "hipaa", "enterprise_plan_available", "minimum_commitment", "sla_url", "ga_date", "starting_price_usd", "price_basis", "mcp_url", "free_tier_limit" ], "source_confidence": "high", "last_verified_at": "2026-06-21T00:00:00.000Z", "contribute": { "note": "This data is crowd-editable. Suggest corrections or leave a review via these endpoints - no auth required, requests are rate-limited, and every submission is reviewed before it goes live. For a field edit, {field} is any key in this response and a citation is required.", "endpoints": [ { "action": "review", "label": "Leave a review or comment", "method": "POST", "url": "https://apio.sh/api/feedback/checkout-com", "example_body": { "kind": "review", "rating": 5, "body": "Your experience with this API…" } }, { "action": "field_edit", "label": "Suggest a correction to a field (cite a source)", "method": "POST", "url": "https://apio.sh/api/suggest/checkout-com/{field}", "example_body": { "value": "corrected value", "citations": [ { "url": "https://source.example/page", "excerpt": "supporting quote" } ], "note": "what changed and why" } }, { "action": "new_api", "label": "Suggest a new API to add (only name is required - send as much as you can cite)", "method": "POST", "url": "https://apio.sh/api/suggest/api", "example_body": { "value": { "name": "Acme Email API", "website_url": "https://acme.example", "vendor_name": "Acme", "categories": [ "email" ], "pricing_model": "usage_based", "has_published_pricing": true, "free_tier_available": true, "price_points": [ { "plan": "Pay as you go", "item": "1,000 emails", "amount_usd": 1, "per": "1,000 emails", "source_url": "https://acme.example/pricing" } ], "soc2": "type_2", "docs_url": "https://docs.acme.example" }, "citations": [ { "url": "https://acme.example/pricing", "excerpt": "$1 per 1,000 emails" } ] }, "value_schema": [ { "field": "name", "type": "string", "label": "Product name (the only required field)" }, { "field": "website_url", "type": "string", "label": "Marketing website URL" }, { "field": "vendor_name", "type": "string", "label": "Company/vendor name behind the product" }, { "field": "vendor_description", "type": "string", "label": "One-line description, quoted from the vendor" }, { "field": "categories", "type": "string[]", "label": "Category/leaf slugs it belongs to, e.g. [\"email\",\"sms\"]" }, { "field": "primary_use_cases", "type": "string[]", "label": "What it's used for" }, { "field": "supported_actions", "type": "string[]", "label": "Concrete API actions/capabilities" }, { "field": "supported_regions", "type": "string[]", "label": "Countries/regions/data-residency" }, { "field": "supported_languages", "type": "string[]", "label": "Human/spoken languages supported" }, { "field": "input_types", "type": "string[]", "label": "Accepted input types/formats" }, { "field": "output_types", "type": "string[]", "label": "Produced output types/formats" }, { "field": "webhooks_supported", "type": "bool", "label": "Supports webhooks?" }, { "field": "sandbox_available", "type": "bool", "label": "Dedicated sandbox/test mode?" }, { "field": "sdk_languages", "type": "string[]", "label": "Languages with an official SDK" }, { "field": "mcp_server_available", "type": "bool", "label": "Official MCP server?" }, { "field": "pricing_model", "type": "enum", "label": "Pricing model", "values": [ "usage_based", "subscription", "seat_based", "hybrid", "contact_sales" ] }, { "field": "has_published_pricing", "type": "bool", "label": "Concrete prices published publicly?" }, { "field": "free_tier_available", "type": "bool", "label": "Recurring/perpetual free tier (not a trial)?" }, { "field": "free_tier_details", "type": "string", "label": "What the free tier includes" }, { "field": "minimum_commitment", "type": "string", "label": "Any stated minimum spend/commitment" }, { "field": "self_serve_signup", "type": "bool", "label": "Get an API key without talking to sales?" }, { "field": "requires_sales_call", "type": "bool", "label": "Does going live require sales?" }, { "field": "enterprise_plan_available", "type": "bool", "label": "Named enterprise tier?" }, { "field": "starting_price_usd", "type": "number", "label": "Lowest published paid entry price (USD number)" }, { "field": "price_basis", "type": "string", "label": "Unit the starting price is per, e.g. '1,000 emails'" }, { "field": "free_tier_limit", "type": "string", "label": "Free-tier ceiling in literal terms" }, { "field": "price_points", "type": "object[]", "label": "Structured prices: [{plan,item,amount_usd,amount_percent,per,source_url}]" }, { "field": "soc2", "type": "enum", "label": "SOC 2 status", "values": [ "type_2", "type_1", "in_progress", "none", "unknown" ] }, { "field": "hipaa", "type": "bool", "label": "HIPAA (e.g. BAA available)?" }, { "field": "gdpr", "type": "bool", "label": "GDPR compliance stated?" }, { "field": "iso_27001", "type": "bool", "label": "ISO 27001 certified?" }, { "field": "pci_dss", "type": "bool", "label": "PCI DSS compliant?" }, { "field": "sla_published", "type": "bool", "label": "Published SLA / uptime commitment?" }, { "field": "documented_rate_limits", "type": "string", "label": "Documented rate limits, quoted" }, { "field": "known_restrictions", "type": "string[]", "label": "Notable documented restrictions/limits" }, { "field": "auth_methods", "type": "string[]", "label": "Auth methods", "values": [ "api_key", "oauth2", "jwt", "basic", "hmac_signature", "mtls", "session" ] }, { "field": "api_style", "type": "enum", "label": "Primary API style", "values": [ "rest", "graphql", "grpc", "soap", "websocket" ] }, { "field": "base_url", "type": "string", "label": "API root/base URL" }, { "field": "api_version", "type": "string", "label": "Current API version string" }, { "field": "quickstart_url", "type": "string", "label": "Quickstart / hello-world URL" }, { "field": "docs_url", "type": "string", "label": "Developer docs URL" }, { "field": "api_reference_url", "type": "string", "label": "API reference URL" }, { "field": "openapi_spec_url", "type": "string", "label": "OpenAPI spec URL" }, { "field": "changelog_url", "type": "string", "label": "Changelog URL" }, { "field": "status_page_url", "type": "string", "label": "Status page URL" }, { "field": "notable_customers", "type": "string[]", "label": "Named public customers" }, { "field": "launched_at", "type": "string", "label": "Launch date (ISO date or year)" } ] }, { "action": "token", "label": "Optional - raise your rate limit", "method": "GET", "url": "https://apio.sh/api/feedback/token" } ] } }