> ## Documentation Index
> Fetch the complete documentation index at: https://docs.herondata.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get EndUser background check dashboard payload

> Get the background check results for an end user, including the screening run status, each subject's identity matches and records, and the outcome of each policy check.




## OpenAPI

````yaml https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check
openapi: 3.0.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data API
  version: '2021-07-19'
servers:
  - description: Production
    url: https://app.herondata.io
security:
  - ApiKeyAuth:
      - key_XXX
externalDocs:
  description: Read Tutorial
  url: https://docs.herondata.io/
paths:
  /api/end_users/{end_user_heron_id}/background_check:
    get:
      tags:
        - EndUsers
      summary: Get EndUser background check dashboard payload
      description: >
        Get the background check results for an end user, including the
        screening run status, each subject's identity matches and records, and
        the outcome of each policy check.
      parameters:
        - description: The Heron ID of the end user
          in: path
          name: end_user_heron_id
          required: true
          schema:
            type: string
        - description: >-
            If true, each record additionally carries its full vendor detail
            under `detail`
          in: query
          name: include_section_detail
          required: false
          schema:
            default: false
            type: boolean
        - description: >
            If true, each subject's search trail is taken from that subject's
            most recent run that used an automatic identity search, ignoring
            runs where the subject was manually pinned. Records and policy
            outcomes are unaffected.
          in: query
          name: exclude_manual
          required: false
          schema:
            default: false
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundCheckResponseSchema'
          description: OK
        '404':
          description: End user not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BackgroundCheckResponseSchema:
      description: >-
        Dates use YYYY-MM-DD. Amounts are decimal strings. Nullable source
        fields return null. SSNs remain masked; full SSNs never appear.
      properties:
        affiliations:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckAffiliationsBlock'
          description: >-
            Reports requested for the subjects' affiliated businesses and
            people; null when none requested.
          nullable: true
        end_user_id:
          description: Heron ID of the end user
          type: string
        overall:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckOverall'
          description: >-
            Headline outcome across all background checks; null until an outcome
            is available.
          nullable: true
        policy:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckPolicy'
          description: >-
            Outcome of each configured background-check policy check; null until
            available.
          nullable: true
        processing_stage:
          description: >-
            While processing: searching, pulling_reports, or analysing. Null
            otherwise.
          enum:
            - searching
            - pulling_reports
            - analysing
            - null
          nullable: true
          type: string
        status:
          description: >-
            Run lifecycle: never_run, processing, succeeded, failed, or
            missing_input_data.
          enum:
            - never_run
            - processing
            - succeeded
            - failed
            - missing_input_data
          type: string
        subjects:
          description: >-
            One entry per searched subject: owner_1, owner_2 when present, and
            business.
          items:
            $ref: '#/components/schemas/BackgroundCheckSubject'
          type: array
      required:
        - end_user_id
        - status
        - subjects
      type: object
    BackgroundCheckAffiliationsBlock:
      properties:
        business:
          description: Reports requested for affiliated businesses, in request order.
          items:
            $ref: '#/components/schemas/BackgroundCheckAffiliateReport'
          type: array
        person:
          description: Reports requested for affiliated people, in request order.
          items:
            $ref: '#/components/schemas/BackgroundCheckAffiliateReport'
          type: array
      required:
        - business
        - person
      type: object
    BackgroundCheckOverall:
      properties:
        check_counts:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckCheckCounts'
          description: Policy check totals.
        result:
          description: 'Headline result: passed, review_required, failed, or missing_data.'
          enum:
            - passed
            - failed
            - review_required
            - missing_data
            - execution_error
            - skipped
        severity:
          description: 'Highest severity found: none, low, medium, or high.'
          enum:
            - none
            - low
            - medium
            - high
          type: string
      required:
        - check_counts
        - result
        - severity
      type: object
    BackgroundCheckPolicy:
      properties:
        checks:
          description: One entry per configured policy check.
          items:
            $ref: '#/components/schemas/BackgroundCheckCheck'
          type: array
        result:
          description: >-
            Worst configured policy outcome: passed, review_required, failed, or
            missing_data.
          enum:
            - passed
            - failed
            - review_required
            - missing_data
            - execution_error
            - skipped
      required:
        - checks
        - result
      type: object
    BackgroundCheckSubject:
      properties:
        application:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckApplication'
          description: Identity searched, taken from the application data.
        candidates:
          description: >-
            Every deduplicated candidate returned across the subject's searches,
            with its match score.
          items:
            $ref: '#/components/schemas/BackgroundCheckCandidate'
          type: array
        case_ref:
          description: Reserved case reference; null in normal use.
          nullable: true
          type: string
        decision:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckDecision'
          description: >-
            Audit of how the winning candidate was selected; null when no
            scoring decision was needed.
          nullable: true
        duns_numbers:
          description: >-
            D&B DUNS numbers of the resolved business. Empty for person
            subjects.
          items:
            type: string
          type: array
        firmographics:
          allOf:
            - $ref: '#/components/schemas/BusinessFirmographics'
          description: Business facts grouped by source; null for person subjects.
          nullable: true
        key:
          description: 'Subject identifier: owner_1, owner_2, or business.'
          enum:
            - owner_1
            - owner_2
            - business
          type: string
        kind:
          description: 'Subject type: person or business.'
          enum:
            - person
            - business
          type: string
        name:
          description: >-
            Label for the subject: the matched record's filed name for a
            business, the searched name for a person. Null when neither is
            known.
          nullable: true
          type: string
        related_party_officers:
          description: Business-filing officers who match a related party on the deal.
          items:
            type: string
          type: array
        resolution:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckResolution'
          description: How and whether the subject was matched.
        role:
          description: Subject's role on the deal; null when unavailable.
          nullable: true
          type: string
        searches:
          description: >-
            Search waterfall in attempted order, including each step's inputs
            and outcome.
          items:
            $ref: '#/components/schemas/SearchAttempt'
          type: array
        sections:
          description: Report findings grouped by record type.
          items:
            $ref: '#/components/schemas/BackgroundCheckSection'
          type: array
        unreported_officers:
          description: >-
            Officers on active business filings who are not listed as owners on
            the application. Empty for person subjects.
          items:
            type: string
          type: array
      required:
        - application
        - candidates
        - firmographics
        - key
        - kind
        - resolution
        - searches
        - sections
        - unreported_officers
      type: object
    BackgroundCheckAffiliateReport:
      properties:
        kind:
          description: Whether the report is for an affiliated business or person.
          enum:
            - person
            - business
          type: string
        name:
          description: Name of the affiliate the report was requested for.
          type: string
        ref:
          description: >-
            Stable reference for this affiliate report request; echo it when
            confirming a candidate or removing the request.
          type: string
        status:
          description: >-
            Report lifecycle: pending until the next screening run pulls it,
            succeeded when the report is ready, not_found when no confident
            match was found (a candidate can be confirmed), or failed.
          enum:
            - pending
            - succeeded
            - not_found
            - failed
          type: string
        subject:
          allOf:
            - $ref: '#/components/schemas/AffiliateSubject'
          description: >-
            The affiliate's search trail and report findings, shaped like a
            subject; null when it failed.
          nullable: true
      required:
        - kind
        - name
        - ref
        - status
      type: object
    BackgroundCheckCheckCounts:
      properties:
        fail:
          description: Number of failed policy checks.
          type: integer
        pass:
          description: Number of passed policy checks.
          type: integer
        review:
          description: Number of policy checks requiring review.
          type: integer
      required:
        - fail
        - pass
        - review
      type: object
    BackgroundCheckCheck:
      properties:
        area:
          description: Display group for the policy check.
          type: string
        area_sub:
          description: Display subgroup for the policy check; null when the check has none.
          nullable: true
          type: string
        auto_reason:
          description: Explanation for the automated policy outcome; null when unavailable.
          nullable: true
          type: string
        auto_status:
          description: 'Automated outcome: pass, review_required, failed, or missing_data.'
          enum:
            - pass
            - failed
            - review_required
            - missing_data
        check_text:
          description: Human-readable description of what the policy check evaluates.
          type: string
        evidence_subjects:
          description: >-
            Per-subject pointers to the findings that produced the policy
            outcome.
          items:
            $ref: '#/components/schemas/BackgroundCheckEvidence'
          type: array
        id:
          description: Stable check ID in <subject_tier>:<signal> form.
          type: string
        override:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckOverride'
          description: Manual reviewer override; null when the automated outcome stands.
          nullable: true
        rule:
          description: >-
            Configured threshold or rule expression; null when the check has
            none.
          nullable: true
          type: string
        signal:
          description: Underlying attribute evaluated by the policy check.
          type: string
      required:
        - area
        - auto_status
        - check_text
        - evidence_subjects
        - id
        - signal
      type: object
    BackgroundCheckApplication:
      description: >-
        The application identity used for the search. All fields are nullable;
        SSNs remain masked.
      properties:
        address:
          description: >-
            Application address used to search this subject; null when
            unavailable.
          nullable: true
          type: string
        business_name:
          description: Application business name; null for person subjects.
          nullable: true
          type: string
        date_of_birth:
          description: Date of birth; null when unavailable.
          format: date
          nullable: true
          type: string
        ein:
          description: >-
            Employer Identification Number used for the search; null when
            unavailable.
          nullable: true
          type: string
        email:
          description: Email address; null when unavailable.
          nullable: true
          type: string
        name:
          description: Application person name; null for business subjects.
          nullable: true
          type: string
        owner:
          description: >-
            Named owner used when searching a business subject; null for person
            subjects.
          nullable: true
          type: string
        phone:
          description: Phone number; null when unavailable.
          nullable: true
          type: string
        ssn:
          description: >-
            Masked SSN. Only the first five digits are ever held or returned;
            the full SSN never appears.
          nullable: true
          type: string
        state:
          description: Application state; null when unavailable.
          nullable: true
          type: string
      type: object
    BackgroundCheckCandidate:
      description: >-
        One deduplicated candidate across the subject's search attempts,
        including its match score.
      properties:
        address:
          description: Candidate address returned by the search.
          nullable: true
          type: string
        aka_names:
          description: Also-known-as names on the candidate.
          items:
            type: string
          type: array
        basis:
          description: >-
            Search basis that returned the candidate, such as the matching name
            variant.
          nullable: true
          type: string
        duns_numbers:
          description: >-
            D&B DUNS numbers from the business candidate; empty for person
            candidates.
          items:
            type: string
          type: array
        entity_id:
          description: Source entity identifier; null when unavailable.
          nullable: true
          type: string
        group_id:
          description: Source record-group identifier; null when unavailable.
          nullable: true
          type: string
        id:
          description: >-
            Stable candidate reference: source entity ID, or group ID as
            fallback.
          type: string
        is_limited:
          description: Whether the candidate is a limited-data record; null when unknown.
          nullable: true
          type: boolean
        matched_address:
          description: >-
            Non-primary address that matched the search; null when the primary
            address matched.
          nullable: true
          type: string
        matched_aka_name:
          description: >-
            Also-known-as name that matched the search; null when the primary
            name matched.
          nullable: true
          type: string
        name:
          description: Candidate name returned by the search.
          nullable: true
          type: string
        rank:
          description: Candidate's position in the search results.
          nullable: true
          type: integer
        relevance:
          description: Source relevance score for the search hit.
          nullable: true
          type: integer
        score:
          allOf:
            - $ref: '#/components/schemas/CandidateScore'
          description: Match score audit; null when the candidate was not scored.
          nullable: true
      required:
        - id
      type: object
    BackgroundCheckDecision:
      properties:
        anchored_by:
          description: >-
            Anchor identifier that resolved the match outright: ein or
            corp_number_echo; null when unanchored.
          nullable: true
          type: string
        near_tie:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckNearTie'
          description: Top-two score comparison; null when the candidates were not close.
          nullable: true
        pooled_count:
          description: Number of candidates pooled and scored.
          nullable: true
          type: integer
        tie_break:
          description: >-
            How the winner separated from the runner-up; null when there was no
            winner/runner-up.
          enum:
            - score
            - key_order
            - flag_probe
            - null
          nullable: true
          type: string
      type: object
    BusinessFirmographics:
      properties:
        accounting_firm:
          description: >-
            Name of the business's accounting firm as recorded by the source.
            Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        address:
          description: Business addresses by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        alternate_names:
          description: >-
            Other names the business is recorded under, such as a trading name
            or a former name, by source. Empty when no source reported any.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        annual_report_date:
          description: >-
            Dates the business last filed an annual report with the registry, in
            ISO 8601 format. Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedDateValue'
          type: array
        associated_entities:
          description: >-
            Names of other entities the registry links to this filing, one entry
            each. Empty when no source reported any.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        authorised_capital:
          description: >-
            Capital the registry authorises the business to raise, in whole
            units of currency. Empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        bank:
          description: >-
            Name of the business's bank as recorded by the source. Empty when no
            source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        business_description:
          description: >-
            How the source describes what the business does, in its own words.
            Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        care_of:
          description: >-
            Care-of line on the registry filing address. Empty when no source
            reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        classification:
          description: >-
            How the company registry classifies the entity. Source-verbatim,
            with no fixed vocabulary; empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        corp_lifetime:
          description: >-
            How long the registry records the entity as existing for, such as
            perpetual. Empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        duns:
          description: D&B DUNS numbers by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        duration_date:
          description: >-
            Date the registry records the entity as ceasing, where its life is
            fixed rather than perpetual. Source-verbatim; empty when no source
            reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        effective_date:
          description: >-
            Dates the registry filing took effect, by source. Often the same as
            the filing date; empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedDateValue'
          type: array
        email:
          description: >-
            Email addresses recorded for the business, by source. Empty when no
            source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        employees:
          description: >-
            Employee counts by source. A source may supply earlier counts
            alongside its current one; the as_of date distinguishes them.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        employees_here:
          description: >-
            Employees at this location only, by source, where the source reports
            it separately from the organisation-wide count. Empty when no source
            reported it.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        employment_growth:
          description: >-
            Headcount growth as the source expressed it, usually a percentage.
            Source-verbatim; empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        establishment_type:
          description: >-
            How the source classifies the site, such as a single location, a
            headquarters, or a branch. Source-verbatim, with no fixed
            vocabulary; empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        fein:
          description: >-
            Federal Employer Identification Numbers recorded for the business,
            by source. A business may have more than one on file. Empty when no
            source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        filing_county:
          description: >-
            County the original registry filing was made in. Empty when no
            source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        filing_date:
          description: >-
            Dates the business's formation document was filed with the company
            registry, by source. A record may carry a filing date without an
            incorporation date, or the reverse; empty when neither is reported.
          items:
            $ref: '#/components/schemas/SourcedDateValue'
          type: array
        filing_history:
          description: >-
            Amendments and other events the registry recorded against the
            filing, one entry each, in source order. An entry's as_of is the
            date of that amendment where the source gives one. Empty when no
            source reported any.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        filing_office:
          description: >-
            Names of the registry offices holding the filing, by source. Empty
            when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        filing_office_address:
          description: >-
            Addresses of the registry offices holding the filing, by source.
            This is the office's own address, not the business's. Empty when no
            source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        filing_state:
          description: >-
            States the registry filing was made in, by source. This is where the
            document was filed, which is not always the state of incorporation.
            Empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        filing_type:
          description: >-
            Kind of document filed with the registry. Source-verbatim; empty
            when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        fiscal_year_end:
          description: >-
            When the business's financial year ends, as the source expressed it.
            Empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        franchise_status:
          description: >-
            Status of the business's franchise tax with the registry. Empty when
            no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        headquarters:
          description: >-
            Name of the business's headquarters where the source records it as a
            branch. Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        incorporation_date:
          description: >-
            Dates the business was incorporated, by source. Empty when no source
            reported one, which happens where a registry record carries only the
            date its formation document was filed.
          items:
            $ref: '#/components/schemas/SourcedDateValue'
          type: array
        industry_group:
          description: Industry groups by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        invested_amount:
          description: >-
            Amount recorded as invested in the business, in whole units of
            currency. Empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        last_annual_financial_date:
          description: >-
            Date of the most recent annual financial figures the source holds,
            in ISO 8601 format. Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedDateValue'
          type: array
        legal_immediate_parent:
          description: Legal immediate parent names by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        legal_immediate_parent_indicator:
          description: Legal immediate parent indicators by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        legal_name:
          description: Legal business names by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        legal_status:
          description: Business legal statuses by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        legal_ultimate_parent:
          description: Legal ultimate parent names by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        legal_ultimate_parent_indicator:
          description: Legal ultimate parent indicators by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        line_of_business:
          description: Lines of business by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        llc_type:
          description: >-
            Sub-type the registry records for a limited liability company. Empty
            when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        mailing_address:
          description: >-
            Mailing addresses where these differ from the trading address, by
            source. Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        msa:
          description: Metropolitan statistical areas by source.
          items:
            $ref: '#/components/schemas/SourcedMSAValue'
          type: array
        naics:
          description: Ranked NAICS codes by source.
          items:
            $ref: '#/components/schemas/SourcedIndustryCodeValue'
          type: array
        net_worth:
          description: >-
            Net worth in whole units of currency, by source. Empty when no
            source reported one.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        number_of_accounts:
          description: >-
            Count of accounts the source holds for the business. Empty when no
            source reported it.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        occupancy_type:
          description: >-
            Whether the source records the premises as owned, rented or
            otherwise held. Source-verbatim; empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        operating_status:
          description: Business operating statuses by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        outstanding_shares:
          description: >-
            Shares currently in issue, as the source expressed it. Empty when no
            source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        ownership:
          description: Business ownership details by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        people:
          description: Business contacts and officers by source.
          items:
            $ref: '#/components/schemas/SourcedPersonValue'
          type: array
        phone:
          description: Business phone numbers by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        profit:
          description: >-
            Profit in whole units of currency, by source. Empty when no source
            reported one.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        registered_agent:
          description: Registered agents by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        registered_agent_address:
          description: >-
            Addresses recorded for the registered agent, by source. This is the
            agent's address, not the business's. Empty when no source reported
            it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        registry_number:
          description: >-
            Identifiers the company registry assigned to the business, by
            source. Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        revenue:
          description: >-
            Annual revenue amounts by source. A source may supply earlier
            figures alongside its current one; the as_of date distinguishes
            them.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        sales_growth:
          description: >-
            Sales growth as the source expressed it, usually a percentage.
            Source-verbatim; empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        sales_territory:
          description: >-
            Geographic area the source records the business as selling into.
            Empty when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        shareholders:
          description: >-
            Shareholder count as the source expressed it. Source-verbatim; empty
            when no source reported it.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        sic:
          description: Ranked SIC codes by source.
          items:
            $ref: '#/components/schemas/SourcedIndustryCodeValue'
          type: array
        square_footage:
          description: >-
            Floor area of the building in square feet, by source. Empty when no
            source reported it.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
        state_of_incorporation:
          description: Incorporation states by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        status_date:
          description: >-
            Dates the registry last changed the business's status, by source.
            Empty when no source reported one.
          items:
            $ref: '#/components/schemas/SourcedDateValue'
          type: array
        ticker_symbol:
          description: >-
            Stock ticker symbols recorded for the business, by source. Empty for
            a business that is not publicly traded.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        web_address:
          description: Business websites by source.
          items:
            $ref: '#/components/schemas/SourcedStringValue'
          type: array
        year_started:
          description: Business start years by source.
          items:
            $ref: '#/components/schemas/SourcedIntegerValue'
          type: array
      required:
        - accounting_firm
        - address
        - alternate_names
        - annual_report_date
        - associated_entities
        - authorised_capital
        - bank
        - business_description
        - care_of
        - classification
        - corp_lifetime
        - duns
        - duration_date
        - effective_date
        - email
        - employees
        - employees_here
        - employment_growth
        - establishment_type
        - fein
        - filing_county
        - filing_date
        - filing_history
        - filing_office
        - filing_office_address
        - filing_state
        - filing_type
        - fiscal_year_end
        - franchise_status
        - headquarters
        - incorporation_date
        - industry_group
        - invested_amount
        - last_annual_financial_date
        - legal_immediate_parent
        - legal_immediate_parent_indicator
        - legal_name
        - legal_status
        - legal_ultimate_parent
        - legal_ultimate_parent_indicator
        - line_of_business
        - llc_type
        - mailing_address
        - msa
        - naics
        - net_worth
        - number_of_accounts
        - occupancy_type
        - operating_status
        - outstanding_shares
        - ownership
        - people
        - phone
        - profit
        - registered_agent
        - registered_agent_address
        - registry_number
        - revenue
        - sales_growth
        - sales_territory
        - shareholders
        - sic
        - square_footage
        - state_of_incorporation
        - status_date
        - ticker_symbol
        - web_address
        - year_started
      type: object
    BackgroundCheckResolution:
      properties:
        aka_names:
          description: Also-known-as names on the resolved entity.
          items:
            type: string
          type: array
        entity_not_found:
          description: True when no matching entity was found.
          type: boolean
        match_threshold:
          description: The deciding evidence-score floor; null on older records.
          nullable: true
          type: number
        method:
          description: >-
            Resolving search step: ssn_only, name_state_dob, name_address,
            name_state, corp_id, manual_recovery (a reviewer manually selected
            the match), or linked_entity_id (no search ran - the report naming
            this affiliation already identified them).
          nullable: true
          type: string
        report_retry_attempted:
          description: True when a failed report retrieval was retried.
          type: boolean
        report_unavailable:
          description: >-
            True when a match resolved but the report pull failed (distinct from
            a search-time error).
          type: boolean
        score_version:
          description: Version of the match-scoring model; null when unavailable.
          nullable: true
          type: string
        status:
          description: 'Resolution status: found, not_found, or error.'
          enum:
            - found
            - not_found
            - error
          type: string
        winner_ref:
          description: >-
            Ref into the subject's candidates[] for the resolved match; null
            when unresolved.
          nullable: true
          type: string
      required:
        - entity_not_found
        - report_retry_attempted
        - report_unavailable
        - status
      type: object
    SearchAttempt:
      properties:
        candidate_count:
          description: Number of candidates this step returned.
          type: integer
        candidate_refs:
          description: >-
            References into candidates for every candidate returned by this
            search step.
          items:
            $ref: '#/components/schemas/SearchAttemptCandidateRef'
          type: array
        inputs:
          allOf:
            - $ref: '#/components/schemas/SearchInputsUsed'
          description: Exact identifiers sent on this search step.
        is_resolving_match:
          description: True on the search step whose match became the subject resolution.
          type: boolean
        matched_group_id:
          description: >-
            Opaque source group identifier for support investigations; null when
            unmatched.
          nullable: true
          type: string
        outcome:
          description: >-
            Search outcome: matched, no_match, one_candidate,
            multiple_candidates, verification_failed, or error.
          enum:
            - matched
            - no_match
            - one_candidate
            - multiple_candidates
            - verification_failed
            - error
          type: string
        outcome_reason:
          allOf:
            - $ref: '#/components/schemas/SearchAttemptOutcomeReason'
          description: >-
            Human-readable explanation of the search outcome; null when
            unavailable.
          nullable: true
        resolved:
          description: >-
            True when this search confidently resolved the subject and ended the
            search waterfall.
          type: boolean
        search_method:
          description: >-
            Search method: ssn_only, name_state_dob, name_address, name_state,
            corp_id, manual_recovery, or linked_entity_id (see the resolution
            method).
          type: string
        top_relevance:
          description: >-
            Source relevance score of the best hit; null when no candidate was
            returned.
          nullable: true
          type: integer
      required:
        - candidate_count
        - candidate_refs
        - inputs
        - is_resolving_match
        - outcome
        - resolved
        - search_method
      type: object
    BackgroundCheckSection:
      description: >-
        A subject's findings for one record type. Record fields differ by
        section key.
      properties:
        addresses:
          description: >-
            Known addresses. Populated only on the `profile` section; empty
            elsewhere.
          items:
            $ref: '#/components/schemas/ProfileAddress'
          type: array
        akas:
          description: >-
            Also-known-as names. Populated only on the `profile` section; empty
            elsewhere.
          items:
            type: string
          type: array
        business_contacts:
          description: Business contacts shown on the `profile` section; empty elsewhere.
          items:
            $ref: '#/components/schemas/BusinessContact'
          type: array
        business_profile_details:
          description: >-
            Customer-safe business identity and profile details shown on the
            `profile` section; empty elsewhere.
          items:
            $ref: '#/components/schemas/BusinessProfileRecordSchema'
          type: array
        corporate_records:
          description: >-
            Business corporate filings shown on the `profile` section; empty
            elsewhere.
          items:
            $ref: '#/components/schemas/CorporateRecordSchema'
          type: array
        count:
          description: Number of records in the section.
          type: integer
        death_records:
          description: >-
            Death records. Populated only on a person's `profile` section; empty
            elsewhere.
          items:
            $ref: '#/components/schemas/DeathRecord'
          type: array
        emails:
          description: >-
            Known email addresses. Populated only on the `profile` section;
            empty elsewhere.
          items:
            $ref: '#/components/schemas/ProfileEmail'
          type: array
        entry_count:
          description: >-
            Number of underlying source entries before roll-up; null for
            sections without combined records.
          nullable: true
          type: integer
        flag:
          description: >-
            Policy flag for this section: ok or fail; null when no policy check
            cites it.
          enum:
            - ok
            - fail
            - null
          nullable: true
          type: string
        identity_fraud_flags:
          description: >-
            Identity-fraud signals. Populated only on a person's `profile`
            section; empty elsewhere.
          items:
            $ref: '#/components/schemas/IdentityFraudFlag'
          type: array
        key:
          description: >-
            Section identifier: profile, criminal, bankruptcy, liens, lawsuits,
            marriage, affiliations, ofac, corporate, ucc, property, or industry.
          enum:
            - profile
            - criminal
            - bankruptcy
            - liens
            - ucc
            - property
            - lawsuits
            - marriage
            - affiliations
            - corporate
            - ofac
            - industry
          type: string
        label:
          description: Display label for the section.
          type: string
        phones:
          description: Populated only on the `profile` section; empty elsewhere.
          items:
            $ref: '#/components/schemas/ProfilePhone'
          type: array
        records:
          description: >-
            Section rows. Fields differ by section key; the profile section has
            no rows.
          items:
            oneOf:
              - $ref: '#/components/schemas/CriminalRecordSchema'
              - $ref: '#/components/schemas/CriminalSectionRecordSchema'
              - $ref: '#/components/schemas/BankruptcyRecordSchema'
              - $ref: '#/components/schemas/LienJudgmentRecordSchema'
              - $ref: '#/components/schemas/LawsuitRecordSchema'
              - $ref: '#/components/schemas/MarriageRecordSchema'
              - $ref: '#/components/schemas/AssociateRecordSchema'
              - $ref: '#/components/schemas/OfacRecordSchema'
              - $ref: '#/components/schemas/CorporateRecordSchema'
              - $ref: '#/components/schemas/UCCRecordSchema'
              - $ref: '#/components/schemas/PropertyRecordSchema'
              - $ref: '#/components/schemas/BusinessProfileRecordSchema'
          type: array
        severity:
          description: 'Highest record severity in the section: none, low, medium, or high.'
          enum:
            - none
            - low
            - medium
            - high
          type: string
        ssn_issuance:
          allOf:
            - $ref: '#/components/schemas/ProfileSsnIssuance'
          description: >-
            SSN issuance details. Populated only on the `profile` section; null
            elsewhere.
          nullable: true
        work_affiliations:
          description: Populated only on the `affiliations` section; empty elsewhere.
          items:
            $ref: '#/components/schemas/WorkAffiliation'
          type: array
      required:
        - count
        - key
        - label
        - records
        - severity
      type: object
    AffiliateSubject:
      properties:
        application:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckApplication'
          description: Identity searched, taken from the application data.
        candidates:
          description: >-
            Every deduplicated candidate returned across the subject's searches,
            with its match score.
          items:
            $ref: '#/components/schemas/BackgroundCheckCandidate'
          type: array
        case_ref:
          description: Reserved case reference; null in normal use.
          nullable: true
          type: string
        decision:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckDecision'
          description: >-
            Audit of how the winning candidate was selected; null when no
            scoring decision was needed.
          nullable: true
        duns_numbers:
          description: >-
            D&B DUNS numbers of the resolved business. Empty for person
            subjects.
          items:
            type: string
          type: array
        firmographics:
          allOf:
            - $ref: '#/components/schemas/BusinessFirmographics'
          description: Business facts grouped by source; null for person subjects.
          nullable: true
        key:
          description: >-
            Identifier for an affiliate report, such as
            affiliate_business_bcs_x7Kp2 - not one of the three fixed subject
            keys.
          type: string
        kind:
          description: 'Subject type: person or business.'
          enum:
            - person
            - business
          type: string
        name:
          description: >-
            Label for the subject: the matched record's filed name for a
            business, the searched name for a person. Null when neither is
            known.
          nullable: true
          type: string
        related_party_officers:
          description: Business-filing officers who match a related party on the deal.
          items:
            type: string
          type: array
        resolution:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckResolution'
          description: How and whether the subject was matched.
        role:
          description: Subject's role on the deal; null when unavailable.
          nullable: true
          type: string
        searches:
          description: >-
            Search waterfall in attempted order, including each step's inputs
            and outcome.
          items:
            $ref: '#/components/schemas/SearchAttempt'
          type: array
        sections:
          description: Report findings grouped by record type.
          items:
            $ref: '#/components/schemas/BackgroundCheckSection'
          type: array
        unreported_officers:
          description: >-
            Officers on active business filings who are not listed as owners on
            the application. Empty for person subjects.
          items:
            type: string
          type: array
      required:
        - application
        - candidates
        - firmographics
        - key
        - kind
        - resolution
        - searches
        - sections
        - unreported_officers
      type: object
    BackgroundCheckEvidence:
      properties:
        filtered:
          description: >-
            True when record_indices is a matched subset. An empty filtered list
            means no records matched.
          type: boolean
        record_indices:
          description: Indices into the cited section's records array.
          items:
            type: integer
          type: array
        section:
          description: >-
            Section key containing the cited evidence; null when no section
            applies.
          nullable: true
          type: string
        subject_key:
          description: >-
            Evidence subject: owner_1, owner_2, business, any_owner, or
            submission.
          enum:
            - owner_1
            - owner_2
            - business
            - any_owner
            - submission
            - null
          nullable: true
          type: string
      required:
        - filtered
        - record_indices
      type: object
    BackgroundCheckOverride:
      properties:
        at:
          description: When the reviewer applied the override.
          format: date-time
          type: string
        by:
          description: Reviewer who applied the override.
          type: string
        status:
          description: Reviewer-selected outcome replacing the automated result.
          enum:
            - pass
            - failed
            - review_required
            - missing_data
      required:
        - at
        - by
        - status
      type: object
    CandidateScore:
      properties:
        anchor_trace:
          allOf:
            - $ref: '#/components/schemas/CandidateAnchorTrace'
          description: Winner-only; null otherwise.
          nullable: true
        anchored_by:
          description: >-
            The anchor identifier that resolved the match (e.g. ein);
            winner-only.
          nullable: true
          type: string
        cap_trace:
          allOf:
            - $ref: '#/components/schemas/CandidateCapTrace'
          description: Audit of the score cap; null when no cap was applied.
          nullable: true
        capped_by:
          description: >-
            Names the clamp when the total isn't the contribution sum (e.g.
            zero_floor); null otherwise.
          nullable: true
          type: string
        contributions:
          description: Per-field ledger of contributions to the candidate's match score.
          items:
            $ref: '#/components/schemas/CandidateScoreContribution'
          type: array
        tier:
          description: 'Score tier: high, medium, or low.'
          enum:
            - high
            - medium
            - low
          type: string
        total:
          description: The match score as a fraction in [0, 1].
          type: number
        version:
          description: Match-scoring model version.
          type: string
      required:
        - contributions
        - tier
        - total
        - version
      type: object
    BackgroundCheckNearTie:
      properties:
        flag_counts:
          additionalProperties:
            type: integer
          description: >-
            Adverse-flag counts per probed candidate, keyed by candidate id;
            null when not probed.
          nullable: true
          type: object
        gap:
          description: Difference between the top two candidate scores.
          type: number
        probed:
          description: >-
            True when both near-tied candidate reports were retrieved and
            compared.
          type: boolean
      required:
        - gap
        - probed
      type: object
    SourcedStringValue:
      properties:
        as_of:
          description: >-
            Date of the record that supplied the value, in ISO 8601 format. Null
            where the source states no date, which is always the case for CLEAR
            Business Overview.
          format: date
          nullable: true
          type: string
        filing_id:
          description: >-
            Groups the readings that came from the same corporate filing, so a
            business with several filings can show each one's status, dates and
            agent together. Set only on Corporate Filing values; null for every
            other source. Stable within a response, not across responses.
          nullable: true
          type: string
        note:
          description: >-
            Any further wording the source attached to the figure, such as
            whether principals are counted in an employee total.
            Source-verbatim; null when the source added nothing.
          nullable: true
          type: string
        qualifier:
          description: >-
            How the source derived the figure: ACTUAL (reported), ESTIMATED
            (approximated by the source), or MODELED (statistically inferred).
            Only ever set on employee and revenue figures; null everywhere else.
          enum:
            - ACTUAL
            - ESTIMATED
            - MODELED
            - null
          nullable: true
          type: string
        source:
          description: >-
            Which record supplied this value. Corporate Filing is a company
            registry filing; Dun & Bradstreet and Worldbase are commercial
            business registers; CLEAR Business Profile is aggregated trade and
            public-record data; CLEAR Business Overview is a combined summary
            record. Sources are not reconciled — two sources may disagree on the
            same field.
          enum:
            - CLEAR Business Overview
            - CLEAR Business Profile
            - Corporate Filing
            - Dun & Bradstreet
            - Worldbase
          type: string
        value:
          description: Source-provided text value.
          type: string
      required:
        - source
        - value
      type: object
    SourcedDateValue:
      properties:
        as_of:
          description: >-
            Date of the record that supplied the value, in ISO 8601 format. Null
            where the source states no date, which is always the case for CLEAR
            Business Overview.
          format: date
          nullable: true
          type: string
        filing_id:
          description: >-
            Groups the readings that came from the same corporate filing, so a
            business with several filings can show each one's status, dates and
            agent together. Set only on Corporate Filing values; null for every
            other source. Stable within a response, not across responses.
          nullable: true
          type: string
        note:
          description: >-
            Any further wording the source attached to the figure, such as
            whether principals are counted in an employee total.
            Source-verbatim; null when the source added nothing.
          nullable: true
          type: string
        qualifier:
          description: >-
            How the source derived the figure: ACTUAL (reported), ESTIMATED
            (approximated by the source), or MODELED (statistically inferred).
            Only ever set on employee and revenue figures; null everywhere else.
          enum:
            - ACTUAL
            - ESTIMATED
            - MODELED
            - null
          nullable: true
          type: string
        source:
          description: >-
            Which record supplied this value. Corporate Filing is a company
            registry filing; Dun & Bradstreet and Worldbase are commercial
            business registers; CLEAR Business Profile is aggregated trade and
            public-record data; CLEAR Business Overview is a combined summary
            record. Sources are not reconciled — two sources may disagree on the
            same field.
          enum:
            - CLEAR Business Overview
            - CLEAR Business Profile
            - Corporate Filing
            - Dun & Bradstreet
            - Worldbase
          type: string
        value:
          description: Source-provided date in ISO 8601 format.
          format: date
          type: string
      required:
        - source
        - value
      type: object
    SourcedIntegerValue:
      properties:
        as_of:
          description: >-
            Date of the record that supplied the value, in ISO 8601 format. Null
            where the source states no date, which is always the case for CLEAR
            Business Overview.
          format: date
          nullable: true
          type: string
        filing_id:
          description: >-
            Groups the readings that came from the same corporate filing, so a
            business with several filings can show each one's status, dates and
            agent together. Set only on Corporate Filing values; null for every
            other source. Stable within a response, not across responses.
          nullable: true
          type: string
        note:
          description: >-
            Any further wording the source attached to the figure, such as
            whether principals are counted in an employee total.
            Source-verbatim; null when the source added nothing.
          nullable: true
          type: string
        qualifier:
          description: >-
            How the source derived the figure: ACTUAL (reported), ESTIMATED
            (approximated by the source), or MODELED (statistically inferred).
            Only ever set on employee and revenue figures; null everywhere else.
          enum:
            - ACTUAL
            - ESTIMATED
            - MODELED
            - null
          nullable: true
          type: string
        source:
          description: >-
            Which record supplied this value. Corporate Filing is a company
            registry filing; Dun & Bradstreet and Worldbase are commercial
            business registers; CLEAR Business Profile is aggregated trade and
            public-record data; CLEAR Business Overview is a combined summary
            record. Sources are not reconciled — two sources may disagree on the
            same field.
          enum:
            - CLEAR Business Overview
            - CLEAR Business Profile
            - Corporate Filing
            - Dun & Bradstreet
            - Worldbase
          type: string
        value:
          description: Source-provided whole-number value.
          type: integer
      required:
        - source
        - value
      type: object
    SourcedMSAValue:
      properties:
        as_of:
          description: >-
            Date of the record that supplied the value, in ISO 8601 format. Null
            where the source states no date, which is always the case for CLEAR
            Business Overview.
          format: date
          nullable: true
          type: string
        filing_id:
          description: >-
            Groups the readings that came from the same corporate filing, so a
            business with several filings can show each one's status, dates and
            agent together. Set only on Corporate Filing values; null for every
            other source. Stable within a response, not across responses.
          nullable: true
          type: string
        note:
          description: >-
            Any further wording the source attached to the figure, such as
            whether principals are counted in an employee total.
            Source-verbatim; null when the source added nothing.
          nullable: true
          type: string
        qualifier:
          description: >-
            How the source derived the figure: ACTUAL (reported), ESTIMATED
            (approximated by the source), or MODELED (statistically inferred).
            Only ever set on employee and revenue figures; null everywhere else.
          enum:
            - ACTUAL
            - ESTIMATED
            - MODELED
            - null
          nullable: true
          type: string
        source:
          description: >-
            Which record supplied this value. Corporate Filing is a company
            registry filing; Dun & Bradstreet and Worldbase are commercial
            business registers; CLEAR Business Profile is aggregated trade and
            public-record data; CLEAR Business Overview is a combined summary
            record. Sources are not reconciled — two sources may disagree on the
            same field.
          enum:
            - CLEAR Business Overview
            - CLEAR Business Profile
            - Corporate Filing
            - Dun & Bradstreet
            - Worldbase
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/FirmographicMSA'
          description: Metropolitan statistical area supplied by the source.
      required:
        - source
        - value
      type: object
    SourcedIndustryCodeValue:
      properties:
        as_of:
          description: >-
            Date of the record that supplied the value, in ISO 8601 format. Null
            where the source states no date, which is always the case for CLEAR
            Business Overview.
          format: date
          nullable: true
          type: string
        filing_id:
          description: >-
            Groups the readings that came from the same corporate filing, so a
            business with several filings can show each one's status, dates and
            agent together. Set only on Corporate Filing values; null for every
            other source. Stable within a response, not across responses.
          nullable: true
          type: string
        note:
          description: >-
            Any further wording the source attached to the figure, such as
            whether principals are counted in an employee total.
            Source-verbatim; null when the source added nothing.
          nullable: true
          type: string
        qualifier:
          description: >-
            How the source derived the figure: ACTUAL (reported), ESTIMATED
            (approximated by the source), or MODELED (statistically inferred).
            Only ever set on employee and revenue figures; null everywhere else.
          enum:
            - ACTUAL
            - ESTIMATED
            - MODELED
            - null
          nullable: true
          type: string
        source:
          description: >-
            Which record supplied this value. Corporate Filing is a company
            registry filing; Dun & Bradstreet and Worldbase are commercial
            business registers; CLEAR Business Profile is aggregated trade and
            public-record data; CLEAR Business Overview is a combined summary
            record. Sources are not reconciled — two sources may disagree on the
            same field.
          enum:
            - CLEAR Business Overview
            - CLEAR Business Profile
            - Corporate Filing
            - Dun & Bradstreet
            - Worldbase
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/FirmographicIndustryCode'
          description: Industry classification supplied by the source.
      required:
        - source
        - value
      type: object
    SourcedPersonValue:
      properties:
        as_of:
          description: >-
            Date of the record that supplied the value, in ISO 8601 format. Null
            where the source states no date, which is always the case for CLEAR
            Business Overview.
          format: date
          nullable: true
          type: string
        filing_id:
          description: >-
            Groups the readings that came from the same corporate filing, so a
            business with several filings can show each one's status, dates and
            agent together. Set only on Corporate Filing values; null for every
            other source. Stable within a response, not across responses.
          nullable: true
          type: string
        note:
          description: >-
            Any further wording the source attached to the figure, such as
            whether principals are counted in an employee total.
            Source-verbatim; null when the source added nothing.
          nullable: true
          type: string
        qualifier:
          description: >-
            How the source derived the figure: ACTUAL (reported), ESTIMATED
            (approximated by the source), or MODELED (statistically inferred).
            Only ever set on employee and revenue figures; null everywhere else.
          enum:
            - ACTUAL
            - ESTIMATED
            - MODELED
            - null
          nullable: true
          type: string
        source:
          description: >-
            Which record supplied this value. Corporate Filing is a company
            registry filing; Dun & Bradstreet and Worldbase are commercial
            business registers; CLEAR Business Profile is aggregated trade and
            public-record data; CLEAR Business Overview is a combined summary
            record. Sources are not reconciled — two sources may disagree on the
            same field.
          enum:
            - CLEAR Business Overview
            - CLEAR Business Profile
            - Corporate Filing
            - Dun & Bradstreet
            - Worldbase
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/FirmographicPerson'
          description: Person and role supplied by the source.
      required:
        - source
        - value
      type: object
    SearchAttemptCandidateRef:
      properties:
        id:
          description: Reference to the matching entry in candidates.
          type: string
        matched_address:
          description: >-
            Address matched on this step; present only when it differs from the
            canonical entry.
          type: string
        matched_aka_name:
          description: >-
            AKA name matched on this step; present only when it differs from the
            canonical entry.
          type: string
        rank:
          description: >-
            Rank on this step; present only when it differs from the canonical
            entry.
          type: integer
        relevance:
          description: >-
            Relevance on this step; present only when it differs from the
            canonical entry.
          type: integer
        score_total:
          description: >-
            Match score on this step; present only when it differs from the
            canonical entry.
          type: number
      required:
        - id
      type: object
    SearchInputsUsed:
      properties:
        address:
          description: Address sent on this step; null when unused.
          nullable: true
          type: string
        address_source:
          description: >-
            Application address used: company_physical_address or
            company_billing_address.
          enum:
            - company_physical_address
            - company_billing_address
            - null
          nullable: true
          type: string
        business_name:
          description: The business name queried on this step; null on person attempts.
          nullable: true
          type: string
        business_name_source:
          description: Which name variant was queried; null on person attempts.
          enum:
            - legal
            - dba
            - candidate_fallback
            - linked_address_fallback
            - null
          nullable: true
          type: string
        corporation_id:
          description: Corporation identifier sent on this step; null when unused.
          nullable: true
          type: string
        date_of_birth:
          description: Date of birth sent on this step; null when unused.
          format: date
          nullable: true
          type: string
        email:
          description: Email sent on this step; null when unused.
          nullable: true
          type: string
        filing_state:
          description: Filing state sent on this step; null when unused.
          nullable: true
          type: string
        fuzzy:
          description: True when this step allowed fuzzy matching.
          type: boolean
        name:
          description: Person name sent on this step; null when unused.
          nullable: true
          type: string
        phone:
          description: Phone number sent on this step; null when unused.
          nullable: true
          type: string
        ssn:
          description: Masked SSN sent on this step; null when unused.
          nullable: true
          type: string
        state:
          description: State sent on this step; null when unused.
          nullable: true
          type: string
      required:
        - fuzzy
      type: object
    SearchAttemptOutcomeReason:
      properties:
        details:
          description: Label and value pairs explaining the search outcome.
          items:
            $ref: '#/components/schemas/SearchAttemptOutcomeReasonDetail'
          type: array
        label:
          description: Summary of the search outcome.
          type: string
      required:
        - details
        - label
      type: object
    ProfileAddress:
      properties:
        address:
          description: Reported address.
          nullable: true
          type: string
        city_state:
          description: Reported city and state.
          nullable: true
          type: string
        first_reported_date:
          description: First reported date; null when unavailable.
          format: date
          nullable: true
          type: string
        is_po_box:
          description: Whether this specific address is classified as a PO Box.
          type: boolean
        last_reported_date:
          description: Last reported date; null when unavailable.
          format: date
          nullable: true
          type: string
        source:
          description: Source that supplied the record.
          nullable: true
          type: string
      type: object
    BusinessContact:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        department:
          description: Department of the business contact.
          nullable: true
          type: string
        emails:
          description: Business email addresses associated with the contact.
          items:
            type: string
          type: array
        job_level:
          description: Job level of the business contact.
          nullable: true
          type: string
        linkedin_url:
          description: LinkedIn profile URL for the contact.
          nullable: true
          type: string
        name:
          description: Name of the business contact.
          nullable: true
          type: string
        organization:
          description: Organisation associated with the contact.
          nullable: true
          type: string
        organization_addresses:
          description: Organisation addresses associated with the contact.
          items:
            $ref: '#/components/schemas/BusinessContactAddress'
          type: array
        phones:
          description: Business phone numbers associated with the contact.
          items:
            $ref: '#/components/schemas/ProfilePhone'
          type: array
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source:
          description: Source that supplied the contact.
          nullable: true
          type: string
        title:
          description: Title of the business contact.
          nullable: true
          type: string
      type: object
    BusinessProfileRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        alternate_business_names:
          description: Other business names on the record.
          items:
            type: string
          type: array
        business_description:
          description: Description of the business's activity.
          nullable: true
          type: string
        business_name:
          description: Business name on the record.
          nullable: true
          type: string
        business_type:
          description: Source-provided business type.
          nullable: true
          type: string
        company_contact:
          description: Company contact named by the source.
          nullable: true
          type: string
        contact_title:
          description: Title of the company contact.
          nullable: true
          type: string
        corporate_status:
          description: Source-provided corporate status.
          nullable: true
          type: string
        current_outstanding_shares:
          description: Current outstanding share count.
          nullable: true
          type: string
        fiscal_year_end:
          description: Fiscal year end from the source.
          nullable: true
          type: string
        incorporation_date:
          description: Date the business was incorporated.
          format: date
          nullable: true
          type: string
        last_annual_financial_date:
          description: Date of the latest annual financial information.
          format: date
          nullable: true
          type: string
        legal_business_name:
          description: Legal business name on the record.
          nullable: true
          type: string
        location_type:
          description: Source-provided business location type.
          nullable: true
          type: string
        non_profit:
          description: Whether the business is a nonprofit.
          nullable: true
          type: boolean
        number_of_employees:
          description: Source-provided employee count.
          nullable: true
          type: string
        operating_status:
          description: Source-provided operating status.
          nullable: true
          type: string
        parent_company:
          description: Immediate or ultimate parent company.
          nullable: true
          type: string
        primary_naics_code:
          description: Primary NAICS industry code.
          nullable: true
          type: string
        primary_naics_desc:
          description: Description of the primary NAICS industry code.
          nullable: true
          type: string
        primary_sic_code:
          description: Primary SIC industry code.
          nullable: true
          type: string
        primary_sic_desc:
          description: Description of the primary SIC industry code.
          nullable: true
          type: string
        public_company:
          description: Whether the business is publicly traded.
          nullable: true
          type: boolean
        registered_agent:
          description: Registered agent named by the source.
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        secondary_naics_codes:
          description: Secondary NAICS industry codes.
          items:
            type: string
          type: array
        secondary_sic_codes:
          description: Secondary SIC industry codes.
          items:
            type: string
          type: array
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        shareholders:
          description: Shareholder information from the source.
          nullable: true
          type: string
        source:
          description: Source that supplied the record.
          nullable: true
          type: string
        state_of_incorporation:
          description: State where the business was incorporated.
          nullable: true
          type: string
        stock_exchange:
          description: Stock exchange for a public company.
          nullable: true
          type: string
        stock_ticker:
          description: Stock ticker for a public company.
          nullable: true
          type: string
        website:
          description: Business website.
          nullable: true
          type: string
        year_established:
          description: Year the business was established.
          nullable: true
          type: string
        year_started:
          description: Year the business started operating.
          nullable: true
          type: string
      type: object
    CorporateRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        annual_report_file_date:
          description: >-
            Date the filing office received the annual report; null when
            unavailable.
          format: date
          nullable: true
          type: string
        associated_business_count:
          description: Number of associated businesses in the source business group.
          type: integer
        business_duns:
          description: DUNS number assigned to the filed business; null when unavailable.
          nullable: true
          type: string
        business_group:
          description: Source grouping identifier for associated businesses.
          nullable: true
          type: string
        business_name:
          description: The registered business name.
          nullable: true
          type: string
        business_type:
          description: >-
            Source-provided business type on the filing; the first value when
            the source reports several.
          nullable: true
          type: string
        corp_lifetime:
          description: >-
            The term the registration was filed for, e.g. PERPETUAL; null when
            unavailable.
          nullable: true
          type: string
        corp_status:
          description: >-
            Filing status classification: active, inactive, dissolved, failed,
            or unknown. Failed covers forfeited, revoked, suspended, and
            administratively dissolved filings.
          enum:
            - active
            - dissolved
            - inactive
            - failed
            - unknown
        corporation_number:
          description: >-
            Corporation number the filing office assigned to the entity; null
            when the source does not report one.
          nullable: true
          type: string
        corporation_type:
          description: >-
            Source-provided corporation classification, separate from the
            filing's business type; null when unavailable.
          nullable: true
          type: string
        duration:
          description: Source-provided duration date or term; null when unavailable.
          nullable: true
          type: string
        federal_emp_id:
          description: Federal employer identification number listed on the filing.
          nullable: true
          type: string
        filing_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        filing_history:
          description: Ordered filing events recorded for this corporate record.
          items:
            $ref: '#/components/schemas/CorporateFilingHistoryEntrySchema'
          type: array
        filing_office_duns:
          description: Source-provided filing DUNS number; null when unavailable.
          nullable: true
          type: string
        filing_office_name:
          description: Office where the filing was recorded.
          nullable: true
          type: string
        filing_state:
          description: State where the filing was recorded.
          nullable: true
          type: string
        filing_state_name:
          description: Full name of the filing state.
          nullable: true
          type: string
        former_names:
          description: Former business names listed on the filing.
          items:
            type: string
          type: array
        franchise_status:
          description: >-
            Franchise-tax standing the filing office reports, e.g. CURRENT; null
            when unavailable.
          nullable: true
          type: string
        has_officers:
          description: True when the filing lists officers.
          type: boolean
        incorporation_date:
          description: Date the entity was incorporated.
          format: date
          nullable: true
          type: string
        is_failed:
          description: True when the corporate filing status is failed.
          type: boolean
        llc_type:
          description: >-
            How the registry classifies the LLC, e.g. MEMBER MANAGED; null when
            unavailable.
          nullable: true
          type: string
        notes:
          description: Source-provided note about the filing; null when unavailable.
          nullable: true
          type: string
        officer_count:
          description: Number of officers listed on the filing.
          type: integer
        officer_names:
          description: Names of officers listed on the filing.
          items:
            type: string
          type: array
        owner_is_officer:
          description: >-
            True when the application's named owner appears among the filing's
            officers.
          type: boolean
        ownership_changed:
          description: True when officers changed across the entity's filings.
          type: boolean
        registered_agent:
          description: Registered agent listed on the filing.
          nullable: true
          type: string
        registered_agent_address:
          description: Address of the registered agent listed on the filing.
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source:
          description: Source that supplied the record.
          nullable: true
          type: string
        state_filing_number:
          description: >-
            Filing number recorded on the filing; null when the source does not
            report one.
          nullable: true
          type: string
        state_of_incorporation:
          description: State where the entity was incorporated.
          nullable: true
          type: string
        status:
          description: Source-provided corporate filing status.
          nullable: true
          type: string
        status_date:
          description: >-
            Date the source recorded the corporate status; null when
            unavailable.
          format: date
          nullable: true
          type: string
        status_effective_date:
          description: Date the filing became effective; null when unavailable.
          format: date
          nullable: true
          type: string
      type: object
    DeathRecord:
      properties:
        age_at_death:
          description: Age at death; null when unavailable.
          nullable: true
          type: integer
        birth_place:
          description: Birth place of the deceased; null when unavailable.
          nullable: true
          type: string
        date_of_birth:
          description: >-
            Birth date of the deceased as the source reports it, often partly
            masked (MM/XX/YYYY); null when unavailable.
          nullable: true
          type: string
        date_of_death:
          description: Date of death; null when unavailable.
          format: date
          nullable: true
          type: string
        date_of_death_note:
          description: >-
            Source text given in place of a date of death, for example 'SSA
            Death Record reported within the last 3 years'; null when a date is
            given or nothing is reported.
          nullable: true
          type: string
        death_certificate_number:
          description: Death certificate reference; null when unavailable.
          nullable: true
          type: string
        death_place:
          description: Place of death; null when unavailable.
          nullable: true
          type: string
        deceased_name:
          description: >-
            Name on the death record, not the applicant's name; null when
            unavailable.
          nullable: true
          type: string
        father_birth_place:
          description: Father's birth place; null when unavailable.
          nullable: true
          type: string
        father_name:
          description: Father named on the record; null when unavailable.
          nullable: true
          type: string
        last_address:
          description: Last address listed for the deceased; null when unavailable.
          nullable: true
          type: string
        matches_subject:
          description: >-
            Whether the deceased_name on the record matches the applicant. Null
            means the record supplied no name to compare.
          nullable: true
          type: boolean
        mother_birth_place:
          description: Mother's birth place; null when unavailable.
          nullable: true
          type: string
        mother_name:
          description: Mother named on the record; null when unavailable.
          nullable: true
          type: string
        record_type:
          description: >-
            Death record class: death_record, deceased_record, obituary_record,
            or death_summary.
          enum:
            - death_record
            - deceased_record
            - obituary_record
            - death_summary
          type: string
        source:
          description: Source that supplied the record; null when unavailable.
          nullable: true
          type: string
        spouse_name:
          description: Spouse named on the record; null when unavailable.
          nullable: true
          type: string
        ssn:
          description: >-
            Social Security number of the deceased, masked to the first five
            digits (123-45-XXXX); null when unavailable.
          nullable: true
          type: string
      required:
        - record_type
      type: object
    ProfileEmail:
      properties:
        email:
          description: Email address.
          nullable: true
          type: string
        source:
          description: Source that supplied the record.
          nullable: true
          type: string
      type: object
    IdentityFraudFlag:
      properties:
        category:
          description: Identity-fraud signal category.
          enum:
            - ssn_multiple_identities
            - deceased_ssn
            - ssn_anomaly
            - ssn_address_alert
          type: string
        detail:
          description: Source-provided signal detail; null when unavailable.
          nullable: true
          type: string
        flag:
          description: Identity-fraud signal reported for the applicant.
          type: string
      required:
        - category
        - flag
      type: object
    ProfilePhone:
      properties:
        carrier:
          description: Phone carrier; null when unavailable.
          nullable: true
          type: string
        number:
          description: Phone number.
          nullable: true
          type: string
        source:
          description: Source that supplied the record.
          nullable: true
          type: string
        type:
          description: Source-provided phone type.
          nullable: true
          type: string
      type: object
    CriminalRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        actual_release_date:
          description: Actual release date from custody; null when unavailable.
          format: date
          nullable: true
          type: string
        arrest_date:
          description: Date of the arrest; null when unavailable.
          format: date
          nullable: true
          type: string
        arresting_agency:
          description: Arresting agency named on the source record; null when unavailable.
          nullable: true
          type: string
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        case_status:
          description: >-
            The court's live case status, such as DISCHARGE or PENDING. Can
            resolve a case even when no disposition is recorded; null when
            unavailable.
          nullable: true
          type: string
        case_status_date:
          description: Date of the case status; null when unavailable.
          format: date
          nullable: true
          type: string
        categories:
          description: >-
            Offence classifications: fraud, violent, dui, drug, burglary,
            domestic_violence, child_related, sex_offense, murder_homicide,
            fiduciary, or other.
          items:
            enum:
              - violent
              - murder_homicide
              - domestic_violence
              - burglary
              - fraud
              - sex_offense
              - child_related
              - fiduciary
              - animal_cruelty
              - drug
              - dui
              - other
          type: array
        category:
          description: Source-provided offence category string.
          nullable: true
          type: string
        court_county:
          description: County of the court; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        crime_date:
          description: >-
            Date the offence occurred, distinct from the case filing date; null
            when unavailable.
          format: date
          nullable: true
          type: string
        detail:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          description: >-
            Only populated when include_section_detail=true is passed on the
            request
          nullable: true
        disposition:
          description: Case or charge outcome; null when unavailable.
          nullable: true
          type: string
        disposition_date:
          description: Date of the disposition; null when unavailable.
          format: date
          nullable: true
          type: string
        entry_count:
          description: Number of underlying source entries combined into this record.
          type: integer
        filed_date:
          description: Case filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        fine_amount:
          description: Fine imposed as a decimal string; null when unavailable.
          nullable: true
          type: number
        grade:
          description: >-
            Offence grade: felony, misdemeanor, petty_misdemeanor, infraction,
            or unknown.
          enum:
            - felony
            - misdemeanor
            - petty_misdemeanor
            - infraction
            - unknown
        is_dismissed:
          description: True when the case was dismissed or not prosecuted.
          type: boolean
        is_felony:
          description: True when any charge on the case is a felony.
          type: boolean
        is_unclassified:
          description: True when the offence could not be classified.
          type: boolean
        number_of_counts:
          description: Number of counts; null when unavailable.
          nullable: true
          type: integer
        offense:
          description: Offence as recorded on the source document.
          nullable: true
          type: string
        offense_location:
          description: Where the offence took place; null when unavailable.
          nullable: true
          type: string
        parole_status:
          description: Parole status; null when unavailable.
          nullable: true
          type: string
        plea:
          description: >-
            The plea entered - the changed plea when one exists, else the
            original; null when unavailable.
          nullable: true
          type: string
        plea_date:
          description: Date of the plea; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_end_date:
          description: >-
            Probation end date - the actual end when recorded, else the
            scheduled end; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_violation:
          description: >-
            Probation violation as recorded on the source; null when
            unavailable.
          nullable: true
          type: string
        projected_release_date:
          description: >-
            Projected release date from custody, falling back to the tentative
            then maximum release date; null when unavailable.
          format: date
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        sentence:
          description: Sentence text; null when unavailable.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        severity_text:
          description: Source-provided severity string.
          nullable: true
          type: string
        shared_case_key:
          description: >-
            Stable key for a record that appears on both owner and business
            reports; null when not shared.
          nullable: true
          type: string
        shared_relationship:
          description: >-
            Where the shared record also appears: also_on_business or
            also_on_owner; null when not shared.
          enum:
            - also_on_owner
            - also_on_business
            - null
          nullable: true
          type: string
        source_entries:
          description: Underlying source rows combined into this record.
          items:
            $ref: '#/components/schemas/CriminalChargeEntrySchema'
          type: array
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
        source_entry_ids:
          description: References for the underlying source rows combined into this record.
          items:
            type: string
          type: array
        statute_code:
          description: Statute code; null when unavailable.
          nullable: true
          type: string
      type: object
    CriminalSectionRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        actual_release_date:
          description: Actual release date from custody; null when unavailable.
          format: date
          nullable: true
          type: string
        arrest_date:
          description: Date of the arrest; null when unavailable.
          format: date
          nullable: true
          type: string
        arrest_time:
          description: Time of the arrest; null when unavailable.
          nullable: true
          type: string
        arresting_agency:
          description: Arresting agency named on the source record; null when unavailable.
          nullable: true
          type: string
        bail_amount:
          description: >-
            Bail amount on the record as a decimal string; null when
            unavailable.
          nullable: true
          type: number
        booking_date:
          description: Date of the booking; null when unavailable.
          format: date
          nullable: true
          type: string
        booking_location:
          description: Booking location; null when unavailable.
          nullable: true
          type: string
        booking_number:
          description: Booking reference; null when unavailable.
          nullable: true
          type: string
        booking_time:
          description: Time of the booking; null when unavailable.
          nullable: true
          type: string
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        case_status:
          description: >-
            The court's live case status, such as DISCHARGE or PENDING. Can
            resolve a case even when no disposition is recorded; null when
            unavailable.
          nullable: true
          type: string
        case_status_date:
          description: Date of the case status; null when unavailable.
          format: date
          nullable: true
          type: string
        categories:
          description: >-
            Offence classifications: fraud, violent, dui, drug, burglary,
            domestic_violence, child_related, sex_offense, murder_homicide,
            fiduciary, or other.
          items:
            enum:
              - violent
              - murder_homicide
              - domestic_violence
              - burglary
              - fraud
              - sex_offense
              - child_related
              - fiduciary
              - animal_cruelty
              - drug
              - dui
              - other
          type: array
        category:
          description: Source-provided offence category string.
          nullable: true
          type: string
        court_county:
          description: County of the court; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        crime_date:
          description: >-
            Date the offence occurred, distinct from the case filing date; null
            when unavailable.
          format: date
          nullable: true
          type: string
        detail:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          description: >-
            Only populated when include_section_detail=true is passed on the
            request
          nullable: true
        disposition:
          description: Case or charge outcome; null when unavailable.
          nullable: true
          type: string
        disposition_date:
          description: Date of the disposition; null when unavailable.
          format: date
          nullable: true
          type: string
        entry_count:
          description: Number of underlying source entries combined into this record.
          type: integer
        filed_date:
          description: Case filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        fine_amount:
          description: Fine imposed as a decimal string; null when unavailable.
          nullable: true
          type: number
        grade:
          description: >-
            Offence grade: felony, misdemeanor, petty_misdemeanor, infraction,
            or unknown.
          enum:
            - felony
            - misdemeanor
            - petty_misdemeanor
            - infraction
            - unknown
        is_dismissed:
          description: True when the case was dismissed or not prosecuted.
          type: boolean
        is_felony:
          description: True when any charge on the case is a felony.
          type: boolean
        is_unclassified:
          description: True when the offence could not be classified.
          type: boolean
        mugshot_record_id:
          description: >-
            Stable identifier used to request this record's mug shot; null when
            no mug shot is available.
          nullable: true
          type: string
        number_of_counts:
          description: Number of counts; null when unavailable.
          nullable: true
          type: integer
        offense:
          description: Offence as recorded on the source document.
          nullable: true
          type: string
        offense_county:
          description: County where the offence occurred; null when unavailable.
          nullable: true
          type: string
        offense_location:
          description: Where the offence took place; null when unavailable.
          nullable: true
          type: string
        parole_status:
          description: Parole status; null when unavailable.
          nullable: true
          type: string
        plea:
          description: >-
            The plea entered - the changed plea when one exists, else the
            original; null when unavailable.
          nullable: true
          type: string
        plea_date:
          description: Date of the plea; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_end_date:
          description: >-
            Probation end date - the actual end when recorded, else the
            scheduled end; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_violation:
          description: >-
            Probation violation as recorded on the source; null when
            unavailable.
          nullable: true
          type: string
        projected_release_date:
          description: >-
            Projected release date from custody, falling back to the tentative
            then maximum release date; null when unavailable.
          format: date
          nullable: true
          type: string
        record_type:
          description: 'Record class: Criminal case or Arrest record.'
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        sentence:
          description: Sentence text; null when unavailable.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        severity_text:
          description: Source-provided severity string.
          nullable: true
          type: string
        shared_case_key:
          description: >-
            Stable key for a record that appears on both owner and business
            reports; null when not shared.
          nullable: true
          type: string
        shared_relationship:
          description: >-
            Where the shared record also appears: also_on_business or
            also_on_owner; null when not shared.
          enum:
            - also_on_owner
            - also_on_business
            - null
          nullable: true
          type: string
        source_entries:
          description: >-
            Underlying source rows combined into this record: one per charge for
            a court case, one per reported arrest entry for an arrest.
          items:
            $ref: '#/components/schemas/CriminalSectionEntrySchema'
          type: array
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
        source_entry_ids:
          description: References for the underlying source rows combined into this record.
          items:
            type: string
          type: array
        state:
          description: State the arrest record was reported in; null when unavailable.
          nullable: true
          type: string
        statute_code:
          description: Statute code; null when unavailable.
          nullable: true
          type: string
      type: object
    BankruptcyRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        chapter:
          description: Bankruptcy chapter number; null when unavailable.
          nullable: true
          type: integer
        chapter_kind:
          description: >-
            Bankruptcy chapter classification: chapter_7, chapter_11,
            chapter_12, chapter_13, other, or unknown.
          enum:
            - chapter_7
            - chapter_11
            - chapter_12
            - chapter_13
            - other
            - unknown
        debtor_name:
          description: Debtor named on the filing.
          nullable: true
          type: string
        detail:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          description: >-
            Only populated when include_section_detail=true is passed on the
            request
          nullable: true
        document_id:
          description: Source document reference; null when unavailable.
          nullable: true
          type: string
        filed_date:
          description: Case filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        is_open:
          description: True when status_kind is neither discharged nor dismissed.
          type: boolean
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        status:
          description: Bankruptcy status value matching status_kind.
          nullable: true
          type: string
        status_kind:
          description: >-
            Bankruptcy status classification: filed, discharged, dismissed, or
            unknown. Discharged and dismissed are closed; filed and unknown are
            open.
          enum:
            - filed
            - discharged
            - dismissed
            - unknown
        total_assets:
          description: >-
            Total scheduled assets as a decimal string; null when the filing
            does not record them.
          nullable: true
          type: number
        total_liabilities:
          description: >-
            Total scheduled liabilities as a decimal string; null when the
            filing does not record them.
          nullable: true
          type: number
      type: object
    LienJudgmentRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        amount:
          description: Amount on the record as a decimal string; null when unavailable.
          nullable: true
          type: number
        amount_band:
          description: >-
            Amount band: none, small under $10,000, medium from $10,000 to
            $49,999.99, or large at $50,000 or more.
          enum:
            - none
            - small
            - medium
            - large
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        court_county:
          description: County of the court; null when unavailable.
          nullable: true
          type: string
        court_location:
          description: Location of the court; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        creditor_count:
          description: Number of creditors on the case.
          type: integer
        creditor_name:
          description: First creditor named on the case; null when unavailable.
          nullable: true
          type: string
        debtor_name:
          description: Debtor named on the filing.
          nullable: true
          type: string
        detail:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          description: >-
            Only populated when include_section_detail=true is passed on the
            request
          nullable: true
        entry_count:
          description: Number of underlying source entries combined into this record.
          type: integer
        file_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        filing_relationship:
          description: >-
            Relationship to another filing: released_by or release_of; null when
            unlinked.
          nullable: true
          type: string
        is_federal_tax_lien:
          description: True when the filing is a federal tax lien.
          type: boolean
        is_mca_creditor:
          description: True when the creditor is a known merchant cash advance funder.
          type: boolean
        is_released:
          description: >-
            True when the source no longer shows the lien as outstanding.
            Vacated and closed records are included, not only released ones.
          type: boolean
        record_type:
          description: Source-provided record class.
          nullable: true
          type: string
        related_filing_number:
          description: Reference of the related filing; null when unlinked.
          nullable: true
          type: string
        release_date:
          description: Lien release date; null when unreleased.
          format: date
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        satisfaction_date:
          description: >-
            Date the debt was satisfied as recorded on the source; null when
            unavailable.
          format: date
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        shared_case_key:
          description: >-
            Stable key for a record that appears on both owner and business
            reports; null when not shared.
          nullable: true
          type: string
        shared_relationship:
          description: >-
            Where the shared record also appears: also_on_business or
            also_on_owner; null when not shared.
          enum:
            - also_on_owner
            - also_on_business
            - null
          nullable: true
          type: string
        source_entries:
          description: Underlying source rows combined into this record.
          items:
            $ref: '#/components/schemas/LienJudgmentEntrySchema'
          type: array
        source_entry_ids:
          description: References for the underlying source rows combined into this record.
          items:
            type: string
          type: array
        status:
          description: 'Lien status: open, released, vacated, or closed.'
          enum:
            - open
            - released
            - vacated
            - closed
        type_of_filing:
          description: >-
            Source-provided filing type, such as JUDGMENT LIEN, FEDERAL TAX
            LIEN, or STATE TAX LIEN.
          nullable: true
          type: string
        type_of_satisfaction:
          description: >-
            How the debt was satisfied as recorded on the source; null when
            unavailable.
          nullable: true
          type: string
        vacate_date:
          description: Judgment vacate date; null when not vacated.
          format: date
          nullable: true
          type: string
      type: object
    LawsuitRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        amount:
          description: Amount on the case as a decimal string; null when unavailable.
          nullable: true
          type: number
        amount_type:
          description: 'What the lawsuit amount represents: demand or judgment.'
          enum:
            - judgment
            - award
            - demand
            - null
          nullable: true
          type: string
        case_category:
          description: Source-provided case category.
          nullable: true
          type: string
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        case_status:
          description: >-
            Status classification: active, ended, judgment, or no_status.
            Judgment means entered and still counts as active.
          enum:
            - active
            - ended
            - judgment
            - no_status
            - null
          nullable: true
        case_sub_category:
          description: Source-provided case subcategory.
          nullable: true
          type: string
        case_title:
          description: Case title; null when unavailable.
          nullable: true
          type: string
        case_type:
          description: Source-provided case type.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        defendant_name:
          description: Defendant named on the case.
          nullable: true
          type: string
        detail:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          description: >-
            Only populated when include_section_detail=true is passed on the
            request
          nullable: true
        entry_count:
          description: Number of underlying source entries combined into this record.
          type: integer
        file_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        is_active:
          description: True when the lawsuit appears to still be live.
          type: boolean
        is_felony:
          description: True when the docket record is felony-graded.
          type: boolean
        is_mca:
          description: >-
            True when the litigation was brought by a known merchant cash
            advance funder.
          type: boolean
        plaintiff_name:
          description: Plaintiff named on the case.
          nullable: true
          type: string
        record_type:
          description: 'Record class: Lawsuit or Court docket.'
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source_entries:
          description: Underlying source rows combined into this record.
          items:
            $ref: '#/components/schemas/LitigationEntrySchema'
          type: array
        source_entry_ids:
          description: References for the underlying source rows combined into this record.
          items:
            type: string
          type: array
        status_text:
          description: Source-provided status string.
          nullable: true
          type: string
      type: object
    MarriageRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        ceremony_type:
          description: Source-provided marriage ceremony type; null for divorce-only rows.
          nullable: true
          type: string
        county:
          description: County named on the record.
          nullable: true
          type: string
        decree_date:
          description: Divorce decree date; null for marriage-only rows.
          format: date
          nullable: true
          type: string
        filing_date:
          description: Divorce filing date; null for marriage-only rows.
          format: date
          nullable: true
          type: string
        is_active:
          description: True when the linked divorce case appears active.
          type: boolean
        is_divorced:
          description: True when the marriage has a linked divorce record.
          type: boolean
        location:
          description: Location named on the record.
          nullable: true
          type: string
        marriage_date:
          description: Marriage date; null for divorce-only rows.
          format: date
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        spouse_name:
          description: Spouse name; null for divorce-only rows.
          nullable: true
          type: string
      type: object
    AssociateRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        age:
          description: Reported age of the associate.
          nullable: true
          type: integer
        association_description:
          description: Source description of the association, such as Shared Address.
          nullable: true
          type: string
        city_state:
          description: Reported city and state.
          nullable: true
          type: string
        date_of_birth:
          description: Date of birth; null when unavailable.
          format: date
          nullable: true
          type: string
        death_date:
          description: Reported date of death; null when unavailable.
          format: date
          nullable: true
          type: string
        entity_id:
          description: Source entity identifier; null when unavailable.
          nullable: true
          type: string
        first_reported_date:
          description: First reported date; null when unavailable.
          format: date
          nullable: true
          type: string
        is_deceased:
          description: True when the associate is reported deceased.
          type: boolean
        is_high_risk:
          description: True when the associate is marked high risk.
          type: boolean
        last_reported_date:
          description: Last reported date; null when unavailable.
          format: date
          nullable: true
          type: string
        name:
          description: Name of the associate.
          nullable: true
          type: string
        relationship:
          description: Source-provided relationship to the subject.
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        shares_address:
          description: True when the associate shares an address with the subject.
          type: boolean
        shares_phone:
          description: True when the associate shares a phone number with the subject.
          type: boolean
        strength_of_association:
          description: Source strength score for the association; null when unavailable.
          nullable: true
          type: integer
      type: object
    OfacRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        action_end_date:
          description: Date the excluded-party action ended.
          format: date
          nullable: true
          type: string
        action_start_date:
          description: Date the excluded-party action began.
          format: date
          nullable: true
          type: string
        action_term:
          description: Source-provided duration of the excluded-party action.
          nullable: true
          type: string
        aliases:
          description: Aliases listed on the sanctions record.
          items:
            type: string
          type: array
        authority:
          description: Authority that issued the excluded-party action, such as SAM.
          nullable: true
          type: string
        charge:
          description: Charge named on the excluded-party record.
          nullable: true
          type: string
        city:
          description: City listed on the sanctions record.
          nullable: true
          type: string
        country:
          description: Country listed on the sanctions record.
          nullable: true
          type: string
        document_title:
          description: Title of the sanctions document.
          nullable: true
          type: string
        entity_type:
          description: >-
            Entity type on the source record, such as INDIVIDUAL, COMPANY, or
            ORGANIZATION.
          nullable: true
          type: string
        finding:
          description: Finding stated on the excluded-party record.
          nullable: true
          type: string
        issuer:
          description: Issuer named on the sanctions record.
          nullable: true
          type: string
        issuer_category:
          description: Category of the sanctions issuer.
          nullable: true
          type: string
        name:
          description: Name on the sanctions or excluded-party record.
          nullable: true
          type: string
        position_role:
          description: Position or role listed on the sanctions record.
          nullable: true
          type: string
        publication_date:
          description: Source publication date; null when unavailable.
          format: date
          nullable: true
          type: string
        publication_name:
          description: Publication named on the excluded-party record.
          nullable: true
          type: string
        region:
          description: Region listed on the sanctions record.
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        sanction_full_text:
          description: Full text of the sanctions record.
          nullable: true
          type: string
        sanction_type:
          description: Type of sanction.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source:
          description: Source that supplied the record.
          nullable: true
          type: string
      type: object
    UCCRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        collateral_description:
          description: Collateral description on the filing.
          nullable: true
          type: string
        collateral_descriptions:
          description: Collateral descriptions across the filing chain.
          items:
            type: string
          type: array
        debtor_address:
          description: Address of the debtor.
          nullable: true
          type: string
        debtor_name:
          description: Debtor named on the filing.
          nullable: true
          type: string
        detail:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          description: >-
            Only populated when include_section_detail=true is passed on the
            request
          nullable: true
        entry_count:
          description: Number of underlying source entries combined into this record.
          type: integer
        expire_date:
          description: Filing lapse date; null when unavailable.
          format: date
          nullable: true
          type: string
        file_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        filing_number:
          description: Filing reference number.
          nullable: true
          type: string
        filing_office_name:
          description: Office where the filing was recorded.
          nullable: true
          type: string
        filing_state:
          description: State where the filing was recorded.
          nullable: true
          type: string
        filing_type:
          description: >-
            Filing type, such as FINANCING STATEMENT, CONTINUATION, or
            TERMINATION.
          nullable: true
          type: string
        in_recent_cluster:
          description: >-
            True when the filing is among at least three new UCC liens in the
            last six months.
          type: boolean
        is_active:
          description: True when the filing chain is active.
          type: boolean
        is_recent:
          description: True when the filing originated recently.
          type: boolean
        is_terminated:
          description: True when the filing chain is terminated.
          type: boolean
        original_file_number_full:
          description: Full reference for the original filing in the chain.
          nullable: true
          type: string
        record_type:
          description: Source-provided record class.
          nullable: true
          type: string
        reference_file_number:
          description: Reference linking this row to the original filing in the chain.
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        secured_party_address:
          description: Address of the secured party.
          nullable: true
          type: string
        secured_party_name:
          description: Name of the secured party.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source_entries:
          description: Underlying source rows combined into this record.
          items:
            $ref: '#/components/schemas/UCCFilingEntrySchema'
          type: array
        source_entry_ids:
          description: References for the underlying source rows combined into this record.
          items:
            type: string
          type: array
        status:
          description: 'UCC filing-chain status: active, terminated, expired, or unknown.'
          enum:
            - active
            - terminated
            - expired
            - unknown
      type: object
    PropertyRecordSchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        absentee_indicator:
          description: Source-provided absentee-owner indicator; null when unavailable.
          nullable: true
          type: string
        attorney_name:
          description: Attorney named on the foreclosure filing; null when unavailable.
          nullable: true
          type: string
        body_type:
          description: Source-provided vehicle body type; null when unavailable.
          nullable: true
          type: string
        building_square_ft:
          description: Building area in square feet; null when unavailable.
          nullable: true
          type: integer
        case_number:
          description: Foreclosure case reference; null when unavailable.
          nullable: true
          type: string
        county:
          description: County where the property is located; null when unavailable.
          nullable: true
          type: string
        deed_type:
          description: Source-provided deed type; null when unavailable.
          nullable: true
          type: string
        filed_date:
          description: Foreclosure filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        filing_source:
          description: >-
            Foreclosure filing source: lis_pendens or judgment; absent on other
            rows.
          enum:
            - lis_pendens
            - judgment
            - null
          nullable: true
          type: string
        filing_type:
          description: Source-provided foreclosure filing type; null when unavailable.
          nullable: true
          type: string
        land_use:
          description: Source-provided land use; null when unavailable.
          nullable: true
          type: string
        legal_description:
          description: Legal property description; null when unavailable.
          nullable: true
          type: string
        lender_name:
          description: Lender named on the record; null when unavailable.
          nullable: true
          type: string
        make:
          description: Vehicle make; null when unavailable.
          nullable: true
          type: string
        model:
          description: Vehicle model; null when unavailable.
          nullable: true
          type: string
        model_year:
          description: Vehicle model year; null when unavailable.
          nullable: true
          type: integer
        mortgage_amount:
          description: Recorded mortgage amount as a decimal string; null when unavailable.
          nullable: true
          type: number
        mortgage_due_date:
          description: Mortgage due date; null when unavailable.
          format: date
          nullable: true
          type: string
        mortgage_type:
          description: Source-provided mortgage type; null when unavailable.
          nullable: true
          type: string
        original_loan_amount:
          description: Original loan amount as a decimal string; null when unavailable.
          nullable: true
          type: number
        original_loan_date:
          description: Original loan date; null when unavailable.
          format: date
          nullable: true
          type: string
        owner_is_corporate:
          description: Whether the listed owner is a business; null when unavailable.
          nullable: true
          type: boolean
        owner_name:
          description: Owner name listed on the record; null when unavailable.
          nullable: true
          type: string
        owners:
          description: Owners listed on the vehicle record.
          items:
            $ref: '#/components/schemas/VehicleOwnerSchema'
          type: array
        parcel_number:
          description: Parcel reference; null when unavailable.
          nullable: true
          type: string
        plaintiff_name:
          description: Plaintiff named on the foreclosure filing; null when unavailable.
          nullable: true
          type: string
        plate_expiration_date:
          description: Plate expiration date; null when unavailable.
          format: date
          nullable: true
          type: string
        plate_number:
          description: Vehicle registration plate; null when unavailable.
          nullable: true
          type: string
        plate_state:
          description: State that issued the plate; null when unavailable.
          nullable: true
          type: string
        plate_type:
          description: Source-provided plate type; null when unavailable.
          nullable: true
          type: string
        property_address:
          description: Property address named on the record; null when unavailable.
          nullable: true
          type: string
        record_group:
          description: >-
            Which record list this row came from. It is the only field
            separating a vehicle row from a real-time vehicle row.
          enum:
            - pre_foreclosure
            - real_property
            - vehicle
            - real_time_vehicle
            - pre_foreclosure_at_address
            - property_at_address
            - vehicle_at_address
          type: string
        record_type:
          description: >-
            Property record class: deed or tax; absent on foreclosure and
            vehicle rows.
          enum:
            - deed
            - tax
            - null
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        sale_date:
          description: Recorded sale date; null when unavailable.
          format: date
          nullable: true
          type: string
        sale_price:
          description: Recorded sale price as a decimal string; null when unavailable.
          nullable: true
          type: number
        seller_name:
          description: Seller name listed on the deed; null when unavailable.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source:
          description: Source that supplied the record; null when unavailable.
          nullable: true
          type: string
        subject_address:
          description: >-
            Applicant address the record was found under; present only on the
            at-address record groups and absent on the others. Identifies the
            address that was searched, not proof of ownership.
          nullable: true
          type: string
        title_company:
          description: Title company listed on the record; null when unavailable.
          nullable: true
          type: string
        vin:
          description: Vehicle identification number; null when unavailable.
          nullable: true
          type: string
      required:
        - record_group
      type: object
    ProfileSsnIssuance:
      properties:
        expiration_date:
          description: SSN issuance expiration date; null when unavailable.
          nullable: true
          type: string
        issuance_text:
          description: Source-provided SSN issuance summary.
          nullable: true
          type: string
        issue_date:
          description: SSN issuance date; null when unavailable.
          nullable: true
          type: string
        issue_state:
          description: State where the SSN was issued; null when unavailable.
          nullable: true
          type: string
      type: object
    WorkAffiliation:
      properties:
        address:
          description: Address of the business; null when unavailable.
          nullable: true
          type: string
        business_name:
          description: Business the subject is affiliated with.
          nullable: true
          type: string
        merged_from:
          description: >-
            Every filing behind this affiliation, each as the source reported
            it, including the one whose values the affiliation shows. A
            single-filing affiliation lists that one filing, so more than one
            entry means values were combined.
          items:
            $ref: '#/components/schemas/MergedFiling'
          type: array
        role:
          description: Role at the business, such as CEO, DIRECTOR, or Registered Agent.
          nullable: true
          type: string
        since_date:
          description: Date the affiliation began; null when unavailable.
          format: date
          nullable: true
          type: string
        status:
          description: Source-provided status of the affiliation.
          nullable: true
          type: string
      type: object
    CandidateAnchorTrace:
      properties:
        anchor:
          description: >-
            Identifier that resolved the match outright: ein or
            corp_number_echo.
          enum:
            - ein
            - corp_number_echo
          type: string
        guard_field:
          description: >-
            Candidate field used to guard the anchor match; null when no guard
            was needed.
          enum:
            - business_name
            - address
            - owner
            - null
          nullable: true
          type: string
        guard_strength:
          description: Guard field's comparison strength; null when no guard was evaluated.
          nullable: true
          type: number
        permitted:
          description: False records an anchor-grade identifier the guard denied.
          type: boolean
      required:
        - anchor
        - permitted
      type: object
    CandidateCapTrace:
      properties:
        cap:
          description: The cap the total was clamped to, as a fraction.
          type: number
        conflict:
          description: Conflicting field that caused the score cap.
          enum:
            - zero_floor
          type: string
        uncapped_total:
          description: The uncapped total, as a fraction.
          type: number
      required:
        - cap
        - conflict
        - uncapped_total
      type: object
    CandidateScoreContribution:
      properties:
        allocation:
          description: Fraction of the 100-point maximum.
          type: number
        application_value:
          description: >-
            The compared application value when it differs from the hoisted
            application block; null otherwise.
          nullable: true
          type: string
        candidate_value:
          description: Candidate value compared for this contribution; null when absent.
          nullable: true
          type: string
        cause:
          description: Why an absent verdict has no evidence; null on scoreable rows.
          enum:
            - missing_application_value
            - missing_candidate_value
            - null
          nullable: true
          type: string
        field:
          description: Application field evaluated by this contribution.
          type: string
        identifier_source:
          description: >-
            For an identifier-echo corroboration (corp_number_echo), which
            system supplied the re-searched number; null on other rows.
          enum:
            - sos_registry
            - clear_filing
            - null
          nullable: true
          type: string
        kind:
          description: >-
            Contribution type: field (a direct comparison), corroboration,
            penalty, or quality.
          enum:
            - field
            - corroboration
            - quality
            - penalty
          type: string
        points:
          description: This row's contribution to the total, as a fraction.
          type: number
        strength:
          description: >-
            Comparator strength in [-1, 1]; null when the field wasn't
            comparable (fall back to the verdict).
          nullable: true
          type: number
        trace:
          allOf:
            - $ref: '#/components/schemas/CandidateFieldTrace'
          description: How the strength was derived; null when trivially derived.
          nullable: true
        verdict:
          description: 'Comparison verdict: agree, fuzzy, diverge, or absent.'
          enum:
            - agree
            - fuzzy
            - diverge
            - absent
          type: string
      required:
        - allocation
        - field
        - kind
        - points
        - verdict
      type: object
    FirmographicMSA:
      properties:
        code:
          description: Metropolitan statistical area code; null when absent.
          nullable: true
          type: string
        name:
          description: Metropolitan statistical area name; null when absent.
          nullable: true
          type: string
      type: object
    FirmographicIndustryCode:
      properties:
        code:
          description: Industry classification code.
          type: string
        description:
          description: Source description of the industry code.
          nullable: true
          type: string
        extension:
          description: Source extension of the industry code; null when absent.
          nullable: true
          type: string
        rank:
          description: >-
            Position within this source's own list of codes; rank one is that
            source's primary code. Ranks restart at one for each source, so the
            same rank appears once per source.
          type: integer
      required:
        - code
        - rank
      type: object
    FirmographicPerson:
      properties:
        address:
          description: >-
            Address the source recorded for this person, which need not be the
            business's own. Null when the source gave none.
          nullable: true
          type: string
        name:
          description: Name of the person associated with the business.
          type: string
        title:
          description: Source-provided role or title; null when absent.
          nullable: true
          type: string
      required:
        - name
      type: object
    SearchAttemptOutcomeReasonDetail:
      properties:
        label:
          description: Display label for the outcome detail.
          type: string
        value:
          description: Value paired with the label; null when unavailable.
          nullable: true
      required:
        - label
      type: object
    BusinessContactAddress:
      properties:
        city:
          description: City of the contact's organisation address.
          nullable: true
          type: string
        country:
          description: Country of the contact's organisation address.
          nullable: true
          type: string
        state:
          description: State or province of the contact's organisation address.
          nullable: true
          type: string
        street:
          description: Street address of the contact's organisation.
          nullable: true
          type: string
        zip_code:
          description: Postal code of the contact's organisation address.
          nullable: true
          type: string
      type: object
    CorporateFilingHistoryEntrySchema:
      properties:
        history_code:
          description: Code assigned to the filing event by the source.
          nullable: true
          type: string
        history_desc:
          description: Source-provided description of the filing event.
          nullable: true
          type: string
      type: object
    BackgroundCheckRecordDetail:
      description: >-
        Supplementary source detail returned with include_section_detail=true.
        The summarised record is the stable typed interface.
      properties:
        additional_fields:
          description: >-
            Every source value not mapped to a named field, as label and value
            pairs.
          items:
            $ref: '#/components/schemas/DetailLabelValue'
          type: array
        arrests:
          description: Arrest entries as source-provided key and value pairs.
          items:
            additionalProperties:
              type: string
            type: object
          type: array
        attorneys:
          description: Counsel the source does not tie to a specific party.
          items:
            $ref: '#/components/schemas/DetailAttorney'
          type: array
        bail:
          description: Bail entries on the case.
          items:
            $ref: '#/components/schemas/DetailBail'
          type: array
        case:
          allOf:
            - $ref: '#/components/schemas/DetailCase'
          description: Case metadata; null when not a case record.
          nullable: true
        charges:
          description: Charges on the case.
          items:
            $ref: '#/components/schemas/DetailCharge'
          type: array
        collateral:
          description: Collateral descriptions on the filing.
          items:
            type: string
          type: array
        creditors:
          description: Creditors named on the filing.
          items:
            type: string
          type: array
        debtors:
          description: Debtors named on the filing.
          items:
            $ref: '#/components/schemas/DetailLienDebtor'
          type: array
        defendant:
          allOf:
            - $ref: '#/components/schemas/DetailDefendant'
          description: Defendant details; null when not applicable.
          nullable: true
        docket_entries:
          description: Docket entries on the case.
          items:
            $ref: '#/components/schemas/DetailDocketEntry'
          type: array
        entries:
          description: >-
            For merged cases: one entry per raw source record, carrying this
            same shape.
          items:
            $ref: '#/components/schemas/BackgroundCheckRecordDetail'
          type: array
        filing:
          allOf:
            - $ref: '#/components/schemas/DetailFiling'
          description: Filing metadata; null when not a filing record.
          nullable: true
        filing_relationship:
          description: Source-provided filing relationship; null when unavailable.
          nullable: true
          type: string
        meeting_341:
          allOf:
            - $ref: '#/components/schemas/DetailMeeting341'
          description: 341 creditors' meeting; null when not applicable.
          nullable: true
        parties:
          description: Parties named on the case.
          items:
            $ref: '#/components/schemas/DetailParty'
          type: array
        record_shape:
          description: Names the source shape this detail carries.
          nullable: true
          type: string
        related:
          description: Related records as label and value pairs.
          items:
            $ref: '#/components/schemas/DetailLabelValue'
          type: array
        secured_parties:
          description: Secured parties named on the filing.
          items:
            $ref: '#/components/schemas/DetailLienDebtor'
          type: array
        source:
          allOf:
            - $ref: '#/components/schemas/DetailSource'
          description: Provenance of the source record; null when unavailable.
          nullable: true
        source_entry_id:
          description: Source-provided source entry reference; null when unavailable.
          nullable: true
          type: string
      type: object
    CriminalChargeEntrySchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        actual_release_date:
          description: Actual release date from custody; null when unavailable.
          format: date
          nullable: true
          type: string
        arrest_date:
          description: Date of the arrest; null when unavailable.
          format: date
          nullable: true
          type: string
        arresting_agency:
          description: Arresting agency named on the source record; null when unavailable.
          nullable: true
          type: string
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        case_status:
          description: >-
            The court's live case status, such as DISCHARGE or PENDING. Can
            resolve a case even when no disposition is recorded; null when
            unavailable.
          nullable: true
          type: string
        case_status_date:
          description: Date of the case status; null when unavailable.
          format: date
          nullable: true
          type: string
        categories:
          description: >-
            Offence classifications: fraud, violent, dui, drug, burglary,
            domestic_violence, child_related, sex_offense, murder_homicide,
            fiduciary, or other.
          items:
            enum:
              - violent
              - murder_homicide
              - domestic_violence
              - burglary
              - fraud
              - sex_offense
              - child_related
              - fiduciary
              - animal_cruelty
              - drug
              - dui
              - other
          type: array
        category:
          description: Source-provided offence category string.
          nullable: true
          type: string
        court_county:
          description: County of the court; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        crime_date:
          description: >-
            Date the offence occurred, distinct from the case filing date; null
            when unavailable.
          format: date
          nullable: true
          type: string
        disposition:
          description: Case or charge outcome; null when unavailable.
          nullable: true
          type: string
        disposition_date:
          description: Date of the disposition; null when unavailable.
          format: date
          nullable: true
          type: string
        filed_date:
          description: Case filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        fine_amount:
          description: Fine imposed as a decimal string; null when unavailable.
          nullable: true
          type: number
        grade:
          description: >-
            Offence grade: felony, misdemeanor, petty_misdemeanor, infraction,
            or unknown.
          enum:
            - felony
            - misdemeanor
            - petty_misdemeanor
            - infraction
            - unknown
        is_dismissed:
          description: True when the case was dismissed or not prosecuted.
          type: boolean
        is_felony:
          description: True when any charge on the case is a felony.
          type: boolean
        number_of_counts:
          description: Number of counts; null when unavailable.
          nullable: true
          type: integer
        offense:
          description: Offence as recorded on the source document.
          nullable: true
          type: string
        offense_location:
          description: Where the offence took place; null when unavailable.
          nullable: true
          type: string
        parole_status:
          description: Parole status; null when unavailable.
          nullable: true
          type: string
        plea:
          description: >-
            The plea entered - the changed plea when one exists, else the
            original; null when unavailable.
          nullable: true
          type: string
        plea_date:
          description: Date of the plea; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_end_date:
          description: >-
            Probation end date - the actual end when recorded, else the
            scheduled end; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_violation:
          description: >-
            Probation violation as recorded on the source; null when
            unavailable.
          nullable: true
          type: string
        projected_release_date:
          description: >-
            Projected release date from custody, falling back to the tentative
            then maximum release date; null when unavailable.
          format: date
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        sentence:
          description: Sentence text; null when unavailable.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        severity_text:
          description: Source-provided severity string.
          nullable: true
          type: string
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
        statute_code:
          description: Statute code; null when unavailable.
          nullable: true
          type: string
      type: object
    CriminalSectionEntrySchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        actual_release_date:
          description: Actual release date from custody; null when unavailable.
          format: date
          nullable: true
          type: string
        arrest_date:
          description: Date of the arrest; null when unavailable.
          format: date
          nullable: true
          type: string
        arresting_agency:
          description: Arresting agency named on the source record; null when unavailable.
          nullable: true
          type: string
        bail_amount:
          description: >-
            Bail amount on this entry as a decimal string; null when
            unavailable.
          nullable: true
          type: number
        booking_number:
          description: Booking reference on this entry; null when unavailable.
          nullable: true
          type: string
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        case_status:
          description: >-
            The court's live case status, such as DISCHARGE or PENDING. Can
            resolve a case even when no disposition is recorded; null when
            unavailable.
          nullable: true
          type: string
        case_status_date:
          description: Date of the case status; null when unavailable.
          format: date
          nullable: true
          type: string
        categories:
          description: >-
            Offence classifications: fraud, violent, dui, drug, burglary,
            domestic_violence, child_related, sex_offense, murder_homicide,
            fiduciary, or other.
          items:
            enum:
              - violent
              - murder_homicide
              - domestic_violence
              - burglary
              - fraud
              - sex_offense
              - child_related
              - fiduciary
              - animal_cruelty
              - drug
              - dui
              - other
          type: array
        category:
          description: Source-provided offence category string.
          nullable: true
          type: string
        court_county:
          description: County of the court; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        crime_date:
          description: >-
            Date the offence occurred, distinct from the case filing date; null
            when unavailable.
          format: date
          nullable: true
          type: string
        disposition:
          description: Case or charge outcome; null when unavailable.
          nullable: true
          type: string
        disposition_date:
          description: Date of the disposition; null when unavailable.
          format: date
          nullable: true
          type: string
        filed_date:
          description: Case filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        fine_amount:
          description: Fine imposed as a decimal string; null when unavailable.
          nullable: true
          type: number
        grade:
          description: >-
            Offence grade: felony, misdemeanor, petty_misdemeanor, infraction,
            or unknown.
          enum:
            - felony
            - misdemeanor
            - petty_misdemeanor
            - infraction
            - unknown
        is_dismissed:
          description: True when the case was dismissed or not prosecuted.
          type: boolean
        is_felony:
          description: True when any charge on the case is a felony.
          type: boolean
        mugshot_record_id:
          description: >-
            Stable identifier used to request this entry's mug shot; null when
            it has none.
          nullable: true
          type: string
        number_of_counts:
          description: Number of counts; null when unavailable.
          nullable: true
          type: integer
        offense:
          description: Offence as recorded on the source document.
          nullable: true
          type: string
        offense_location:
          description: Where the offence took place; null when unavailable.
          nullable: true
          type: string
        parole_status:
          description: Parole status; null when unavailable.
          nullable: true
          type: string
        plea:
          description: >-
            The plea entered - the changed plea when one exists, else the
            original; null when unavailable.
          nullable: true
          type: string
        plea_date:
          description: Date of the plea; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_end_date:
          description: >-
            Probation end date - the actual end when recorded, else the
            scheduled end; null when unavailable.
          format: date
          nullable: true
          type: string
        probation_violation:
          description: >-
            Probation violation as recorded on the source; null when
            unavailable.
          nullable: true
          type: string
        projected_release_date:
          description: >-
            Projected release date from custody, falling back to the tentative
            then maximum release date; null when unavailable.
          format: date
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        sentence:
          description: Sentence text; null when unavailable.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        severity_text:
          description: Source-provided severity string.
          nullable: true
          type: string
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
        state:
          description: State this entry was reported in; null when unavailable.
          nullable: true
          type: string
        statute_code:
          description: Statute code; null when unavailable.
          nullable: true
          type: string
      type: object
    LienJudgmentEntrySchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        amount:
          description: Amount on the record as a decimal string; null when unavailable.
          nullable: true
          type: number
        amount_band:
          description: >-
            Amount band: none, small under $10,000, medium from $10,000 to
            $49,999.99, or large at $50,000 or more.
          enum:
            - none
            - small
            - medium
            - large
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        court_county:
          description: County of the court; null when unavailable.
          nullable: true
          type: string
        court_location:
          description: Location of the court; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        creditor_count:
          description: Number of creditors on the case.
          type: integer
        creditor_name:
          description: First creditor named on the case; null when unavailable.
          nullable: true
          type: string
        debtor_name:
          description: Debtor named on the filing.
          nullable: true
          type: string
        file_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        filing_relationship:
          description: >-
            Relationship to another filing: released_by or release_of; null when
            unlinked.
          nullable: true
          type: string
        is_federal_tax_lien:
          description: True when the filing is a federal tax lien.
          type: boolean
        is_mca_creditor:
          description: True when the creditor is a known merchant cash advance funder.
          type: boolean
        is_released:
          description: >-
            True when the source no longer shows the lien as outstanding.
            Vacated and closed records are included, not only released ones.
          type: boolean
        original_filing_number:
          description: Original filing number for this source entry.
          nullable: true
          type: string
        record_type:
          description: Source-provided record class.
          nullable: true
          type: string
        related_filing_number:
          description: Reference of the related filing; null when unlinked.
          nullable: true
          type: string
        release_date:
          description: Lien release date; null when unreleased.
          format: date
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        satisfaction_date:
          description: >-
            Date the debt was satisfied as recorded on the source; null when
            unavailable.
          format: date
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
        type_of_filing:
          description: >-
            Source-provided filing type, such as JUDGMENT LIEN, FEDERAL TAX
            LIEN, or STATE TAX LIEN.
          nullable: true
          type: string
        type_of_satisfaction:
          description: >-
            How the debt was satisfied as recorded on the source; null when
            unavailable.
          nullable: true
          type: string
        vacate_date:
          description: Judgment vacate date; null when not vacated.
          format: date
          nullable: true
          type: string
      type: object
    LitigationEntrySchema:
      properties:
        case_number:
          description: Court case reference; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Court name; null when unavailable.
          nullable: true
          type: string
        file_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        record_type:
          description: 'Source record class: lawsuit or court docket.'
          nullable: true
          type: string
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
        status_text:
          description: Source-provided status string.
          nullable: true
          type: string
      type: object
    UCCFilingEntrySchema:
      description: >-
        A background-check finding. Risk and severity carry the same none, low,
        medium, or high tier.
      properties:
        collateral_description:
          description: Collateral description on the filing.
          nullable: true
          type: string
        collateral_descriptions:
          description: Collateral descriptions across the filing chain.
          items:
            type: string
          type: array
        debtor_address:
          description: Address of the debtor.
          nullable: true
          type: string
        debtor_name:
          description: Debtor named on the filing.
          nullable: true
          type: string
        expire_date:
          description: Filing lapse date; null when unavailable.
          format: date
          nullable: true
          type: string
        file_date:
          description: Filing date; null when unavailable.
          format: date
          nullable: true
          type: string
        filing_number:
          description: Filing reference number.
          nullable: true
          type: string
        filing_office_name:
          description: Office where the filing was recorded.
          nullable: true
          type: string
        filing_state:
          description: State where the filing was recorded.
          nullable: true
          type: string
        filing_type:
          description: >-
            Filing type, such as FINANCING STATEMENT, CONTINUATION, or
            TERMINATION.
          nullable: true
          type: string
        in_recent_cluster:
          description: >-
            True when the filing is among at least three new UCC liens in the
            last six months.
          type: boolean
        is_recent:
          description: True when the filing originated recently.
          type: boolean
        original_file_number_full:
          description: Full reference for the original filing in the chain.
          nullable: true
          type: string
        record_type:
          description: Source-provided record class.
          nullable: true
          type: string
        reference_file_number:
          description: Reference linking this row to the original filing in the chain.
          nullable: true
          type: string
        risk:
          description: Record risk tier.
          enum:
            - none
            - low
            - medium
            - high
        secured_party_address:
          description: Address of the secured party.
          nullable: true
          type: string
        secured_party_name:
          description: Name of the secured party.
          nullable: true
          type: string
        severity:
          description: Record severity tier, mirroring risk.
          readOnly: true
        source_entry_id:
          description: >-
            Stable reference for the underlying source row; null when
            unavailable.
          nullable: true
          type: string
      type: object
    VehicleOwnerSchema:
      properties:
        address:
          description: Address reported for the vehicle owner; null when unavailable.
          nullable: true
          type: string
        name:
          description: Name of the vehicle owner; null when unavailable.
          nullable: true
          type: string
        owner_type:
          description: >-
            The owner's role as the source reports it, uppercase, such as
            REGISTRANT, LESSEE or LIENHOLDER. On real-time registrations with no
            reported role it is REGISTERED, SECONDARY or ADDITIONAL, from the
            owner's position on the registration. Null when unavailable.
          nullable: true
          type: string
      type: object
    MergedFiling:
      properties:
        address:
          description: Address on this filing; null when unavailable.
          nullable: true
          type: string
        business_name:
          description: Business name on this filing; null when unavailable.
          nullable: true
          type: string
        role:
          description: Role recorded on this filing; null when unavailable.
          nullable: true
          type: string
        since_date:
          description: Date this filing reported the affiliation began.
          format: date
          nullable: true
          type: string
        status:
          description: Status this filing reported; null when unavailable.
          nullable: true
          type: string
      type: object
    CandidateFieldTrace:
      properties:
        base:
          description: Comparator strength before named modifiers are applied.
          type: number
        components:
          description: Per-part evidence used to derive the strength.
          items:
            $ref: '#/components/schemas/CandidateTraceComponent'
          type: array
        mode:
          description: >-
            How the strength was derived: exact, similarity, stepped, or
            composite.
          enum:
            - exact
            - similarity
            - stepped
            - composite
          type: string
        modifiers:
          description: Named adjustments applied to the base strength.
          items:
            $ref: '#/components/schemas/CandidateTraceModifier'
          type: array
      required:
        - base
        - components
        - mode
        - modifiers
      type: object
    DetailLabelValue:
      properties:
        label:
          description: Display label for the source value.
          type: string
        value:
          description: Value paired with the label; null when unavailable.
          nullable: true
          type: string
      required:
        - label
      type: object
    DetailAttorney:
      properties:
        address:
          description: Source-provided address; null when unavailable.
          nullable: true
          type: string
        bar_number:
          description: Source-provided bar number; null when unavailable.
          nullable: true
          type: string
        email:
          description: Source-provided email address; null when unavailable.
          nullable: true
          type: string
        firm:
          description: Source-provided firm; null when unavailable.
          nullable: true
          type: string
        name:
          description: Source-provided attorney name; null when unavailable.
          nullable: true
          type: string
        phone:
          description: Source-provided phone number; null when unavailable.
          nullable: true
          type: string
        role:
          description: Source-provided role; null when unavailable.
          nullable: true
          type: string
        status:
          description: Source-provided status; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailBail:
      properties:
        bond_number:
          description: Source-provided bond number; null when unavailable.
          nullable: true
          type: string
        bondsman:
          description: Source-provided bondsman; null when unavailable.
          nullable: true
          type: string
        date:
          description: Source-provided bail date; null when unavailable.
          nullable: true
          type: string
        posted:
          description: Source-provided posted amount; null when unavailable.
          nullable: true
          type: string
        status:
          description: Source-provided bail status; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailCase:
      properties:
        case_details:
          description: Source-provided case details; null when unavailable.
          nullable: true
          type: string
        case_number:
          description: Source-provided case number; null when unavailable.
          nullable: true
          type: string
        case_title:
          description: Source-provided case title; null when unavailable.
          nullable: true
          type: string
        category:
          description: Source-provided case category; null when unavailable.
          nullable: true
          type: string
        chapter:
          description: Source-provided bankruptcy chapter; null when unavailable.
          nullable: true
          type: string
        company_interest:
          description: Source-provided company interest; null when unavailable.
          nullable: true
          type: string
        county:
          description: Source-provided county; null when unavailable.
          nullable: true
          type: string
        court:
          description: Source-provided court; null when unavailable.
          nullable: true
          type: string
        discharge_date:
          description: Source-provided discharge date; null when unavailable.
          nullable: true
          type: string
        disposition:
          description: Source-provided disposition; null when unavailable.
          nullable: true
          type: string
        disposition_date:
          description: Source-provided disposition date; null when unavailable.
          nullable: true
          type: string
        division:
          description: Source-provided court division; null when unavailable.
          nullable: true
          type: string
        docket_number:
          description: Source-provided docket number; null when unavailable.
          nullable: true
          type: string
        document_id:
          description: Source-provided document reference; null when unavailable.
          nullable: true
          type: string
        filed_date:
          description: Source-provided filed date; null when unavailable.
          nullable: true
          type: string
        filing_office:
          description: Source-provided filing office; null when unavailable.
          nullable: true
          type: string
        filing_state:
          description: Source-provided filing state; null when unavailable.
          nullable: true
          type: string
        final_decree_date:
          description: Source-provided final decree date; null when unavailable.
          nullable: true
          type: string
        judge:
          description: Source-provided judge; null when unavailable.
          nullable: true
          type: string
        jury_demand:
          description: Source-provided jury demand; null when unavailable.
          nullable: true
          type: string
        jury_demand_amount:
          description: Source-provided jury demand amount; null when unavailable.
          nullable: true
          type: string
        nature_of_suit:
          description: Source-provided nature of suit; null when unavailable.
          nullable: true
          type: string
        nature_of_suit_code:
          description: Source-provided nature of suit code; null when unavailable.
          nullable: true
          type: string
        state:
          description: Source-provided state; null when unavailable.
          nullable: true
          type: string
        status:
          description: Source-provided case status; null when unavailable.
          nullable: true
          type: string
        sub_category:
          description: Source-provided case subcategory; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailCharge:
      properties:
        additional_fields:
          description: Unmapped source values as label and value pairs.
          items:
            $ref: '#/components/schemas/DetailLabelValue'
          type: array
        amended_offense:
          description: Source-provided amended offence; null when unavailable.
          nullable: true
          type: string
        amended_statute:
          description: Source-provided amended statute; null when unavailable.
          nullable: true
          type: string
        case_comments:
          description: Source-provided case comments; null when unavailable.
          nullable: true
          type: string
        case_information:
          description: Source-provided case information; null when unavailable.
          nullable: true
          type: string
        case_number:
          description: Source-provided case number; null when unavailable.
          nullable: true
          type: string
        case_status:
          description: Source-provided case status; null when unavailable.
          nullable: true
          type: string
        category:
          description: Source-provided charge category; null when unavailable.
          nullable: true
          type: string
        citation_number:
          description: Source-provided citation number; null when unavailable.
          nullable: true
          type: string
        class_of_offense:
          description: Source-provided class of offence; null when unavailable.
          nullable: true
          type: string
        counts:
          description: Source-provided counts; null when unavailable.
          nullable: true
          type: string
        court_charge:
          description: Source-provided court charge; null when unavailable.
          nullable: true
          type: string
        court_county:
          description: Source-provided court county; null when unavailable.
          nullable: true
          type: string
        court_name:
          description: Source-provided court name; null when unavailable.
          nullable: true
          type: string
        crime_date:
          description: Source-provided crime date; null when unavailable.
          nullable: true
          type: string
        disposition:
          description: Source-provided disposition; null when unavailable.
          nullable: true
          type: string
        disposition_date:
          description: Source-provided disposition date; null when unavailable.
          nullable: true
          type: string
        duplicate_report:
          description: True when the charge duplicates another reported entry.
          type: boolean
        facts:
          description: >-
            Arrest entries only: this entry's own key facts as label and value
            pairs, ahead of the unmapped source values.
          items:
            $ref: '#/components/schemas/DetailLabelValue'
          type: array
        fee_amount:
          description: Source-provided fee amount; null when unavailable.
          nullable: true
          type: string
        filed_date:
          description: Source-provided filed date; null when unavailable.
          nullable: true
          type: string
        fined_amount:
          description: Source-provided fined amount; null when unavailable.
          nullable: true
          type: string
        max_sentence_months:
          description: Source-provided maximum sentence months; null when unavailable.
          nullable: true
          type: string
        offense:
          description: Source-provided offence; null when unavailable.
          nullable: true
          type: string
        offense_code:
          description: Source-provided offence code; null when unavailable.
          nullable: true
          type: string
        offense_date:
          description: Source-provided offence date; null when unavailable.
          nullable: true
          type: string
        offense_notes:
          description: Source-provided offence notes; null when unavailable.
          nullable: true
          type: string
        plea:
          description: Source-provided plea; null when unavailable.
          nullable: true
          type: string
        probation_months:
          description: Source-provided probation months; null when unavailable.
          nullable: true
          type: string
        sentence:
          description: Source-provided sentence; null when unavailable.
          nullable: true
          type: string
        sequence:
          description: Source-provided charge sequence; null when unavailable.
          nullable: true
          type: string
        severity:
          description: Source-provided charge severity; null when unavailable.
          nullable: true
          type: string
        source_entry_id:
          description: Source-provided source entry reference; null when unavailable.
          nullable: true
          type: string
        statute:
          description: Source-provided statute; null when unavailable.
          nullable: true
          type: string
        warrant_date:
          description: Source-provided warrant date; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailLienDebtor:
      properties:
        address:
          description: Source-provided address; null when unavailable.
          nullable: true
          type: string
        duns_number:
          description: Source-provided DUNS number; null when unavailable.
          nullable: true
          type: string
        fein:
          description: Source-provided federal EIN; null when unavailable.
          nullable: true
          type: string
        name:
          description: Source-provided name; null when unavailable.
          nullable: true
          type: string
        owed_amount:
          description: Source-provided owed amount; null when unavailable.
          nullable: true
          type: string
        role:
          description: Source-provided role; null when unavailable.
          nullable: true
          type: string
        suffix:
          description: Source-provided name suffix; null when unavailable.
          nullable: true
          type: string
        type_of_party:
          description: Source-provided stated party type; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailDefendant:
      properties:
        additional_fields:
          description: Unmapped source values as label and value pairs.
          items:
            $ref: '#/components/schemas/DetailLabelValue'
          type: array
        address:
          description: Source-provided address; null when unavailable.
          nullable: true
          type: string
        addresses:
          description: Addresses on the record; arrests can carry several.
          items:
            type: string
          type: array
        akas:
          description: Also-known-as names on the record.
          items:
            type: string
          type: array
        dob:
          description: Source-provided date of birth; null when unavailable.
          nullable: true
          type: string
        name:
          description: Source-provided defendant name; null when unavailable.
          nullable: true
          type: string
        sex:
          description: Source-provided sex; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailDocketEntry:
      properties:
        attorney:
          description: Source-provided attorney; null when unavailable.
          nullable: true
          type: string
        date:
          description: Source-provided entry date; null when unavailable.
          nullable: true
          type: string
        description:
          description: Source-provided entry description; null when unavailable.
          nullable: true
          type: string
        disposition:
          description: Source-provided disposition; null when unavailable.
          nullable: true
          type: string
        docketed_date:
          description: Source-provided docketed date; null when unavailable.
          nullable: true
          type: string
        document:
          description: Source-provided document; null when unavailable.
          nullable: true
          type: string
        entry_number:
          description: Source-provided entry number; null when unavailable.
          nullable: true
          type: string
        fee:
          description: Source-provided fee; null when unavailable.
          nullable: true
          type: string
        file_type:
          description: Source-provided file type; null when unavailable.
          nullable: true
          type: string
        judge:
          description: Source-provided judge; null when unavailable.
          nullable: true
          type: string
        location:
          description: Source-provided location; null when unavailable.
          nullable: true
          type: string
        misc:
          description: Source-provided miscellaneous notes; null when unavailable.
          nullable: true
          type: string
        party:
          description: Source-provided party; null when unavailable.
          nullable: true
          type: string
        party_type:
          description: Source-provided party type; null when unavailable.
          nullable: true
          type: string
        room:
          description: Source-provided room; null when unavailable.
          nullable: true
          type: string
        time:
          description: Source-provided time; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailFiling:
      properties:
        certificate_number:
          description: Source-provided certificate number; null when unavailable.
          nullable: true
          type: string
        court:
          description: Source-provided court; null when unavailable.
          nullable: true
          type: string
        court_county:
          description: Source-provided court county; null when unavailable.
          nullable: true
          type: string
        expire_date:
          description: Source-provided expiry date; null when unavailable.
          nullable: true
          type: string
        file_date:
          description: Source-provided file date; null when unavailable.
          nullable: true
          type: string
        file_number_full:
          description: Source-provided full file number; null when unavailable.
          nullable: true
          type: string
        file_pages:
          description: Source-provided file page count; null when unavailable.
          nullable: true
          type: string
        filing_date:
          description: Source-provided filing date; null when unavailable.
          nullable: true
          type: string
        filing_number:
          description: Source-provided filing number; null when unavailable.
          nullable: true
          type: string
        filing_office:
          description: Source-provided filing office; null when unavailable.
          nullable: true
          type: string
        filing_office_address:
          description: Source-provided filing office address; null when unavailable.
          nullable: true
          type: string
        filing_state:
          description: Source-provided filing state; null when unavailable.
          nullable: true
          type: string
        filing_type:
          description: Source-provided filing type; null when unavailable.
          nullable: true
          type: string
        hidden_filing_number:
          description: Source-provided hidden filing number; null when unavailable.
          nullable: true
          type: string
        original_filing_number:
          description: Source-provided original filing number; null when unavailable.
          nullable: true
          type: string
        perfected_date:
          description: Source-provided perfected date; null when unavailable.
          nullable: true
          type: string
        reference_file_number:
          description: Source-provided reference file number; null when unavailable.
          nullable: true
          type: string
        related_file_date:
          description: Source-provided related file date; null when unavailable.
          nullable: true
          type: string
        release_date:
          description: Source-provided release date; null when unavailable.
          nullable: true
          type: string
        type_of_action:
          description: Source-provided type of action; null when unavailable.
          nullable: true
          type: string
        type_of_filing:
          description: Source-provided type of filing; null when unavailable.
          nullable: true
          type: string
        type_of_tax:
          description: Source-provided type of tax; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailMeeting341:
      properties:
        date:
          description: Source-provided meeting date; null when unavailable.
          nullable: true
          type: string
        location:
          description: Source-provided meeting location; null when unavailable.
          nullable: true
          type: string
        time:
          description: Source-provided meeting time; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailParty:
      properties:
        address:
          description: Source-provided address; null when unavailable.
          nullable: true
          type: string
        akas:
          description: Also-known-as names on the party.
          items:
            type: string
          type: array
        attorneys:
          description: Attorneys the source ties to this party.
          items:
            $ref: '#/components/schemas/DetailAttorney'
          type: array
        name:
          description: Source-provided party name; null when unavailable.
          nullable: true
          type: string
        phone:
          description: Source-provided phone number; null when unavailable.
          nullable: true
          type: string
        reported_date:
          description: Source-provided reported date; null when unavailable.
          nullable: true
          type: string
        role:
          description: Source-provided role; null when unavailable.
          nullable: true
          type: string
        sex:
          description: Source-provided sex; null when unavailable.
          nullable: true
          type: string
        status:
          description: Source-provided status; null when unavailable.
          nullable: true
          type: string
        type_of_party:
          description: Source-provided stated party type; null when unavailable.
          nullable: true
          type: string
      type: object
    DetailSource:
      properties:
        publication_date:
          description: Source-provided publication date; null when unavailable.
          nullable: true
          type: string
        source_document_guid:
          description: Source-provided source document reference; null when unavailable.
          nullable: true
          type: string
        source_name:
          description: Source-provided source name; null when unavailable.
          nullable: true
          type: string
        source_state:
          description: Source-provided source state; null when unavailable.
          nullable: true
          type: string
      type: object
    CandidateTraceComponent:
      properties:
        part:
          description: >-
            Compared part of a compound field, such as street, city, zip, or
            name similarity.
          enum:
            - name_similarity
            - full_name_similarity
            - house
            - street
            - city
            - state
            - zip
            - zip5
            - zip4
          type: string
        value:
          description: >-
            Bool for exact part matches, a 0-1 float for fuzzy ones; null when
            uncompared.
          nullable: true
      required:
        - part
      type: object
    CandidateTraceModifier:
      properties:
        detail:
          description: Free-text specifics; display verbatim.
          nullable: true
          type: string
        effect:
          description: The strength delta this adjustment contributed.
          type: number
        kind:
          description: 'Adjustment applied: aka_lift, dba_basis, or premises_composite.'
          enum:
            - aka_lift
            - corroboration_admitted
            - dba_basis
            - merged_filing_basis
            - middle_initial_cap
            - partial_agreement_floor
            - premises_composite
          type: string
      required:
        - effect
        - kind
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.