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

# Get Entity Report

> A stored report, owner only; ``?format=pdf`` renders it as PDF.

With X-Report-Token instead of a key: the report that token was issued for.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/reports/{report_id}
openapi: 3.1.0
info:
  title: Limitguard.ai
  description: >-
    Lead validation API: the company behind each lead checked against the NL and
    BE business registers, EU VAT and sanctions lists, plus company, KYB and
    agent wallet checks for developers and AI agents
  version: 0.1.0
servers:
  - url: https://api.limitguard.ai
security: []
paths:
  /v1/reports/{report_id}:
    get:
      tags:
        - reports
      summary: Get Entity Report
      description: >-
        A stored report, owner only; ``?format=pdf`` renders it as PDF.


        With X-Report-Token instead of a key: the report that token was issued
        for.
      operationId: get_entity_report_v1_reports__report_id__get
      parameters:
        - name: report_id
          in: path
          required: true
          schema:
            type: string
            title: Report Id
        - name: format
          in: query
          required: false
          schema:
            enum:
              - json
              - pdf
            type: string
            default: json
            title: Format
        - name: X-Report-Token
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Report-Token
      responses:
        '200':
          description: The stored report as JSON, or as PDF with ?format=pdf.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReport'
            application/pdf:
              schema:
                type: string
                format: binary
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    EntityReport:
      properties:
        report_id:
          type: string
          title: Report Id
        check_id:
          type: string
          title: Check Id
        schema_version:
          type: string
          title: Schema Version
          default: '1'
        created_at:
          type: string
          title: Created At
        entity:
          $ref: '#/components/schemas/ReportEntity'
        identity:
          items:
            $ref: '#/components/schemas/IdentityRecord'
          type: array
          title: Identity
        identification:
          anyOf:
            - $ref: '#/components/schemas/Identification'
            - type: 'null'
        sanctions:
          $ref: '#/components/schemas/SanctionsScreen'
        pep:
          $ref: '#/components/schemas/PepScreen'
        wallet:
          anyOf:
            - $ref: '#/components/schemas/WalletScreen'
            - type: 'null'
        domain:
          anyOf:
            - $ref: '#/components/schemas/DomainSignals'
            - type: 'null'
        financials:
          anyOf:
            - $ref: '#/components/schemas/FinancialsSection'
            - type: 'null'
        group_structure:
          anyOf:
            - $ref: '#/components/schemas/GroupStructure'
            - type: 'null'
        group_chain:
          anyOf:
            - $ref: '#/components/schemas/GroupChain'
            - type: 'null'
        be_accounts:
          anyOf:
            - $ref: '#/components/schemas/BeAccountsSection'
            - type: 'null'
        website_phones:
          anyOf:
            - items:
                $ref: '#/components/schemas/ReportWebsitePhone'
              type: array
            - type: 'null'
          title: Website Phones
        website_phones_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Website Phones Reason
        activity_evidence:
          anyOf:
            - $ref: '#/components/schemas/ActivityEvidence'
            - type: 'null'
        kbo_functions:
          anyOf:
            - $ref: '#/components/schemas/ReportKboFunctions'
            - type: 'null'
        entity_links:
          anyOf:
            - $ref: '#/components/schemas/ReportEntityLinks'
            - type: 'null'
        risk:
          $ref: '#/components/schemas/RiskSection'
        correlations:
          $ref: '#/components/schemas/Correlations'
        findings:
          items:
            $ref: '#/components/schemas/Finding'
          type: array
          maxItems: 12
          title: Findings
        findings_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Findings Note
        sources:
          items:
            $ref: '#/components/schemas/ReportSource'
          type: array
          title: Sources
        attributions:
          items:
            type: string
          type: array
          title: Attributions
        evidence:
          $ref: '#/components/schemas/Evidence'
      type: object
      required:
        - report_id
        - check_id
        - created_at
        - entity
        - sanctions
        - pep
        - risk
        - correlations
        - evidence
      title: EntityReport
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReportEntity:
      properties:
        entity_name:
          type: string
          title: Entity Name
        country:
          type: string
          title: Country
      type: object
      required:
        - entity_name
        - country
      title: ReportEntity
    IdentityRecord:
      properties:
        source:
          type: string
          title: Source
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        fetched_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Fetched At
        verified:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Verified
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        registration_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Registration Number
        legal_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Legal Status
        founding_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Founding Date
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        nace_main:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Nace Main
        contacts:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Contacts
        contacts_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Contacts Reason
        data_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Data Date
        profile:
          anyOf:
            - $ref: '#/components/schemas/CompanyProfile'
            - type: 'null'
        juridical_situation:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Juridical Situation
        activities:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Activities
        places_of_business:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Places Of Business
      type: object
      required:
        - source
        - status
      title: IdentityRecord
    Identification:
      properties:
        method:
          type: string
          enum:
            - given
            - website
          title: Method
        status:
          type: string
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        correlation:
          anyOf:
            - type: number
            - type: 'null'
          title: Correlation
        discovered_identifiers:
          items:
            $ref: '#/components/schemas/DiscoveredIdentifier'
          type: array
          title: Discovered Identifiers
      type: object
      required:
        - method
        - status
      title: Identification
      description: >-
        How the company was identified: from the numbers found on its own

        website, each checked with its register. Absent when the customer gave a

        number or discovery was skipped; present for every other outcome, also

        when nothing was found or the read was refused, blocked, timed out or
        failed.
    SanctionsScreen:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        screened_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Screened At
        result:
          type: string
          enum:
            - no_match
            - match
            - not_screened
          title: Result
        match_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Match Score
        threshold:
          type: number
          title: Threshold
        lists:
          items:
            $ref: '#/components/schemas/SanctionsList'
          type: array
          title: Lists
      type: object
      required:
        - status
        - result
        - threshold
      title: SanctionsScreen
    PepScreen:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        screened_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Screened At
        exposure:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Exposure
        matches:
          items:
            $ref: '#/components/schemas/app__models__report__PepMatch'
          type: array
          title: Matches
        truncated:
          type: boolean
          title: Truncated
          default: false
      type: object
      required:
        - status
      title: PepScreen
    WalletScreen:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        address:
          type: string
          title: Address
        chain:
          anyOf:
            - type: string
            - type: 'null'
          title: Chain
        valid_format:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Valid Format
        screening:
          type: string
          title: Screening
      type: object
      required:
        - status
        - address
        - screening
      title: WalletScreen
    DomainSignals:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        fetched_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Fetched At
        domain:
          type: string
          title: Domain
        domain_age_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Domain Age Days
        has_mx:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Mx
        has_spf:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Spf
        has_dmarc:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Dmarc
        ssl_valid:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Ssl Valid
        ssl_issuer:
          anyOf:
            - type: string
            - type: 'null'
          title: Ssl Issuer
        registered_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Registered At
      type: object
      required:
        - status
        - domain
      title: DomainSignals
    FinancialsSection:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        retrieved_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Retrieved At
        retrieved_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Retrieved Note
        cache_age_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cache Age Days
        has_filings:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Filings
        financial_year:
          anyOf:
            - type: integer
            - type: 'null'
          title: Financial Year
        adoption_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Adoption Date
        sbi_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Sbi Code
        currency:
          type: string
          title: Currency
          default: EUR
        balance_sheet:
          anyOf:
            - $ref: '#/components/schemas/BalanceSheet'
            - type: 'null'
        income_statement:
          anyOf:
            - $ref: '#/components/schemas/IncomeStatement'
            - type: 'null'
        consolidated:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Consolidated
        consolidated_balance_sheet:
          anyOf:
            - $ref: '#/components/schemas/BalanceSheet'
            - type: 'null'
        consolidated_income_statement:
          anyOf:
            - $ref: '#/components/schemas/IncomeStatement'
            - type: 'null'
        negative_equity:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Negative Equity
        current_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Current Ratio
        filing_age_years:
          anyOf:
            - type: integer
            - type: 'null'
          title: Filing Age Years
        benchmark:
          anyOf:
            - $ref: '#/components/schemas/FinancialsBenchmark'
            - type: 'null'
        derived_note:
          type: string
          title: Derived Note
          default: >-
            negative_equity, current_ratio and filing_age_years are derived from
            the filing as inputs for your own assessment, not a credit rating
      type: object
      required:
        - status
      title: FinancialsSection
      description: |-
        Financials (NL): the latest annual accounts filed with KVK.

        ``has_filings`` is None whenever the source did not answer: an
        ``unavailable`` source never reads as "none filed".
    GroupStructure:
      properties:
        status:
          type: string
          enum:
            - ok
            - not_found
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        lei:
          anyOf:
            - type: string
            - type: 'null'
          title: Lei
        legal_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Legal Name
        entity_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Status
        registration_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Registration Status
        next_renewal_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Renewal Date
        matched_by:
          anyOf:
            - type: string
              enum:
                - registration_number
                - legal_name
            - type: 'null'
          title: Matched By
        direct_parent:
          anyOf:
            - $ref: '#/components/schemas/ParentEntity'
            - type: 'null'
        ultimate_parent:
          anyOf:
            - $ref: '#/components/schemas/ParentEntity'
            - type: 'null'
        retrieved_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Retrieved At
        cache_age_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cache Age Days
        parents_screened:
          type: boolean
          const: false
          title: Parents Screened
          default: false
        source:
          type: string
          const: gleif
          title: Source
          default: gleif
      type: object
      required:
        - status
      title: GroupStructure
      description: |-
        Group structure from GLEIF Level 2 data.

        Parents are not screened for sanctions (Walker, 2026-09-25): that is a
        separately priced add-on, so ``parents_screened`` is always False. A
        parent is None when GLEIF holds no parent LEI record; on any status
        other than ``ok`` every entity field is None, never "no parent".
    GroupChain:
      properties:
        status:
          type: string
          enum:
            - ok
            - not_found
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
        nearest:
          anyOf:
            - type: string
            - type: 'null'
          title: Nearest
        top:
          anyOf:
            - type: string
            - type: 'null'
          title: Top
        links:
          items:
            $ref: '#/components/schemas/GroupLink'
          type: array
          maxItems: 12
          title: Links
        filing_year:
          anyOf:
            - type: integer
            - type: 'null'
          title: Filing Year
        filing_reference:
          anyOf:
            - type: string
            - type: 'null'
          title: Filing Reference
        parents_screened:
          type: boolean
          const: false
          title: Parents Screened
          default: false
      type: object
      required:
        - status
      title: GroupChain
      description: >-
        A Belgian company's group: the parent named in its NBB filing, chained
        up through GLEIF.


        Read from the latest filing's consolidated-accounts declaration and
        shareholder

        structure, then each named parent's GLEIF direct and ultimate parent.
        The chain

        stops at the first missing link. Shown, never scored; parents are not

        screened for sanctions (Walker, 2026-09-25).
    BeAccountsSection:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        has_filings:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Filings
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
        model_kind:
          anyOf:
            - type: string
              enum:
                - full
                - short
                - consolidated
                - unknown
            - type: 'null'
          title: Model Kind
        consolidated:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Consolidated
        enterprise_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Enterprise Name
        period_start:
          anyOf:
            - type: string
            - type: 'null'
          title: Period Start
        period_end:
          anyOf:
            - type: string
            - type: 'null'
          title: Period End
        approval_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Approval Date
        years:
          items:
            type: integer
          type: array
          title: Years
        values:
          additionalProperties:
            $ref: '#/components/schemas/AccountValue'
          type: object
          title: Values
        history:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: History
        history_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: History Reason
        periods:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Periods
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Url
        retrieved_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Retrieved At
        cache_age_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cache Age Days
        source:
          anyOf:
            - type: string
              enum:
                - web_services
                - consult
            - type: 'null'
          title: Source
      type: object
      required:
        - status
      title: BeAccountsSection
      description: >-
        Belgian annual accounts filed with the National Bank of Belgium.


        Shown on the report, never scored. ``values`` maps the official account
        code

        (``"70"`` turnover, ``"10/15"`` equity, ...) to the filed amounts;
        ``history``

        holds the two older years a small company's second filing adds. On any

        status other than ``ok`` every figure field is empty, never "nothing
        filed".

        ``source`` is ``"consult"`` when read from the public Consult app; None

        means the web services, or a report stored before.
    ReportWebsitePhone:
      properties:
        number:
          type: string
          title: Number
          description: E.164
          examples:
            - '+3220000000'
        type:
          type: string
          enum:
            - landline
            - mobile
            - freephone
          title: Type
        found_on_url:
          type: string
          title: Found On Url
        retrieved_at:
          type: string
          title: Retrieved At
        source:
          type: string
          const: website
          title: Source
          default: website
        source_label:
          type: string
          title: Source Label
          examples:
            - on example.com, contact page
        page_kind:
          anyOf:
            - type: string
              enum:
                - home
                - company_details
                - contact
                - about
            - type: 'null'
          title: Page Kind
        register_number_on_page:
          type: boolean
          title: Register Number On Page
          default: false
        whatsapp:
          type: boolean
          title: Whatsapp
          description: The site links this number on wa.me.
          default: false
      additionalProperties: false
      type: object
      required:
        - number
        - type
        - found_on_url
        - retrieved_at
        - source_label
      title: ReportWebsitePhone
      description: >-
        A phone number the company publishes on its own website, read as

        lead verify reads it (, ``models.lead_verify.WebsitePhone``), plus
        whether

        the same site links it to WhatsApp. The company's number, never a
        person's.
    ActivityEvidence:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        fetched_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Fetched At
        website:
          anyOf:
            - type: string
            - type: 'null'
          title: Website
        attribution:
          anyOf:
            - type: string
              enum:
                - registrant
                - number
                - site_data
                - name_city
            - type: 'null'
          title: Attribution
        registrant:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Registrant
        site_names:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Site Names
        products:
          items:
            type: string
          type: array
          title: Products
        numbers:
          items:
            type: string
          type: array
          title: Numbers
        shops:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Shops
        domain_registered_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain Registered At
        matched_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Matched Name
        matched_city:
          anyOf:
            - type: string
            - type: 'null'
          title: Matched City
        matched_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Matched Number
      type: object
      required:
        - status
      title: ActivityEvidence
      description: >-
        What the company's website and shop listings show about its activities.


        ``attribution`` is the Amendment 2 rule's answer
        (business_activities.attribute):

        a name match and one related source, the domain's RDAP ``registrant``, a
        company

        or VAT ``number`` on the site, or the site's own structured data
        (``site_data``);

        else ``name_city`` (a site name matching a trade name, same city); None:
        the

        site is not the company's as far as the sources show, and no activity is
        shown.

        ``registrant`` holds the organisation only (org, city, country,
        registrar_host),

        never a person's fields.
    ReportKboFunctions:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        functions:
          items:
            $ref: '#/components/schemas/ReportFunction'
          type: array
          title: Functions
        register_phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Register Phone
        register_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Register Email
        register_website:
          anyOf:
            - type: string
            - type: 'null'
          title: Register Website
        retrieved_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Retrieved At
        register_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Register Date
          description: The page's own 'state of the KBO database' date.
      additionalProperties: false
      type: object
      required:
        - status
      title: ReportKboFunctions
      description: >-
        The people and contact lines read from the company's public KBO search
        page

        at check time. ``status`` ok: ``functions`` is the whole "Functies"
        block ([] = the

        register lists none). Anything else: no name, never a stale or guessed
        one.
    ReportEntityLinks:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        links:
          items:
            $ref: '#/components/schemas/ReportEntityLink'
          type: array
          title: Links
        group_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Group Name
        group_site:
          anyOf:
            - type: string
            - type: 'null'
          title: Group Site
        place_checks:
          items:
            $ref: '#/components/schemas/ReportPlaceCheck'
          type: array
          title: Place Checks
        fetched_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Fetched At
      additionalProperties: false
      type: object
      required:
        - status
      title: ReportEntityLinks
      description: >-
        What the company trades as and the group it belongs to, from the
        websites

        the register lists, judged by the link check (lg-entity-link). ``links``
        are the

        shown links only: a name alone never links.
    RiskSection:
      properties:
        trust_score:
          type: integer
          title: Trust Score
        trust_level:
          type: string
          title: Trust Level
        recommendation:
          type: string
          title: Recommendation
        cluster:
          type: string
          title: Cluster
        confidence:
          type: number
          title: Confidence
        sources_checked:
          type: integer
          title: Sources Checked
        rules_fired:
          items:
            $ref: '#/components/schemas/RuleFired'
          type: array
          title: Rules Fired
      type: object
      required:
        - trust_score
        - trust_level
        - recommendation
        - cluster
        - confidence
        - sources_checked
      title: RiskSection
    Correlations:
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        scope_note:
          type: string
          title: Scope Note
        links:
          items:
            $ref: '#/components/schemas/CorrelationLink'
          type: array
          title: Links
      type: object
      required:
        - status
        - scope_note
      title: Correlations
    Finding:
      properties:
        action:
          type: string
          minLength: 1
          title: Action
        why:
          type: string
          minLength: 1
          title: Why
        expected_result:
          type: string
          minLength: 1
          title: Expected Result
      type: object
      required:
        - action
        - why
        - expected_result
      title: Finding
    ReportSource:
      properties:
        source:
          type: string
          title: Source
        status:
          type: string
          enum:
            - ok
            - unavailable
            - error
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        fetched_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Fetched At
        latency_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Latency Ms
      type: object
      required:
        - source
        - status
      title: ReportSource
    Evidence:
      properties:
        report_hash:
          type: string
          title: Report Hash
        hash_algorithm:
          type: string
          title: Hash Algorithm
          default: sha256
        canonicalization:
          type: string
          title: Canonicalization
          default: >-
            json.dumps(sort_keys=True, default=str) of the report without
            'evidence'
        audit_event_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Audit Event Id
      type: object
      required:
        - report_hash
      title: Evidence
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CompanyProfile:
      properties:
        status:
          type: string
          enum:
            - active
            - stopped
          title: Status
        stopped_on:
          anyOf:
            - type: string
            - type: 'null'
          title: Stopped On
          description: ISO date the business stopped, when it has
        headline:
          type: string
          title: Headline
        industry:
          anyOf:
            - $ref: '#/components/schemas/Industry'
            - type: 'null'
        other_activities:
          items:
            $ref: '#/components/schemas/Industry'
          type: array
          title: Other Activities
          default: []
        employees:
          anyOf:
            - $ref: '#/components/schemas/Employees'
            - type: 'null'
        branches:
          anyOf:
            - $ref: '#/components/schemas/Branches'
            - type: 'null'
          description: >-
            Always null: branch counts are not in the KVK basisprofiel and need
            a second paid request.
        kvk_non_mailing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Kvk Non Mailing
          description: >-
            True when the company asked KVK not to receive unsolicited marketing
            mail
        statutory_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Statutory Name
        trade_names:
          items:
            type: string
          type: array
          title: Trade Names
          default: []
        extended_legal_form:
          anyOf:
            - type: string
            - type: 'null'
          title: Extended Legal Form
        websites:
          items:
            type: string
          type: array
          title: Websites
          default: []
        lines:
          items:
            type: string
          type: array
          title: Lines
          default: []
        personal_data_withheld:
          type: boolean
          title: Personal Data Withheld
          description: >-
            True for a sole trader or other natural-person form: its personal
            register data is not returned
          default: false
      additionalProperties: false
      type: object
      required:
        - status
        - headline
      title: CompanyProfile
      description: >-
        What the KVK register says about the company, in fields and in plain
        lines.
    DiscoveredIdentifier:
      properties:
        kind:
          type: string
          enum:
            - kvk_number
            - kbo_number
            - vat_number
          title: Kind
        value:
          type: string
          title: Value
          examples:
            - '24330087'
            - 0809.309.701
            - NL810433941B01
        found_on_url:
          type: string
          title: Found On Url
        status:
          type: string
          enum:
            - confirmed
            - other_company
            - unverified
          title: Status
        registered_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Registered Name
        confirmed_by:
          anyOf:
            - type: string
              enum:
                - kvk
                - kbo
                - vies
            - type: 'null'
          title: Confirmed By
        name_match:
          anyOf:
            - type: number
            - type: 'null'
          title: Name Match
        used:
          type: boolean
          title: Used
          default: false
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
      additionalProperties: false
      type: object
      required:
        - kind
        - value
        - found_on_url
        - status
      title: DiscoveredIdentifier
      description: One number found on the website, and what its register says about it.
    SanctionsList:
      properties:
        name:
          type: string
          title: Name
        as_of:
          anyOf:
            - type: string
            - type: 'null'
          title: As Of
        as_of_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: As Of Reason
          default: not_reported_by_source
      type: object
      required:
        - name
      title: SanctionsList
    app__models__report__PepMatch:
      properties:
        caption:
          type: string
          title: Caption
        score:
          type: number
          title: Score
        datasets:
          items:
            type: string
          type: array
          title: Datasets
        topics:
          items:
            type: string
          type: array
          title: Topics
      type: object
      required:
        - caption
        - score
      title: PepMatch
    BalanceSheet:
      properties:
        assets:
          anyOf:
            - type: integer
            - type: 'null'
          title: Assets
        assets_current:
          anyOf:
            - type: integer
            - type: 'null'
          title: Assets Current
        assets_noncurrent:
          anyOf:
            - type: integer
            - type: 'null'
          title: Assets Noncurrent
        equity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Equity
        liabilities:
          anyOf:
            - type: integer
            - type: 'null'
          title: Liabilities
        liabilities_current:
          anyOf:
            - type: integer
            - type: 'null'
          title: Liabilities Current
        liabilities_noncurrent:
          anyOf:
            - type: integer
            - type: 'null'
          title: Liabilities Noncurrent
        provisions:
          anyOf:
            - type: integer
            - type: 'null'
          title: Provisions
        equity_and_liabilities:
          anyOf:
            - type: integer
            - type: 'null'
          title: Equity And Liabilities
      type: object
      title: BalanceSheet
      description: Whole euros, as filed.
    IncomeStatement:
      properties:
        gross_margin:
          anyOf:
            - type: integer
            - type: 'null'
          title: Gross Margin
        operating_result:
          anyOf:
            - type: integer
            - type: 'null'
          title: Operating Result
        result_before_tax:
          anyOf:
            - type: integer
            - type: 'null'
          title: Result Before Tax
        result_after_tax:
          anyOf:
            - type: integer
            - type: 'null'
          title: Result After Tax
        employee_benefits_expenses:
          anyOf:
            - type: integer
            - type: 'null'
          title: Employee Benefits Expenses
      type: object
      title: IncomeStatement
      description: Whole euros, as filed.
    FinancialsBenchmark:
      properties:
        fiscal_year:
          type: integer
          title: Fiscal Year
        same_sector:
          type: boolean
          title: Same Sector
        equity_ratio_pct:
          type: integer
          title: Equity Ratio Pct
        direction:
          type: string
          enum:
            - lower
            - higher
          title: Direction
        share:
          type: integer
          enum:
            - 50
            - 75
            - 90
          title: Share
      type: object
      required:
        - fiscal_year
        - same_sector
        - equity_ratio_pct
        - direction
        - share
      title: FinancialsBenchmark
      description: >-
        Where the filing's own-capital ratio sits among Dutch filings of the
        same

        year (KVK open data, aggregates only). ``share`` percent of those
        companies have a

        higher (direction "lower") or a lower (direction "higher") ratio;
        ``same_sector``

        is False when the comparison is with every Dutch company of the year.
    ParentEntity:
      properties:
        lei:
          type: string
          title: Lei
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
      type: object
      required:
        - lei
      title: ParentEntity
    GroupLink:
      properties:
        role:
          type: string
          enum:
            - shareholder
            - consolidating_parent
            - direct_parent
            - ultimate_parent
          title: Role
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        country_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Text
        enterprise_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Enterprise Number
        share_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Share Pct
        scope:
          anyOf:
            - type: string
              enum:
                - largest
                - smallest
            - type: 'null'
          title: Scope
        lei:
          anyOf:
            - type: string
            - type: 'null'
          title: Lei
        lei_registration_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Lei Registration Status
        lei_lapsed_since:
          anyOf:
            - type: integer
            - type: 'null'
          title: Lei Lapsed Since
        lookup:
          anyOf:
            - type: string
            - type: 'null'
          title: Lookup
        lookup_source:
          anyOf:
            - type: string
            - type: 'null'
          title: Lookup Source
        of:
          anyOf:
            - type: string
            - type: 'null'
          title: Of
        source:
          type: string
          title: Source
      type: object
      required:
        - role
        - source
      title: GroupLink
      description: >-
        One link of a group chain, with the source it comes from.


        ``shareholder`` and ``consolidating_parent`` come from the NBB filing

        (``source`` "NBB filing <year>"), with ``lookup`` saying how the GLEIF
        search

        for it went ("ok", "no_lei", "ambiguous_name", "not_cached",
        "country_unknown",

        ...). ``direct_parent`` and ``ultimate_parent`` come from GLEIF and name
        the

        link they belong to in ``of``.
    AccountValue:
      properties:
        current:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Current
        previous:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Previous
        reason_current:
          anyOf:
            - type: string
              enum:
                - not_in_filing
                - left_blank
                - not_published_short_form
            - type: 'null'
          title: Reason Current
        reason_previous:
          anyOf:
            - type: string
              enum:
                - not_in_filing
                - left_blank
                - not_published_short_form
            - type: 'null'
          title: Reason Previous
      type: object
      title: AccountValue
      description: |-
        One account code, current and previous year.

        Whole euros except code 9087 (average staff in full-time equivalents). A
        missing amount is None with its reason, never 0.
    ReportFunction:
      properties:
        role:
          type: string
          title: Role
          examples:
            - Bestuurder
        name:
          type: string
          title: Name
          examples:
            - Jan Janssens
        given:
          anyOf:
            - type: string
            - type: 'null'
          title: Given
          description: >-
            A natural person's given name(s) as printed; None for a legal
            person.
        since:
          anyOf:
            - type: string
            - type: 'null'
          title: Since
          description: ISO date; None when the page's date is unreadable.
      additionalProperties: false
      type: object
      required:
        - role
        - name
      title: ReportFunction
      description: One line of the register's "Functies" block, as printed there.
    ReportEntityLink:
      properties:
        name:
          type: string
          title: Name
        kind:
          type: string
          enum:
            - trades_as
            - brand
            - group_member
          title: Kind
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
        site:
          type: string
          title: Site
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        evidence:
          type: string
          enum:
            - place_of_business_address
            - registered_address
            - register_phone
            - register_email
            - company_number
            - domain_registrant
            - group_site
          title: Evidence
        place_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Place Number
        place_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Place Name
        confidence:
          type: number
          maximum: 1
          minimum: 0
          title: Confidence
      additionalProperties: false
      type: object
      required:
        - name
        - kind
        - site
        - evidence
        - confidence
      title: ReportEntityLink
      description: >-
        One link the link check judged and the gate showed, with the evidence it

        rests on. ``evidence`` is a code; the view turns it into a source line.


        This docstring is published in the API reference (the report routes
        declare

        EntityReport), so it names no internal engine
        (scripts/scan_sync_diff.py).
    ReportPlaceCheck:
      properties:
        number:
          anyOf:
            - type: string
            - type: 'null'
          title: Number
        place_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Place Name
        address_result:
          type: string
          enum:
            - match
            - no_match
          title: Address Result
        website_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Website Name
        name_result:
          anyOf:
            - type: string
              enum:
                - match
                - differs
            - type: 'null'
          title: Name Result
      additionalProperties: false
      type: object
      required:
        - address_result
      title: ReportPlaceCheck
      description: |-
        One place of business the register lists, against the websites it lists.
        ``name_result`` only when the address matched.
    RuleFired:
      properties:
        rule:
          type: string
          title: Rule
        kind:
          type: string
          enum:
            - cap
            - correlation
            - factor
            - source_gap
          title: Kind
        value:
          anyOf:
            - type: number
            - type: integer
            - type: string
            - type: 'null'
          title: Value
        effect:
          type: string
          title: Effect
      type: object
      required:
        - rule
        - kind
        - effect
      title: RuleFired
    CorrelationLink:
      properties:
        kind:
          type: string
          title: Kind
        value_display:
          type: string
          title: Value Display
        seen_with_report_id:
          type: string
          title: Seen With Report Id
        seen_at:
          type: string
          title: Seen At
        scope:
          type: string
          const: workspace_reports
          title: Scope
          default: workspace_reports
      type: object
      required:
        - kind
        - value_display
        - seen_with_report_id
        - seen_at
      title: CorrelationLink
    Industry:
      properties:
        code:
          type: string
          title: Code
          description: SBI code
          examples:
            - '01241'
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: KVK's own (Dutch) SBI description
          examples:
            - Teelt van appels en peren
        is_main:
          type: boolean
          title: Is Main
      additionalProperties: false
      type: object
      required:
        - code
        - is_main
      title: Industry
    Employees:
      properties:
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        full_time:
          anyOf:
            - type: integer
            - type: 'null'
          title: Full Time
        part_time:
          anyOf:
            - type: integer
            - type: 'null'
          title: Part Time
      additionalProperties: false
      type: object
      title: Employees
    Branches:
      properties:
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        commercial:
          anyOf:
            - type: integer
            - type: 'null'
          title: Commercial
      additionalProperties: false
      type: object
      title: Branches
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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