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

# Get a Screening Check

> Re-read a check by id. Checks are immutable — the result never changes after creation, so this is safe to poll and is not billed. Re-screening a subject against refreshed lists means POSTing a new check.



## OpenAPI

````yaml GET /v1/platform/screening/checks/{check_id}
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/screening/checks/{check_id}:
    get:
      tags:
        - screening
      summary: Get a screening check
      description: >-
        Re-read a check by id. Checks are immutable — the result never changes
        after creation, so this is safe to poll and is not billed. Re-screening
        a subject against refreshed lists means POSTing a new check.
      operationId: get_check_v1_platform_screening_checks__check_id__get
      parameters:
        - name: check_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: The screening check id.
            title: Check Id
          description: The screening check id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_ScreeningCheckRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    CommonResponse_ScreeningCheckRead_:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          $ref: '#/components/schemas/ScreeningCheckRead'
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse[ScreeningCheckRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ScreeningCheckRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        entityType:
          type: string
          title: Entitytype
        decision:
          type: string
          title: Decision
          description: >-
            The value to act on: clear, review, blocked, or unavailable. 'clear'
            = proceed; 'review'/'blocked' = hold for a human; 'unavailable'
            means the screening service could not complete — treat it as
            not-yet-screened, never clear.
        topScore:
          anyOf:
            - type: number
            - type: 'null'
          title: Topscore
          description: >-
            Highest match score among the hits (0.0–1.0), or null if none.
            DIAGNOSTIC ONLY — a name-similarity score, not a risk score. Do not
            build thresholds on it: a true watchlist entry scores 0.8122 on name
            alone while an innocent common name scores 0.7513; the score is not
            comparable between subjects screened with different amounts of
            identity data; and it moves as the watchlists refresh (the same
            entry scored 0.8762 and then 0.9025 two days later, unchanged
            software). Lists reload every 12h. Act on 'decision', which is a
            stable contract.
        dataCompleteness:
          type: string
          title: Datacompleteness
          description: >-
            full, partial, or name_only — how much identity data was screened. A
            name_only check is weaker; supply a date of birth or address to
            strengthen it.
        hits:
          items:
            $ref: '#/components/schemas/ScreeningHitRead'
          type: array
          title: Hits
        confirmWith:
          items:
            $ref: '#/components/schemas/ScreeningConfirmationField'
          type: array
          title: Confirmwith
          description: >-
            The ONE piece of identity data that would most improve this result —
            the strongest field you have not already sent. At most one entry, so
            send it and POST a new check; if that still hits, the next check
            asks for the next field, and nothing already in hand is ever asked
            for twice. Populated only when there is something to resolve
            ('review' or 'blocked'); empty on 'clear', and empty on
            'unavailable' because nothing was screened. Empty on a hit means the
            check is already as strong as this API can make it and the remaining
            question needs a human.
        subjectName:
          anyOf:
            - type: string
            - type: 'null'
          title: Subjectname
          description: The name that was screened, as submitted on the check.
        externalRef:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalref
        createdAt:
          type: string
          format: date-time
          title: Createdat
      type: object
      required:
        - id
        - entityType
        - decision
        - dataCompleteness
        - createdAt
      title: ScreeningCheckRead
      description: The result of a screening check.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ScreeningHitRead:
      properties:
        sourceList:
          type: string
          title: Sourcelist
        sourceId:
          type: string
          title: Sourceid
        entityName:
          type: string
          title: Entityname
        matchScore:
          type: number
          title: Matchscore
        category:
          type: string
          title: Category
          description: 'Legal effect: sanctions_blocking, sanctions_restricting, pep, other.'
        programs:
          items:
            type: string
          type: array
          title: Programs
      type: object
      required:
        - sourceList
        - sourceId
        - entityName
        - matchScore
        - category
      title: ScreeningHitRead
      description: One matched watchlist entity.
    ScreeningConfirmationField:
      properties:
        key:
          type: string
          title: Key
          description: >-
            The request-body field to send it in — always one this endpoint
            accepts, so the ask is directly actionable by re-POSTing a check
            with this field populated. E.g. 'dateOfBirth', 'governmentIds',
            'altNames', 'address'.
        label:
          type: string
          title: Label
          description: Human-readable name, for showing to whoever supplies it.
      type: object
      required:
        - key
        - label
      title: ScreeningConfirmationField
      description: One piece of identity data that would confirm or rule out a match.
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````