openapi: 3.2.0 info: title: Advanced Screening and Monitoring Search 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: Search description: The Search API allows clients to run ad-hoc, low-latency searches. Results from searches are not persisted in the system. paths: /search/{strategy}: post: summary: Search against one or more identifiers using a strategy description: 'This performs a search against the Identity Resolution service to see what possible matches we have for the provided identifier(s). A result is returned for each entity record specified in the request body, and the order of the results matches the order of the entities in the 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. **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 | 57 ms | | 90th percentile | 99 ms | | 95th percentile | 208 ms | | 98th percentile | 438 ms | | 99th percentile | 589 ms | ' operationId: searchStrategy tags: - Search x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 56.71 p90: 98.43 p95: 207.8 p98: 437.44 p99: 588.9 sampleSize: 578411 parameters: - name: recordProperties in: query description: 'A comma-delimited list of the names of properties that should be included when returning records. If returnRecords is false, this parameter is ignored. If this parameter isn''t specified, and returnRecords is true, entire records are returned for matches. ' required: false schema: type: string - name: returnQuery in: query description: Returns the query object as given under the “query” key. required: false schema: type: boolean default: false - name: returnReasons in: query description: Returns the match reasons for each result. Can be verbose. required: false schema: type: boolean default: false - name: returnRecords in: query description: Returns the full details for each match. required: false schema: type: boolean default: false - name: strategy in: path description: 'Search strategy to employ. Options are configuration-dependent. ' required: true schema: type: string requestBody: required: true content: application/json: schema: type: array description: Array of entity records minItems: 1 items: description: The search entity associated with this evidence oneOf: - type: object allOf: - type: object required: - type - name properties: type: type: string enum: - person - aircraft - vessel - organisation - unknown name: type: string identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string associatedCities: associatedCities: type: array items: type: string properties: type: const: person forename: type: string description: Given name of the person surname: type: string description: Family name of the person gender: type: string enum: - MALE - FEMALE - OTHER description: Known gender type of the person, must be in capitals dateOfBirth: type: array description: Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' nationalityCodes: type: array description: Country codes of the countries for which the person has citizenship. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfResidenceCode: type: array description: Country codes of the countries for which the person is domiciled. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW middleNames: type: array description: Middle names of the person items: type: string - type: object allOf: - type: object required: - type - name properties: type: type: string enum: - person - aircraft - vessel - organisation - unknown name: type: string identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string associatedCities: associatedCities: type: array items: type: string properties: type: const: organisation dateOfIncorporation: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' countryOfIncorporation: 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: - type - name properties: type: type: string enum: - person - aircraft - vessel - organisation - unknown name: type: string identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string associatedCities: associatedCities: type: array items: type: string properties: type: const: vessel associatedCountryCodes: 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 countryOfIncorporation: 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 vesselCallSign: type: array items: type: string vesselFlagCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - type: object allOf: - type: object required: - type - name properties: type: type: string enum: - person - aircraft - vessel - organisation - unknown name: type: string identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string associatedCities: associatedCities: type: array items: type: string properties: type: const: aircraft associatedCountryCodes: 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 dateOfIncorporation: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' - type: object allOf: - type: object required: - type - name properties: type: type: string enum: - person - aircraft - vessel - organisation - unknown name: type: string identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string associatedCities: associatedCities: type: array items: type: string properties: type: const: unknown associatedCountryCodes: 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 aliases: type: array description: An array of alternative names items: type: string discriminator: propertyName: type mapping: person: ../../../common/schemas/search-entity/SearchEntityPerson.yaml aircraft: ../../../common/schemas/search-entity/SearchEntityAircraft.yaml organisation: ../../../common/schemas/search-entity/SearchEntityOrganisation.yaml vessel: ../../../common/schemas/search-entity/SearchEntityVessel.yaml unknown: ../../../common/schemas/search-entity/SearchEntityUnknown.yaml responses: '200': description: Success content: application/json: schema: type: array minItems: 1 items: description: 'An array of objects equal in length to the number of records in the search request. Each object contains the results for the entity record in the same position in the request array. ' type: object required: - results properties: results: type: array minItems: 0 items: type: object required: - profileId - score properties: profileId: type: string description: 'Profile identifier for the record this match is for. Can be used in the records endpoint. ' score: type: number format: float minimum: 0 maximum: 1 description: 'Normalised matching score modelling the system''s confidence in the match. A score of 0 means the system has no basis on which to believe the match is correct — naturally this should _never_ happen. A score of 1 means the system has full confidence in a match, and this also never happens. However, as more and more pieces of independent evidence contribute to a match, this number geometrically grows closer to 1. ' '400': description: The request was invalid and at least one search could not be performed 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 '401': description: Unauthenticated request '403': description: The authenticated user cannot perform searches '404': description: Strategy not found '500': description: An unexpected error occurred performing the search 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 /search/record/{profileId}: get: summary: Retrieve a profile record given the ID. description: 'The search endpoint returns profile identifiers with their scores. This endpoint retrieves the full records for those profiles. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: searchProfile tags: - Search x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 7 p90: 7 p95: 7 p98: 7 p99: 7 sampleSize: 3 parameters: - name: profileId in: path required: true description: 'A unique identifier for a structured data profile of an entity that the search service might match a query against. ' schema: type: string responses: '200': description: Record profile retrieved content: application/json: schema: description: The list entity associated with this evidence. Present if the evidence is of type 'list' and the 'lists' enrichment is enabled oneOf: - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: person: type: object description: 'The person entity schema must contain the following fileds; firstName, middleName, surname, name ' properties: name: type: string description: Full name of the person. Can be used as well as, or instead of, fields for individual name parts firstName: type: string description: Given name of the person surname: type: string description: Family name of the person aliases: type: array description: An aray of alternative names by which a person is known. Fields in each name are as for the main name fields with some additions items: type: object properties: type: type: string firstName: type: string surname: type: string middleName: type: string titleHonorific: type: string maidenName: type: string gender: type: string enum: - MALE - FEMALE - OTHER description: Known gender type of the person, must be in capitals deceased: type: boolean description: Is the person deceased? birthPlace: type: string description: The name of the persons birthplace. Populated automatically from birthPlaceCountryCode birthPlaceCity: type: string description: The persons city of birth dateOfBirthArray: type: array description: Possible values for the persons date of birth. This is an array to allow for the uncertanty in reported dates items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' images: type: array description: URLs pointing to the images of, or related to, the person items: type: string birthPlaceCountryCode: type: string description: The country code of the persons birth citizenshipCode: type: array description: Country codes of the countries for which the person has citizenship. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW residentOfCode: type: array description: Country codes of the countries for which the person is domiciled. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfReportedAllegationCode: type: array description: Country codes of the countries in which alleged misconduct took place. May be more than one items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW middleName: type: string description: Middle name of the person roles: type: array description: Current jobs or roles of the person items: type: object properties: name: type: string category: type: string categoryId: type: string since: type: string description: Date in the form yyyy-mm-dd previousRoles: type: array description: Past jobs or roles of the person items: type: object properties: name: type: string category: type: string categoryId: type: string since: type: string description: Date in the form yyyy-mm-dd to: type: string description: Date in the form yyyy-mm-dd jurisdictionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW deceasedDateArray: type: array description: If the person is deceased (deceased=true), possible values for the persons date of death. This is an array to allow for uncertainty in reported cases suffix: type: string description: An honorific that comes after the person's name, rather than before - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: company: type: object description: 'The company entity schema must contain the following fields: name, keyTerms ' properties: name: type: string description: The companies main name suffix: type: string description: Company suffix, e.g. Ltd, PLC or GmbH aliases: type: array description: An array of alternative names by which a company is known items: type: object properties: type: type: string name: type: string suffix: type: string entityName: type: string dateOfRegistrationArray: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' companyURLs: type: array description: Associated URLs for the company items: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfAffiliationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW formerlySanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW sanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW cessationDateArray: type: array description: For non-active companies, the date(s) on which the company ceased trading items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' keyTerms: type: array description: Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles items: keyTerms: type: string - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: location: type: object description: "Location entities are an extension of entities. All of the base fields are included in addition to the fields defined below. \nLocations can be used to represent high risk countries, and can match with location fields on clients or other entities of \ninterest in order to highlight links between the entities and these countries.\n" properties: name: type: string description: Name of the location countryCode: type: string maxLength: 2 minLength: 2 description: The country code of the location enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW locationType: type: string description: This must be country cities: type: array description: A list of names of cities associated with this location items: type: string subType: type: string enum: - country - city - region - sub-region - free-trade-zone - airport - port description: The sub-type of a location entity - allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. - type: object properties: entityType: type: string enum: - listVessel vesselCallSigns: type: array items: type: string vesselTypes: type: array items: type: string vesselTonnages: type: array items: type: integer vesselOwners: type: array items: type: string vesselCustomers: type: array items: type: string vesselGrts: type: array items: type: integer vesselFlags: type: array items: type: string vesselFlagsCode: type: array items: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW vesselImoNumber: type: string vesselAdditionalOperators: type: array items: type: object properties: operatorCategory: type: string enum: - groupBeneficialOwner - operator - registeredOwner - shipManager - technicalManager operatorName: type: string countryOfControl: type: string countryOfDomicile: type: string countryOfRegistration: type: string - type: object allOf: - type: object allOf: - type: object required: - profileID - name - activeStatus properties: profileID: type: string description: Unique ID for this profile, used when creating relationships entityType: type: string enum: - listPerson - listAircraft - listLocation - listOrganisation - listVessel name: type: string activeStatus: type: string enum: - Active - Inactive description: Defines whether the entity profile is active or inactive. Typically, entities that are active have anb active membership of at least one active list. identityNumbers: description: Identity numbers associated with the entity, for example Company Identification Number. Each array item consists of a type string that lables the ID number or code and a value string. type: array items: type: object required: - type - value properties: type: type: string value: type: string notes: type: string addresses: type: array items: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string poBox: type: string city: type: string state: type: string province: type: string country: type: string countryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW postcode: type: string addressType: type: string enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW profileNotes: type: string lists: type: array items: type: object description: "Each entity is on one or more lists. Lists are defined as part of a hierarchy, and may have one or more levels of parent list. \nFor example, a Special Interest Person (SIP) list may have sub-lists for different crime regions and beneath those for different kinds of crime.\n" properties: id: type: string description: ID of the list that the entity is on name: type: string description: Name of the list that the entity is on hierarchy: type: array description: "Contains an entry for the list itself (that the entity is on) and each of its parents. \nThe list that the entity is on will be the lowest element in the hierarchy. \nEach lists parent element contains the ID of the list above it. \nThat list should also be included in this hierarchy definition. The top level list has no parent.\n" items: id: type: string name: type: string parent: type: string active: type: boolean description: "Defines whether the entity is currently a member of this list. If an entity was previously a member of the list and has since been removed, this property would be set to false. \nTypically, when this value is set to false the to property would be populated to indicate when the entity was removed from the list.\n" listActive: type: boolean description: 'Defines whether the list itself is currently active. For example, a list relating to a sanctions regime which has been decommissioned would have listActive set to false. ' additionalFields: type: array description: 'Any additional properties of the list as key/value pairs ' items: key: type: string value: type: string since: type: string format: date description: When the entity was added to the list example: '2023-12-25' to: type: string format: date description: If the entity is no longer on this list (i.e. active is false), this property can be provided to show when the entity was removed from the list example: '2023-12-25' sources: description: Sources used when compiling the list entity type: array items: type: string aliases: type: array items: type: object properties: name: type: string entityName: type: string suffix: type: string forename: type: string middlename: type: string surname: type: string maidenName: type: string singleStringName: type: string titleHonorific: type: string relationships: type: array description: Relationships between this entity and the other list entities. Properties on a relationship are; current - boolean, is this a current relationship?, type - string, the type of relationship, profileID - the profile ID of the entity items: type: object properties: current: type: boolean type: type: string profileID: type: integer categories: type: array description: Categories are optional but can be used to capture arbitrary categories for an entity. Categories have a type, reflecting the type of category, for example 'risk' items: type: object properties: type: type: string description: The type of risk category value: type: string description: Value of the risk e.g. high hash: type: string description: A hash of the entity record can optionally be provided. The hash is generated by the client and can be used to reconsile the version of the entity stored in the system with versions mastered in the source system. properties: company: type: object description: 'The company entity schema must contain the following fields: name, keyTerms ' properties: name: type: string description: The companies main name suffix: type: string description: Company suffix, e.g. Ltd, PLC or GmbH aliases: type: array description: An array of alternative names by which a company is known items: type: object properties: type: type: string name: type: string suffix: type: string entityName: type: string dateOfRegistrationArray: type: array description: 'Company registration dates ' items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' companyURLs: type: array description: Associated URLs for the company items: type: string countryOfRegistrationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW countryOfAffiliationCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW formerlySanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW sanctionedRegionCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW enhancedRiskCountryCode: type: string maxLength: 2 minLength: 2 description: 'An ISO-3166 alpha-2 country code digraph as defined here: ' enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW cessationDateArray: type: array description: For non-active companies, the date(s) on which the company ceased trading items: type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' keyTerms: type: array description: Keywords used in entity matching to automatically match this list entity to client profiles that contain one or more of the key terms. Viewing the list entity will then show all linked client profiles items: keyTerms: type: string properties: aircraft: type: object description: 'Aircraft entities are an extension of company entities. As well as the base fields and aircraft-specific fields, all company properties are also included. ' properties: name: type: string description: The aircraft's tail number. The prefix of the tail number is used to determine the aircraft's country of origin. discriminator: propertyName: entityType mapping: listPerson: ./ListEntityPerson.yaml listAircraft: ./ListEntityAircraft.yaml listLocation: ./ListEntityLocation.yaml listOrganisation: ./ListEntityOrganisation.yaml listVessel: ./ListEntityVessel.yaml '401': description: Unauthenticated request '403': description: The authenticated user cannot view records '404': description: Profile record with that ID not found '500': description: An unexpected error occurred 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 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.