openapi: 3.2.0 info: title: Advanced Screening and Monitoring Entity 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: Entity description: The Entity API allows clients to retrieve details of and reconcile entities (i.e. clients, risk profiles and internal list entities) stored in the system. paths: /entity/client-count: get: summary: Fetch the number of clients in the system description: 'Returns the total number of clients in the system including counts of active and inactive clients. ### 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. ' operationId: entityClientCount tags: - Entity x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 8 p90: 12.8 p95: 13.4 p98: 13.76 p99: 13.88 sampleSize: 3 parameters: - in: query name: ignoreSecurity required: false description: 'Whether or not to ignore security and either return the full count in LS or return the visible count for the authenticated user. If `false`, the counts represent the number of entities that are visible to the authenticated calling user based on the user''s security settings. If `true`, the counts returned are the totals for all entities in the system, ignoring the authenticated user''s security settings. ' schema: type: boolean responses: '200': description: Counts retrieved successfully content: application/json: schema: type: object description: Counts of the number of client entities in the system. The counts will either be for the entities visible to the calling user, or all entities depending on the value of the `ignoreSecurity` flag in the request. properties: count: type: number description: The number of client entities in the system. active: type: number description: The number of counted entities with Active status. inactive: type: number description: The number of counted entities with Inactive status. '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: Forbidden 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 '500': description: An unexpected error occurred when fetching the client counts. 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 examples: unexpectedError: summary: Unexpected Error value: code: '500' message: An error occurred getting the clients counts. /entity/client-query: post: summary: Queries the clients in LS and streams response description: 'Returns clients filtered by the query specified in the request. For example, requesting all Active clients will return the list of active clients that the calling user has permission to see. Client records are streamed as line-delimited JSON records conforming to the schema. The records returned are restricted by the calling user''s security settings, so that the user will not see restricted information that is outside their own permissions. ### 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 | 5.5 s | | 90th percentile | 6.7 s | | 95th percentile | 7.3 s | | 98th percentile | 8.5 s | | 99th percentile | 9.4 s | 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: entityClientQuery tags: - Entity x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 5460.74 p90: 6655.51 p95: 7347.59 p98: 8522.95 p99: 9409.2 sampleSize: 10962 requestBody: required: false content: application/json: schema: type: object properties: queryFields: type: object description: 'Any field that a client can have can be filtered against. Below is a subset of common fields that will most likely be used for filtering. ' properties: name: type: string description: The full name of the individual surname: type: string description: The family name of the individual firstName: type: string description: The primary given name of the individual middleName: type: string description: All other parts of the legal name not covered in first and surname fields gender: type: string enum: - MALE - FEMALE - OTHER citizenshipCode: description: 'A list of country codes reflecting known citizenships of the individual. ' type: array minLength: 1 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: description: 'ISO ALPHA 2 country code for the primary country of residence for the individual ' type: string type: type: string enum: - person - organisation - aircraft - vessel vesselCallSigns: description: 'Array of known call signs for the vessel ' type: array minLength: 1 items: type: string vesselFlagsCode: description: 'Array of ISO Alpha 2 country codes for flags under which the vessel may sail. ' 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: description: 'The IMO number of the vessel if known. ' type: string responses: '200': description: Clients finished streaming content: application/octet-stream: schema: 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 '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: Forbidden 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 '500': description: An unexpected error occurred when fetching the client counts. 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 examples: unexpectedError: summary: Unexpected Error value: code: '500' message: An error occurred streaming the clients. /entity/risk-profile-query: post: summary: Query full profile details for a list of profile IDs description: 'Returns the most recent version of profile records for up to 200 profile IDs in a single request. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. *Generated from limited sample size.* **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 | 79 ms | | 90th percentile | 709 ms | | 95th percentile | 1.1 s | | 98th percentile | 2.2 s | | 99th percentile | 2.8 s | The response is JSON Lines (`application/x-ndjson`) — one JSON object per line, in the same order as the requested `ids`. Each line is either a successful profile entry or an inline error entry (e.g. `NOT_FOUND`, `BAD_ID`); the request as a whole never fails because of an individual lookup miss. Example source of IDs for this query: `POST /search/{strategy}` returns `results[].profileId`, which can be passed as `ids` here. Duplicate `ids` are rejected with HTTP `400`. With `relationships=true`, profiles include `relationships` (`relationshipType`, `profileId`, and `name` only when known). Default is `relationships=false` (no relationship data). Ripjar profiles do not return relationships here; when `sourceProfileIds` is present, use an appropriate id from that array for follow-up requests (e.g. linked watchlist profile). By default deleted profiles are returned. Pass `retrieveDeleted=false` to return them as `NOT_FOUND` instead. ' operationId: entityRiskProfileQuery tags: - Entity x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 79 p90: 708.5 p95: 1053.35 p98: 2171.64 p99: 2756.07 sampleSize: 60 parameters: - in: query name: relationships required: false schema: type: boolean default: false description: 'When `true`, include each profile''s `relationships` (`relationshipType`, `profileId`, optional `name`). ' - in: query name: retrieveDeleted required: false schema: type: boolean default: true description: 'When `false`, deleted profiles are returned as inline `NOT_FOUND` entries instead of being included in the response. ' requestBody: required: true content: application/json: schema: type: object required: - ids properties: ids: type: array description: 'List of profile IDs to retrieve (1–200 entries, non-empty strings, all distinct). ' minItems: 1 maxItems: 200 uniqueItems: true items: type: string minLength: 1 example: listEntity:1234 examples: basicRequest: summary: Three Ripjar profile IDs value: ids: - listEntity:list_entity-urn:ripjar:kat-rek-kod-kig - listEntity:list_entity-urn:ripjar:wid-sav-yiv-ciq - listEntity:list_entity-urn:ripjar:kiz-pil-nor-tas responses: '200': description: 'One JSON Lines entry per requested ID, in request order. Each line is independently parseable. May contain a mix of successful profiles and inline error entries. The **examples** are single lines (one object each); a real response concatenates many such lines separated by newlines. ' content: application/x-ndjson: schema: description: 'A single line of the JSON Lines response. Either a successful profile entry or an inline error entry. Discriminated by the presence of a `profile` or `error` field. ' oneOf: - type: object required: - id - profile properties: id: type: string description: The profile ID as supplied in the request. example: listEntity:1234 profile: type: object description: 'A profile record returned by risk-profile-query. Internal fields and `metadata` are stripped from the response. ' required: - id properties: id: type: string description: The profile ID. example: listEntity:1234 name: type: string description: Display name of the profile. entityType: type: string description: Entity type (e.g. `listPerson`, `listOrganisation`, `listLocation`, `listVessel`, `listAircraft`). sourceProfileIds: type: array items: type: string description: 'Optional. Same values as `metadata.sourceProfileIds` on the source record, copied to the profile root because `metadata` is not returned. Clients choose which id (if any) to use in follow-up requests. ' example: - listEntity:list_entity-urn:ripjar:kat-rek-kod-kig - listEntity:list_entity-urn:ripjar:wid-sav-yiv-ciq - listEntity:list_entity-urn:ripjar:kiz-pil-nor-tas relationships: type: array description: Present only when the request was made with `relationships=true`. items: type: object description: 'Relationship type, related profile id, and optional display name for the related profile. ' required: - relationshipType - profileId properties: relationshipType: type: string nullable: true description: Type of the relationship (e.g. `spouse`, `affiliate`). profileId: type: string nullable: true description: ID of the related profile (the side of the edge that is not the anchor profile). example: listEntity:5678 name: type: string description: Display name of the related profile when available. additionalProperties: true - type: object description: 'Inline error entry for a profile that could not be returned. The response will still contain a line for this ID, in the same position as the request. ' required: - id - error properties: id: type: string description: The profile ID as supplied in the request. example: listEntity:9999 error: type: string description: 'Machine-readable error code identifying why this profile could not be returned. ' enum: - NOT_FOUND - BAD_ID message: type: string description: Human-readable detail when supplied (e.g. invalid id format for `BAD_ID`). examples: successWithRelationships: summary: Success line when relationships=true description: 'Includes two relationships — one without `name`, one with `name`. ' value: id: listEntity:1234 profile: id: listEntity:1234 name: Alice Example entityType: listPerson relationships: - relationshipType: affiliate profileId: listEntity:8888 - relationshipType: spouse profileId: listEntity:5678 name: Bob Example successWithSourceProfileIds: summary: Success line with optional sourceProfileIds value: id: listEntity:list_entity-urn:ripjar:kat-rek-kod-kig profile: id: listEntity:list_entity-urn:ripjar:kat-rek-kod-kig name: Example adverse media entity entityType: listPerson sourceProfileIds: - listEntity:list_entity-urn:ripjar:kat-rek-kod-kig - listEntity:list_entity-urn:ripjar:wid-sav-yiv-ciq - listEntity:list_entity-urn:ripjar:kiz-pil-nor-tas inlineNotFound: summary: Inline NOT_FOUND value: id: listEntity:9999 error: NOT_FOUND inlineBadId: summary: Inline BAD_ID value: id: not-a-profile error: BAD_ID message: Id "not-a-profile" is not a profile id (must start with "listEntity:") '400': description: 'Bad request (e.g. invalid body, duplicate `ids`, or more than 200 ids). ' 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 '500': description: 'An unexpected error occurred while fetching the requested profiles. The request did not produce any inline result entries. ' 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 /entity/client-export: post: summary: Exports the clients in LS and streams response, optionally filtered by Last Modified Date only description: 'Unlike /entity/client-query, this endpoint optionally filters by Last Modified Date only. If Last Modified Date is provided it will return all clients that have been modified since the Last Modified Date. If no Last Modified Date is provided it will return all clients. Unlike /entity/client-query, this endpoint does not filter by any other fields. ### 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. *Generated from limited sample size.* **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 | 1.2 s | | 90th percentile | 1:36 (min) | | 95th percentile | 1:36 (min) | | 98th percentile | 1:36 (min) | | 99th percentile | 3:02 (min) | ' operationId: clientExport tags: - Entity x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 1177.92 p90: 96184.08 p95: 96184.08 p98: 96184.08 p99: 182949.49 sampleSize: 266 requestBody: required: false content: application/json: schema: type: object properties: lastModifiedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' responses: '200': description: Clients retrieved content: application/jsonld: schema: description: Line-delimited JSON client objects type: object properties: addresses: oneOf: - type: array description: Addresses associated with the client (array) items: type: object additionalProperties: true aircraftManufactureDate: oneOf: - type: string example: '2018-03-15' description: Aircraft manufacture date in ISO 8601 format (YYYY-MM-DD) - type: number example: 1521072000000 description: Aircraft manufacture date as Unix timestamp (milliseconds since epoch) aircraftModel: type: string example: 737-800 description: Model of the aircraft (string) aircraftName: type: string example: Boeing 737 description: Name of the aircraft for aircraft clients (string) aircraftOperator: type: string example: Airline Inc description: Operator of the aircraft (string) alertingTimezone: oneOf: - type: number example: 0 description: Timezone offset for alerting (number) aliases: oneOf: - type: array description: Alternative names for the client (array) items: type: object properties: name: type: string example: Johnny Doe description: Full alias name nameType: type: string example: nickname description: Type of alias (e.g., primary, variant, nickname, abbreviation) required: - name - nameType additionalProperties: false associatedCities: type: array items: type: string example: - London - New York description: Cities associated with the client (always returned as array of strings - single strings are converted to single-item arrays) associatedCountryCodes: type: array items: type: string example: - US - CA description: Associated country codes (always returned as array of strings - single strings are converted to single-item arrays, accepts any string value) 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 bookingCenter: oneOf: - type: string example: LONDON description: Booking center associated with the client (string) businessDivisions: type: array items: type: string example: - Technology - Finance description: Business divisions the client belongs to (always returned as array of strings - single strings are converted to single-item arrays) clientId: type: string example: '12345' description: Unique identifier for the client companyName: type: string example: Acme Corp description: Company name for organization clients (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 example: - GB description: ISO 3166-1 alpha-2 country of affiliation codes (always returned as array of 2-character country codes - single strings are converted to single-item arrays) 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 dateOfBirth: oneOf: - type: string example: '1952-10-07' description: Date of birth in ISO 8601 format (YYYY-MM-DD) - type: number example: 631152000000 description: Date of birth as Unix timestamp (milliseconds since epoch) dateOfIncorporation: oneOf: - type: string example: '2020-01-01' description: Date of incorporation in ISO 8601 format (YYYY-MM-DD) - type: number example: 1577836800000 description: Date of incorporation as Unix timestamp (milliseconds since epoch) deceasedOn: oneOf: - type: string example: '2023-01-01' description: Date of death in ISO 8601 format (YYYY-MM-DD) - type: number example: 1672531200000 description: Date of death as Unix timestamp (milliseconds since epoch) 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 example: - GB - US description: ISO 3166-1 alpha-2 domicile codes (always returned as array of 2-character country codes - single strings are converted to single-item arrays) employeeContactDetails: oneOf: - type: object description: Employee contact details (object) properties: email: type: string format: email example: jane@example.com description: Contact email address name: type: string example: Jane Smith description: Contact person name phoneNumber: type: string example: '+1234567890' description: Contact phone number entityType: type: string enum: - PERSON - ORGANISATION - VESSEL - AIRCRAFT - UNKNOWN example: PERSON description: The type of entity this client represents (strictly valid enum only) fixedAlertSpanPeriod: oneOf: - type: string pattern: ^[0-9]+[ymdh]$ example: 2d description: 'Period for fixed alert spans (format: [0-9]+[ymdh])' fixedAlertSpanStartDate: oneOf: - type: string example: '2024-01-01' description: Fixed alert span start date in ISO 8601 format (YYYY-MM-DD) - type: number example: 1640995200000 description: Fixed alert span start date as Unix timestamp (milliseconds since epoch) fixedAlertSpans: oneOf: - type: boolean example: false description: Whether fixed alert spans are enabled (boolean) - type: string enum: - 'true' - 'false' - 'yes' - '0' - '1' example: 'false' description: 'Whether fixed alert spans are enabled (limited string values: true, false, yes, 0, 1)' forename: type: string example: John description: First name of the client (string) freeTextItems: oneOf: - type: array description: Free text items associated with the client (array of objects with flexible structure) items: type: object additionalProperties: true properties: fieldId: type: string example: notes description: Identifier for the field (commonly used property) value: type: string example: Additional client information description: Value of the field (commonly used property) example: fieldId: notes value: Additional client information gender: oneOf: - type: string example: MALE description: Gender of the client (string) identityNumbers: oneOf: - type: array description: Identity numbers associated with the client (array of objects with flexible structure) items: type: object additionalProperties: true properties: type: type: string example: passport_no description: Type of identity document (must be a configured identity type) value: type: string example: '123456789' description: Identity number value required: - type - value example: - type: passport_no value: '123456789' - type: swift_code value: DEUTDEFF500 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 industries: type: array items: type: string example: - Banking - Technology description: Industries the client operates in (always returned as array of strings - single strings are converted to single-item arrays) lastReviewed: oneOf: - type: number example: 1640995200000 description: Unix timestamp of last review (number) lastScreenedDate: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' middlename: oneOf: - type: string example: Michael description: Middle name of the client (string) monitorEndDate: oneOf: - type: string example: '2025-12-31' description: Monitoring end date in ISO 8601 format (YYYY-MM-DD) - type: number example: 1672531200000 description: Monitoring end date as Unix timestamp (milliseconds since epoch) name: type: string example: John Doe description: Full name of the client (strictly string only) 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 example: - GB - US description: ISO 3166-1 alpha-2 nationality codes (always returned as array of 2-character country codes - single strings are converted to single-item arrays) objectType: type: string example: client description: The type of object, always 'client' for client exports occupation: oneOf: - type: string example: Software Engineer description: Occupation of the client (string) periodicReviewPeriod: oneOf: - type: string pattern: ^[0-9]+[ymdh]$ example: 1y description: 'Period for periodic reviews (format: [0-9]+[ymdh])' periodicReviewStartDate: oneOf: - type: string example: '2024-01-01' description: Periodic review start date in ISO 8601 format (YYYY-MM-DD) - type: number example: 1640995200000 description: Periodic review start date as Unix timestamp (milliseconds since epoch) riskScore: oneOf: - type: number example: 75 description: Risk score assigned to the client (number) segment: oneOf: - type: string example: HIGH_NET_WORTH description: Client segment classification (string) status: type: string enum: - ACTIVE - INACTIVE example: ACTIVE description: Current status of the client surname: oneOf: - type: string example: Doe description: Last name of the client (string) suffixes: type: array items: type: string example: - Jr - Sr description: Suffixes associated with the client (always returned as array of strings - single strings are converted to single-item arrays) titles: type: array items: type: string example: - Mr - Dr description: Titles associated with the client (always returned as array of strings - single strings are converted to single-item arrays) vesselCallSigns: type: array items: type: string example: - GB1234 - US5678 description: Vessel call signs (always returned as array of strings - single strings are converted to single-item arrays) vesselFlagsCode: type: array items: type: string example: - GB - US description: Vessel flag country codes (always returned as array of strings - single strings are converted to single-item arrays) vesselGrts: type: array items: type: integer example: - 123456789 - 987654321 description: Vessel GRT (Gross Register Tonnage) numbers (always returned as array of integers - single integers are converted to single-item arrays) vesselImoNumber: type: string example: '1234567' description: International Maritime Organization number (string) vesselName: type: string example: Ocean Explorer description: Name of the vessel for vessel clients (string) vesselOwners: type: array items: type: string example: - Ocean Shipping Ltd - Maritime Corp description: Vessel owners (always returned as array of strings - single strings are converted to single-item arrays) vesselTonnages: type: array items: type: integer example: - 50000 - 75000 description: Vessel tonnages (always returned as array of integers - single integers are converted to single-item arrays) '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: Forbidden 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 '429': description: Rate limit exceeded content: application/json: schema: type: object properties: error: type: string example: Too many requests, please try again later description: Rate limit error message retryAfter: type: integer example: 60 description: Number of seconds to wait before retrying required: - error - retryAfter '500': description: An unexpected error occurred when fetching the client counts. 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 examples: unexpectedError: summary: Unexpected Error value: code: '500' message: An error occurred streaming the clients. /entity: delete: summary: Delete multiple clients description: 'Delete all of the clients specified in the request body. This is a hard delete that deletes the client along with all of their alerts and associated information. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: entityMultipleDelete tags: - Entity requestBody: required: true content: application/json: schema: type: array description: A list of the IDs of the clients to delete. properties: ids: type: array description: List of client ids minItems: 1 items: type: string responses: '200': description: Clients deleted successfully content: application/json: schema: description: Entity deletion response type: object properties: message: type: string example: Successfully deleted 2 entities. warnings: type: array items: type: object properties: id: type: string description: Id of the entity that produced the warning description: type: string example: Entity does not exist alerts: description: Alert deletion details type: object properties: alerts: description: Total number of alerts deleted type: number evidence: description: Total number of alert evidence items deleted type: number reasons: description: Total number alert reasons deleted type: number annotations: description: Total number of alert annotations deleted type: number activity: description: Total number of alert activities deleted type: number attachments: description: Total number of alert attachments deleted type: number blacklistedEvidence: description: Total number of alert black listed evidence items deleted type: number activity: description: Total number of activity items deleted type: number assessmentStore: description: Total number of assessment store items deleted type: number jobErrors: description: Total number of job errors deleted type: number vos: description: VOS deletion details type: object properties: totalDeletedFromMongo: description: Total items deleted from mongo type: number totalDeletedFromSearch: 'description:': Total items deleted from elastic search type: number blacklist: description: Total blacklist items deleted type: number irs: description: Total irs items deleted type: number periodicReview: description: Total periodic review items deleted type: number uploadedClients: description: Total uploaded client items deleted type: number activityCreated: description: Total activity created items deleted type: number example: message: Successfully deleted 1 entities. warnings: - id: '571' description: Entity does not exist alerts: alerts: 0 evidence: 0 reasons: 0 comments: 0 annotations: 0 activity: 0 attachments: 0 blacklistedEvidence: 0 activity: 0 assessmentStore: 0 jobErrors: 0 vos: totalDeletedFromMongo: 2 totalDeletedFromSearch: 1 blacklist: 0 irs: 1 fixedPeriodAlerting: 0 periodicReview: 0 uploadedClients: 1 activityCreated: 0 '400': description: Invalid 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: Forbidden 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 '500': description: An unexpected error occurred when performing client deletion. 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 /entity/{entity_id}: delete: summary: Delete single client description: 'Delete the client with the specified ID. This is a hard delete of the client along with all of their alerts and associated information. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: entitySingleDelete tags: - Entity parameters: - name: entity_id in: path required: true schema: type: string description: ID of the client to delete responses: '200': description: Client deleted successfully. content: application/json: schema: description: Entity deletion response type: object properties: message: type: string example: Successfully deleted 2 entities. warnings: type: array items: type: object properties: id: type: string description: Id of the entity that produced the warning description: type: string example: Entity does not exist alerts: description: Alert deletion details type: object properties: alerts: description: Total number of alerts deleted type: number evidence: description: Total number of alert evidence items deleted type: number reasons: description: Total number alert reasons deleted type: number annotations: description: Total number of alert annotations deleted type: number activity: description: Total number of alert activities deleted type: number attachments: description: Total number of alert attachments deleted type: number blacklistedEvidence: description: Total number of alert black listed evidence items deleted type: number activity: description: Total number of activity items deleted type: number assessmentStore: description: Total number of assessment store items deleted type: number jobErrors: description: Total number of job errors deleted type: number vos: description: VOS deletion details type: object properties: totalDeletedFromMongo: description: Total items deleted from mongo type: number totalDeletedFromSearch: 'description:': Total items deleted from elastic search type: number blacklist: description: Total blacklist items deleted type: number irs: description: Total irs items deleted type: number periodicReview: description: Total periodic review items deleted type: number uploadedClients: description: Total uploaded client items deleted type: number activityCreated: description: Total activity created items deleted type: number '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: Forbidden 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 '404': description: Specified client not found or not visible to the calling user. 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 performing client deletion. 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 /entity/validate-data: post: summary: Validate list entity and client data description: 'Check the validity of list entity (profile) and client data by comparing the hash stored on the entity with the expected hash in the request. Use the `prefix` parameter to scope validation to list entities or clients. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. Hashes must be supplied when loading data (list import API or client import API). Ripjar does not generate hashes; they are supplied by the client to reconcile the version in the system with the source system. ' operationId: entityValidateData tags: - Entity parameters: - name: prefix in: query required: true schema: type: string description: 'The endpoint takes a prefix parameter that defines the prefix used for the key of the entity. Only entities whose key starts with the given prefix will be validated. **List entities (profiles):** The keys are generated within the system, and are of the form: listEntity:internal:provider:source: Provider and source are the values provided in the call to the list import API when this entity was loaded. The ListEntityId corresponds to the profileId of the specific list entity. Keys for list entities are automatically prefixed with listEntity, and so to validate list data the query should be: `…/entity/validate-data?prefix=listEntity` **Clients:** The keys are generated within the system, and are of the form: eoi: To validate clients for a given client key, use: `…/entity/validate-data?prefix=eoi`. ' requestBody: required: false description: 'Line-delimited JSON (NDJSON); each line is a single JSON object describing one entity to validate. Each object must have a `key` (the entity key) and may optionally have a `hash` (the expected hash to compare). See the `DataValidationItem` schema for the structure. ' content: text/plain: schema: description: Newline-delimited JSON, one object per line allOf: - type: object description: Specifies the ID and hash of an entity expected to exist in the system. properties: key: type: string description: The ID of the expected entity hash: type: string description: 'The hash value of the expected entity. Optional; when omitted, the endpoint will only check that the entity exists in the system (e.g. for clients that were loaded without a hash). ' required: - key examples: listEntity: summary: List entities (prefix=listEntity) description: '**Full request body (NDJSON — one JSON object per line):** ```json { "key": "listEntity:internal:provider:source:listEntity1001", "hash": "sdfuh" } { "key": "listEntity:internal:provider:source:listEntity1002", "hash": "aksjh" } { "key": "listEntity:internal:provider:source:listEntity1004", "hash": "aksjh" } { "key": "listEntity:internal:provider:source:listEntity1004", "hash": "aksjh" } { "key": "listEntity:internal:provider:source:listEntity1005" } ``` ' value: key: listEntity:internal:provider:source:listEntity1001 hash: sdfuh eoi: summary: Clients (prefix=eoi) description: '**Full request body (NDJSON — one JSON object per line):** ```json { "key": "eoi:123-4567-1001", "hash": "sdfuh" } { "key": "eoi:123-4567-1002", "hash": "aksjh" } { "key": "eoi:123-4567-1004", "hash": "aksjh" } { "key": "eoi:123-4567-1004", "hash": "aksjh" } { "key": "eoi:123-4567-1005" } ``` ' value: key: eoi:123-4567-1001 hash: sdfuh responses: '200': description: 'The data validation response, comprising a list of line-delimited JSON records describing the status of each record. **Examples:** Use the response example with the same name as the request body example (`listEntity` or `eoi`) — they are paired for documentation. ' content: application/octet-stream: schema: allOf: - type: object description: A record detailing a record that was described in the validation request, or that exists in the system that was not included in the validation request, along with its "./paths/alert/id-status.yaml" properties: code: description: "An HTTP status code describing the status of the record in the system. Codes are represented as follows:\n 200 - The hash for the entity in the system matched the hash supplied\n 400 - The entity Id was duplicated in the validation request\n 404 - The specified entity Id was not found in the system\n 409 - The hash value presented for validation ('hashPresented') did not match the hash value stored in the system ('ourHash')\n 417 - This entity was stored in the system (and had a key that fell within the requested range) but was not present in the validation request\n" type: integer enum: - 200 - 400 - 404 - 409 - 417 entityId: description: The ID of the entity record that the response relates to. type: string message: description: Message describing details of the validation item. type: string hashPresented: description: The hash value that was provided for the record in the validation request. type: string ourHash: description: The hash value that was present in the system for the version of the record with the given ID. type: string required: - code - entityId examples: listEntity: summary: Response for listEntity request example description: '**Full response body (NDJSON — one JSON object per line):** ```json { "code": 200, "entityId": "listEntity:internal:provider:source:listEntity1001" } { "code": 409, "entityId": "listEntity:internal:provider:source:listEntity1002", "hashPresented": "aksjh", "ourHash": "ppohs" } { "code": 404, "entityId": "listEntity:internal:provider:source:listEntity1004" } { "code": 400, "entityId": "listEntity:internal:provider:source:listEntity1004", "message": "Entity id is duplicated" } { "code": 200, "entityId": "listEntity:internal:provider:source:listEntity1005" } ``` ' value: code: 200 entityId: listEntity:internal:provider:source:listEntity1001 eoi: summary: Response for eoi request example description: '**Full response body (NDJSON — one JSON object per line):** ```json { "code": 200, "entityId": "eoi:123-4567-1001" } { "code": 409, "entityId": "eoi:123-4567-1002", "hashPresented": "aksjh", "ourHash": "ppohs" } { "code": 404, "entityId": "eoi:123-4567-1004" } { "code": 400, "entityId": "eoi:123-4567-1004", "message": "Entity id is duplicated" } { "code": 200, "entityId": "eoi:123-4567-1005" } ``` ' value: code: 200 entityId: eoi:123-4567-1001 '401': description: Unauthenticated request '403': description: Forbidden request '500': description: An unexpected error occurred during data validation. 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 examples: unexpectedError: summary: Unexpected Error value: code: '500' message: An error occurred during data validation. 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.