openapi: 3.2.0 info: title: Advanced Screening and Monitoring Alert Export API description: 'Dow Jones ### Rate limits Most endpoints are subject to a general rate limit of 10,000 requests per user per 15 minutes. Some endpoints are also subject to a global concurrent request limit of 5 simultaneous requests per customer.' version: '3' license: {} contact: {} servers: - url: API_INSTANCE security: - basicAuth: [] - jwt: [] - clientCert: [] tags: - name: Alert Export description: The Alert Export API allows clients to export details of alerts, alert evidence and alert activities. paths: /alert/export/jsonl: post: summary: Export alerts description: 'Request to export alerts in the system as JSON-L format. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 90 ms | | 90th percentile | 460 ms | | 95th percentile | 561 ms | | 98th percentile | 651 ms | | 99th percentile | 755 ms | Each alert includes `riskTags` (including custom category stamps such as `cc42-active`) and `tags` (including `userTag-{pillLabel}-active|inactive` entries derived from those stamps when custom categories are enabled). No separate `customCategories` property is returned. Please note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at. ' operationId: alertExport tags: - Alert Export x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 89.07 p90: 459.66 p95: 560.44 p98: 650.23 p99: 754.4 sampleSize: 196722846 requestBody: required: true content: application/json: schema: type: object required: - alertFilter properties: alertFilter: allOf: - type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters - type: object properties: skip: type: integer default: 0 description: The number of records to skip. limit: type: integer default: 100 description: The number of records to return. Setting this to zero (0) returns all records. sort: type: string example: time.created:-1 enum: - id:-1 - id:1 - time.created:-1 - time.created:1 - time.lastEvidence:-1 - time.lastEvidence:1 - time.lastUpdated:-1 - time.lastUpdated:1 - currentStatus.status:-1 - currentStatus.status:1 - target:-1 - target:1 - state:-1 - state:1 - score:-1 - score:1 - docCount:1 - docCount:-1 operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR projections: type: object description: set of fields to return example: client: clientId: true name: true entityType: true properties: client: type: object description: 'An object defining the client fields that should be returned in the response. The object should consist of properties whose names match the client field to be included, and whose value should been the boolean flag `true`. Consult the client import schema for details. ' links: clientImport: operationId: clientBulkImport properties: clientFieldName: type: boolean description: Replace clientFieldName with the name of the client field to be returned, for example `name` components: schemas: AlertFilter: allOf: - type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters - type: object properties: skip: type: integer default: 0 description: The number of records to skip. limit: type: integer default: 100 description: The number of records to return. Setting this to zero (0) returns all records. sort: type: string example: time.created:-1 enum: - id:-1 - id:1 - time.created:-1 - time.created:1 - time.lastEvidence:-1 - time.lastEvidence:1 - time.lastUpdated:-1 - time.lastUpdated:1 - currentStatus.status:-1 - currentStatus.status:1 - target:-1 - target:1 - state:-1 - state:1 - score:-1 - score:1 - docCount:1 - docCount:-1 operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR Filters: type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters NestedFilters: type: object required: - filters properties: filters: type: array items: oneOf: - type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters FilterKeyValues: type: object properties: tags: oneOf: - type: array items: type: string example: - policy-10127 - type: string example: policy-10127 previousAssignees: type: object properties: includes: type: array items: type: number example: - 10034 excludes: type: array items: type: number example: - 10034 id: oneOf: - type: array items: type: number example: - 10001 - type: number example: 10001 type: oneOf: - type: array items: type: number example: - 10127 - type: number example: 10127 state: oneOf: - type: array items: type: integer example: - 10127 - type: integer example: 10127 score: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 docCount: type: object properties: gte: type: number example: 0 lte: type: number example: 120 gt: type: number example: 40 lt: type: number example: 100 currentStatus.status: type: object properties: gte: type: number example: 10 lte: type: number example: 2000 gt: type: number example: 1 lt: type: number example: 100 time.created: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastEvidence: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 time.lastUpdated: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590973346512 gt: type: number example: 1590973346512 lt: type: number example: 1590973346512 target: description: The IDs of the client of clients to fetch alerts for. Note that the client IDs must have the prefix "eoi:" oneOf: - type: array items: type: string example: - eoi: - type: string example: eoi: Projections: type: object description: set of fields to return example: client: clientId: true name: true entityType: true properties: client: type: object description: 'An object defining the client fields that should be returned in the response. The object should consist of properties whose names match the client field to be included, and whose value should been the boolean flag `true`. Consult the client import schema for details. ' links: clientImport: operationId: clientBulkImport properties: clientFieldName: type: boolean description: Replace clientFieldName with the name of the client field to be returned, for example `name` responses: '200': description: Alert activities returned in JSON-L format content: application/json: schema: oneOf: - type: object description: Line-delimited JSON alert objects properties: history: type: array description: The assignment history of the alert items: type: object properties: assignedUsers: type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 timestamp: type: integer description: The timestamp for when the alert was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 assignedGroups: type: array description: list of group ids the alert has been assigned to, where appropriate. items: type: number example: 10 tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active listEntityIds: type: array description: a list of the IDs of the list entities or risk profiles that have generated evidence within the alert items: type: string description: the ID of the list entity or risk profile, including the namespace prefix example: listEntity:internal:test:test:arb-list-test-1 state: type: string description: Current state of the alert example: OPENED enum: - MONITORING - OPENED - CLOSED - REOPENED - OPENED_FIXED_PERIOD score: type: integer description: Score of the alert, based on the evidence accrued example: 100 sortKey: type: integer description: Internal field docCount: type: integer description: The total number of evidence items in the alert currentStatus: type: object description: records details of the alerts status (versus state) properties: status: type: object description: The current alert status properties: statusCode: type: integer description: The status code label: type: string description: The status code name / label example: statusCode: 100 label: Awaiting Allocation reason: type: object description: Closure reason details (if closed) properties: code: type: integer description: Closure code withAction: type: boolean description: Flag indicating if the alert was closed with further withAction value: type: string description: String representation of closure code isTrueHit: type: boolean description: Flag representing if this closure reason indicates risk isNoHit: type: boolean description: Flag representing if this closure reason indicates no risk example: code: 3 withAction: false value: Duplicate of a previous alert isTrueHit: true isNoHit: false consequence: type: object description: Closure consequence details (if closed) properties: code: type: integer description: Consequence code value: type: string description: String representation of consequence code level: type: string description: Severity of the consequence code example: code: 0 value: Client Communication level: Minor timestamp: type: integer description: timestamp of the last status change example: 1590989346512 time: type: object description: set of relevant timestamps for the alert properties: created: description: when the alert was created as an epoch timestamp in milliseconds type: integer lastUpdated: description: when the alert last received updated information as an epoch timestamp in milliseconds type: integer breached: description: when the alert transitioned from monitoring to opened as an epoch timestamp in milliseconds type: integer lastEvidence: description: when the last piece of evidence was added to the alert as an epoch timestamp in milliseconds type: integer namespace: type: string description: Internal field target: type: string description: The target object (client) that encapsulates the activity example: eoi:10001 security: type: object description: The alert's security object properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions description: type: string description: A brief description of the alert example: torch clientKey: type: string description: Internal field mode: type: string description: The client key the activity is owned by example: lowercasekey id: type: integer description: The id of the alert example: 10001 threshold: type: integer description: The value of the threshold to breach an alert when this alert breached example: 100 lastActivity: description: The timestamp of the last activity on the alert type: integer client: type: object description: details of the alert's associated client, conforming to the client schema from the client import API and filtered according to the projection clause of the request. discriminator: propertyName: entityType mapping: PERSON: ./PersonClient.yaml ORGANISATION: ./OrganisationClient.yaml VESSEL: ./VesselClient.yaml AIRCRAFT: ./AircraftClient.yaml anyOf: - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' description: "Entity specifier for a person. Must provide at least one of the following:\n\n * name (recommended)\n * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n" properties: entityType: const: PERSON gender: type: string titles: type: array items: type: string surname: type: string forename: type: string middlename: type: string suffixes: type: array items: type: string aliases: type: array items: type: object properties: titles: type: array items: type: string surname: type: string forename: type: string middlename: type: string name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' suffixes: type: array items: type: string nameType: type: string dateOfBirth: oneOf: - type: string - type: integer birthPlaceCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW deceasedOn: oneOf: - type: string - type: integer nationalityCodes: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW domicileCodes: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW occupation: type: string - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' properties: entityType: const: ORGANISATION companyName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' aliases: type: array items: type: object properties: companyName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' nameType: type: string dateOfIncorporation: oneOf: - type: string - type: integer incorporationCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW required: - companyName - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' description: 'An entity specifier for a maritime vessel. Must provide AT LEAST ONE of: name, aliases, vesselCallSigns or vesselImoNumber ' required: - vesselName properties: entityType: const: VESSEL aliases: type: array items: type: object properties: name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' nameType: type: string vesselName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' vesselCallSigns: type: array items: type: string vesselTypes: type: array items: type: string vesselTonnages: type: array items: type: number vesselOwners: type: array items: type: string vesselCustomers: type: array items: type: string vesselGrts: type: array items: type: number vesselFlags: type: array items: type: string vesselFlagsCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW vesselImoNumber: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' properties: entityType: const: AIRCRAFT aliases: type: array items: type: object properties: name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' nameType: type: string aircraftManufactureDate: oneOf: - type: string - type: integer aircraftModel: type: string aircraftName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' aircraftOperator: type: string countryOfAffiliationCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code '400': description: Bad request '401': description: Unauthenticated request '403': description: The authenticated user is not permitted to export alert activities '500': description: An unexpected error occurred when exporting alert activities content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code /alert/activity/export/jsonl: post: summary: Export alert activities description: 'Request to export alert activities in the system as JSON-L format ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 21 ms | | 90th percentile | 24 ms | | 95th percentile | 26 ms | | 98th percentile | 28 ms | | 99th percentile | 33 ms | Please note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at. ' operationId: alertExportActivity tags: - Alert Export x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 20.46 p90: 23.9 p95: 25.16 p98: 27.88 p99: 32.5 sampleSize: 74466 requestBody: required: true content: application/json: schema: type: object required: - activityFilter properties: activityFilter: oneOf: - type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters - type: object properties: skip: type: integer default: 0 description: The number of records to skip. limit: type: integer default: 100 description: The number of records to return. Setting this to zero (0) returns all records. sort: type: string example: createdAt:-1 enum: - createdAt:-1 - createdAt:1 components: schemas: ActivityFilter: oneOf: - type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters - type: object properties: skip: type: integer default: 0 description: The number of records to skip. limit: type: integer default: 100 description: The number of records to return. Setting this to zero (0) returns all records. sort: type: string example: createdAt:-1 enum: - createdAt:-1 - createdAt:1 Filters: type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters NestedFilters: type: object required: - filters properties: filters: type: array items: oneOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters ActivityFilterKeyValues: type: object allOf: - not: required: - createdBy - createdByExternalIds properties: alertIds: type: array items: type: number example: 10001 activityTypes: type: array items: type: string example: alertOpened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed activityDate: type: object properties: gte: type: number example: 1590973346512 lte: type: number example: 1590989346512 gt: type: number example: 1590989346512 lt: type: number example: 1590989346512 createdBy: description: Internal IDs of users who performed the activity. Cannot be used in conjunction with createdByExternalIds. type: array items: type: number example: 990 createdByExternalIds: description: External IDs of users who performed the activity. Cannot be used in conjunction with createdBy. type: array items: type: string example: john.smith@ripjar.com activityIds: type: array items: type: number example: 12 example: activityFilter: filters: - activityTypes: - alertOpened activityDate: gte: 0 lte: 1590989346512 - operator: OR filters: - alertIds: - 10001 - activityIds: - 1 operator: OR skip: 0 limit: 0 sort: createdAt:-1 responses: '200': description: Alert activities returned in JSON-L format content: application/json: schema: oneOf: - type: object description: Line-delimited JSON alert activity objects properties: id: type: number description: The activity\'s ID example: 10001 createdAt: type: number description: Time the activity was created as an Epoch timestamp example: 1590668036303 type: type: string description: The type of the activity example: alertReopened enum: - alertOpened - alertReopened - alertClosed - newEvidence - alertAssigned - alertViewed - alertStatusChanged - commentCreated - commentDeleted - commentEdited - evidenceAssessed - evidenceBulkAssessed description: type: string description: Description of the activity example: Evidence added to alert 10001 data: type: object description: Data relevant to the particular type of activity. This will vary depending on the type of activity that was captured. security: type: object description: The activity\'s security object example: {} target: type: string description: The target object that encapsulates the activity, prefixed with 'alert-' example: alert-10001 namespace: type: string description: The system namespace in which the activity occurred example: torch createdBy: description: details of the user who created the activity type: object properties: username: type: string description: the name of the user example: Example user email: type: string description: the email address of the user example: example.user@example.com roles: type: array description: the roles assigned to the user items: type: string example: ANALYST id: type: integer description: the system user ID of the user example: 10024 clientKey: type: string description: The client key the activity is owned by example: lowercasekey context: type: string description: the ID of the alert associated with the activity, prefixed with 'alert-' example: alert-186453 - type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code '400': description: Bad request content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code '401': description: Unauthenticated request content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code '403': description: The authenticated user is not permitted to export alert activities content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code '500': description: An unexpected error occurred when export alert activities content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code /alert/evidence/export/jsonl: post: summary: Export evidence description: 'Streaming filtered export of evidence in jsonl format. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 254 ms | | 90th percentile | 755 ms | | 95th percentile | 1.0 s | | 98th percentile | 1.4 s | | 99th percentile | 1.6 s | Each evidence row includes `riskTags` on that row only (custom categories as `cc{id}` with optional `-active` / `-inactive`). Exported `tags` include `userTag-{pillLabel}-active|inactive` derived from that row''s `riskTags`, not from the parent alert. Please note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at. ' operationId: alertEvidenceExport tags: - Alert Export x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 253.47 p90: 754.4 p95: 1015.36 p98: 1366.48 p99: 1585.2 sampleSize: 13124171 requestBody: required: true content: application/json: schema: type: object properties: evidenceFilter: description: nested filters oneOf: - type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters - type: object properties: skip: type: integer default: 0 description: The number of records to skip. limit: type: integer default: 100 description: The number of records to return. Setting this to zero (0) returns all records. sort: type: string description: field to sort by and sort order enum: - alertId:1 - alertId:-1 - createdTimestamp:1 - createdTimestamp:-1 - target:1 - target:-1 - totalRisk:1 - totalRisk:-1 enrich: type: object description: Instructions to enrich specific parts to the results properties: assessments: type: boolean description: enrich results with evidence assessment details default: false comments: type: boolean description: enrich results with comment details default: false matches: type: boolean description: enrich results with identity matches details. If using on a closed assessment, this matches field will not be populated. default: false lists: type: boolean description: enrich results with list entity details default: false projections: type: object description: set of fields to return or not return properties: assessments: type: object description: set of evidence assessment fields to return or not return evidence: type: object description: set of evidence fields to return or not return comments: type: object description: set of comments fields to return or not return lists: type: object description: set of list entity fields to return or not return example: name: true significantProfiles: true lists: true properties: activeStatus: type: boolean additionalNames: type: boolean additionalNamesAliasVariant: type: boolean additionalNamesArabicArabicNormalised: type: boolean additionalNamesDiacriticVariants: type: boolean additionalNamesHomophones: type: boolean additionalNamesLatinArabicNormalised: type: boolean additionalNamesLevenshteinVariants: type: boolean additionalNamesSubtractionVariants: type: boolean additionalNamesTlevVariants: type: boolean additionalNamesTransliterationVariants: type: boolean additionalNamesVariants: type: boolean addresses: type: boolean aliases: type: boolean ameDetails: type: boolean arabicArabicNormalisedName: type: boolean birthPlace: type: boolean birthPlaceCity: type: boolean birthPlaceCountry: type: boolean birthPlaceCountryCode: type: boolean callSignsPrefixCodes: type: boolean callSignsPrefixes: type: boolean callSignsVariants: type: boolean categories: type: boolean citizenship: type: boolean citizenshipCode: type: boolean coreName: type: boolean coreNameAliasVariants: type: boolean coreNameDiacriticVariants: type: boolean coreNameHomophones: type: boolean coreNameVariants: type: boolean countryOfReportedAllegation: type: boolean countryOfReportedAllegationCode: type: boolean dateOfBirthRange: type: boolean dateOfBirthRanges: type: boolean deceased: type: boolean deceasedDateRange: type: boolean deceasedDateRanges: type: boolean descriptions: type: boolean enhancedRiskCountry: type: boolean enhancedRiskCountryCode: type: boolean entityType: type: boolean default: true firstSeen: type: boolean firstSignificantSeen: type: boolean forename: type: boolean formerlySanctionedRegionCode: type: boolean gender: type: boolean hash: type: boolean id: type: boolean default: true identityNumbers: type: boolean imageKeys: type: boolean images: type: boolean initialisedNameVariants: type: boolean initialisedNames: type: boolean internal: type: boolean isSignificantProfile: type: boolean jurisdiction: type: boolean jurisdictionCode: type: boolean keyTerms: type: boolean lastModifiedDateRange: type: boolean lastSeen: type: boolean lastSignificantSeen: type: boolean lastSignificantUpdate: type: boolean latinArabicNormalisedName: type: boolean levSubtractionVariants: type: boolean levenshteinVariants: type: boolean listId: type: boolean lists: type: boolean default: true metadata: type: boolean default: true middlename: type: boolean name: type: boolean default: true nameOrigin: type: boolean ngrams: type: boolean normalisedName: type: boolean originalScriptName: type: boolean otherRoles: type: boolean previousRoles: type: boolean profileNotes: type: boolean residentOf: type: boolean residentOfCode: type: boolean roles: type: boolean sanctionedRegionCode: type: boolean script: type: boolean security: type: boolean significantDocuments: type: boolean significantProfiles: type: boolean singleStringName: type: boolean sources: type: boolean stateOwnershipDetails: type: boolean suffix: type: boolean surname: type: boolean systemEvent: type: boolean titleHonorific: type: boolean tlevVariants: type: boolean transliterationVariants: type: boolean cessationDateRange: type: boolean cessationDateRanges: type: boolean companyUrls: type: boolean countryOfAffiliation: type: boolean countryOfAffiliationCode: type: boolean countryOfRegistration: type: boolean countryOfRegistrationCode: type: boolean dateOfRegistrationRange: type: boolean dateOfRegistrationRanges: type: boolean formerlySanctionedRegion: type: boolean sanctionedRegion: type: boolean vesselAdditionalOperators: type: boolean vesselCallSigns: type: boolean vesselCustomers: type: boolean vesselFlags: type: boolean vesselFlagsCode: type: boolean vesselGrts: type: boolean vesselImoNumber: type: boolean vesselOwners: type: boolean vesselTonnages: type: boolean vesselTypes: type: boolean cities: type: boolean countryCode: type: boolean locationType: type: boolean enforceClientInEntity: type: boolean description: If enabled, `reasons.data.match.entity` will always contain the client entity, and the list profile will be included in `reasons.data.match.matchedData` components: schemas: EvidenceFilter: description: nested filters oneOf: - type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters - type: object properties: skip: type: integer default: 0 description: The number of records to skip. limit: type: integer default: 100 description: The number of records to return. Setting this to zero (0) returns all records. sort: type: string description: field to sort by and sort order enum: - alertId:1 - alertId:-1 - createdTimestamp:1 - createdTimestamp:-1 - target:1 - target:-1 - totalRisk:1 - totalRisk:-1 Filters: type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters NestedFilters: type: object properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: type: array items: oneOf: - type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) - type: object description: recursive filters properties: operator: type: string description: high level boolean operator (default "AND") enum: - AND - OR filters: description: recursive filters EvidenceFilterKeyValues: type: object properties: alertId: type: array items: type: integer description: the alert id of the evidence alertType: type: array items: type: integer description: the alert type of the evidence assessment.codes: type: array items: type: integer description: the alert type of the evidence totalRisk: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to fields greater or equal to this value gt: type: number description: Match to fields greater than this value lte: type: number description: Match to fields less or equal to this value lt: type: number description: Match to fields less than this value type: description: the type of alert enum: - list - risk createdTimestamp: description: filter the results based on the evidence created timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) assessment.timestamp: description: filter the results based on the evidence assessment timestamp type: object properties: gte: type: number description: Match to evidence greater or equal to than this unix timestamp (milliseconds) gt: type: number description: Match to evidence greater than this unix timestamp (milliseconds) lte: type: number description: Match to evidence less or equal to than this unix timestamp (milliseconds) lt: type: number description: Match to evidence less than this unix timestamp (milliseconds) example: evidenceFilter: filters: - alertId: - 10001 totalRisk: gte: 0 lte: 100 assessment.timestamp: gte: 0 lte: 1590973346512 - operator: AND filters: - createdTimestamp: gt: 0 - createdTimestamp: lt: 1590973346512 operator: OR skip: 0 limit: 0 sort: alertId:1 enrich: assessments: true comments: true matches: true lists: true projections: assessments: {} evidence: {} comments: {} lists: {} responses: '200': description: Evidence items returned in line-delimited JSON format content: application/jsonld: schema: oneOf: - description: Line-delimited JSON evidence objects type: object properties: alertId: type: number description: ID of associated alert example: 18793 documentId: type: string descrption: the ID of the underlying evidence document capturing the details of the matched profile example: 6119b7f33b0a33d02163d0fbeae918b75d7e98d7 alertType: type: number description: ID of policy that resulted in the associated alert example: 10001 clientKey: type: string description: User's client key example: lowercasekey createdTimestamp: type: number description: Time evidence was created as an Epoch timestamp example: 1592889012822 data: type: object description: Additional metadata example: documentSource: Risk Profiles properties: documentSource: type: string id: type: number description: The evidence item\'s ID example: 39824 listEntityId: type: string description: The ID of the list entity or risk profile associated with the evidence, including the full namespace prefix example: listEntity:list_entity-urn:ripjar:fix-jog-nec-pod isGroupMaster: type: boolean description: Determines whether the evidence item is a master item example: true matchTypes: type: array items: type: string enum: - NAME - ADDRESS - LOCATION namespace: type: string description: The system\'s namespace example: torch reasons: type: array items: type: object properties: data: type: object properties: match: type: object properties: active: type: boolean allPoliciesEvaluated: type: boolean cellId: type: string entity: description: The entity of interest sent for matching, either a client or a list depending on if the Alert is breached due to client load or profile load oneOf: - discriminator: propertyName: entityType mapping: PERSON: ./PersonClient.yaml ORGANISATION: ./OrganisationClient.yaml VESSEL: ./VesselClient.yaml AIRCRAFT: ./AircraftClient.yaml anyOf: - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' description: "Entity specifier for a person. Must provide at least one of the following:\n\n * name (recommended)\n * firstName and surname (with optional middleName)\n\nIf all three are provided, the system will use \"name\". Our recommendation is\nfor you to provide a single, whole, name string which we will then analyse.\n\n**Note**: Name structure is a cultural artefact. We strongly recommend using\nthe full name field as we handle many cross-cultural aspects. If you do wish\nto separate out the name then we consider \"firstName\" to be the given name of\nan individual, and \"surname\" to be a \"family\" name.\n" properties: entityType: const: PERSON gender: type: string titles: type: array items: type: string surname: type: string forename: type: string middlename: type: string suffixes: type: array items: type: string aliases: type: array items: type: object properties: titles: type: array items: type: string surname: type: string forename: type: string middlename: type: string name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' suffixes: type: array items: type: string nameType: type: string dateOfBirth: oneOf: - type: string - type: integer birthPlaceCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW deceasedOn: oneOf: - type: string - type: integer nationalityCodes: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW domicileCodes: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW occupation: type: string - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' properties: entityType: const: ORGANISATION companyName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' aliases: type: array items: type: object properties: companyName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' nameType: type: string dateOfIncorporation: oneOf: - type: string - type: integer incorporationCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW required: - companyName - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' description: 'An entity specifier for a maritime vessel. Must provide AT LEAST ONE of: name, aliases, vesselCallSigns or vesselImoNumber ' required: - vesselName properties: entityType: const: VESSEL aliases: type: array items: type: object properties: name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' nameType: type: string vesselName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' vesselCallSigns: type: array items: type: string vesselTypes: type: array items: type: string vesselTonnages: type: array items: type: number vesselOwners: type: array items: type: string vesselCustomers: type: array items: type: string vesselGrts: type: array items: type: number vesselFlags: type: array items: type: string vesselFlagsCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW vesselImoNumber: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - type: object allOf: - type: object required: - objectType - entityType - clientId properties: objectType: type: string enum: - client clientId: type: string entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' status: type: string enum: - ACTIVE - INACTIVE freeTextItems: type: array items: type: object properties: fieldId: type: string value: type: string required: - fieldId - value addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string security: type: object description: 'The security attributes applied to this data item. Labyrinth Screening applies Attribute-Based Security (ABAC) to some data items in the system, e.g. clients, alerts and attributes. These data items have security attributes defined that govern which users should have visibility of them. The rules governing this visibility are defined in the system''s security policy. Systems can have different security policies, but the default policy compares the dataRolesN tags of a given user to the orTagsN tags of each data item. For a user to have visibility of a data item, they need to have at least one tag in their dataRolesN tags for each of the corresponding orTagsN tags of the data item. ' properties: enabled: type: boolean default: false orTags1: type: array items: type: string orTags2: type: array items: type: string orTags3: type: array items: type: string andTags1: type: array items: type: string andTags2: type: array items: type: string andTags3: type: array items: type: string notTags1: type: array items: type: string notTags2: type: array items: type: string notTags3: type: array items: type: string compositeTags1: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions compositeTags2: type: array items: type: object description: an object containing a set of security tags that should be considered together when making access control decisions lastReviewed: type: string fixedAlertSpans: type: boolean description: A flag to indicate that this client's alerts should transition to fixed-period alerts at the specified interval. default: false fixedAlertSpanPeriod: type: string description: The period alerts should cover at the point they transition to fixed-period alerts. Specified as an integer value followed by a time unit indicator (d=day, h=hour, y=year). default: 1d fixedAlertSpanStartDate: default: the time the client is loaded description: 'The time that that the initial fixed period alerting should start. When the fixed-period setting above are set or updated for a client, the start of the next review period for the client is calculated as follows: The fixedAlertSpanStartDate is rounded up to the next midnight UTC and then offset by the number of minutes specified by alertingTimezone . When this initial alert period time is reached, the next review period is calculated by adding the fixedAlertSpanPeriod to this value. ' type: string format: date example: '2023-12-25' alertingTimezone: type: integer description: 'The timezone offset in minutes from midnight UTC that should be applied when calculating the start of each fixed alert period. For example, if alerts should transition to fixed period alerts at 03:00 UTC, the alertingTimezone should be set to 180. ' default: 0 periodicReviewPeriod: type: string periodicReviewStartDate: type: integer identityNumbers: type: array items: type: object properties: type: type: string value: type: string required: - type - value bookingCenter: type: string segment: type: string businessRelationshipNumbers: type: array items: type: string businessRelationship: type: array items: type: string riskScore: type: number riskDescription: type: string employeeContactDetails: type: object properties: name: type: string phoneNumber: type: string email: type: string industries: type: array items: type: string lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' properties: entityType: const: AIRCRAFT aliases: type: array items: type: object properties: name: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' nameType: type: string aircraftManufactureDate: oneOf: - type: string - type: integer aircraftModel: type: string aircraftName: type: string maxLength: 460 minLength: 1 description: 'The full name of the client. This is a key field used in identity matching. The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts. Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit. ' aircraftOperator: type: string countryOfAffiliationCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - description: The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled oneOf: - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: person: type: object description: 'The person entity schema must contain the following fileds; firstName, middleName, surname, name ' properties: name: type: string description: Full name of the person. Can be used as well as, or instead of, fields for individual name parts firstName: type: string description: Given name of the person surname: type: string description: Family name of the person aliases: type: array description: An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions items: type: object properties: type: type: string firstName: type: string surname: type: string middleName: type: string titleHonorific: type: string maidenName: type: string gender: type: string enum: - MALE - FEMALE - OTHER description: Known gender type of the person, must be in capitals deceased: type: boolean description: Is the person deceased? birthPlace: type: string description: The name of the persons birthplace. Populated automatically from birthPlaceCountryCode birthPlaceCity: type: string description: The persons city of birth dateOfBirthArray: type: array description: Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' images: type: array description: URLs pointing to the images of, or related to, the person items: type: string birthPlaceCountryCode: type: string description: The country code of the persons birth citizenshipCode: type: array description: Country codes of the countries for which the person has citizenship. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW residentOfCode: type: array description: Country codes of the countries for which the person is domiciled. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfReportedAllegationCode: type: array description: Country codes of the countries in which alleged misconduct took place. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW middleName: type: string description: Middle name of the person roles: type: array description: Current jobs or roles of the person items: type: object properties: name: type: string category: type: string categoryId: type: string since: type: string description: Date in the form yyyy-mm-dd previousRoles: type: array description: Past jobs or roles of the person items: type: object properties: name: type: string category: type: string categoryId: type: string since: type: string description: Date in the form yyyy-mm-dd to: type: string description: Date in the form yyyy-mm-dd jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW deceasedDateArray: type: array description: If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases suffix: type: string description: An honorific that comes after the person's name, rather than before - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: company: type: object description: 'The company entity schema must contain the following fields: name, keyTerms ' properties: name: type: string description: The companies main name suffix: type: string description: Company suffix, e.g. Ltd, PLC or GmbH aliases: type: array description: An array of alternative names by which a company is known items: type: object properties: type: type: string name: type: string suffix: type: string entityName: type: string dateOfRegistrationArray: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' companyURLs: type: array description: Associated URLs for the company items: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfAffiliationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW formerlySanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW sanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW cessationDateArray: type: array description: For non-active companies, the date(s) on which the company ceased trading items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' keyTerms: type: array description: Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles items: keyTerms: type: string - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: location: type: object description: "Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n" properties: name: type: string description: Name of the location countryCode: type: string maxLength: 2 minLength: 2 description: The country code of the location enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW locationType: type: string description: This must be country cities: type: array description: A list of names of cities associated with this location items: type: string subType: type: string enum: - country - city - region - sub-region - free-trade-zone - airport - port description: The sub-type of a location entity - allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. - type: object properties: entityType: type: string enum: - listVessel vesselCallSigns: type: array items: type: string vesselTypes: type: array items: type: string vesselTonnages: type: array items: type: integer vesselOwners: type: array items: type: string vesselCustomers: type: array items: type: string vesselGrts: type: array items: type: integer vesselFlags: type: array items: type: string vesselFlagsCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW vesselImoNumber: type: string vesselAdditionalOperators: type: array items: type: object properties: operatorCategory: type: string enum: - groupBeneficialOwner - operator - registeredOwner - shipManager - technicalManager operatorName: type: string countryOfControl: type: string countryOfDomicile: type: string countryOfRegistration: type: string - type: object allOf: - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: company: type: object description: 'The company entity schema must contain the following fields: name, keyTerms ' properties: name: type: string description: The companies main name suffix: type: string description: Company suffix, e.g. Ltd, PLC or GmbH aliases: type: array description: An array of alternative names by which a company is known items: type: object properties: type: type: string name: type: string suffix: type: string entityName: type: string dateOfRegistrationArray: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' companyURLs: type: array description: Associated URLs for the company items: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfAffiliationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW formerlySanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW sanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW cessationDateArray: type: array description: For non-active companies, the date(s) on which the company ceased trading items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' keyTerms: type: array description: Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles items: keyTerms: type: string properties: aircraft: type: object description: 'Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included. ' properties: name: type: string description: The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin. discriminator: propertyName: entityType mapping: listPerson: ./ListEntityPerson.yaml listAircraft: ./ListEntityAircraft.yaml listLocation: ./ListEntityLocation.yaml listOrganisation: ./ListEntityOrganisation.yaml listVessel: ./ListEntityVessel.yaml irs_version: type: integer isNew: type: boolean lineNumber: type: integer matchedData: description: Entity that matches the sent entity of interest, trimmed down to only properties required for matching anyOf: - additionalProperties: false properties: activeStatus: type: string addresses: items: additionalProperties: false properties: addressType: type: string city: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW line: type: string poBox: type: string postcode: type: string province: type: string type: object type: array aliases: items: additionalProperties: false properties: firstName: type: string maidenName: type: string middleName: type: string name: type: string suffix: type: string surname: type: string titleHonorific: type: string type: type: string type: object type: array associatedCities: items: type: string type: array associatedCountryCodes: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array citizenshipCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array clientKey: type: string dateOfBirthArray: items: anyOf: - type: string - items: - anyOf: - type: number - format: date-time type: string - type: 'null' - anyOf: - type: number - format: date-time type: string - type: 'null' - enum: - year - month - day - range type: string maxItems: '3' minItems: '3' type: array type: array dateOfDeceasedArray: items: anyOf: - type: string - items: - anyOf: - type: number - format: date-time type: string - type: 'null' - anyOf: - type: number - format: date-time type: string - type: 'null' - enum: - year - month - day - range type: string maxItems: '3' minItems: '3' type: array type: array deceased: type: boolean firstName: type: string formerlySanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array gender: enum: - MALE - FEMALE - OTHER type: string identityNumbers: items: additionalProperties: false properties: type: type: string value: type: string type: object type: array lastModifiedDate: anyOf: - format: date-time type: string - type: number lastReviewed: anyOf: - format: date-time type: string - type: number - type: string lastSignificantUpdate: anyOf: - format: date-time type: string - type: number lists: items: additionalProperties: false properties: active: type: boolean additionalFields: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array description: type: string hierarchy: items: additionalProperties: false properties: id: type: string name: type: string parent: type: string required: - id - name type: object type: array id: type: string jurisdiction: type: string jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW listActive: type: boolean name: type: string provider: type: string since: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object sinceRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object source: type: string tags: items: type: string type: array to: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object toRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object required: - id - name - description - active - listActive - hierarchy type: object type: array loadOptions: additionalProperties: false properties: suppressNotification: type: boolean type: object middleName: type: string name: type: string profileId: type: string residentOfCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array sanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array significantDocuments: items: additionalProperties: false properties: additionalProperties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array articleId: type: string dates: additionalProperties: false properties: arrivalDch: format: date-time type: string published: format: date-time type: string required: - published - arrivalDch type: object enTitle: type: string groupId: type: string language: type: string models: items: additionalProperties: false properties: confidence: type: number model: type: string name: type: string required: - name - model - confidence type: object type: array properties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array provider: type: string source: type: string storyline: type: string title: type: string required: - articleId - title - groupId - provider - source - dates type: object type: array status: type: string suffix: type: string surname: type: string tags: items: type: string type: array titleHonorific: type: string type: const: person type: string required: - profileId - type type: object - additionalProperties: false properties: activeStatus: type: string addresses: items: additionalProperties: false properties: addressType: type: string city: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW line: type: string poBox: type: string postcode: type: string province: type: string type: object type: array aliases: items: additionalProperties: false properties: name: type: string suffix: type: string type: type: string type: object type: array associatedCities: items: type: string type: array associatedCountryCodes: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array clientKey: type: string countryOfAffiliationCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array countryOfRegistrationCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array dateOfCessationArray: items: anyOf: - type: string - items: - anyOf: - type: number - format: date-time type: string - type: 'null' - anyOf: - type: number - format: date-time type: string - type: 'null' - enum: - year - month - day - range type: string maxItems: '3' minItems: '3' type: array type: array dateOfRegistrationArray: items: anyOf: - type: string - items: - anyOf: - type: number - format: date-time type: string - type: 'null' - anyOf: - type: number - format: date-time type: string - type: 'null' - enum: - year - month - day - range type: string maxItems: '3' minItems: '3' type: array type: array formerlySanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array identityNumbers: items: additionalProperties: false properties: type: type: string value: type: string type: object type: array lastModifiedDate: anyOf: - format: date-time type: string - type: number lastReviewed: anyOf: - format: date-time type: string - type: number - type: string lastSignificantUpdate: anyOf: - format: date-time type: string - type: number lists: items: additionalProperties: false properties: active: type: boolean additionalFields: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array description: type: string hierarchy: items: additionalProperties: false properties: id: type: string name: type: string parent: type: string required: - id - name type: object type: array id: type: string jurisdiction: type: string jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW listActive: type: boolean name: type: string provider: type: string since: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object sinceRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object source: type: string tags: items: type: string type: array to: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object toRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object required: - id - name - description - active - listActive - hierarchy type: object type: array loadOptions: additionalProperties: false properties: suppressNotification: type: boolean type: object name: type: string profileId: type: string sanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array significantDocuments: items: additionalProperties: false properties: additionalProperties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array articleId: type: string dates: additionalProperties: false properties: arrivalDch: format: date-time type: string published: format: date-time type: string required: - published - arrivalDch type: object enTitle: type: string groupId: type: string language: type: string models: items: additionalProperties: false properties: confidence: type: number model: type: string name: type: string required: - name - model - confidence type: object type: array properties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array provider: type: string source: type: string storyline: type: string title: type: string required: - articleId - title - groupId - provider - source - dates type: object type: array status: type: string suffix: type: string tags: items: type: string type: array type: const: organisation type: string required: - profileId - type type: object - additionalProperties: false properties: activeStatus: type: string addresses: items: additionalProperties: false properties: addressType: type: string city: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW line: type: string poBox: type: string postcode: type: string province: type: string type: object type: array aliases: items: additionalProperties: false properties: name: type: string type: type: string type: object type: array associatedCities: items: type: string type: array associatedCountryCodes: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array clientKey: type: string countryOfAffiliationCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array countryOfRegistrationCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array formerlySanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array identityNumbers: items: additionalProperties: false properties: type: type: string value: type: string type: object type: array lastModifiedDate: anyOf: - format: date-time type: string - type: number lastReviewed: anyOf: - format: date-time type: string - type: number - type: string lastSignificantUpdate: anyOf: - format: date-time type: string - type: number lists: items: additionalProperties: false properties: active: type: boolean additionalFields: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array description: type: string hierarchy: items: additionalProperties: false properties: id: type: string name: type: string parent: type: string required: - id - name type: object type: array id: type: string jurisdiction: type: string jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW listActive: type: boolean name: type: string provider: type: string since: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object sinceRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object source: type: string tags: items: type: string type: array to: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object toRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object required: - id - name - description - active - listActive - hierarchy type: object type: array loadOptions: additionalProperties: false properties: suppressNotification: type: boolean type: object name: type: string profileId: type: string sanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array significantDocuments: items: additionalProperties: false properties: additionalProperties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array articleId: type: string dates: additionalProperties: false properties: arrivalDch: format: date-time type: string published: format: date-time type: string required: - published - arrivalDch type: object enTitle: type: string groupId: type: string language: type: string models: items: additionalProperties: false properties: confidence: type: number model: type: string name: type: string required: - name - model - confidence type: object type: array properties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array provider: type: string source: type: string storyline: type: string title: type: string required: - articleId - title - groupId - provider - source - dates type: object type: array status: type: string tags: items: type: string type: array type: const: vessel type: string vesselCallSigns: items: type: string type: array vesselFlagsCode: items: type: string type: array vesselGrts: items: type: string type: array vesselImoNumber: type: string vesselOwners: items: type: string type: array vesselTonnages: items: type: string type: array vesselTypes: items: type: string type: array required: - profileId - type type: object - additionalProperties: false properties: activeStatus: type: string addresses: items: additionalProperties: false properties: addressType: type: string city: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW line: type: string poBox: type: string postcode: type: string province: type: string type: object type: array aliases: items: additionalProperties: false properties: name: type: string type: type: string type: object type: array associatedCities: items: type: string type: array associatedCountryCodes: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array clientKey: type: string countryOfAffiliationCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array countryOfRegistrationCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array formerlySanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array identityNumbers: items: additionalProperties: false properties: type: type: string value: type: string type: object type: array lastModifiedDate: anyOf: - format: date-time type: string - type: number lastReviewed: anyOf: - format: date-time type: string - type: number - type: string lastSignificantUpdate: anyOf: - format: date-time type: string - type: number lists: items: additionalProperties: false properties: active: type: boolean additionalFields: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array description: type: string hierarchy: items: additionalProperties: false properties: id: type: string name: type: string parent: type: string required: - id - name type: object type: array id: type: string jurisdiction: type: string jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW listActive: type: boolean name: type: string provider: type: string since: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object sinceRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object source: type: string tags: items: type: string type: array to: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object toRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object required: - id - name - description - active - listActive - hierarchy type: object type: array loadOptions: additionalProperties: false properties: suppressNotification: type: boolean type: object name: type: string profileId: type: string sanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array significantDocuments: items: additionalProperties: false properties: additionalProperties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array articleId: type: string dates: additionalProperties: false properties: arrivalDch: format: date-time type: string published: format: date-time type: string required: - published - arrivalDch type: object enTitle: type: string groupId: type: string language: type: string models: items: additionalProperties: false properties: confidence: type: number model: type: string name: type: string required: - name - model - confidence type: object type: array properties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array provider: type: string source: type: string storyline: type: string title: type: string required: - articleId - title - groupId - provider - source - dates type: object type: array status: type: string tags: items: type: string type: array type: const: aircraft type: string required: - profileId - type type: object - additionalProperties: false properties: activeStatus: type: string addresses: items: additionalProperties: false properties: addressType: type: string city: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW line: type: string poBox: type: string postcode: type: string province: type: string type: object type: array aliases: items: additionalProperties: false properties: name: type: string type: type: string type: object type: array associatedCities: items: type: string type: array associatedCountryCodes: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array cities: items: type: string type: array clientKey: type: string formerlySanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array identityNumbers: items: additionalProperties: false properties: type: type: string value: type: string type: object type: array lastModifiedDate: anyOf: - format: date-time type: string - type: number lastReviewed: anyOf: - format: date-time type: string - type: number - type: string lastSignificantUpdate: anyOf: - format: date-time type: string - type: number lists: items: additionalProperties: false properties: active: type: boolean additionalFields: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array description: type: string hierarchy: items: additionalProperties: false properties: id: type: string name: type: string parent: type: string required: - id - name type: object type: array id: type: string jurisdiction: type: string jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW listActive: type: boolean name: type: string provider: type: string since: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object sinceRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object source: type: string tags: items: type: string type: array to: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object toRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object required: - id - name - description - active - listActive - hierarchy type: object type: array loadOptions: additionalProperties: false properties: suppressNotification: type: boolean type: object name: type: string profileId: type: string sanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array significantDocuments: items: additionalProperties: false properties: additionalProperties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array articleId: type: string dates: additionalProperties: false properties: arrivalDch: format: date-time type: string published: format: date-time type: string required: - published - arrivalDch type: object enTitle: type: string groupId: type: string language: type: string models: items: additionalProperties: false properties: confidence: type: number model: type: string name: type: string required: - name - model - confidence type: object type: array properties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array provider: type: string source: type: string storyline: type: string title: type: string required: - articleId - title - groupId - provider - source - dates type: object type: array status: type: string subType: type: string enum: - country - city - region - sub-region - free-trade-zone - airport - port description: The sub-type of a location entity tags: items: type: string type: array type: const: location type: string required: - profileId - subType - type type: object - additionalProperties: false properties: activeStatus: type: string addresses: items: additionalProperties: false properties: addressType: type: string city: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW line: type: string poBox: type: string postcode: type: string province: type: string type: object type: array aliases: anyOf: - items: additionalProperties: false properties: name: type: string type: type: string type: object type: array - items: additionalProperties: false properties: firstName: type: string maidenName: type: string middleName: type: string name: type: string suffix: type: string surname: type: string titleHonorific: type: string type: type: string type: object type: array - items: additionalProperties: false properties: name: type: string suffix: type: string type: type: string type: object type: array associatedCities: items: type: string type: array associatedCountryCodes: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array clientKey: type: string formerlySanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array identityNumbers: items: additionalProperties: false properties: type: type: string value: type: string type: object type: array lastModifiedDate: anyOf: - format: date-time type: string - type: number lastReviewed: anyOf: - format: date-time type: string - type: number - type: string lastSignificantUpdate: anyOf: - format: date-time type: string - type: number lists: items: additionalProperties: false properties: active: type: boolean additionalFields: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array description: type: string hierarchy: items: additionalProperties: false properties: id: type: string name: type: string parent: type: string required: - id - name type: object type: array id: type: string jurisdiction: type: string jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW listActive: type: boolean name: type: string provider: type: string since: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object sinceRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object source: type: string tags: items: type: string type: array to: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object toRange: additionalProperties: false properties: end: anyOf: - format: date-time type: string - type: number granularity: enum: - year - month - day - range type: string start: anyOf: - format: date-time type: string - type: number required: - start - end - granularity type: object required: - id - name - description - active - listActive - hierarchy type: object type: array loadOptions: additionalProperties: false properties: suppressNotification: type: boolean type: object name: type: string profileId: type: string sanctionedRegionCode: items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: array significantDocuments: items: additionalProperties: false properties: additionalProperties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array articleId: type: string dates: additionalProperties: false properties: arrivalDch: format: date-time type: string published: format: date-time type: string required: - published - arrivalDch type: object enTitle: type: string groupId: type: string language: type: string models: items: additionalProperties: false properties: confidence: type: number model: type: string name: type: string required: - name - model - confidence type: object type: array properties: items: additionalProperties: false properties: key: type: string value: type: string required: - key - value type: object type: array provider: type: string source: type: string storyline: type: string title: type: string required: - articleId - title - groupId - provider - source - dates type: object type: array status: type: string tags: items: type: string type: array type: const: unknown type: string required: - profileId - type type: object notificationPolicyCombiner: type: object notificationPolicyResults: type: array items: type: object properties: className: type: string description: type: string evaluated: type: boolean executionTime: type: number name: type: string params: type: object properties: active_if_new: type: boolean data_source: type: string delta: type: integer diff_record_query: type: object properties: $or: type: array items: type: object properties: lists.hierarchy.id: type: object properties: $in: type: array items: type: string tags: type: object properties: $regex: type: string diff_rules: type: array items: type: object properties: field: type: string id_field: type: string new_field: type: 'null' reverse: type: boolean type: type: string inclusive: type: boolean operator: type: string threshold: type: integer reason: type: string value: type: boolean version: type: string reasons: type: array items: type: object properties: is_consistent: type: boolean is_match: type: boolean is_property_matcher_mandatory: type: boolean mandatory_group: type: integer match_score: type: integer matching_details: type: array items: type: object properties: data_source: type: string field: type: string field_label: type: string id: type: string special_score: type: integer value: type: string property_matcher_id: type: integer property_matcher_name: type: string result_reason: type: string weight: type: integer score: type: number individualMatchScore: type: number suppressed: type: boolean uuid: type: string policy: type: object properties: _id: type: string active: type: boolean cells: type: array items: type: object properties: cellId: type: string dataMatchingGroup: type: integer isStructured: type: boolean cellType: type: string enum: - NAME - ADDRESS - LOCATION notificationPolicyConfig: type: array items: type: object properties: class_name: type: string name: type: string params: type: object properties: data_source: type: string delta: type: integer diff_record_query: type: object properties: $or: type: array items: type: object properties: lists.hierarchy.id: type: object properties: $in: type: array items: type: string tags: type: object properties: $regex: type: string diff_rules: type: array items: type: object properties: field: type: string id_field: type: string type: type: string inclusive: type: boolean operator: type: string threshold: type: integer score: type: integer strategyKey: type: string tagQuery1: type: object properties: allTags: type: array items: type: string anyTags: type: array items: type: string noneTags: type: array items: type: string tagQuery2: type: object properties: allTags: type: array items: type: string anyTags: type: array items: type: string noneTags: type: array items: type: string clientKey: type: string created: type: number dataSource1: type: string dataSource2: type: string default: type: boolean disabled: type: boolean entityGroups: type: array items: type: integer id: type: integer lastUpdated: type: number matchOnlyFromDataSource2: type: boolean name: type: string systemGenerated: type: boolean threshold: type: integer type: type: string withExisting: type: boolean impact: type: integer matchScore: type: number individualMatchScore: type: number reasonType: type: string tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active target: type: string description: 'A representation of the target entity for which this evidence was raised ' example: eoi:329164 totalRisk: type: number description: The total risk contribution the evidence had to the associated alert example: 200 type: type: string description: The evidence type example: risk assessment: type: object description: Contains data related to the evidence\'s assessment example: codes: - 10001 user: email: bobby.tables@ripjar.com username: Bobby Tables id: '123' cn: example roles: - ROLE1 - ROLE2 timestamp: 1594050360827 properties: codes: type: array description: The assessment codes raised against the evidence items: description: Depending on configuration oneOf: - type: number - type: object properties: code: type: number description: type: string example: code: 10001 description: There is high confidence that the evidence references a client which has been correctly associated with risk user: type: object description: An object representing a user in the system. required: - username - email - cn properties: excludedApps: type: array items: type: string description: A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening. username: type: string description: The name of the user. This is the value displayed when the user is referenced in the UI. email: type: string description: The email address of the user. Can be used as part of basic authentication. mobile: type: string description: The mobile/cell phone number of the user. roles: type: array items: type: string description: 'A list of the user roles that this user has. Labyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users. Each role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system. These permissions used by the Screening system are described in the Ripjar Security Implementation document. When users are loaded into the system, each user account should include the list of roles they are allowed to perform. ' password: type: string description: 'The user''s password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users. ' cn: type: string description: The user's canonical name. Used to lookup user accounts when performing certificate-based authentication. externalId: type: string description: The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system. security: type: object description: 'The security attributes for this user. A user''s security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user''s roles, which govern the operations a user can carry out in the system. The security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system. By default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item. If the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute. ' properties: dataRoles1: type: array items: type: string dataRoles2: type: array items: type: string dataRoles3: type: array items: type: string compositeDataRoles1: type: array items: type: object timestamp: type: number description: When the assessment was performed, in epoch time example: 1594050360827 assessments: type: array description: Details of each assessment currently applied to the evidence items: properties: relevant: type: boolean example: true description: type: string example: There is high confidence that the evidence references a client which has been correctly associated with risk list: type: boolean example: true active: type: boolean example: true id: type: string example: '10001' risk: type: boolean example: true matches: type: array description: 'Contains data describing the matches between entities and the alerting client in the evidence ' items: type: object properties: active: type: boolean example: true activate_state: type: number example: 11974 active_from: type: number example: 1590674133787 blacklisted: type: boolean example: false reason: type: object properties: property_match_combiner_name: type: string example: Person News Combiner is_match: type: boolean example: true result_reason: type: string example: All properties were consistent match_score: type: number example: 0.6711888086280882 property_match_results: type: array example: - property_matcher_id: 1 is_consistent: true is_match: true result_reason: entity_types exactly match match_score: 1 property_matcher_name: Entity Type is_property_matcher_mandatory: true weight: 0 items: type: object description: Each object represents a match reason security: type: object data_source: type: string id: type: string comments: type: array items: type: object properties: namespace: type: string description: The namespace the comment belongs to example: torch target: type: string description: The ID of the resource the comment belongs to example: document-56350b74-3981-4734-8076-62163bca2255 security: type: object description: The comment's security block example: {} body: type: string description: The comment's content example: Hello, world context: type: string description: The alert the comment belongs to example: alert-10001 user: type: object description: An object representing a user in the system. required: - username - email - cn properties: excludedApps: type: array items: type: string description: A list of the applications that this user is excluded from accessing. Not used in Labyrinth Screening. username: type: string description: The name of the user. This is the value displayed when the user is referenced in the UI. email: type: string description: The email address of the user. Can be used as part of basic authentication. mobile: type: string description: The mobile/cell phone number of the user. roles: type: array items: type: string description: 'A list of the user roles that this user has. Labyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the interface to the needs of particular users. Each role is made up of a set of permissions which provide fine grained control over the actions a user can perform. Roles can be configured to match the business roles required by the users of the Screening system. These permissions used by the Screening system are described in the Ripjar Security Implementation document. When users are loaded into the system, each user account should include the list of roles they are allowed to perform. ' password: type: string description: 'The user''s password, used for basic authentication or to retrieve a bearer auth (JWT) token. Not available in API responses. Required when creating or updating users. ' cn: type: string description: The user's canonical name. Used to lookup user accounts when performing certificate-based authentication. externalId: type: string description: The user's ID external to the system. Typically maps to a username or ID in an external user entitlement system. security: type: object description: 'The security attributes for this user. A user''s security attributes govern the data items in the system (such as clients, alerts and assessments) that the user has visibility of. These are distinct from the user''s roles, which govern the operations a user can carry out in the system. The security schema contains a set of generic attributes that the user can be assigned. The meaning of these attributes varies depending on the security policy installed on the system. By default, the security policy will compare the list of strings (also known as tags) in dataRolesN fields of the user to the list of strings in the orTagsN field in the security attributes of the data item. If the user has any of the tags that appear on the data item, they can view that item. If the data item has multiple orTags fields, for example orTags1 and orTags2, the user must has at least one of the tags in each of the corresponding dataRoles fields, i.e. there is an AND logic between each attribute. ' properties: dataRoles1: type: array items: type: string dataRoles2: type: array items: type: string dataRoles3: type: array items: type: string compositeDataRoles1: type: array items: type: object clientKey: type: string description: The client key of the comment example: lowercasekey commentId: type: number description: The ID of the comment example: 10001 createdTimestamp: type: number description: The time the comment was created, in epoch time example: 1602680554666 listEntity: description: The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled oneOf: - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: person: type: object description: 'The person entity schema must contain the following fileds; firstName, middleName, surname, name ' properties: name: type: string description: Full name of the person. Can be used as well as, or instead of, fields for individual name parts firstName: type: string description: Given name of the person surname: type: string description: Family name of the person aliases: type: array description: An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions items: type: object properties: type: type: string firstName: type: string surname: type: string middleName: type: string titleHonorific: type: string maidenName: type: string gender: type: string enum: - MALE - FEMALE - OTHER description: Known gender type of the person, must be in capitals deceased: type: boolean description: Is the person deceased? birthPlace: type: string description: The name of the persons birthplace. Populated automatically from birthPlaceCountryCode birthPlaceCity: type: string description: The persons city of birth dateOfBirthArray: type: array description: Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' images: type: array description: URLs pointing to the images of, or related to, the person items: type: string birthPlaceCountryCode: type: string description: The country code of the persons birth citizenshipCode: type: array description: Country codes of the countries for which the person has citizenship. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW residentOfCode: type: array description: Country codes of the countries for which the person is domiciled. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfReportedAllegationCode: type: array description: Country codes of the countries in which alleged misconduct took place. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW middleName: type: string description: Middle name of the person roles: type: array description: Current jobs or roles of the person items: type: object properties: name: type: string category: type: string categoryId: type: string since: type: string description: Date in the form yyyy-mm-dd previousRoles: type: array description: Past jobs or roles of the person items: type: object properties: name: type: string category: type: string categoryId: type: string since: type: string description: Date in the form yyyy-mm-dd to: type: string description: Date in the form yyyy-mm-dd jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW deceasedDateArray: type: array description: If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases suffix: type: string description: An honorific that comes after the person's name, rather than before - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: company: type: object description: 'The company entity schema must contain the following fields: name, keyTerms ' properties: name: type: string description: The companies main name suffix: type: string description: Company suffix, e.g. Ltd, PLC or GmbH aliases: type: array description: An array of alternative names by which a company is known items: type: object properties: type: type: string name: type: string suffix: type: string entityName: type: string dateOfRegistrationArray: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' companyURLs: type: array description: Associated URLs for the company items: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfAffiliationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW formerlySanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW sanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW cessationDateArray: type: array description: For non-active companies, the date(s) on which the company ceased trading items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' keyTerms: type: array description: Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles items: keyTerms: type: string - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: location: type: object description: "Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n" properties: name: type: string description: Name of the location countryCode: type: string maxLength: 2 minLength: 2 description: The country code of the location enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW locationType: type: string description: This must be country cities: type: array description: A list of names of cities associated with this location items: type: string subType: type: string enum: - country - city - region - sub-region - free-trade-zone - airport - port description: The sub-type of a location entity - allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. - type: object properties: entityType: type: string enum: - listVessel vesselCallSigns: type: array items: type: string vesselTypes: type: array items: type: string vesselTonnages: type: array items: type: integer vesselOwners: type: array items: type: string vesselCustomers: type: array items: type: string vesselGrts: type: array items: type: integer vesselFlags: type: array items: type: string vesselFlagsCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW vesselImoNumber: type: string vesselAdditionalOperators: type: array items: type: object properties: operatorCategory: type: string enum: - groupBeneficialOwner - operator - registeredOwner - shipManager - technicalManager operatorName: type: string countryOfControl: type: string countryOfDomicile: type: string countryOfRegistration: type: string - type: object allOf: - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: company: type: object description: 'The company entity schema must contain the following fields: name, keyTerms ' properties: name: type: string description: The companies main name suffix: type: string description: Company suffix, e.g. Ltd, PLC or GmbH aliases: type: array description: An array of alternative names by which a company is known items: type: object properties: type: type: string name: type: string suffix: type: string entityName: type: string dateOfRegistrationArray: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' companyURLs: type: array description: Associated URLs for the company items: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfAffiliationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW formerlySanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW sanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW cessationDateArray: type: array description: For non-active companies, the date(s) on which the company ceased trading items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' keyTerms: type: array description: Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles items: keyTerms: type: string properties: aircraft: type: object description: 'Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included. ' properties: name: type: string description: The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin. discriminator: propertyName: entityType mapping: listPerson: ./ListEntityPerson.yaml listAircraft: ./ListEntityAircraft.yaml listLocation: ./ListEntityLocation.yaml listOrganisation: ./ListEntityOrganisation.yaml listVessel: ./ListEntityVessel.yaml - type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code '400': description: Bad request '401': description: Unauthenticated request '403': description: Unauthorised request '500': description: Internal Server Error components: securitySchemes: jwt: type: http scheme: bearer bearerFormat: JWT description: JWT authentication is the preferred authentication method, and should be used for new integrations. Contact support to request a service account. basicAuth: type: http scheme: basic description: Basic authentication is supported for existing users, but is deprecated. Existing users are encouraged to contact support for a dedicated service account and switch to JWT authentication.