api-ninjas-com Sanctions Screening API

openapi: 3.2.0
info:
  title: Ninjas Sanctions Screening API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Sanctions Screening
  description: 'The Sanctions Screening API screens a name (person, entity, vessel, or aircraft) against major government sanctions lists with fuzzy name matching and returns ranked matches with confidence scores.


    Available endpoints:

    - GET /v1/sanctionsscreening — screen a single name against the configured sanctions lists.


    Screen results are not retained on our servers. If you need an audit trail of historical screens (for example, to evidence what list versions were active when a customer was onboarded), store the full response payload on your end.'
paths:
  /v1/sanctionsscreening:
    get:
      tags:
      - Sanctions Screening
      summary: Screen a name against major government sanctions lists
      description: Returns ranked matches against the configured government sanctions lists. The set of lists and entity types available depends on subscription tier — Free covers OFAC SDN individuals only, Developer adds EU and entities, Business adds UK/UN/AU and vessels/aircraft.
      operationId: screenSanctions
      parameters:
      - $ref: '#/components/parameters/SanctionsScreeningOpenapi_name'
      - $ref: '#/components/parameters/entity_type'
      - $ref: '#/components/parameters/SanctionsScreeningOpenapi_country'
      - $ref: '#/components/parameters/dob'
      - $ref: '#/components/parameters/nationality'
      - $ref: '#/components/parameters/sources'
      - $ref: '#/components/parameters/min_score'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SanctionsScreenResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SanctionsScreeningOpenapi_ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SanctionsScreeningOpenapi_ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SanctionsScreeningOpenapi_ErrorResponse'
      security:
      - ApiKeyAuth: []
components:
  parameters:
    SanctionsScreeningOpenapi_name:
      in: query
      name: name
      required: true
      schema:
        type: string
      description: Name to screen. Full name, ordering doesn't matter.
      example: Vladimir Putin
    nationality:
      in: query
      name: nationality
      required: false
      schema:
        type: string
      description: ISO 3166-1 alpha-2 nationality filter. Developer tier and above.
    dob:
      in: query
      name: dob
      required: false
      schema:
        type: string
        format: date
      description: 'Date of birth (YYYY-MM-DD) to filter individual matches. Loose match: ±1 year. Developer tier and above.'
    min_score:
      in: query
      name: min_score
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 100
      description: Minimum confidence score (0-100) to return. Default 70. Developer tier and above.
    SanctionsScreeningOpenapi_country:
      in: query
      name: country
      required: false
      schema:
        type: string
      description: ISO 3166-1 alpha-2 country code to filter results by nationality/jurisdiction. Developer tier and above.
    sources:
      in: query
      name: sources
      required: false
      schema:
        type: string
      description: Comma-separated subset of OFAC,EU,UK,UN,AU to scope the screen to specific lists. Developer tier and above.
    entity_type:
      in: query
      name: entity_type
      required: false
      schema:
        type: string
        enum:
        - individual
        - entity
        - vessel
        - aircraft
      description: Restrict the screen to a specific entity type. Vessel and aircraft are Business tier and above.
  schemas:
    SanctionsScreeningOpenapi_ErrorResponse:
      type: object
      properties:
        error:
          type: string
    SanctionsScreenResponse:
      type: object
      properties:
        query:
          type: object
          properties:
            name:
              type: string
              example: Vladimir Putin
            entity_type:
              type:
              - string
              - 'null'
              example: null
            country:
              type:
              - string
              - 'null'
              example: null
            dob:
              type:
              - string
              - 'null'
              example: null
        matches:
          type: array
          items:
            $ref: '#/components/schemas/SanctionsMatch'
        list_versions:
          type: object
          additionalProperties:
            type: string
            format: date
          description: Per-source list-version dates active at screen time. Business tier and above.
          example:
            OFAC_SDN: '2026-05-13'
            EU_CFSP: '2026-05-12'
            UN_SC: '2026-05-08'
            UK_HMT: '2026-05-13'
            AU_DFAT: '2026-04-30'
        stale_data_warning:
          type:
          - object
          - 'null'
          description: Present when any source list is more than 7 days behind. Business tier and above.
          properties:
            stale_sources:
              type: array
              items:
                type: string
        attribution:
          type: array
          items:
            type: string
          description: Licence notices for the lists screened. Display them if you show or redistribute results.
        screened_at:
          type: integer
          description: Unix timestamp (seconds since epoch) at which the screen was performed.
          example: 1779032521
    SanctionsMatch:
      type: object
      properties:
        confidence_score:
          type: integer
          description: Match confidence from 0 to 100.
          example: 98
        match_strength:
          type: string
          enum:
          - strong
          - weak
          example: strong
        source_list:
          type: string
          enum:
          - OFAC_SDN
          - EU_CFSP
          - UN_SC
          - UK_HMT
          - AU_DFAT
          example: OFAC_SDN
        source_id:
          type: string
          example: '26746'
        entity_type:
          type: string
          enum:
          - individual
          - entity
          - vessel
          - aircraft
          example: individual
        primary_name:
          type: string
          example: PUTIN, Vladimir Vladimirovich
        matched_alias:
          type: string
          description: The alias the query name matched against (may equal primary_name).
          example: Vladimir Putin
        alias_quality:
          type: string
          enum:
          - primary
          - aka_strong
          - aka_weak
          example: primary
        date_of_birth:
          type: array
          items:
            type: string
            format: date
          example:
          - '1952-10-07'
        place_of_birth:
          type: array
          items:
            type: string
          example:
          - Leningrad, Russia
        nationalities:
          type: array
          items:
            type: string
          description: ISO 3166-1 alpha-2 country codes.
          example:
          - RU
        addresses:
          type: array
          items:
            type: string
          example: []
        identifiers:
          type: array
          items:
            type: string
          description: Passport numbers, national IDs, IMO numbers, aircraft tail numbers.
          example: []
        sanction_programs:
          type: array
          items:
            type: string
          example:
          - UKRAINE-EO13661
          - RUSSIA-EO14024
        designation_date:
          type: string
          format: date
          example: '2022-02-25'
        last_modified:
          type: integer
          description: Unix timestamp (seconds since epoch) of the last upstream record modification.
          example: 1726099200
        score_breakdown:
          type: object
          description: What drove the confidence score. Business tier and above.
          properties:
            name_similarity:
              type: number
              description: Name similarity, 0-100.
              example: 85.5
            token_overlap:
              type: number
              description: Overlap of name tokens regardless of order, 0-100.
              example: 100
            phonetic_match:
              type: boolean
              description: Whether the names sound alike.
              example: true
            alias_type:
              type: string
              enum:
              - primary
              - aka_strong
              - aka_weak
              description: Kind of name that matched.
              example: primary
        source_url:
          type: string
          example: https://sanctionssearch.ofac.treas.gov/Details.aspx?id=26746
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api