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 Report 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: Report
paths:
/v1/report:
get:
summary: Full screening report
parameters:
- name: name
in: query
schema:
type: string
description: Person or business name. "John Smith" or "Smith, John".
- name: npi
in: query
schema:
type: string
description: 10-digit National Provider Identifier.
- name: dob
in: query
schema:
type: string
description: Date of birth, YYYYMMDD.
- name: state
in: query
schema:
type: string
description: Two-letter state code. Corroborates only.
- name: uei
in: query
schema:
type: string
description: SAM.gov Unique Entity Identifier, 12 alphanumeric characters.
- name: cage
in: query
schema:
type: string
description: CAGE code, 5 alphanumeric characters.
- name: v
in: query
schema:
type: string
enum:
- '2'
description: Set to "2" for the shared CF Soft envelope response shape (service/version/verdict/confidence/basis/counts/records/sources/limits/as_of), used identically across every CF Soft booth. Omit for today's existing response shape, unchanged.
x-payment-info:
protocols:
- x402
price:
mode: fixed
currency: USD
amount: 0.5
responses:
'200':
description: Screening result.
'402':
description: Payment required. See the `payment-required` header.
tags:
- Report
operationId: getV1Report
x-operation-id-source: derived