Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: CF Exclusion Check Batch API
version: 1.0.0
description: Pay-per-call screening against the HHS-OIG LEIE and SAM.gov exclusion lists.
x-guidance: Call GET /v1/health first (free) to confirm the service is live and see loaded row counts. GET /.well-known/x402 carries the exact x402 v2 payment requirements. A bare unpaid call to /v1/check or /v1/report returns 402, not a validation error, even with no query parameters. Add ?v=2 to any priced endpoint for the shared CF Soft envelope shape, identical across every CF Soft booth — see this repo's README for the response shape.
contact:
email: info@cfaisolutions.com
servers:
- url: https://exclusions.cfsoft.us
tags:
- name: Batch
paths:
/v1/batch:
post:
summary: Screen 2-200 items in one call.
parameters:
- name: v
in: query
schema:
type: string
enum:
- '2'
description: Set to "2" for the shared CF Soft envelope shape (hoisted service/sources/limits/as_of, one result object per item with its own verdict/confidence/basis/counts/records). Omit for today's existing response shape, unchanged.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
items:
type: array
minItems: 2
maxItems: 200
required:
- items
x-payment-info:
protocols:
- x402
price:
mode: fixed
currency: USD
amount: 0.3
x-note: Fixed amount shown is the lowest tier; the actual charge is tiered by item count — see the summary and the live payment-required header.
responses:
'200':
description: Batch screening result, one entry per input item.
'400':
description: Item count out of range, or every item invalid. Not charged.
'402':
description: Payment required. See the `payment-required` header for the exact tiered amount.
tags:
- Batch
operationId: postV1Batch
x-operation-id-source: derived