PatchOps Business Audit data contract

Provenance

PublisherPatchOps Business Audit composite

Freshness & coverage

FreshnessNear real-time — Assembled on request from independently cached live or scheduled sources; the composite cache is 15 minutes.

GeographicGlobal, United States, Texas

Temporal… → present — Varies by selected source and record type; the result preserves source filing dates and coverage caveats.

AuthenticationNo credentials required

Caveats

⚠ This composite is a public-record screening aid, not a credit report or dispositive compliance determination.

Methods (3)

runPublicAudit

read

Run the complete public-source business audit in one call.

Required paramslegalName

Entitiesbusiness, audit-evidence

Paginationnone

FreshnessNear real-time

Input schema

{
  "type": "object",
  "properties": {
    "legalName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "jurisdiction": {
      "type": "string",
      "maxLength": 100
    },
    "city": {
      "type": "string",
      "maxLength": 80
    },
    "state": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Za-z]{2}$"
    },
    "country": {
      "type": "string",
      "minLength": 2,
      "maxLength": 3,
      "pattern": "^[A-Za-z]{2,3}$",
      "description": "ISO country code. Two-letter US is translated to the SAM.gov three-letter USA code."
    },
    "taxpayerNumber": {
      "type": "string",
      "pattern": "^\\d{11}$"
    },
    "uei": {
      "type": "string",
      "pattern": "^[A-Za-z0-9]{12}$"
    },
    "cageCode": {
      "type": "string",
      "pattern": "^[A-Za-z0-9]{5}$"
    },
    "lei": {
      "type": "string",
      "pattern": "^[A-Za-z0-9]{20}$"
    },
    "cik": {
      "type": "string",
      "pattern": "^\\d{1,10}$"
    },
    "rrcOperatorNumber": {
      "type": "string",
      "pattern": "^\\d{6}$"
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "csl",
          "sam",
          "texas-comptroller",
          "courtlistener",
          "gleif",
          "sec",
          "rrc"
        ]
      },
      "uniqueItems": true,
      "maxItems": 7
    },
    "sourceTimeoutMs": {
      "type": "integer",
      "minimum": 2000,
      "maximum": 15000
    }
  },
  "required": [
    "legalName"
  ],
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "contractVersion": {
      "const": "business-audit.v1"
    },
    "subject": {
      "type": "object",
      "additionalProperties": true
    },
    "summary": {
      "type": "object",
      "additionalProperties": true
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "credit": {
      "type": "object",
      "additionalProperties": true
    },
    "generatedAt": {
      "type": "string"
    },
    "disclaimer": {
      "type": "string"
    }
  },
  "required": [
    "contractVersion",
    "subject",
    "summary",
    "checks",
    "errors",
    "credit",
    "generatedAt",
    "disclaimer"
  ],
  "additionalProperties": true
}

⚠ Potential matches require identifier verification.
⚠ SEC metrics retain source filing periods and are not converted into a score.
⚠ The result is not a credit report or legal determination.

Returns evidence and coverage, never a synthetic score.

getCreditReadiness

read

Describe the gated credit tier and onboarding requirements.

Entitiescredit-readiness

Paginationnone

FreshnessStatic

Output schema

{
  "type": "object",
  "properties": {
    "tier": {
      "const": "gated_credit_data"
    },
    "status": {
      "type": "string"
    },
    "score": {
      "type": "null"
    },
    "reason": {
      "type": "string"
    },
    "potentialProviders": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "requirements": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "design": {
      "type": "string"
    }
  },
  "required": [
    "tier",
    "status",
    "score",
    "reason",
    "potentialProviders",
    "requirements",
    "design"
  ],
  "additionalProperties": true
}

getServiceInfo

read

Describe source coverage, resolution, concurrency, and evidence semantics.

Entitiesservice-metadata

Paginationnone

FreshnessStatic

Output schema

{
  "type": "object",
  "properties": {
    "service": {
      "type": "string"
    },
    "purpose": {
      "type": "string"
    },
    "methods": {
      "type": "object",
      "additionalProperties": true
    },
    "sources": {
      "type": "object",
      "additionalProperties": true
    },
    "behavior": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "service",
    "purpose",
    "methods",
    "sources",
    "behavior"
  ],
  "additionalProperties": true
}