> ## Documentation Index > Fetch the complete documentation index at: https://docs.beltic.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Screening > Create a new compliance screening request. The `data.type` field determines the screening type and must be one of: - `screening/politically-exposed-person`: PEP screening - `screening/watchlist`: Sanctions and watchlist screening - `screening/business-watchlist`: Business sanctions screening - `screening/business-adverse-media`: Business adverse media screening Each type accepts a typed `query` object specific to that screening type. **Execution Modes:** - `async`: Returns immediately with pending status, processes in background (default) - `sync`: Waits for processing to complete (timeout: 55 seconds) ## OpenAPI ````yaml POST /v1/screenings openapi: 3.1.0 info: title: Beltic Screening API version: 1.0.0 description: >- # Compliance Screening API The Beltic Screening API provides compliance screening capabilities including PEP, Watchlist, and Business screening checks. ## Authentication All endpoints require authentication. Include your API key in the `X-Api-Key` header: ``` X-Api-Key: YOUR_API_KEY ``` ## Screening Types - **politically-exposed-person**: PEP screening - **watchlist**: Sanctions/watchlist screening - **business-watchlist**: Business sanctions screening - **business-adverse-media**: Business adverse media ## Execution Modes - **async** (default): Returns immediately with pending status. Poll GET endpoint for results. - **sync**: Waits up to 55 seconds for completion. contact: name: Beltic API Support email: engineering@beltic.com servers: - url: https://api.beltic.com description: Production security: - ApiKeyAuth: [] tags: - name: Screenings description: Compliance screening operations paths: /v1/screenings: post: tags: - Screenings summary: Create screening description: >- Create a new compliance screening request. The `data.type` field determines the screening type and must be one of: - `screening/politically-exposed-person`: PEP screening - `screening/watchlist`: Sanctions and watchlist screening - `screening/business-watchlist`: Business sanctions screening - `screening/business-adverse-media`: Business adverse media screening Each type accepts a typed `query` object specific to that screening type. **Execution Modes:** - `async`: Returns immediately with pending status, processes in background (default) - `sync`: Waits for processing to complete (timeout: 55 seconds) requestBody: content: application/json: schema: type: object properties: data: oneOf: - type: object properties: type: type: string enum: - screening/politically-exposed-person attributes: type: object properties: execution_mode: type: string enum: - sync - async default: async query: type: object properties: name_first: type: string minLength: 1 maxLength: 100 name_last: type: string minLength: 1 maxLength: 100 birthdate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ country_code: type: string minLength: 2 maxLength: 2 required: - name_first - name_last example: name_first: John name_last: Doe birthdate: '1985-01-15' country_code: US required: - query relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string format: uuid required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string format: uuid required: - type - id required: - data required: - type - attributes title: screening/politically-exposed-person example: type: screening/politically-exposed-person attributes: execution_mode: sync query: name_first: John name_last: Doe birthdate: '1985-01-15' country_code: US - type: object properties: type: type: string enum: - screening/watchlist attributes: type: object properties: execution_mode: type: string enum: - sync - async default: async query: type: object properties: name_first: type: string minLength: 1 maxLength: 100 name_last: type: string minLength: 1 maxLength: 100 birthdate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ country_code: type: string minLength: 2 maxLength: 2 required: - name_first - name_last example: name_first: John name_last: Doe country_code: US required: - query relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string format: uuid required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string format: uuid required: - type - id required: - data required: - type - attributes title: screening/watchlist example: type: screening/watchlist attributes: execution_mode: sync query: name_first: John name_last: Doe country_code: US - type: object properties: type: type: string enum: - screening/business-watchlist attributes: type: object properties: execution_mode: type: string enum: - sync - async default: async query: type: object properties: business_name: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 registration_number: type: string maxLength: 50 required: - business_name - country example: business_name: Acme Corp country: US required: - query relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string format: uuid required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string format: uuid required: - type - id required: - data required: - type - attributes title: screening/business-watchlist example: type: screening/business-watchlist attributes: execution_mode: sync query: business_name: Acme Corp country: US - type: object properties: type: type: string enum: - screening/business-adverse-media attributes: type: object properties: execution_mode: type: string enum: - sync - async default: async query: type: object properties: business_name: type: string minLength: 1 maxLength: 255 country: type: string minLength: 2 maxLength: 2 required: - business_name - country example: business_name: Acme Corp country: US required: - query relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string format: uuid required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string format: uuid required: - type - id required: - data required: - type - attributes title: screening/business-adverse-media example: type: screening/business-adverse-media attributes: execution_mode: sync query: business_name: Acme Corp country: US required: - data responses: '201': description: Screening created successfully content: application/json: schema: type: object properties: data: oneOf: - type: object properties: type: type: string enum: - screening/watchlist id: type: string attributes: type: object properties: status: type: string enum: - pending - processing - completed - failed - not_found execution_mode: type: string enum: - sync - async query: type: object additionalProperties: {} has_match: type: - boolean - 'null' created_at: type: string started_at: type: - string - 'null' completed_at: type: - string - 'null' errors: type: - array - 'null' items: type: object properties: code: type: string message: type: string details: type: object additionalProperties: {} required: - code - message matched_lists: type: - array - 'null' items: type: object properties: name: type: string url: type: string list_type: type: string list_types: type: array items: type: string slug: type: string flag_code: type: string country_code: type: string entities: type: array items: type: object properties: name: type: string alias_type: type: string birthdates: type: array items: type: object properties: day: type: string year: type: string month: type: string granularity: type: string birthdate: type: - string - 'null' match_types: type: array items: type: string ignore_list: type: array items: {} required: - status - execution_mode - query - has_match - created_at - completed_at - matched_lists relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string required: - type - id required: - data required: - type - id - attributes title: screening/watchlist - type: object properties: type: type: string enum: - screening/politically-exposed-person id: type: string attributes: type: object properties: status: type: string enum: - pending - processing - completed - failed - not_found execution_mode: type: string enum: - sync - async query: type: object additionalProperties: {} has_match: type: - boolean - 'null' created_at: type: string started_at: type: - string - 'null' completed_at: type: - string - 'null' errors: type: - array - 'null' items: type: object properties: code: type: string message: type: string details: type: object additionalProperties: {} required: - code - message result: type: - array - 'null' items: type: object properties: entity_id: type: string name: type: string birthdates: type: array items: type: string death_dates: type: array items: type: - string - 'null' locations: type: array items: type: - string - 'null' country: type: string sex: type: - string - 'null' positions: type: array items: type: object properties: pep_class: type: string source_key: type: string name: type: string topics: type: array items: type: string start_date: type: string end_date: type: - string - 'null' associates: type: array items: type: object properties: name: type: string relationship: type: string affiliations: type: array items: type: object properties: source_key: type: string name: type: string related_urls: type: array items: type: object properties: source_key: type: string name: type: string images: type: array items: type: - string - 'null' sources: type: object additionalProperties: {} match_types: type: array items: type: string pep_type: type: - string - 'null' ignore_list: type: array items: {} required: - status - execution_mode - query - has_match - created_at - completed_at - result relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string required: - type - id required: - data required: - type - id - attributes title: screening/politically-exposed-person - type: object properties: type: type: string enum: - screening/business-watchlist id: type: string attributes: type: object properties: status: type: string enum: - pending - processing - completed - failed - not_found execution_mode: type: string enum: - sync - async query: type: object additionalProperties: {} has_match: type: - boolean - 'null' created_at: type: string started_at: type: - string - 'null' completed_at: type: - string - 'null' errors: type: - array - 'null' items: type: object properties: code: type: string message: type: string details: type: object additionalProperties: {} required: - code - message matched_lists: type: array items: type: string sanction_list: type: array items: type: object properties: name: type: string url: type: string fitness_probity_list: type: array items: type: object properties: name: type: string url: type: string warning_list: type: array items: type: object properties: name: type: string url: type: string required: - status - execution_mode - query - has_match - created_at - completed_at relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string required: - type - id required: - data required: - type - id - attributes title: screening/business-watchlist - type: object properties: type: type: string enum: - screening/business-adverse-media id: type: string attributes: type: object properties: status: type: string enum: - pending - processing - completed - failed - not_found execution_mode: type: string enum: - sync - async query: type: object additionalProperties: {} has_match: type: - boolean - 'null' created_at: type: string started_at: type: - string - 'null' completed_at: type: - string - 'null' errors: type: - array - 'null' items: type: object properties: code: type: string message: type: string details: type: object additionalProperties: {} required: - code - message result: type: - object - 'null' properties: adverse_media: type: array items: type: object properties: title: type: string url: type: string date: type: string related_sources: type: array items: type: object properties: akas: type: array items: type: string birthdates: type: array items: type: - string - 'null' match_types: type: array items: type: string name: type: string id: type: string media: type: array items: type: object properties: date: type: string snippet: type: string url: type: string title: type: string sources: type: array items: type: object properties: country_codes: type: array items: type: string name: type: string token: type: string types: type: array items: type: string required: - status - execution_mode - query - has_match - created_at - completed_at relationships: type: object properties: account: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - account id: type: string required: - type - id required: - data business: type: object properties: data: type: - object - 'null' properties: type: type: string enum: - business id: type: string required: - type - id required: - data required: - type - id - attributes title: screening/business-adverse-media required: - data '400': description: Validation error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string code: type: string required: - status - title required: - errors '500': description: Internal server error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string code: type: string required: - status - title required: - errors security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Api-Key description: |- API key for authentication. Access https://console.beltic.com/ to obtain your API key. ````