compliapi-com Screen API

openapi: 3.2.0
info:
  title: Compli Screen API
  description: 'Real-time OFAC/sanctions compliance screening. Authenticate with `Authorization: Bearer ` — create tokens in the dashboard.'
  contact:
    name: CompliAPI
    url: https://compliapi.com/
    email: help@compliapi.com
  version: 2.0.0
servers:
- url: https://api.compliapi.com/api/v1
tags:
- name: screen
paths:
  /screen/lists:
    get:
      tags:
      - screen
      summary: Screening Lists
      description: The source lists this API screens against. Unauthenticated, like /stats.
      operationId: screening_lists_screen_lists_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ListInfo'
                type: array
                title: Response Screening Lists Screen Lists Get
      security: []
  /screen/lists/{slug}/entities:
    get:
      tags:
      - screen
      summary: Screening List Entities
      description: 'Full current dataset for one source list (rendered on the marketing

        data-source pages and offered as a public download). Unauthenticated,

        like /stats; disabled or unknown lists 404.'
      operationId: screening_list_entities_screen_lists__slug__entities_get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: format
        in: query
        required: false
        schema:
          type: string
          pattern: ^(json|csv)$
          description: json (default) or csv.
          default: json
          title: Format
        description: json (default) or csv.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100000
          minimum: 1
          default: 5000
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEntitiesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security: []
  /screen/crypto/{address}:
    get:
      tags:
      - screen
      summary: Screen Crypto
      description: 'Screen a crypto address (any chain) or ENS name across the enabled lists.


        Dotted names (e.g. name.eth, name.base.eth) go through ENS resolution;

        everything else screens directly, so Bitcoin/Tron/... addresses just work.'
      operationId: screen_crypto_screen_crypto__address__get
      parameters:
      - name: address
        in: path
        required: true
        schema:
          type: string
          title: Address
      - name: lists
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
          title: Lists
        description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /screen/email/{email}:
    get:
      tags:
      - screen
      summary: Screen Email
      description: Screen an email address across the enabled lists.
      operationId: screen_email_screen_email__email__get
      parameters:
      - name: email
        in: path
        required: true
        schema:
          type: string
          title: Email
      - name: lists
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
          title: Lists
        description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /screen/website:
    get:
      tags:
      - screen
      summary: Screen Website
      description: Screen a website or domain across the enabled lists.
      operationId: screen_website_screen_website_get
      parameters:
      - name: address
        in: query
        required: true
        schema:
          type: string
          description: Website address or web domain
          title: Address
        description: Website address or web domain
      - name: lists
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
          title: Lists
        description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /screen/id/{government_id}:
    get:
      tags:
      - screen
      summary: Screen Government Id
      description: Screen a government-issued identifier (fuzzy) across the enabled lists.
      operationId: screen_government_id_screen_id__government_id__get
      parameters:
      - name: government_id
        in: path
        required: true
        schema:
          type: string
          title: Government Id
      - name: lists
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
          title: Lists
        description: 'Comma-separated list slugs to screen against (default: all enabled lists).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /screen/pep:
    get:
      tags:
      - screen
      summary: Screen Pep
      description: 'Screen a person''s name against the OpenSanctions PEPs dataset

        (politically exposed persons — live proxy, not one of our ingested lists,

        so no `lists` filter and its own response shape). `pep` is true when any

        candidate clears the 0.7 decision threshold. Data: OpenSanctions.'
      operationId: screen_pep_screen_pep_get
      parameters:
      - name: name
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 200
          description: Full name of the person to screen.
          title: Name
        description: Full name of the person to screen.
      - name: birth_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Birth date (YYYY-MM-DD, or partial e.g. 1961) to sharpen matching.
          title: Birth Date
        description: Birth date (YYYY-MM-DD, or partial e.g. 1961) to sharpen matching.
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Country name or ISO code of citizenship/residence.
          title: Country
        description: Country name or ISO code of citizenship/residence.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 10
          minimum: 1
          description: Maximum candidates to return.
          default: 5
          title: Limit
        description: Maximum candidates to return.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PepScreenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /screen/country/{country}:
    get:
      tags:
      - screen
      summary: Screen Country
      description: 'Check whether a country or region carries sanctions designations.


        Designations are OFAC-curated today; the envelope matches the other

        /screen endpoints so coverage can extend to ...'
      operationId: getScreenCountryByCountry
      x-operation-id-source: derived
components:
  schemas:
    PepScreenResponse:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    HTTPValidationError:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    ListEntitiesResponse:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    ScreenResponse:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    ListInfo:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true