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

# Get customer screening

> Get read-only sanctions screening detail for a customer.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/customers/{customerId}/screening
openapi: 3.1.0
info:
  title: Nuvera API
  description: Nuvera Payment Platform REST API
  version: '1.0'
  contact: {}
servers:
  - url: http://localhost:45000
security: []
tags: []
paths:
  /api/v1/customers/{customerId}/screening:
    get:
      tags:
        - Screening
      summary: Get customer screening
      description: Get read-only sanctions screening detail for a customer.
      operationId: ScreeningController_getCustomerScreening
      parameters:
        - name: customerId
          required: true
          in: path
          schema:
            type: string
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectScreeningOutputDto_Output'
      security:
        - x-api-key: []
          signed-request: []
components:
  schemas:
    SubjectScreeningOutputDto_Output:
      type: object
      properties:
        subject:
          type: object
          properties:
            subjectId:
              type: string
            subjectType:
              type: string
              enum:
                - CUSTOMER
                - CUSTOMER_PERSON
                - CUSTOMER_LEGAL_ENTITY_SHAREHOLDER
                - BENEFICIARY
            entityId:
              type: string
            displayName:
              type: string
            customerId:
              anyOf:
                - type: string
                - type: 'null'
            customerName:
              anyOf:
                - type: string
                - type: 'null'
            beneficiaryId:
              anyOf:
                - type: string
                - type: 'null'
            status:
              type: string
              enum:
                - NOT_SCREENED
                - PENDING
                - CLEAR
                - UNDER_REVIEW
                - CLEARED
                - CONFIRMED_HIT
            paymentHold:
              type: boolean
            onboardingBlocked:
              type: boolean
            openMatchCount:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            lastScreenedAt:
              anyOf:
                - type: string
                - type: 'null'
            nextDueAt:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - subjectId
            - subjectType
            - entityId
            - displayName
            - customerId
            - customerName
            - beneficiaryId
            - status
            - paymentHold
            - onboardingBlocked
            - openMatchCount
            - lastScreenedAt
            - nextDueAt
          additionalProperties: false
        query:
          anyOf:
            - type: object
              properties:
                schema:
                  type: string
                  enum:
                    - Company
                    - Person
                properties:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      key:
                        type: string
                      values:
                        type: array
                        items:
                          type: string
                    required:
                      - label
                      - key
                      - values
                    additionalProperties: false
                algorithm:
                  type: string
                threshold:
                  type: string
                topicsScope:
                  type: array
                  items:
                    type: string
                datasetScope:
                  type: string
                dataVersion:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - schema
                - properties
                - algorithm
                - threshold
                - topicsScope
                - datasetScope
                - dataVersion
              additionalProperties: false
            - type: 'null'
        openMatches:
          type: array
          items:
            type: object
            properties:
              matchId:
                type: string
              osEntityId:
                type: string
              caption:
                type: string
              schema:
                type: string
              score:
                type: string
              isMatch:
                type: boolean
              topics:
                type: array
                items:
                  type: string
              datasets:
                type: array
                items:
                  type: string
              severity:
                type: string
                enum:
                  - BLOCKING
                  - ADVISORY
              alertState:
                type: string
                enum:
                  - NEW
                  - SUPPRESSED
                  - ESCALATED
              statusLabel:
                type: string
                enum:
                  - Needs decision
                  - Under review
                  - Suppressed
                  - Confirmed
                  - Cleared
              features:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    label:
                      type: string
                    score:
                      anyOf:
                        - type: string
                        - type: 'null'
                    matchedValue:
                      anyOf:
                        - type: string
                        - type: 'null'
                    candidateValue:
                      anyOf:
                        - type: string
                        - type: 'null'
                    note:
                      anyOf:
                        - type: string
                        - type: 'null'
                  required:
                    - key
                    - label
                    - score
                    - matchedValue
                    - candidateValue
                    - note
                  additionalProperties: false
              evidence:
                type: array
                items:
                  type: object
                  properties:
                    label:
                      type: string
                    values:
                      type: array
                      items:
                        type: string
                    fullWidth:
                      type: boolean
                  required:
                    - label
                    - values
                  additionalProperties: false
              aliases:
                type: array
                items:
                  type: string
              disposition:
                anyOf:
                  - type: object
                    properties:
                      id:
                        type: string
                      osEntityId:
                        type: string
                      disposition:
                        type: string
                        enum:
                          - TRUE_MATCH
                          - FALSE_POSITIVE
                          - ACCEPTED_PEP
                      reason:
                        type: string
                      topicsAtDecision:
                        type: array
                        items:
                          type: string
                      reviewedByUserId:
                        type: string
                      reviewedByDisplayName:
                        type: string
                      reviewedAt:
                        type: string
                    required:
                      - id
                      - osEntityId
                      - disposition
                      - reason
                      - topicsAtDecision
                      - reviewedByUserId
                      - reviewedByDisplayName
                      - reviewedAt
                    additionalProperties: false
                  - type: 'null'
              createdAt:
                type: string
            required:
              - matchId
              - osEntityId
              - caption
              - schema
              - score
              - isMatch
              - topics
              - datasets
              - severity
              - alertState
              - statusLabel
              - features
              - evidence
              - aliases
              - disposition
              - createdAt
            additionalProperties: false
        previouslyCleared:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              osEntityId:
                type: string
              disposition:
                type: string
                enum:
                  - TRUE_MATCH
                  - FALSE_POSITIVE
                  - ACCEPTED_PEP
              reason:
                type: string
              topicsAtDecision:
                type: array
                items:
                  type: string
              reviewedByUserId:
                type: string
              reviewedByDisplayName:
                type: string
              reviewedAt:
                type: string
            required:
              - id
              - osEntityId
              - disposition
              - reason
              - topicsAtDecision
              - reviewedByUserId
              - reviewedByDisplayName
              - reviewedAt
            additionalProperties: false
        historyCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        readOnlyReason:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - subject
        - query
        - openMatches
        - previouslyCleared
        - historyCount
        - readOnlyReason
      additionalProperties: false
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Nuvera API application secret key
    signed-request:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: RS256 per-request signed JWT

````