> ## 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.

# Sanctions Screen Route

> Screen a name against the local OFAC SDN, EU and UN lists: matched entries.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/sanctions/screen
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/sanctions/screen:
    post:
      tags:
        - sanctions
      summary: Sanctions Screen Route
      description: >-
        Screen a name against the local OFAC SDN, EU and UN lists: matched
        entries.
      operationId: sanctions_screen_route_v1_sanctions_screen_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SanctionsScreenRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SanctionsScreenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    SanctionsScreenRequest:
      properties:
        name:
          type: string
          maxLength: 200
          minLength: 1
          title: Name
          description: Company or person name to screen
        country:
          anyOf:
            - type: string
              maxLength: 2
              minLength: 2
            - type: 'null'
          title: Country
          description: >-
            ISO 3166-1 alpha-2 country code (optional; orders matches, never
            excludes one)
      additionalProperties: false
      type: object
      required:
        - name
      title: SanctionsScreenRequest
    SanctionsScreenResponse:
      properties:
        possible_match:
          type: boolean
          title: Possible Match
        matches:
          items:
            $ref: '#/components/schemas/SanctionsMatch'
          type: array
          title: Matches
        matches_truncated:
          type: boolean
          title: Matches Truncated
          description: True when more entries matched than are listed
        lists_checked:
          items:
            type: string
          type: array
          title: Lists Checked
        list_dates:
          additionalProperties:
            anyOf:
              - type: string
              - type: 'null'
          type: object
          title: List Dates
          description: Each list's publication date, by list name
        disclaimer:
          type: string
          title: Disclaimer
        screened_at:
          type: string
          title: Screened At
          description: ISO 8601 timestamp of the screen
      type: object
      required:
        - possible_match
        - matches
        - matches_truncated
        - lists_checked
        - list_dates
        - disclaimer
        - screened_at
      title: SanctionsScreenResponse
      description: 'The paid screen: the matched entries.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SanctionsMatch:
      properties:
        list:
          type: string
          title: List
          description: The list's display name
        list_key:
          type: string
          title: List Key
          description: The list's stable key
        entry_id:
          type: string
          title: Entry Id
          description: The entry's id on its list
        entry_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Entry Type
          description: Person, entity, vessel or aircraft
        matched_name:
          type: string
          title: Matched Name
          description: The listed name or alias that matched
        programmes:
          items:
            type: string
          type: array
          title: Programmes
          description: Sanctions programmes of the entry
        countries:
          items:
            type: string
          type: array
          title: Countries
          description: Countries the entry names
        listed_on:
          anyOf:
            - type: string
            - type: 'null'
          title: Listed On
          description: Date the entry was listed
        match_score:
          type: number
          title: Match Score
          description: 1.0 for an exact name match, lower for a token match
        match_type:
          type: string
          enum:
            - name_exact
            - name_tokens
          title: Match Type
      type: object
      required:
        - list
        - list_key
        - entry_id
        - matched_name
        - programmes
        - countries
        - match_score
        - match_type
      title: SanctionsMatch
      description: >-
        One list entry the name matched.


        ``List`` from typing: the field named ``list`` shadows the builtin in
        this body.
    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
  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.