swagger: '2.0' info: title: London Stock Exchange Group LSEG World-Check One API description: > The World-Check One API enables developers to integrate the next generation of LSEG screening capabilities into existing workflows and internal systems (such as CRMs) in order to help streamline the processes for on-boarding, KYC and third party due diligence. The API provides, among other features: - The ability to screen entity names, with or without secondary fields such as date of birth for individuals. These names are called “cases” within the World-Check One system. - The ability to retrieve results of the screening process from the World-Check database - The ability to flag cases for Ongoing Screening, and retrieve the World-Check results from the Ongoing Screening process. - The ability to submit request for reports. - The ability to fetch the status of the report requests and download the completed reports. > © 2018 - 2023 LSEG. All rights reserved. Republication or redistribution of LSEG content, including by framing or similar means, is prohibited without the prior written consent of LSEG. 'LSEG' and the LSEG logo are registered trademarks and trademarks of LSEG and its affiliated companies. version: 2.61.0 termsOfService: https://www.lseg.com/en/risk-intelligence/screening-solutions/world-check-kyc-screening/one-kyc-verification contact: name: LSEG World-Check One API Q&A url: https://community.developers.refinitiv.com/index.html email: c3r.api1@lseg.com license: name: Commercial url: https://www.lseg.com/en/risk-intelligence/screening-solutions/world-check-kyc-screening/one-kyc-verification externalDocs: description: Refer to the LSEG Developer Portal for additional documentation on the World-Check One API. url: https://developers.lseg.com/en/api-catalog/customer-and-third-party-screening/world-check-one-api host: api-worldcheck.refinitiv.com basePath: /v2 tags: - name: Api-Info description: Operations for the API info domain. - name: Audit description: Operations for the audit domain. - name: Case description: Operations for the case domain. - name: Case-Rating description: Operations for the rating domain. - name: Client-Watchlist description: Operations for the Watchlist domain. - name: Group description: Operations for the group domain. - name: Linked-Cases description: Operations for the linked cases domain. - name: Media-Check description: Operations for the Media-Check domain. - name: Passport-Check description: Operations for the Passport-Check domain. - name: Reference description: Operations for the reference domain. - name: Reporting description: Operations for the report domain. - name: Smart-Filter description: Operations for the smart filter domain. - name: Upcoming description: | Operations for upcoming features and changes. **Note:** Requests to these endpoints will return an HTTP '404 Not Found' response status code until officially released. - name: User description: Operations for the user domain. - name: Zfs description: Operations for the ZFS domain. x-tagGroups: - name: Upcoming Features and Changes tags: - upcoming - name: Zero Footprint Screening tags: - zfs - name: Case Management and Audit tags: - api-info - reference - group - case - audit - media-check - client-watchlist - user - passport-check - linked-cases - case-rating - smart-filter - reporting schemes: - https consumes: - application/json produces: - application/json - application/octet-stream responses: Unauthorized: description: The request has failed an authorisation check. This can happen for a variety of reasons, such as an invalid or expired API key, an invalid HMAC signature or a request timing issue/problem with the Date header value. The API client should ensure a correctly synchronised clock is used to generate request timestamps. CannotReturnResponse: description: Cannot return response schema: type: array items: $ref: '#/definitions/Error' UnsupportedMediaType: description: For requests with payloads, an unsupported Content-Type was specified. The World-Check One API only supports a content type of application/json. TooManyRequests: description: The API client is making too many concurrent requests, and some are being throttled. Throttled requests can be retried (with an updated request Date and HTTP signature) after a short delay. BadRequest: description: Bad request schema: type: array items: $ref: '#/definitions/Error' UnexpectedError: description: Unexpected error schema: type: array items: $ref: '#/definitions/Error' Forbidden: description: Forbidden schema: type: array items: $ref: '#/definitions/Error' InactiveResource: description: For requests to a resource that is no longer available. schema: type: array items: $ref: '#/definitions/Error' Conflict: description: Conflict error. schema: type: array items: $ref: '#/definitions/Error' paths: /apiInfo: get: operationId: getApiInfo tags: - Api-Info summary: London Stock Exchange Group Get information about the Public API. description: Get information about the version of the Public API, a link to the documentation, and a date and time that can be used to verify the 'Date' header. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true responses: 200: description: The information about the Public API. schema: $ref: '#/definitions/ApiInfo' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /groups: get: operationId: getGroups tags: - Group - Zfs summary: London Stock Exchange Group Get all the top-level groups with their immediate descendants description: Get all the top-level groups with their immediate descendants parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true responses: 200: description: A list of all top-level groups containing their immediate descendants schema: type: array items: $ref: '#/definitions/Group' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /groups/{groupId}: get: operationId: getGroupById tags: - Group - Zfs summary: London Stock Exchange Group Get a specified group including its immediate descendants description: Get a specified group including its immediate descendants parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: groupId in: path type: string required: true description: Group ID under which we wish to retrieve children groups responses: 200: description: A specified group including its immediate descendants schema: $ref: '#/definitions/Group' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /groups/{groupId}/caseTemplate: get: operationId: getCaseTemplateForGroup tags: - Group - Zfs summary: London Stock Exchange Group Get the CaseTemplate for the given Group description: | Get the CaseTemplate for the given Group, used for constructing a Case **Available secondary fields:**
Click here to expand | Type ID | NAME | VALUE | |--|-|| | SFCT_1 | GENDER | MALE, FEMALE, UNSPECIFIED | | SFCT_2 | DATE OF BIRTH | DATE | | SFCT_3 | COUNTRY LOCATION | COUNTRY CODE | | SFCT_4 | PLACE OF BIRTH | COUNTRY CODE | | SFCT_5 | NATIONALITY | COUNTRY CODE | | SFCT_6 | REGISTERED COUNTRY | COUNTRY CODE | | SFCT_7 | IMO NUMBER | TEXT | | SFCT_8 | PASSPORT GIVEN NAMES | TEXT | | SFCT_9 | PASSPORT LAST NAME | TEXT | | SFCT_10 | PASSPORT GENDER | MALE, FEMALE, UNSPECIFIED | | SFCT_11 | PASSPORT ISSUING STATE | STATE CODE | | SFCT_12 | PASSPORT NATIONALITY | STATE CODE | | SFCT_13 | PASSPORT DATE OF BIRTH | DATE | | SFCT_14 | PASSPORT DOCUMENT TYPE | PASSPORT, ID1, ID2 | | SFCT_15 | PASSPORT ID NUMBER | TEXT | | SFCT_16 | PASSPORT DATE OF EXPIRY | DATE | | SFCT_191 | DOCUMENT ID | TEXT | | SFCT_192 | DOCUMENT ID COUNTRY | COUNTRY CODE | | SFCT_193 | DOCUMENT ID TYPE | TEXT |
parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: groupId in: path type: string required: true description: Group ID under which we wish to manage Cases and perform screening responses: 200: description: The CaseTemplate for the given Group schema: $ref: '#/definitions/CaseTemplateResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /groups/{groupId}/resolutionToolkit: get: operationId: getResolutionToolkitForGroup tags: - Group summary: London Stock Exchange Group Get the ResolutionToolkit for the given Group. description: | Get the ResolutionToolkit for the given Group, used to construct a valid resolution request(s) on the results for a Case belonging to the given Group `groupId`. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: groupId in: path type: string required: true description: ID of the Group to which the resolution toolkit belongs. responses: 200: description: The ResolutionToolkit for the given Group. schema: $ref: '#/definitions/ResolutionToolkitResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /groups/{groupId}/resolutionToolkits: get: operationId: getResolutionToolkitsForGroup tags: - Group summary: London Stock Exchange Group Get all the ResolutionToolkits for the given Group description: | Get the ResolutionToolkits for the given Group for all enabled provider types, used to construct a valid resolution request(s) on the results for a Case belonging to the given Group `groupId`. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: groupId in: path type: string required: true description: ID of the Group to which the resolution toolkits belong. responses: 200: description: Map of ResolutionToolkits for the given Group keyed by provider type schema: type: object additionalProperties: $ref: '#/definitions/ResolutionToolkitResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /groups/{groupId}/resolutionToolkits/{providerType}: get: operationId: getResolutionToolkitForGroupWithProviderType tags: - Group summary: London Stock Exchange Group Get the ResolutionToolkit for a specific provider type for the given Group description: | Get the ResolutionToolkit for a specific provider type the given Group, used to construct a valid resolution request(s) on the results for a Case belonging to the given Group `groupId`. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: groupId in: path type: string required: true description: ID of the Group to which the resolution toolkit belongs. - name: providerType in: path type: string required: true description: Provider type for which the resolution toolkit applies. enum: - WATCHLIST - CLIENT_WATCHLIST responses: 200: description: The ResolutionToolkit for the given Group and provider type schema: $ref: '#/definitions/ResolutionToolkitResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /caseIdentifiers: head: operationId: checkCaseIdentifierAvailability tags: - Case summary: London Stock Exchange Group Check if a given caseId is available for use description: | caseIds must be unique within each Client. If any Group under a Client has a Case with a particular caseId, that caseId cannot be reused on another Case within the same Client. This endpoint allows the user to check if a given caseId is available to use when creating or updating a Case. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseId in: query type: string required: true description: Id to check if it is available to use as a caseId responses: 200: description: | The given caseId is in use within the current user's Client, therefore is not available to use on a different Case. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: description: | The given caseId is not found within the current user's Client, therefore is available to use as a caseId on any Case. 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /caseReferences: get: operationId: getCaseReference tags: - Case summary: London Stock Exchange Group Return the CaseReference (caseId, caseSystemId) for a caseId description: | Returns the CaseReference containing the caseId and caseSystemId pair for an existing Case with the given caseId. This is useful if only the caseId is known but caseSystemId is required by other endpoints such as `GET /cases/{caseSystemId}`. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseId in: query type: string required: true description: Case ID provided by the client or else generated by the system for the client responses: 200: description: CaseReference for the given caseId schema: $ref: '#/definitions/CaseReference' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases: post: operationId: saveCase tags: - Case summary: London Stock Exchange Group Create a new case description: | Creates a new Case for asynchronous screening. Synchronous screening on the dedicated ZFS gateway host via `/cases/screeningRequest` should be used instead of this for Zero Footprint Screening (ZFS). **Info about available secondary fields can be found [here](#tag/groups/operation/getCaseTemplateForGroup).** parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: newCase in: body description: Case to be created required: true schema: $ref: '#/definitions/NewCase' responses: 201: description: Case created schema: $ref: '#/definitions/Case' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 403: $ref: '#/responses/Forbidden' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/screeningRequest: post: operationId: screen tags: - Case - Zfs summary: London Stock Exchange Group Perform synchronous screening for a new case description: | Perform synchronous screening for a new case. This endpoint can perform a synchronous screening for a set of valid case details and, if provided, set the ongoing screening (OGS) state for the given provider types. The supported provider types for setting the OGS state are WATCHLIST and MEDIA_CHECK. They both can be set to either INITIAL (OGS disabled) or ONGOING (OGS enabled) state. You cannot set the OGS state when using Zero Footprint Screening (ZFS) groups. The returned result collection contains the regular case result details plus identity documents and important events. ZFS is enabled by specifying a ZFS group id in the body and is available for dedicated Zero-footprint API customers or Regular WC1 API customers using ZFS-specific groups. The response may contain Special Interest Categories (SIC) records that depends on the user subscription type. This helps in SIC risk analysis: - if a user has subscription type is Premium or Premium Plus, the keywords for SIC subcategories provided in the "sources" field and full value of SIC keywords code in the "categories" field; - if a user has a Standard subscription type then the "categories" field will not contain SIC keywords; - the above behavior is the same for ZFS. The example response body includes SIC with Premium or Premium Plus user subscription: ``` { "sources":[ "b_trwc_M:1TQ", "b_trwc_4" ], "categories":[ "Special Interest Categories", "Other Bodies" ] } ``` **Note:** The maximum number of World-Check screenings (including initial, rescreening, and ZFP ones) that a client can perform in an hour is limited. When using the API care should be taken when using operator words even when combined with an apostrophe, for example the below combinations will cause an error 403 to be returned: - String ‘AND (String) - String ‘OR (String) - String ‘AND NOT (String) - String ‘OR NOT (String) - String ‘AND AS (String) - String ‘OR AS (String) **Info about available secondary fields can be found [here](#tag/groups/operation/getCaseTemplateForGroup).** parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: screeningRequest in: body description: Screening Request required: true schema: $ref: '#/definitions/ScreeningRequest' responses: 200: description: Collection of Screening Results schema: $ref: '#/definitions/ScreeningResultCollection' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 403: $ref: '#/responses/Forbidden' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}: put: operationId: updateExistingCase tags: - Case summary: London Stock Exchange Group Update an existing Case by its caseSystemId description: | Updates an existing Case identified by the given caseSystemId. When the case is updated, all the non-empty fields for the case are required to be sent, including the updated field(s). Non-empty fields that are not sent when calling this endpoint will be overwritten as null. For example, if the date of birth for a case need to be updated, existing fields such as nationality, etc. should contain the original values, otherwise it will be updated as null. That is, all the other fields should be included in the body with their existing data. This applies to Custom Fields as well. **Note:** When updating an existing Case details with Passport-Check details within the API, to check the details in the UI information you must refresh the page to view all updated details. **Info about available secondary fields can be found [here](#tag/groups/operation/getCaseTemplateForGroup).** parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: updateCase in: body description: Update Case required: true schema: $ref: '#/definitions/UpdateCase' responses: 200: description: Case updated schema: $ref: '#/definitions/Case' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' patch: operationId: partialUpdateCase tags: - Case summary: London Stock Exchange Group Partial update an existing Case by its caseSystemId description: | Updates an existing Case identified by the given caseSystemId. When the case is updated, only updated field(s) for the case are required to be sent. If non-empty fields are not sent they will be left untouched. Case screening results related to the value provided in Screen query parameter. Calling the endpoint without any change in the existing case payload, but retained query parameter screen=SYNC, works as synchronous re-screening. **Note:** The maximum number of World-Check screenings (including initial, rescreening, and ZFP ones) that a client can perform in an hour is limited. When updating an existing Case details with Passport-Check details within the API, to check the details in the UI information you must refresh the page to view all updated details. **Info about available secondary fields can be found [here](#tag/groups/operation/getCaseTemplateForGroup).** parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: updateCase in: body description: Update Case required: true schema: $ref: '#/definitions/PartialUpdateCase' - name: screen in: query description: Screen mode required: false type: string enum: [NONE, SYNC, ASYNC] default: NONE responses: 200: description: Case updated schema: $ref: '#/definitions/ScreeningResultCollection' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 403: $ref: '#/responses/Forbidden' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' get: operationId: getCase tags: - Case summary: London Stock Exchange Group Fetch Full Case Details description: | Returns full details of the Case identified by the given 'caseSystemId'. **Note:** A delay of up to 40s after Case is screened is recommended while fetching full Case details with aggregated summaries, although a delay of up to 5s would work in most of the cases. If aggregated summaries return nil stats, a responsible retry mechanism with a maximum of five retries is recommended for the Cases where stats are expected. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: aggregatedSummary in: query description: Flag to enable aggregated summary for case required: false type: boolean responses: 200: description: Case response schema: $ref: '#/definitions/Case' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: deleteCase tags: - Case summary: London Stock Exchange Group Delete a Case description: | Delete a Case identified by the given caseSystemId. The case must be first archived in order to delete it. The user must be active and have delete permissions. The client must have delete functionality enabled. **Note:** After successful deletion, a corresponding audit with actionType 'DELETE_CASE' will be saved for the case. All other audits for this case will be deleted within 15 minutes. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string responses: 204: description: Case deleted 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/screeningRequest: post: operationId: screenCase tags: - Case summary: London Stock Exchange Group Request full or delta screening for an existing Case. description: | Make a request for screening of the Case identified by the given caseSystemId. Screening could be synchronous or asynchronous operation. The type of Screening could be full or delta. In the case of asynchronous Screening result will return immediately. As a result of this call, the screening request will be queued to be processed. When this request has been processed, there will be a new `SCREENED_CASE` audit event that can be queried via `/cases/{caseSystemId}/auditEvents` and then the results can be retrieved via `/cases/{caseSystemId}/results`. In the case of a synchronous screening as a result of the call will be returned result collection contains the regular case result details plus identity documents and important events. Delta Screening performs Screening from the time of the last screening date and shows new results that appeared after the last screening. **Note:** The maximum number of World-Check screenings (including initial, rescreening, and ZFP ones) that a client can perform in an hour is limited. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json'). in: header type: string required: false - name: Content-Length description: The length of the request body in octets (8-bit bytes). in: header type: integer required: false - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: CaseScreeningRequest description: Case Screening Request. in: body required: false schema: $ref: '#/definitions/CaseScreeningRequest' responses: 200: description: Collection of screening results. schema: $ref: '#/definitions/CaseScreeningResultCollection' 201: description: Screening request successfully queued for asynchronous processing. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 403: $ref: '#/responses/Forbidden' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/ongoingScreening: put: operationId: enableOngoingScreening tags: - Case summary: London Stock Exchange Group Enable OGS for a Case. description: | Enable Ongoing Screening for the Case identified by the given caseSystemId. This will schedule the Case to be re-screened periodically by the system. In order to enable Ongoing Screening for multiple or specific provider type fill out an optional request body with provider types for which to enable Ongoing Screening. If no request body provided Ongoing Screening request will be performed for WATCHLIST provider type. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json'). in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes). in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: ongoingScreeningRequest in: body description: Request containing details to enable Ongoing Screening for Case. required: false schema: $ref: '#/definitions/OngoingScreeningRequest' responses: 204: description: Ongoing Screening enabled for Case. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: disableOngoingScreening tags: - Case summary: London Stock Exchange Group Disable OGS for a Case. description: | Disable Ongoing Screening for the Case identified by the given caseSystemId. In order to disable Ongoing Screening for multiple or specific provider type fill out an optional request body with provider types for which to disable Ongoing Screening. If no request body provided Ongoing Screening request will be performed for WATCHLIST provider type. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json'). in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes). in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: ongoingScreeningRequest in: body description: Request containing details to disable Ongoing Screening for Case. required: false schema: $ref: '#/definitions/OngoingScreeningRequest' responses: 204: description: Ongoing Screening disabled for Case. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/archive: put: operationId: archiveCase tags: - Case summary: London Stock Exchange Group Archive a Case. description: | Archive the Case identified by the given caseSystemId. This will put the case into a state from which it can be either unarchived or deleted. The user must be active and have the archive permission. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string responses: 204: description: Case archived. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: unarchive tags: - Case summary: London Stock Exchange Group Unarchive a Case description: | Unarchive the Case identified by the given caseSystemId. The user must be active and have the archive permission. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string responses: 204: description: Case unarchived 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/bulk/archive: post: operationId: archiveCases tags: - Case summary: London Stock Exchange Group Bulk Update Archive States description: | Bulk Update Archive States of cases identified by the given `caseSystemIds`. The arhive states are updated according to the value specified in the `"archive"` field: if set to `true` then all the cases will be updated with the "archive" state, otherwise, the "unarchived" state will be used. In response, the user receives a summary (`"statuses"`) of the archiving operation for each case. *Example HTTP response* below, shows the following summary: 1. The first case with `"caseSystemId1"` has been archived successfully. 2. The second case with `"caseSystemId2"` has been archived successfully. 3. The third case with `"caseSystemId3"` has not been archived because it does not meet the validation criteria; `"error"` and `"cause"` fields contain detailed information on the error. The user must be active and have the archive permission. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseBulkArchiveRequest in: body description: A request on Bulk Update Archive States required: true schema: $ref: '#/definitions/CaseBulkArchiveRequest' responses: 200: description: A response on Bulk Update Archive States schema: $ref: '#/definitions/CaseBulkResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/bulk/assign: post: operationId: assignCases tags: - Case summary: London Stock Exchange Group Bulk Update Case Assignments description: | Bulk Update Case Assignments, where `Case`s are identified by the given `caseSystemIds` and assignee `User` is identified by the given `userId` (in case of assigning action). The case assignements are updated according to the value specified in the `"userId"` field: if set to `null` or is absent then the bulk unassigning action happens, otherwise, the bulk assigning to the `User` identified by the given `userId` action is performed. In response, the user receives a summary (`"statuses"`) of the assigning/unassigning operation for each case. *Example HTTP response* below, shows the following summary: 1. The first case with `"caseSystemId1"` has been assigned successfully. 2. The second case with `"caseSystemId2"` has been assigned successfully. 3. The third case with `"caseSystemId3"` has not been assigned because it does not meet the validation criteria; `"error"` and `"cause"` fields contain detailed information on the error. The user must be active and have the archive permission. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseBulkAssignRequest in: body description: A request on Bulk Update Case Assignments required: true schema: $ref: '#/definitions/CaseBulkAssignRequest' responses: 200: description: A response on Bulk Update Case Assignments schema: $ref: '#/definitions/CaseBulkResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/bulk/delete: post: operationId: deleteCases tags: - Case summary: London Stock Exchange Group Bulk Delete Cases description: | Bulk Delete Cases identified by the given `caseSystemIds`. The cases must be first archived in order to delete them. The user must be active and have delete permissions. The client must have delete functionality enabled. In response, the user receives a summary (`"statuses"`) of the archiving operation for each case. *Example HTTP response* below, shows the following summary: 1. The first case with `"caseSystemId1"` has been deleted successfully. 2. The second case with `"caseSystemId2"` has been deleted successfully. 3. The third case with `"caseSystemId3"` has not been deleted because it does not meet the validation criteria; `"error"` and `"cause"` fields contain detailed information on the error. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseBulkDeleteRequest in: body description: A request on Bulk Delete Cases required: true schema: $ref: '#/definitions/CaseBulkDeleteRequest' responses: 200: description: A response on Bulk Delete Cases schema: $ref: '#/definitions/CaseBulkResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/bulk/move: post: operationId: updateCasesOwner tags: - Case summary: London Stock Exchange Group Bulk Move Cases Between Groups description: | Bulk Move Cases identified by the given `caseSystemIds` to the `Group` identified by the given `groupId`. The user must be active and have move cases between groups permissions. The client must have move cases functionality enabled. The current Group and the destination Group should contain identical custom fields. Cases can not be moved to ZFS group. In response, the user receives a summary (`"statuses"`) of the moving cases operation for each case. *Example HTTP response* below, shows the following summary: 1. The first case with `"caseSystemId1"` has been moved successfully. 2. The second case with `"caseSystemId2"` has been moved successfully. 3. The third case with `"caseSystemId3"` has not been moved because it does not meet the validation criteria; `"error"` and `"cause"` fields contain detailed information on the error. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseBulkMoveRequest in: body description: A request on Bulk Move Cases required: true schema: $ref: '#/definitions/CaseBulkMoveRequest' responses: 200: description: A response on Bulk Move Cases schema: $ref: '#/definitions/CaseBulkResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/bulk/ongoingScreening: post: operationId: toggleOngoingScreeningByProviderTypes tags: - Case summary: London Stock Exchange Group Bulk Update Ongoing Screening States description: | Bulk Update Ongoing Screening (OGS) States of cases with provided `caseSystemIds` and `ProviderType`s specified in `caseScreeningState`. Ongoing screening can be performed for MEDIA_CHECK and WATCHLIST provider types. The user must be active and have CASE_OGS permissions. In response, the user receives a summary (`"statuses"`) of the World-Check/Media-Check Ongoing Screening operation for each case. *Example HTTP response* below, shows the following summary: 1. Watchlist Ongoing Screening successfully enabled for the first case with `"caseSystemId1"`. 2. Media Check Ongoing Screening successfully disabled for the second case with `"caseSystemId2"`. 3. World-Check/Media-Check Ongoing Screening operation can not be performed for the third case with `"caseSystemId3"` because it does not meet the validation criteria; `"error"` and `"cause"` fields contain detailed information on the error. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseBulkOngoingScreeningRequest in: body description: A request on Bulk Update Ongoing Screening States required: true schema: $ref: '#/definitions/CaseBulkOngoingScreeningRequest' responses: 200: description: A response on Bulk Update Ongoing Screening States schema: $ref: '#/definitions/CaseBulkResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/bulk/link: post: operationId: linkCases tags: - Case summary: London Stock Exchange Group Bulk Update Case Links description: | Bulk Update Case Links for `Case`s with provided `caseSystemIds` and `relationshipTypes` specified in `relationshipType` field. The case links are updated according to the value specified in the "link" field: if set to `true` then the link bulk action happens, otherwise, the unlinking is performed. In response, the user receives a summary (`"statuses"`) of the Link/Unlink operation for each case. *Example HTTP response* below, shows the following summary: 1. The first case with `"caseSystemId1"` was linked/unlinked successfully. 2. The second case with `"caseSystemId2"` was linked/unlinked successfully. 3. Link/Unlink operation can not be performed for the third case with `"caseSystemId3"` because it does not meet the validation criteria; `"error"` and `"cause"` fields contain detailed information on the error. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseBulkLinkRequestCollection in: body description: A request on Bulk Update Case Links required: true schema: $ref: '#/definitions/CaseBulkLinkRequestCollection' responses: 200: description: A response on Bulk Update Case Links schema: $ref: '#/definitions/CaseBulkResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/results: get: operationId: getResults tags: - Case summary: London Stock Exchange Group Get collection of Results for a Case by its caseSystemId description: | Return a collection of Results for the Case identified by the given caseSystemId. The response may contain Special Interest Categories (SIC) records that depends on the user subscription type. This helps in SIC risk analysis: If a user has subscription type is Premium or Premium Plus, the keywords for SIC subcategories provided in the "sources" field and full value of SIC keywords code in the "categories" field. If a user has a Standard subscription type then the "categories" field will not contain SIC keywords. The above behavior is the same for Zero Footprint Screening (ZFS). The example response body includes SIC with Premium or Premium Plus user subscription: ``` { "sources":[ "b_trwc_M:1TQ", "b_trwc_4" ], "categories":[ "Special Interest Categories", "Other Bodies" ] } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for a Case required: true type: string responses: 200: description: Collection of Results schema: type: array items: $ref: '#/definitions/Result' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/results/review: put: operationId: reviewResults tags: - Case summary: London Stock Exchange Group Add a review remark to the specified result IDs for the given case description: Add a review remark to the specified result IDs for the given case. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: resultsReview in: body description: Object representing the IDs to be reviewed, and the review remark required: true schema: $ref: '#/definitions/ResultsReview' responses: 204: description: All result IDs were successfully updated 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/results/resolution: put: operationId: resolveResults tags: - Case summary: London Stock Exchange Group Resolves a list of results. description: | Resolves a list of results for the Case identified by the given caseSystemId. The endpoint for the resolution toolkit '/groups/{groupId}/resolutionToolkit' provides the resolution rules to be applied when resolving results of any [Case](#Case) within a specific [Group](#Group). Any resultIds which relate to records that have been removed from World-Check One can only be resolved as FALSE. parameters: - name: Authorization in: header type: string description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). required: true - name: Date in: header type: string description: The date and time at which the message was originated in 'RFC 1123' format. required: true - name: Content-Type in: header type: string description: The media type of the request (e.g., 'application/json'). required: true - name: Content-Length in: header type: integer description: The length of the request body in octets (8-bit bytes). required: true - name: caseSystemId in: path type: string description: System generated ID for the Case. required: true - name: resultsResolutionAction in: body description: | Represents the request details required for resolving Results. **Note:** Fields 'reasonId' and 'resolutionRemark' are required **ONLY** if they are specified accordingly in the configuration settings. required: true schema: $ref: '#/definitions/ResultsResolutionAction' responses: 204: description: Results resolved. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/auditEvents: post: operationId: getCaseAuditEventsByCaseSystemId tags: - Audit summary: London Stock Exchange Group Get a filtered list of AuditEvents for a Case by its caseSystemId description: | Return all audit events related to cases visible to the current user. To get all audit events initial request with no payload should be provided. However, please note that when audit is requested without any date range for eventDate in the query, it returns audit data for the last 168 hours by default. Also, caller may filter and sort the response by: **eventDate**: The time when the Audit Event was created (ISO 8601 format excluding Week and Ordinal dates) e.g. eventDate>=2010-07-28T22:25:51Z;eventDate<2015-07-28T22:25:51Z **actionType**: Signifies the event links to a Case object. Please refer to ``ActionType`` object for detailed description. e.g. actionType=='ASSIGN_CASE' actionType=in=('ASSIGN_CASE', 'NEW_MATCH') **actionedByUserId**: Identifier of the User who created this audit event. Please refer to ``AuditEvent/properties/actionedByUserId`` for detailed description. e.g. actionedByUserId==663b4481-5b45-40a4-8b76-54ef805beea5 **The above criteria can also be combined** e.g. eventDate>=20120915T155300;eventDate<=2015-07-28T22:25:51Z;actionType=='NEW_MATCH' actionedByUserId==663b4481-5b45-40a4-8b76-54ef805beea5;eventDate>=2010-07-28T22:25:51Z **Please note that the above examples are only for the ``query`` part of the Filter** parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: filter in: body description: Filter the AuditEvents in the response required: false schema: $ref: '#/definitions/Filter' responses: 200: description: Collection of audit events in relation to a particular case schema: $ref: '#/definitions/AuditSearchResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/auditEvents/{auditEventId}: get: operationId: retrieveCaseAuditEvent tags: - Audit summary: London Stock Exchange Group Retrieves the audit event with the given 'auditEventId' belonging to the case identified by the given 'caseSystemId'. description: Retrieves the audit event with the given 'auditEventId' belonging to the case identified by the given 'caseSystemId'. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: caseSystemId description: System generated ID for the Case. in: path type: string required: true - name: auditEventId description: ID of the audit event. in: path type: string required: true responses: 200: description: Details about the desired audit event. schema: $ref: '#/definitions/AuditEventDetailsResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/ongoingScreeningUpdates: post: operationId: getOngoingScreeningUpdates tags: - Case summary: London Stock Exchange Group Get ongoing screening updates. description: | Get ongoing screening updates for all `Case` objects that are visible to the current user and are flagged for ongoing screening. Filter and sort the ongoing screening updates in the response by: **updateDate**: The date and time of this ongoing screening update in ISO 8601 format (excluding Week and Ordinal dates). Required. **providerType**: Ongoing screening provider type to query for results. Optional. e.g. Filter body that specifies the page size to be `50` and queries the first page of ongoing screening updates for WATCHLIST and MEDIA_CHECK provider types occurred since `2016-07-26T00:00:00Z` sorted by `updateDate` in `DESCENDING` order: { "query": "updateDate>='2016-07-26T00:00:00Z', providerType==WATCHLIST, providerType==MEDIA_CHECK", "sort": [ { "columnName": "updateDate", "order": "DESCENDING" } ], "pagination": { "currentPage": 1, "itemsPerPage": 50 } } parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: filter in: body description: Filter and sort the ongoing screening updates in the response. required: true schema: $ref: '#/definitions/Filter' responses: 200: description: Ongoing screening update search response. schema: $ref: '#/definitions/OngoingScreeningUpdateSearchResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/assignee: put: operationId: assignCase tags: - Case summary: London Stock Exchange Group Assign the Case to a User. description: | Assign the Case to a User. '/users' endpoint provides the active users that a Case can be assigned to. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: assignee in: body description: User to whom the case will be assigned. required: true schema: $ref: '#/definitions/Assignee' responses: 204: description: The case has been assigned successfully. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: unassignCase tags: - Case summary: London Stock Exchange Group Unassign a Case. description: Once you have assigned the case to the User, you can now unassign the same case. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string responses: 204: description: The case has been unassigned successfully. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/search: post: operationId: searchCases tags: - Case summary: London Stock Exchange Group Search for Cases based on specified criteria using filter or query parameters. description: | Search for Cases based on specified criteria using filter or query parameters. This endpoint allows you to find cases that match your search criteria. You can provide these criteria through the [CaseSearchRequest](#CaseSearchRequest) object, which includes 'query' and 'filter' fields. Expressions in 'query' and 'filter' must adhere to the Atom Feed Item Query Language (FIQL), which is documented in [RFC 4288](https://tools.ietf.org/html/rfc4288) and the superset supported by the WC1 API, as documented in [WC1 API Query Language](https://github.com/jirutka/rsql-parser). **Note:** To learn about the available search fields and their usage, you can use the `GET /reference/searchFilters` endpoint. Response details can be customized using the 'detailLevel' field: - 'CASE': The search response will provide full Case details. - 'CASE_AND_RESULTS': The search response will include Сase details and Result summary related to this Case. - 'CASE_AND_AGGREGATED_RESULTS': The search response will provide full Case details with an aggregated Result summary, summarizing data from primary and sub-cases. - 'CASE_AND_RESULTS_AND_AGGREGATED_RESULTS': The search response will provide full Case details with a Result and aggregated(summarizing data from primary and sub-cases) summaries. Number of results can be controlled through 'pagination' and 'sort' fields. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json'). in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes). in: header type: integer required: true - name: caseSearchRequest description: The request containing search criteria. in: body required: true schema: $ref: '#/definitions/CaseSearchRequest' responses: 200: description: A set of Cases that match the specified criteria. schema: $ref: '#/definitions/CaseSearchResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/summaries: post: operationId: retrieveCaseSummaries tags: - Case summary: London Stock Exchange Group User activity monitoring. Initial request. description: | Return a collection of Cases that were modified by users in particular date range. Endpoint allow to initiate search and retrieve the first page of result set. The query supports next field to specify searching criteria: 'modificationDate' - Time when the case has been modified by the user; 'assignedUserId' - Identifier of the User cases are assigned to; 'groupId' - Identifier of the Group that owns the case; 'creatorUserId' - Identifier of the case author; 'modifierUserId' - Identifier of the recent changes author; 'creationDate' - Time when the case has been created. To retrieve the next set of results please use '/cases/summaries/cursor' endpoint. **Note:** Cursor lifespan keeps extending if the cursor is accessed within its current lifespan. For example, once the cursor-id is generated using `POST /cases/summaries` endpoint, its lifespan is 60secs from there. Within that 60secs, if `POST /cases/summaries/cursor` endpoint is called, it extends the lifespan of the cursor to another 60secs from the point that call is made – and so on. If there are no subsequent calls to `POST /cases/summaries/cursor` endpoint using the same cursor within 60secs, cursor will expire. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: filter in: body description: The "query" is a FIQL expression which allows specifying comparison expression on case fields and it also allows specifying boolean operators AND/OR. The "sort" allows specifying items order in the response. The "cursorOptions" allows specifying count of items in the first response. required: true schema: $ref: '#/definitions/CaseSummaryFilter' responses: 200: description: Case search response. schema: $ref: '#/definitions/CaseSearchResultResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/summaries/cursor: post: operationId: scrollCaseSummaries tags: - Case summary: London Stock Exchange Group User activity monitoring. Subsequent request. description: | Continue loading result sets by cursor ID retrieved from POST/cases/summaries. **Note:** Cursor lifespan keeps extending if the cursor is accessed within its current lifespan. For example, once the cursor-id is generated using `POST /cases/summaries` endpoint, its lifespan is 60secs from there. Within that 60secs, if `POST /cases/summaries/cursor` endpoint is called, it extends the lifespan of the cursor to another 60secs from the point that call is made – and so on. If there are no subsequent calls to `POST /cases/summaries/cursor` endpoint using the same cursor within 60secs, cursor will expire. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: cursor in: body description: Request to continue cases retrieval. required: true schema: $ref: '#/definitions/Cursor' responses: 200: description: Case search response. schema: $ref: '#/definitions/CaseSearchResultResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results: post: operationId: getMediaCheckDetails tags: - Media-Check summary: London Stock Exchange Group Retrieve MediaCheck results description: | Retrieve MediaCheck headlines results by the case ID. The retrieval of MediaCheck headlines results may require a number of steps depending on the size of the headline result set. 1. Initially the API consumer does basic search of MediaCheck news articles by specifying initial filters and facets to return. 2. Later the API consumer may invoke the endpoint several times in order to scroll the results page by page or to narrow down the results by selecting specific facet values. Initial search request usually contains: * `pagination` object with specified fields `itemsPerPage` and `sort`, while the field `pageReference` is not specified. It is possible not to specify the `pagination` object at all, in this case WC1-API will use the default pagination values. * `facets` object contains list of facet categories to return. * `drilldownKeys` is empty on initial search. * `archivedArticles` field set as `true` within the `baseFilter` object (see explanation below). The `archivedArticles` field previously within the `baseFilter` object is deprecated and should not be used in future development work. Additionally, you may also limit publication dates through `publicationDate` field within `baseFilter` object. The sample initial search request below specifies search within Media Check news articles according to the *Archive limit* of the *Media Check* Group settings issued in 2017, and requests up to 10 `geography` facet values, and a default number of `topic` facet values: ``` { "baseFilter": { "smartFilter": true "reviewRequiredArticles": true, "archivedArticles": true, "publicationDate": { "min": "2017-01-01T00:00:00.000Z", "max": "2018-01-01T00:00:00.000Z" } }, "facets": { "geography": { "limit": 10 }, "topic": {} }, "pagination": { "itemsPerPage": 25, "sort": "NEW_TO_OLD" } } ``` For example, consider the response returns a total result count of 100 articles, displaying 25 headlines per page. In order to retrieve the second page results, the one should include `pageReferences` field (the 26-50 news articles), or for the last page results (the 76-100 news articles). There are also facet values for requested `geographies` and `topics` facets, as well as `matchingEntities` values because search request has `"smartFilter": true`. ``` { "totalResultCount": 100, "results": [...25 items in the array...], "pageReferences": { "last": "tokenLastPage", "next": "tokenSecondPage" }, "facets": { "geographies": [ { "drilldownKey": "drillDownKeyUK", "facetLabel": "United Kingdom", "articleCount": "56" } ], "topics": [ { "drilldownKey": "drillDownKeyFraud", "facetLabel": "Fraud", "articleCount": "43" } ], "matchingEntities": [ { "drilldownKey": "drillDownKeyDonald", "facetLabel": "DONALD DUCK", "articleCount": "20", "matchStrength": "1" } ] } } ``` The second page results are only possible to be viewed after retrieving the first page of the headline result set. The next and subsequent pages results can be retrieved in a similar way, but additionally the request should include the `pageReference` field within the pagination object. For better performance there's no need to provide `facets` object while requesting the second page. ``` { "pagination": { "pageReference": "tokenSecondPage" }, "baseFilter": { "archivedArticles": true, "reviewRequiredArticles": true, "publicationDate": { "max": "2017-01-01T00:00:00.000Z", "min": "2017-12-31T23:59:59.999Z" } } } ``` Alternatively, it is possible to narrow down results to the "United Kingdom" and "Fraud" topics instead of scrolling over huge number of results. The example request looks like the initial search with the list of `drilldownKeys`. ``` { "pagination": { "itemsPerPage": 25, "sort": "NEW_TO_OLD" }, "baseFilter": { "archivedArticles": true, "reviewRequiredArticles": true, "publicationDate": { "max": "2017-01-01T00:00:00.000Z", "min": "2017-12-31T23:59:59.999Z" } }, "facets": {...}, "drilldownKeys": [ "drillDownKeyFraud", "drillDownKeyUK" ] } ``` **Note on articles count display**: With deduplication on, the total articles count is returned, including duplicates, if any. The duplicate articles are returned in the `duplicatesKey` field. The API user can use this field in the [Retrieve MediaCheck Article Duplicates](#_retrievemediacheckduplicates) endpoint to view the article duplicates. *For example*, consider the following request: ``` { "baseFilter": { "archivedArticles": true, "reviewRequiredArticles": true }, "pagination": { "itemsPerPage": 25, "sort": "NEW_TO_OLD" } } ``` If the deduplication is on, the API user may recieve a response containing the `duplicatesKey`: ``` { ... "results": [ { ... "articleSummary": { ... "duplicatesKey": "someDuplicatedKeyHash", ... } }, ... ], ... "totalResultCount": 10550, ... } ``` Then the value of the received `duplicatesKey` may be used in [MediaCheckDuplicatesRequest](#MediaCheckDuplicatesRequest): ``` { "deduplicationHash": "someDuplicatedKeyHash" } ``` Afterwards the API user will get the response containing duplicated articles: ``` { "duplicates": [ "articleId": "someArticleId", ... ] } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: Accept-Language description: A value that identifies GUI language for the request. The response will be provided in the selected GUI language where available, otherwise it will be returned in English. Note this cannot be used to filter content by language and is used to display localized metadata. type: string in: header required: false - name: caseSystemId in: path description: System generated ID for a Case. required: true type: string - name: request in: body description: | A request to retrieve the news results. required: true schema: $ref: '#/definitions/MediaCheckResultsRequest' responses: 200: description: News articles headline summaries schema: $ref: '#/definitions/MediaCheckResultsResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/metadata: post: operationId: getMediaCheckArticlesMetadata tags: - Media-Check summary: London Stock Exchange Group Retrieve article metadata by the article IDs description: | Retrieve Media Check headlines results by the article IDs. **Example HTTP request** ``` { "articleIds":[ "articleID1", "articleID2", "articleID3" ] } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: Accept-Language description: A value that identifies UI language for request. The response will be provided in the selected UI language where available, otherwise it will be returned in English. type: string in: header required: false - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: metadataRequest in: body description: Collection of Article IDs. required: true schema: $ref: '#/definitions/MediaCheckArticlesMetadataRequest' responses: 200: description: News articles headline summaries. schema: $ref: '#/definitions/MediaCheckArticlesMetadataResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/{articleId}/metadata: get: operationId: getMediaCheckSingleArticleMetadata tags: - Media-Check summary: London Stock Exchange Group Retrieve article metadata by the article ID description: | Retrieve Media Check headlines results by the article ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Accept-Language description: A value that identifies UI language for request. The response will be provided in the selected UI language where available, otherwise it will be returned in English. type: string in: header required: false - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: articleId in: path description: MediaCheck news article ID required: true type: string responses: 200: description: News articles headline summaries. schema: $ref: '#/definitions/MediaCheckArticlesMetadataResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/content: post: operationId: getMediaCheckResultsContent tags: - Media-Check summary: London Stock Exchange Group Retrieve MediaCheck news articles content description: | Retrieve MediaCheck news articles content and summary by the given caseSystemId and list of article IDs. **Example HTTP request** ``` { "articleIds":[ "articleID1", "articleID2", "articleID3" ] } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: request in: body description: Request to retrieve MediaCheck new articles content. required: true schema: $ref: '#/definitions/MediaCheckContentRequest' - name: enableHighlight in: query description: Flag to enable terms highlight required: false type: boolean - name: context in: query description: Terms to highlight required: false type: string responses: 200: description: MediaCheck news articles content and summaries. schema: $ref: '#/definitions/MediaCheckResultsContentResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/{articleId}/content: get: operationId: getSingleArticleMediaCheckContent tags: - Media-Check summary: London Stock Exchange Group Retrieve content of single MediaCheck news article. description: Retrieve content of single MediaCheck news article by the given caseSystemId and article ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case required: true type: string - name: articleId in: path description: MediaCheck news article ID required: true type: string - name: enableHighlight in: query description: Flag to enable terms highlight required: false type: boolean - name: context in: query description: Terms to highlight required: false type: string responses: 200: description: MediaCheck news article content and summary. schema: $ref: '#/definitions/MediaCheckResultsContentResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/review: put: operationId: updateArticlesReviewedDate tags: - Media-Check summary: London Stock Exchange Group Mark all MediaCheck news articles as reviewed for a case. description: Marks all news articles as reviewed for the Case identified by the given caseSystemId. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string responses: 200: description: Date and time when all articles were reviewed. schema: $ref: '#/definitions/ArticlesReviewDate' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/attach: put: operationId: attachArticles tags: - Media-Check summary: London Stock Exchange Group Attach articles to a case. description: Attach articles to a case identified by the given caseSystemId. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: articleAttachment in: body description: Articles attachment. required: true schema: $ref: '#/definitions/ResultsMediaCheckResolutionRequest' responses: 200: description: Articles have been attached. schema: $ref: '#/definitions/ResultsMediaCheckResolutionResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' get: operationId: retrieveArticles tags: - Media-Check summary: London Stock Exchange Group Retrieve all articles attached to the case. description: Retrieve Media Check results by the article attached to the case. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Accept-Language description: A value that identifies UI language for request. The response will be provided in the selected UI language where available, otherwise it will be returned in English. type: string in: header required: false - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string responses: 200: description: News articles headline summaries. schema: $ref: '#/definitions/MediaCheckArticlesMetadataResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: detachArticles tags: - Media-Check summary: London Stock Exchange Group Detach articles from a case. description: Detach articles from a case identified by the given caseSystemId. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: articleDetachment in: body description: Articles detachment. required: true schema: $ref: '#/definitions/MediaCheckDetachArticlesRequest' responses: 200: description: Articles have been detached. schema: $ref: '#/definitions/ResultsMediaCheckResolutionResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/{articleId}/attach: delete: operationId: detachArticle tags: - Media-Check summary: London Stock Exchange Group Detach single article from a case. description: Detach single article from a case identified by the given caseSystemId. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for the Case. required: true type: string - name: articleId in: path description: MediaCheck news article ID. required: true type: string responses: 204: description: MediaCheck article has been datached from a case. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/saveAndScreen: post: operationId: saveAndScreenCases tags: - Case summary: London Stock Exchange Group Save and screen multiple cases. description: | Save and screen multiple cases for the given group Id. Caller may include multiple cases with up to 50 entities in a single request (see *Example HTTP request* below). In response, the caller receives a summary of the creation operation for each case. *Example HTTP response* below, shows the following summary: 1. The first case has been created successfully. 2. The second case has not been created successfully because it does not meet the validation criteria; "errors" and "cause" fields contain detailed information. **Example HTTP response** ``` [ { "name": "Name 1", "caseId": "Case ID 1", "caseSystemId": "Case System ID 1", "nameTransposition": true, "caseScreeningState": { "WATCHLIST": "INITIAL" } }, { "name": "Name 2", "caseId": "Case ID 2", "errors": [ { "error": "CASE_ID_EXISTS", "cause": "Case IDs must be unique within the same client and request." } ] } ] ``` **Note:** The maximum number of World-Check screenings (including initial, rescreening, and ZFP ones) that a client can perform in an hour is limited. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseDetailsCollection in: body description: Container of cases that is used in scope of creation operation. required: true schema: $ref: '#/definitions/CaseDetailsCollection' responses: 200: description: | If the request passed general validation, the caller receives response with CaseReference list, with summaries for each case located in payload. schema: type: array items: $ref: '#/definitions/CaseReferenceDetails' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 403: $ref: '#/responses/Forbidden' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/screeningStatus: post: operationId: screeningStatus tags: - Case summary: London Stock Exchange Group Retrieve case screening status and aggregated result for multiple cases. description: | Retrieve case screening statuses and aggregated results. Caller may include multiple cases with up to 50 entities in a single request (see *Example HTTP request* below). In response, the caller receives a status and aggregated screening results for each case. **Example HTTP response** ``` Response example returned for request not containing "providerTypes" field. [ { "caseSystemId": "Case System ID 1", "screeningStatus": "SCREENED", "requestFromScreenedDate": "2020-10-24T11:40:21.517Z", "lastScreenedDate": "2019-12-16T14:44:15.582Z", "providerSummaries": { "WATCHLIST": { "totalMatches": 38, "reviewRequired": 0, "unresolved": 35 } } }, { "caseSystemId": "Case System ID 2", "screeningStatus": "NOT_SCREENED", "requestFromScreenedDate": "2020-10-24T11:40:21.517Z", "providerSummaries": { "WATCHLIST": { "totalMatches": 0, "reviewRequired": 0, "unresolved": 0 }, "PASSPORT_CHECK": { "isReviewRequired": false } } }, { "caseSystemId": "Case System ID 3", "screeningStatus": "SCREENED", "requestFromScreenedDate": "2019-10-24T11:40:21.517Z", "lastScreenedDate": "2019-12-20T08:25:32.146Z", "providerSummaries": { "WATCHLIST": { "totalMatches": 625, "reviewRequired": 0, "unresolved": 618 } } } ] Response example returned for request containing "providerTypes" field. [ { "caseSystemId": "Case System ID 1", "requestFromScreenedDate": "2020-10-24T11:40:21.517Z", "lastScreenedDate": "2019-12-16T14:44:15.582Z", "providerSummaries": { "WATCHLIST": { "status": "SCREENED", "totalMatches": 38, "reviewRequired": 0, "unresolved": 35 } } }, { "caseSystemId": "Case System ID 2", "requestFromScreenedDate": "2020-10-24T11:40:21.517Z", "providerSummaries": { "WATCHLIST": { "status": "SCREENED", "totalMatches": 0, "reviewRequired": 0, "unresolved": 0 }, "PASSPORT_CHECK": { "isReviewRequired": false } } }, { "caseSystemId": "Case System ID 3", "requestFromScreenedDate": "2019-10-24T11:40:21.517Z", "lastScreenedDate": "2019-12-20T08:25:32.146Z", "providerSummaries": { "WATCHLIST": { "status": "SCREENED", "totalMatches": 625, "reviewRequired": 0, "unresolved": 618 }, "MEDIA_CHECK": { "status": "SCREENED", "isReviewRequired": } } } ] ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseScreeningStatus in: body description: Allows to specify cases and their screening dates that are using to define the screening status. required: true schema: $ref: '#/definitions/ScreeningStatusRequestCollection' responses: 200: description: | If the request passed general validation, the caller receives a response with screening status and aggregated results for each case in the payload. schema: type: array items: $ref: '#/definitions/ScreeningStatusResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/countries: get: operationId: getCountries tags: - Reference - Zfs summary: London Stock Exchange Group Get Map of country codes and country names description: Get Map of ISO-3166-1 alpha-3 country codes and country names in English parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true responses: 200: description: | Map of ISO-3166-1 alpha-3 country codes and country names in English, where ISO-3166-1 alpha-3 country code is the Key and country name is the Value schema: type: object additionalProperties: type: string 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/nationalities: get: operationId: getNationalities tags: - Reference summary: London Stock Exchange Group Get Map of nationality codes and nationality names description: Get Map of ISO-3166-1 alpha-3 nationality codes and nationality names in English parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true responses: 200: description: | Map of ISO-3166-1 alpha-3 nationality codes and nationality names in English, where ISO-3166-1 alpha-3 nationality code is the Key and nationality name is the Value schema: type: object additionalProperties: type: string 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/providers: get: operationId: getProviders tags: - Reference summary: London Stock Exchange Group Get a list of available providers and their sources. description: Get a list of all available providers and their sources. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true responses: 200: description: A list of available providers and their sources. schema: type: array items: $ref: '#/definitions/ProviderDetail' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/identityDocumentLocationTypes: get: tags: - Reference summary: London Stock Exchange Group Get identity document location types data set definition. description: Get each identity document location type log, that refers to a specific country and entity type. responses: 200: description: A list of identity document location type data set definition. schema: type: array items: $ref: '#/definitions/IdentityDocumentLocationTypeDataSet' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/searchFilters: get: operationId: getSearchFilters tags: - Reference summary: London Stock Exchange Group Retrieves all search filters that are accessible to the User. description: Retrieves all search filters that are accessible to the User. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true responses: 200: description: Collection of available search filters accessible to the User. schema: $ref: '#/definitions/SearchParameterCollection' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/profile/{id}: get: deprecated: true operationId: getProfile tags: - Reference summary: London Stock Exchange Group Get a profile by its ID description: | Warning: This endpoint is deprecated due to migration to a new one: `/reference/records/{id}` Get a profile by its ID. This service returns a specific subclass of 'Entity', depending on its particular 'ProfileEntityType' discriminator field. Please note in the context of World-Check One, 'Profile' and 'Entity' are synonymous concepts. For 'Zero Footprint Screening (ZFS)', this endpoint should be called on the dedicated 'ZFS' gateway host. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` The response may contain Special Interest Categories (SIC) records that depends on User subscription type to be able to analyze SIC risk: If a User has subscription type is Premium or Premium Plus, the SIC details are returned for that entity in the 'sources' field. The response will contain translated details of the 'details' section when 'Accept-Language' header is specified. The example response body: ``` { "sources": [ { "abbreviation": "M:1U5", "creationDate": "2020-10-23T07:43:21Z", "identifier": "b_trwc_M:1U5", "importIdentifier": null, "name": "Sexual Exploitation", "provider": null, "providerSourceStatus": "ACTIVE", "regionOfAuthority": null, "subscriptionCategory": "STANDARD", "type": { "category": { "description": "Description for Special Interest Categories", "identifier": "ec_6", "name": "Special Interest Categories", "providerSourceTypes": [] }, "identifier": "t_trwc_14", "name": "Special Interest Categories" } } ] } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: id in: path required: true type: string responses: 200: description: Profile response schema: $ref: '#/definitions/Entity' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 410: $ref: '#/responses/InactiveResource' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/records/{id}: get: operationId: getRecord tags: - Reference - Zfs summary: London Stock Exchange Group Get a record by its ID description: | Get a record by its ID. This service returns a specific subclass of 'Entity', depending on its particular 'RecordEntityType' discriminator field. Please note in the context of World-Check One, 'Record' and 'Entity' are synonymous concepts. For 'Zero Footprint Screening (ZFS)', this endpoint should be called on the dedicated 'ZFS' gateway host. The 'Entity' subclasses corresponding to each type of entity are: * 'COUNTRY' : 'CountryEntity' * 'INDIVIDUAL' : 'IndividualEntity' * 'ORGANISATION' : 'OrganisationEntity' * 'VESSEL' : 'VesselEntity' The response may contain Special Interest Categories (SIC) record that depends on User subscription type to be able to analyze SIC risk: If a User has subscription type is Premium or Premium Plus, the SIC details are returned for that entity in the 'sources' field. The response will contain translated details of the 'details' section when Accept-Language header is specified. The example response body: ``` { "sources": [ { "abbreviation": "M:1U5", "creationDate": "2020-10-23T07:43:21Z", "identifier": "b_trwc_M:1U5", "importIdentifier": null, "name": "Sexual Exploitation", "provider": null, "providerSourceStatus": "ACTIVE", "regionOfAuthority": null, "subscriptionCategory": "STANDARD", "type": { "category": { "description": "Description for Special Interest Categories", "identifier": "ec_6", "name": "Special Interest Categories", "providerSourceTypes": [] }, "identifier": "t_trwc_14", "name": "Special Interest Categories" } } ] } ``` parameters: - name: Authorization in: header type: string description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). required: true - name: Date in: header type: string description: The date and time at which the message was originated in 'RFC 1123' format. required: true - name: id in: path type: string description: Record identifier. required: true responses: 200: description: Record response. schema: $ref: '#/definitions/Entity' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 410: $ref: '#/responses/InactiveResource' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/profile/{id}/pep: post: deprecated: true operationId: retrieveProfilePepDetails tags: - Reference summary: London Stock Exchange Group Retrieves PEP details by the given profile ID description: | Warning: This endpoint is deprecated due to migration to a new one: `/reference/records/{id}/pep` Retrieves detailed information for "Politically Exposed Person (PEP)" category by given profile ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: id in: path description: Profile identifier. required: true type: string - name: pepDetailsRequest in: body description: Defines the sort order for retrieved PEP roles details. required: false schema: $ref: '#/definitions/PepDetailsRequest' responses: 200: description: PEP details response. schema: $ref: '#/definitions/PepDetailsResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 410: $ref: '#/responses/InactiveResource' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/records/{id}/pep: post: operationId: retrievePepDetails tags: - Reference summary: London Stock Exchange Group Retrieves PEP details by the given record ID description: Retrieves detailed information for "Politically Exposed Person (PEP)" category by given record ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: id in: path description: Record identifier. required: true type: string - name: pepDetailsRequest in: body description: Defines the sort order for retrieved PEP roles details. required: false schema: $ref: '#/definitions/PepDetailsRequest' responses: 200: description: PEP details response. schema: $ref: '#/definitions/PepDetailsResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 410: $ref: '#/responses/InactiveResource' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/providers/sources/{identifier}: put: operationId: createOrUpdateProviderSource tags: - Client-Watchlist - Zfs summary: London Stock Exchange Group Create or update a provider source description: | Create or update a provider source for uploading entity records to. An example usage would be for a client watchlist. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: identifier description: Unique identifier for this provider source. Has to be alphanumeric. in: path required: true type: string - name: providerSource in: body description: Provider source details required: true schema: $ref: '#/definitions/ProviderSource' responses: 204: description: Provider source definition updated 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reference/watchlist: post: operationId: saveWatchlist tags: - Client-Watchlist - Zfs summary: London Stock Exchange Group Maintain your Watchlist data description: | Maintain your Watchlist data using the following supported entity actions. * entityCreateOrUpdate - Add a new entity to your Watchlist or replace if it already exists. * entityDelete - Mark the given entity as deleted in your Watchlist. * entitySupersede - Supersede enables you to redirect matches against your superseded entity to a new entity. This is useful if you want to redirect users with existing matches against an old entity to a newer / more accurate version of those entities. * entityPurge - Purge enables you to remove an entity as required by GDPR whereby the personally identifiable information is removed. Due to the large number of entries within a Watchlist it is not possible to update the entire Watchlist in a single request The overall request must be split into blocks of up to 500 individual entity actions. The response consists of a list of any entities which were not successfully processed and a reason for failure. **Note:** The client watchlist record may not be considered for re-screening if the 'modificationDate' field has not been specified while modifying the record. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: watchlistDataSet in: body description: A collection of maintenance actions to be performed on your Watchlist. required: true schema: $ref: '#/definitions/WatchlistDataSet' responses: 201: description: Request to maintain Watchlist data has succeeded. Please review the contents of WatchlistResponse errors for details on any individual entity actions which were not successful. schema: $ref: '#/definitions/WatchlistResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /users: get: operationId: getUsers tags: - User summary: London Stock Exchange Group Get a list of active users in the client's account. description: Get a list of active users in the client's account. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true responses: 200: description: A list of active users in the client's account. schema: type: array items: $ref: '#/definitions/UserSummary' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /mediacheck/risks: get: operationId: getMediaCheckRisks tags: - Media-Check summary: London Stock Exchange Group Retrieve mediacheck risk definitions description: | Retrieves a list of mediacheck risk definitions. The mediacheck risk definitions are used when attaching mediacheck articles to a case. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true responses: 200: description: A list of mediacheck risk definitions schema: type: array items: $ref: '#/definitions/RiskDefinition' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /passportcheck/mrz: post: operationId: getMrzData tags: - Passport-Check summary: London Stock Exchange Group Generates MRZ data description: | Performs generation of MRZ data according to provided data parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: mrzGenerationRequest in: body description: Object containing data for generation of MRZ required: true schema: $ref: '#/definitions/MRZGenerationRequest' responses: 200: description: Object with the list of MRZ lines schema: $ref: '#/definitions/MRZGenerationResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/results/duplicates: post: operationId: retrieveMediaCheckDuplicates tags: - Media-Check summary: London Stock Exchange Group Retrieve MediaCheck article duplicates. description: | Retrieve article duplicates by specifying article deduplicationHash. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: Accept-Language description: A value that identifies GUI language for the request. The response will be provided in the selected GUI language where available, otherwise it will be returned in English. Note this cannot be used to filter content by language and is used to display localized metadata. type: string in: header required: false - name: caseSystemId in: path description: System generated ID for a Case. required: true type: string - name: deduplicationRequest in: body description: Request containing data to retrieve article duplicates. required: true schema: $ref: '#/definitions/MediaCheckDuplicatesRequest' responses: 200: description: Response containing duplicated articles summary. schema: $ref: '#/definitions/MediaCheckArticlesMetadataResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/relationship/{relationshipType}: # ==================================================================== # # Renamed the path parameter name for POST method from 'relationshipTypes' to 'relationshipType' # because the Swagger OpenApi v2 specification does not allow equivalent paths. # We may rename the path parameter for POST method back when the swagger file is migrated to OpenApi v3. # The previous name ('relationshipTypes') was plural because the parameter is an array. # # ==================================================================== post: operationId: getRelationshipIdentifiers tags: - Linked-Cases summary: London Stock Exchange Group Retrieve the list of case relationships description: | Retrieve the list of case relationships with cases linked to it. Relationship type strategies examples: * `primary-to-subcase` : declares `caseSystemId` as a primary case and lists cases linked to it with `primary-to-subcase` relationship type. * `subcase-to-primary` : declares `caseSystemId` as a subcase and lists cases linked to it with `subcase-to-primary` relationship type. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for a Case required: true type: string - name: relationshipType in: path description: Relationship type between cases. Multiple comma separated values allowed required: true type: array uniqueItems: true items: type: string enum: [primary-to-subcase, subcase-to-primary] - name: caseRelationshipRequest in: body description: Request containing pagination to list case relationships. required: true schema: $ref: '#/definitions/CaseRelationshipRequest' responses: 200: description: Response containing the list of relationships between cases schema: $ref: '#/definitions/CaseRelationshipResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' put: operationId: linkingCases tags: - Linked-Cases summary: London Stock Exchange Group Create links between cases description: | Create links between cases based on relationship type strategy(`relationshipType`). **Note:** There is a maximum number of World-Check One relationships between cases: * Maximum 500 primary cases are allowed per a subcase. * Maximum 50 subcases are allowed per a primary case. Relationship type strategies examples: * `primary-to-subcase` : declares `caseSystemId` as a primary case and cases listed in `linkedCasesRequest` as subcases which will be linked to a primary case. * `subcase-to-primary` : declares `caseSystemId` as a subcase and cases listed in `linkedCasesRequest` as primary cases which will be linked to a subcase. **Example HTTP request** ``` { "relatedCaseSystemIds":[ "Case System ID 1", "Case System ID 2", ] } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for a case. required: true type: string - name: relationshipType in: path description: Relationship type between cases. required: true type: string enum: [primary-to-subcase, subcase-to-primary] - name: linkedCasesRequest in: body description: Related case system IDs. required: true schema: $ref: '#/definitions/LinkedCasesRequest' responses: 201: description: Links between cases have been created. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: unlinkingCases tags: - Linked-Cases summary: London Stock Exchange Group Delete links between cases description: | Unlink cases based on relationship type strategy(`relationshipType`). Relationship type strategies examples: * `primary-to-subcase` : declares `caseSystemId` as a primary case and cases listed in `linkedCasesRequest` as subcases which will be unlinked from a primary case. * `subcase-to-primary` : declares `caseSystemId` as a subcase and cases listed in `linkedCasesRequest` as primary cases which will be unlinked from a subcase. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for a Case. required: true type: string - name: relationshipType in: path description: Relationship type between cases. required: true type: string enum: [primary-to-subcase, subcase-to-primary] - name: linkedCasesRequest in: body description: Related case system IDs. required: true schema: $ref: '#/definitions/LinkedCasesRequest' responses: 204: description: Links between cases have been deleted. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/rating: get: operationId: retrieveCaseRating tags: - Case-Rating summary: London Stock Exchange Group Retrieve a case rating description: | Retrieve the case rating in the case provided in the request path. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for a case. required: true type: string responses: 200: description: Cases rating has been successfully retrieved. schema: $ref: '#/definitions/CaseRatingResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' put: operationId: saveCaseRating tags: - Case-Rating summary: London Stock Exchange Group Update a case rating description: | Update the case rating in the case provided in the request path. The request contains a detailed reason to make it easier to resolve a case based on screening results. The reason is not a required field in the request. **Example HTTP request** ``` { "caseRating": "HIGH", "reason": "The reason" } ``` parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json') in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes) in: header type: integer required: true - name: caseSystemId in: path description: System generated ID for a case. required: true type: string - name: caseRatingRequest in: body description: The object representing a case rating. required: true schema: $ref: '#/definitions/CaseRatingRequest' responses: 204: description: Cases rating has been successfully updated. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /cases/{caseSystemId}/mediacheck/smartFilter: get: operationId: getMediaCheckSmartFilter tags: - Smart-Filter summary: London Stock Exchange Group Retrieve smart filter on a case description: | Retrieve the smart filter state on the case provided in the request path. The request body should be empty for the case provided in the request path ('caseSystemId'). The case should be created with enabled mediacheck provider. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for a case. required: true type: string responses: 200: description: The smart filter on the case retrieved. schema: $ref: '#/definitions/SmartFilterResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' put: operationId: enableSmartFilterOnCase tags: - Smart-Filter summary: London Stock Exchange Group Enable smart filter on a case description: | Update the smart filter state on the case provided in the request path. The group setting "Allow users to enable/disable the Smart Filter" should be equal to true to have the ability to update the smart filter state on the case. The request body should be empty for the case provided in the request path ('caseSystemId'). The case should be created with enabled mediacheck provider. If the smart filter has already enabled then the smart filter status will not be updated. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for a case. required: true type: string responses: 204: description: The smart filter on the case enabled. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: disableSmartFilterOnCase tags: - Smart-Filter summary: London Stock Exchange Group Disable smart filter on a case description: | Update the smart filter state on the case provided in the request path. The group setting "Allow users to enable/disable the Smart Filter" should be equal to true to have the ability to update the smart filter state on the case. The request body should be empty for the case provided in the request path ('caseSystemId'). The case should be created with enabled mediacheck provider. If the smart filter has already disabled then the smart filter status will not be updated. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details) in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format in: header type: string required: true - name: caseSystemId in: path description: System generated ID for a case. required: true type: string responses: 204: description: The smart filter on the case disabled. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reports: post: operationId: submitRequestForAsyncReport tags: - Reporting summary: London Stock Exchange Group Submit request for async report based on the given filter conditions and return the 'reportId'. description: Submit request for async report based on the given filter conditions and return the 'reportId'. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: Content-Type description: The media type of the request (e.g., 'application/json'). in: header type: string required: true - name: Content-Length description: The length of the request body in octets (8-bit bytes). in: header type: integer required: true - name: asyncReportRequest description: The payload for async report request. in: body schema: $ref: '#/definitions/AsyncReportRequest' responses: 200: description: The response to async report request returns the request details and report ID. schema: $ref: '#/definitions/AsyncReportResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 409: $ref: '#/responses/Conflict' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reports/{reportId}/status: get: operationId: getSingleReportStatusByReportId tags: - Reporting summary: London Stock Exchange Group Get the report status for the given report ID. description: Get the report status for the given report ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: reportId description: Report ID for which the status needs to be fetched. in: path type: string required: true responses: 200: description: The report status for single report with the report ID. schema: $ref: '#/definitions/ReportStatus' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reports/status: get: operationId: getPaginatedMultipleReportStatus tags: - Upcoming summary: London Stock Exchange Group Get the report status for all active reports by pagination params. description: Get the report status for all active reports by pagination params. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: currentPage description: Current page number. in: query type: integer format: int32 required: true default: 1 - name: itemsPerPage description: Report items per page. in: query type: integer format: int32 required: true enum: [5, 15, 20] default: 15 responses: 200: description: Report status of all active reports by pagination params. schema: $ref: '#/definitions/PaginatedReportStatusesResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reports/{reportId}/error: get: operationId: getReportErrorDetails tags: - Upcoming summary: London Stock Exchange Group Get the error details for the given 'reportId'. description: Get the error details for the given 'reportId'. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: reportId description: Report ID for which the status needs to be fetched. in: path type: string required: true responses: 200: description: Error details for the given report ID. schema: $ref: '#/definitions/ReportErrorResponse' 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' /reports/{reportId}: get: operationId: getReportDataByReportId tags: - Reporting summary: London Stock Exchange Group Download the report for given report ID. description: Download the report for given report ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: reportId description: Report ID for which the report needs to be fetched. in: path type: string required: true produces: - application/octet-stream - application/json responses: 200: description: The report data for single report with the report ID. schema: type: string format: binary 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' delete: operationId: cancelReportByReportId tags: - Upcoming summary: London Stock Exchange Group Cancel the report request for the given report ID. description: Cancel the report request for the given report ID. parameters: - name: Authorization description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details). in: header type: string required: true - name: Date description: The date and time at which the message was originated in 'RFC 1123' format. in: header type: string required: true - name: reportId description: ID of the report to be cancelled. in: path type: string required: true responses: 204: description: The report cancelation status for the given report ID. 400: $ref: '#/responses/BadRequest' 401: $ref: '#/responses/Unauthorized' 404: $ref: '#/responses/CannotReturnResponse' 415: $ref: '#/responses/UnsupportedMediaType' 429: $ref: '#/responses/TooManyRequests' 500: $ref: '#/responses/UnexpectedError' definitions: ApiInfo: type: object description: Auxiliary information about the Public API. required: - version - systemDateTime - documentationLink properties: version: type: string description: Current API version. systemDateTime: type: string format: date-time description: Current system date and time. documentationLink: type: string description: Link to the API Documentation. example: version: 2.53.0 systemDateTime: 2023-02-20T11:46:28.131000Z apiDocumentationLink: wc1-api.documentation.com # # Definitions for Audit domain # ============================ # AuditEvent: type: object description: Abstract audit event object required: - id - objectId - entityType - eventDate - actionType - actionedByUserId - actionedByUserName - details properties: id: type: string description: Identifier for this audit event maxLength: 255 objectId: type: string description: Identifier of the entity for which this audit event was created maxLength: 255 entityType: $ref: '#/definitions/AuditEntityType' eventDate: type: string format: date-time description: Creation date and time of this audit event in ISO 8601 format excluding Week and Ordinal dates. actionType: $ref: '#/definitions/AuditEventActionType' sourceType: $ref: '#/definitions/AuditEventSourceType' actionedByUserId: type: string maxLength: 255 description: Identifier of the User who created this audit event actionedByUserName: type: string maxLength: 2001 description: Full name of the User who created this audit event note: type: string maxLength: 1000 description: a comment added by the user auditEventToDate: type: string format: date-time description: Unused field to represent the date and time of the last event for a continuous series of OGS audit events with zero matches. The value is in ISO 8601 format excluding Week and Ordinal dates. details: $ref: '#/definitions/AbstractAuditDetails' AuditEventDetailsResponse: type: object description: Audit event response object. allOf: - $ref: '#/definitions/AuditEvent' - type: object properties: matchEvents: type: array description: A Set of [AuditMatchEvent](#AuditMatchEvent) that is included only for the [ScreenCaseAuditDetails](#ScreenCaseAuditDetails) 'detailsType'. uniqueItems: true items: $ref: '#/definitions/AuditMatchEvent' example: id: Audit ID objectId: Object ID eventDate: Event date actionedByUserId: Actioned by User ID actionedByUserName: Actioned by User Name note: Note entityType: CASE actionType: CHANGED_CASE_MEDIA_CHECK_SMART_FILTER_PREFERENCE sourceType: API auditEventToDate: details: - detailsType: ChangedCaseMediaCheckSmartFilterPreferenceAuditDetails casePreferenceType: MEDIA_CHECK_SMART_FILTER status: false dateTimeModification: 2022-05-15T15:03:24.984000Z matchEvents: - providerType: WATCHLIST referenceId: e_tr_wc_1234567 matchedTerms: - term: Maxym type: PRIMARY categories: - PEP matchedDate: 2022-05-15T15:03:24.984000Z alertDate: actionTypes: score: 0.8979323846 matchEventType: UNRESOLVED matchStatus: UNRESOLVED AuditMatchEvent: type: object description: Represents a match that was found on the Case during screening. required: - providerType - referenceId - matchedTerms - categories - matchedDate - score - matchEventType - matchStatus properties: providerType: description: The provider type. $ref: '#/definitions/ProviderType' referenceId: type: string description: The reference ID of the matched Entity. maxLength: 255 matchedTerms: type: array description: The matched terms. items: $ref: '#/definitions/AuditMatchTerm' categories: type: array description: Sources for the result/match. uniqueItems: true items: type: string matchedDate: type: string description: Date on which the result was matched. format: date-time alertDate: type: string description: Date on which the result was auto resolved, 'null' otherwise. format: date-time actionTypes: type: array description: Action type for the case indicating why the action was taken (reasons for an action). uniqueItems: true items: $ref: '#/definitions/MatchActionType' score: type: number description: The score of the result term. format: double matchEventType: description: The case match event type. $ref: '#/definitions/MatchEventType' matchStatus: type: string description: Last resolution status of the match. AuditMatchTerm: type: object description: The Case match details. required: - term - type properties: term: type: string description: The matched term. maxLength: 255 type: description: The matched name type. $ref: '#/definitions/MatchedNameType' AuditSearchResponse: type: object description: Audit Search Response Object allOf: - $ref: '#/definitions/SearchResponse' - type: object properties: results: type: array items: $ref: '#/definitions/AuditEvent' AbstractAuditDetails: type: object description: Abstract case audit event details object discriminator: detailsType required: - detailsType properties: detailsType: type: string description: Concrete case details type enum: - CaseCreatedAuditDetails - CaseDeletedAuditDetails - CaseEditedAuditDetails - ScreenCaseAuditDetails - AssignCaseToUserAuditDetails - ChangeCaseLifecycleStateAuditDetails - ChangeCaseScreeningStateAuditDetails - MigrationEventAuditDetails - ReviewResultsAuditDetails - ResolveResultsAuditDetails - VerifyPassportAuditDetails - EDDRequestAuditDetails - AddNoteToCaseAuditDetails - ChildCaseAuditDetails - ChildCaseEventAuditDetails - MergeCaseAuditDetails - ChildCaseTransferredOutParent - ChildCaseTransferredInParent - ChildCaseMove - ParentCaseDetailsChangedEventDetails - ResolveMediaCheckResultsAuditDetails - DeleteAttachedMediaCheckResultsAuditDetails - ChangedCaseMediaCheckOgsPreferenceAuditDetails - ChangedCaseMediaCheckSmartFilterPreferenceAuditDetails GenericCaseAuditDetails: type: object description: | Audit details for NEW_CASE, DELETE_CASE or EDITED_CASE actions raised when a Case is first created, deleted or edited. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - required: - caseSystemId - caseName - createDate - entityType - groupName - updateDate properties: batchDetails: type: array items: $ref: '#/definitions/BatchDetail' caseSystemId: type: string maxLength: 192 description: System generated ID for the Case. caseId: type: string maxLength: 512 description: Case ID provided by the client or else generated by the system for the client. caseName: type: string maxLength: 1000 description: Case name to be screened. entityType: type: string description: Case Entity Type Enumeration. enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED updateDate: type: string format: date-time description: Case update date and time. createDate: type: string format: date-time description: Case creation date and time. groupName: type: string nameTransposition: $ref: '#/definitions/TypeAvailableSelected' gender: type: string country: type: string nationality: type: string placeOfBirth: type: string dateOfBirth: type: string format: date description: The 'date of birth' secondary field on this case. countryOfResidence: type: string countryOfRegistration: type: string imoNumber: type: string givenName: type: string lastName: type: string passportGender: type: string issuingState: type: string passportNationality: type: string passportDateOfBirth: type: string format: date documentType: type: string idNumber: type: string customFields: type: object description: Mapping of custom field types to their values. additionalProperties: type: string expirationDate: type: string format: date idInformation: type: string CaseCreatedAuditDetails: type: object description: Extends [GenericCaseAuditDetails](#GenericCaseAuditDetails). allOf: - $ref: '#/definitions/GenericCaseAuditDetails' CaseDeletedAuditDetails: type: object description: Extends [GenericCaseAuditDetails](#GenericCaseAuditDetails). allOf: - $ref: '#/definitions/GenericCaseAuditDetails' CaseEditedAuditDetails: type: object description: Extends [GenericCaseAuditDetails](#GenericCaseAuditDetails). allOf: - $ref: '#/definitions/GenericCaseAuditDetails' BatchDetail: type: object description: Batch detail referenced from GenericCaseAuditDetails required: - batchId - batchName properties: batchId: type: string batchName: type: string TypeAvailableSelected: type: object description: Represents a type and also tells whether it is available and whether it should be selected by default properties: selected: type: boolean default: false type: type: string available: type: boolean default: false ScreenCaseAuditDetails: type: object description: Audit details for SCREENED_CASE action raised when a Case screening has been completed. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - caseSystemId - noOfAutoResolvedResults - noOfExcludedResults - noOfNewResults - noOfReviewRequiredResults - providerTypes - screeningState - startScreeningDate - statusCode - userId properties: userId: type: string maxLength: 255 description: Identifier of the user who screened the case caseSystemId: type: string maxLength: 192 description: System generated ID for the Case statusCode: type: string description: Status code of the screening operation (ie COMPLETED) screeningState: type: string description: Screening state (ie ANONYMOUS, INITIAL, ONGOING) startScreeningDate: type: string format: date-time description: Start screening date noOfNewResults: type: integer format: int32 description: Number of new results added after the screening run noOfReviewRequiredResults: type: integer format: int32 description: Number of screening Results requiring a review noOfExcludedResults: type: integer format: int32 description: Number of results have been excluded from the result set due to auto resolution rules noOfAutoResolvedResults: type: integer format: int32 description: Number of results have been auto resolved as False set due to auto resolution rules providerTypes: type: array description: Array of provider types used in screening uniqueItems: true minItems: 1 items: $ref: '#/definitions/ProviderType' AssignCaseToUserAuditDetails: type: object description: Audit details for ASSIGN_CASE action raised when a Case is assigned to a user. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - assigneeEmail - assigneeUserId - assigneeUserName - assignorName - caseName properties: assigneeUserName: type: string description: User name of the assignee assigneeUserId: type: string maxLength: 255 description: User Id of the assignee assigneeEmail: type: string format: email description: Email of the assignee caseName: type: string description: Case name to be screened assignorName: type: string description: Name of the assignor AddNoteToCaseAuditDetails: type: object description: Audit details for action raised when a Case note is set. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - caseID - caseName - assignorName - assigneeName - assigneeEmail - title - body properties: caseID: type: string description: ID of the case on which the note is set caseName: type: string description: case name to be screened assignorName: type: string description: assignor's name assigneeName: type: string description: assignee's name assigneeEmail: type: string format: email title: type: string description: title body: type: string description: message body ChangeCaseLifecycleStateAuditDetails: type: object description: Audit details for CHANGE_CASE_LIFECYCLE_STATE action raised when the Case Lifecycle state has changed. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - nextCaseLifecycleState - previousCaseLifecycleState properties: previousCaseLifecycleState: type: string description: Case Lifecycle State Enumeration enum: - ARCHIVED - UNARCHIVED nextCaseLifecycleState: type: string description: Case Lifecycle State Enumeration enum: - ARCHIVED - UNARCHIVED ChangeCaseScreeningStateAuditDetails: type: object description: Audit details for CHANGE_CASE_SCREENING_STATE action raised when the Case Screening state has changed. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - caseScreeningState - dateTimeModification properties: dateTimeModification: type: string format: date-time description: The date and time when CaseScreeningState of the Case was changed caseScreeningState: $ref: '#/definitions/CaseScreeningState' MigrationEventAuditDetails: type: object description: Audit details for MIGRATION action raised when migration of names is performed. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object properties: caseSystemId: type: string description: System generated ID for the Case actionLogs: type: array items: $ref: '#/definitions/AbstractMigrationEventPayload' AbstractMigrationEventPayload: type: object description: Represents a single action details in MigrationEventAuditDetails required: - actionDate - actionNote - actionType - userName properties: actionType: $ref: '#/definitions/MigrationAuditActionType' actionDate: type: string format: date-time description: The date and time when the migration event happened. actionNote: type: string userName: type: string ReviewResultsAuditDetails: type: object description: Audit details for REVIEW_RESULT action raised when a case result has been reviewed. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - remark - resultIds properties: resultIds: type: array description: Identifiers of the reviewed results uniqueItems: true items: type: string maxLength: 255 remark: type: string description: Remark describing the review ResolveResultsAuditDetails: type: object description: Audit details for RESOLVE_RESULT action raised when a case result has been resolved. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - reason - remark - resultDetails - risk - status properties: resultDetails: type: array uniqueItems: true items: $ref: '#/definitions/ResultDetail' remark: type: string description: Remark describing the resolution status: type: string description: Status of the resolution risk: type: string description: Risk of the resolution reason: type: string description: Comments on the resolution ResultDetail: type: object description: Audit details of a single result and it is referenced from ResolveResultsAuditDetails. required: - entityType - matchedTerms - resultId properties: resultId: type: string maxLength: 255 description: Result identifier matchedTerms: type: array uniqueItems: true items: type: string entityType: type: string description: Case Entity Type Enumeration enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED ResultsReview: type: object description: Entity to set the review remark of supplied result IDs required: - resultIds - remark properties: resultIds: type: array description: Result IDs of the case we are wishing to review uniqueItems: true items: type: string remark: type: string description: The review remark we wish to assign to the supplied result IDs ResultsMediaCheckResolutionRequest: type: object description: | Articles to attach. User able to attach articles only to unarchive case. required: - articleIds - risk properties: reason: type: string maxLength: 2000 description: Reason description. risk: type: string description: Definition of Media Check attached article risk level example: HIGH articleIds: type: array description: | MediaCheck articles IDs. Request may contain up to 200 articles. uniqueItems: true minItems: 1 maxItems: 200 items: type: string MediaCheckDetachArticlesRequest: type: object description: Articles to detach. required: - articleIds properties: articleIds: type: array description: | MediaCheck articles IDs. Request may contain up to 200 articles. uniqueItems: true minItems: 1 maxItems: 200 items: type: string VerifyPassportAuditDetails: type: object description: Audit details for VERIFY_PASSPORT_DETAILS action raised when passport details are verified. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - dateOfBirth - documentType - expiryDate - gender - givenName - idNumber - issuingState - lastName - mrzLine1 - mrzLine2 - mrzLine3 - nationality - validity properties: validity: $ref: '#/definitions/PassportCheckValidityType' mrzLine1: type: string description: Line 1 of the MRZ (Machine Readable Zone) information mrzLine2: type: string description: Line 2 of the MRZ (Machine Readable Zone) information mrzLine3: type: string description: Line 3 of the MRZ (Machine Readable Zone) information givenName: type: string lastName: type: string gender: type: string issuingState: type: string nationality: type: string dateOfBirth: type: string format: date documentType: type: string idNumber: type: string expiryDate: type: string format: date EDDRequestAuditDetails: type: object description: Audit details for EDD_REPORT_REQUESTED_CASE action raised when EDD report is requested. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object properties: entityType: type: string description: Case Entity Type Enumeration enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED caseSystemId: type: string description: System generated ID for the Case caseName: type: string caseCountry: type: string gender: $ref: '#/definitions/Gender' dateOfBirth: type: string format: date description: The 'date of birth' secondary field of the Case placeOfBirth: type: string nationality: type: string organisationSecondaryFields: $ref: '#/definitions/OrganisationSecondaryFields' title: type: string description: Title of requester firstName: type: string description: First name of requester lastName: type: string description: Last name of requester jobTitle: type: string description: Job title of requester jobCategory: type: string description: Job category of requester jobLevel: type: string description: Job level of requester companyName: type: string description: Company name of requester email: type: string description: Email of requester phone: type: string description: Phone number of requester fax: type: string description: Fax details of requester fullAddress: type: string description: Full address of requester country: type: string description: Country of requester additionalInfo: type: string description: Additional info provided by requester ChildCaseAuditDetails: type: object description: | Audit details contain information about the child case. For example, an audit event when an existing child case is merged into a parent. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - parentCaseExternalId properties: parentCaseExternalId: type: string description: The ID of the parent case. ChildCaseEventAuditDetails: type: object description: | Audit details contain information about a child case. For example, an audit event when the user creates a new child case under an existing parent or one or more child cases are deleted. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - childCaseExternalId properties: childCaseExternalId: type: string description: The ID of the child case at the time of the event. MergeCaseAuditDetails: type: object description: Audit details which contains information about a merge event. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - childCaseId - childCaseExternalId - childCaseName - childCaseCreatedDate properties: childCaseId: type: string description: The ID of the child case. childCaseExternalId: type: string description: The ID of the child case at the time of merging. childCaseName: type: string description: The name of the child case at the time of merging. childCaseCreatedDate: type: string format: date-time description: The date and time the child was created. ChildCaseTransferredOutParent: type: object description: | Audit details contain information about a child case. For example, an audit event when a user moves a child case from/to one parent to another. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - childCaseExternalId - toParentCaseExternalId properties: childCaseExternalId: type: string description: The ID of the child case at the time of the event. toParentCaseExternalId: type: string description: The ID of the parent case the child was moved to at the time of the event. ChildCaseTransferredInParent: type: object description: Audit details which contains information about a child case. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - childCaseExternalId - fromParentCaseExternalId properties: childCaseExternalId: type: string description: The ID of the child case at the time of the event. fromParentCaseExternalId: type: string description: The ID of the parent case the child was moved from at the time of the event. ChildCaseMove: type: object description: Audit details which contains information about the childcase. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - fromParentCaseExternalId - toParentCaseExternalId properties: fromParentCaseExternalId: type: string description: The ID of the parent case the transfer was from. toParentCaseExternalId: type: string description: The ID of the parent case the transfer was to. ParentCaseDetailsChangedEventDetails: type: object description: Audit details which contains information about a change to the parent case. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - externalId - caseName - previousExternalId - previousCaseName properties: externalId: type: string description: The ID of the case at the time of audit. caseName: type: string description: The name of the case at the time of audit. previousExternalId: type: string description: The previous external id of the case at the time of audit. previousCaseName: type: string description: The previous name of the case at the time of audit. ResolveMediaCheckResultsAuditDetails: type: object description: Audit details which contains details of resolving media check results. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - articles - riskLevel - reason properties: articles: type: array description: Set of articles items: $ref: '#/definitions/Article' riskLevel: type: string description: Risk on the resolution reason: type: string description: Comments on the resolution DeleteAttachedMediaCheckResultsAuditDetails: type: object description: Audit details which contains details of deleting attached media check results. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - articles properties: articles: type: array description: Set of articles items: $ref: '#/definitions/Article' ChangedCaseMediaCheckOgsPreferenceAuditDetails: type: object description: Audit details which contains details of changing the status of MediaCheck OGS. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - casePreferenceType - status - dateTimeModification properties: casePreferenceType: description: Represents the type of case preference. $ref: '#/definitions/CasePreferenceType' status: type: string description: Status of the resolution. dateTimeModification: type: string format: date-time description: The date and time when MediaCheck OGS of the Case status was changed. ChangedCaseMediaCheckSmartFilterPreferenceAuditDetails: type: object description: Audit details which contains details of changing the state of MediaCheck smart filter. Extends [AbstractAuditDetails](#AbstractAuditDetails). allOf: - $ref: '#/definitions/AbstractAuditDetails' - type: object required: - casePreferenceType - status - dateTimeModification properties: casePreferenceType: description: Represents the type of case preference. $ref: '#/definitions/CasePreferenceType' status: type: string description: Status of the resolution. dateTimeModification: type: string format: date-time description: The date and time the state of the MediaCheck smart filter on a Case changed. OrganisationSecondaryFields: type: object description: Secondary fields defined for entity type organisation and it is referenced from EDDRequestAuditDetails properties: registeredCountry: type: string Article: type: object description: Contains attributes that are derived from the result obtained from media check. required: - articleId - title - publicationDate - sourceName properties: articleId: type: string description: Identifiers of the resolved article. title: type: string description: Title of the news item. publicationDate: type: string format: date-time description: Published datetime of this news item. sourceName: type: string description: Source name of the news. # # Enumerations for Audit domain # ============================= # MigrationAuditActionType: type: string description: Enumerations of action types for a migration event enum: - 'NULL' - NEW_NAME - NEW_MATCH - CHANGE_MATCH_STATUS - CHANGE_MATCH_RISK - CHANGE_CLIENT_STATUS - NEW_NOTE - CHANGE_CLIENT_SYSTEM_STATUS - CHANGE_NAME_OWNER - CHANGE_MATCH_RESOLUTION - UPDATE_LAST_SCREENED - CHANGE_CLIENT_SYSTEM_FIELD - ASSIGN - SAVE_SEARCH_SETTINGS - ADD_CUSTOM_FIELD - CHANGE_CLIENT_CUSTOM_FIELDS - BATCH_CHANGE_STATUS - BATCH_CHANGE_OWNER - BATCH_ASSIGN - NEW_BATCH - BATCH_UPDATE - MATCH_ENTITY_UPDATED - MATCH_ENTITY_ACKNOWLEDGED - NEW_JOB MatchActionType: type: string description: The matched action type enumeration. enum: - DATA_ISSUE - RESULT_NOT_FOUND - SCORE_INCREASED - SCORE_DECREASED - PROFILE_UPDATED - PROFILE_UPDATED_C1 - PROFILE_UPDATED_C2 - PROFILE_UPDATED_C3 - PROFILE_UPDATED_C4 - AUTO_RESOLVED_FALSE_PREVIOUS_POSITIVE - GENDER_UPDATED - DATE_OF_BIRTH_UPDATED - COUNTRY_LOCATION_UPDATED - PLACE_OF_BIRTH_UPDATED - NATIONALITY_UPDATED - REGISTERED_COUNTRY_UPDATED - IMO_NUMBER_UPDATED MatchEventType: type: string description: The matched event type enumeration. enum: - UNRESOLVED - AUTO_RESOLVED - REVIEW_REQUIRED - REVIEW_REQUIRED_ALERT MatchedNameType: type: string description: The matched name type enumeration. enum: - PRIMARY - AKA - AKAENHANCED - FKA - DBA - MAIDEN - LANG_VARIATION - PREVIOUS - VEHICLE_ID - LOW_QUALITY_AKA - NATIVE_AKA - DOCUMENT_ID PassportCheckValidityType: type: string description: Indicates if the user has accepted or rejected the passport check enum: - NOT_SET - VALID - INVALID # # Definitions for Case domain # =========================== # ScreeningResultCollection: type: object description: Contains an array of Watchlist Screening Result objects from a synchronous screening operation. required: - results - name - providerTypes - groupId - entityType properties: caseId: type: string maxLength: 512 description: | Case ID provided by the client or else generated by the system for the client. No case ID will be returned when using Zero Footprint Screening (ZFS) and it should not be specified in the request either. name: type: string maxLength: 1000 description: Name to screen for this case. providerTypes: type: array description: | Provider Types required to Screen this case. For Zero Footprint Screening (ZFS), only `WATCHLIST` is supported. minItems: 1 items: $ref: '#/definitions/ProviderType' customFields: description: | Case Custom Fields. Available custom fields and their definitions can be obtained via `groups/{groupId}/caseTemplate`. Custom fields cannot be used with Zero Footprint Screening (ZFS). type: array items: $ref: '#/definitions/Field' secondaryFields: description: | Case Secondary Fields. Available secondary fields and their definitions can be obtained via `groups/{groupId}/caseTemplate`. type: array items: $ref: '#/definitions/Field' groupId: type: string maxLength: 255 description: | Group identifier owning this case. The group determines whether the case is screened as Zero Footprint Screnning (ZFS) or not. entityType: type: string description: Case Entity Type Enumeration enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED caseSystemId: type: string maxLength: 192 description: System generated ID for the Case caseScreeningState: description: | Mapping from ProviderType to indicate whether Ongoing Screening is enabled for this Case on the specific ProviderType. By default, value will be set from account settings. type: object additionalProperties: type: string lifecycleState: type: string description: Case Lifecycle State Enumeration enum: - ARCHIVED - UNARCHIVED creator: $ref: '#/definitions/UserSummary' modifier: $ref: '#/definitions/UserSummary' assignee: $ref: '#/definitions/UserSummary' creationDate: type: string format: date-time description: Case creation date and time modificationDate: type: string format: date-time description: Case modification date and time nameTransposition: type: boolean description: Flag indicating whether name transposition is enabled for the case. outstandingActions: type: boolean description: Flag indicating outstanding actions on a Case lastScreenedDatesByProviderType: type: object description: Case screenings date and time by provider type. additionalProperties: type: string format: date-time maxLength: 255 description: Date and time by Provider Type. lastIndexDatesByProviderType: type: object description: | Case index date and time by provider type. Represents date and time that should be used during ZFS screening as starting point to not lose any results. Available only for ZFS screening. additionalProperties: type: string format: date-time maxLength: 255 description: Date and time by Provider Type. providerTypeDetails: $ref: '#/definitions/ProviderTypeDetails' results: description: Contains the Screening Result objects of the screening. type: array items: $ref: '#/definitions/Result' CaseScreeningResultCollection: type: object description: Contains an array of Watchlist Screening Result objects from a synchronous screening operation. properties: case: type: object description: Contains the Case data. $ref: '#/definitions/Case' results: type: array description: Contains the Screening Result objects of the screening. items: $ref: '#/definitions/Result' AbstractCase: type: object description: | Defines Case data that can be sent when creating or updating a Case. Note that availability and definitions of 'customFields' and 'secondaryFields' should be obtained via `groups/{groupId}/caseTemplate` before creating or updating a Case. Following are some example JSON segments for secondary fields using unreal 'typeId's for illustrative purposes. - Example INDIVIDUAL secondary fields 1. GENDER ``` { "typeId":"SFCT_1", "value":"MALE" } ``` 2. DATE_OF_BIRTH ``` { "typeId":"SFCT_2", "dateTimeValue":"1990-12-20" } ``` or ``` { "typeId":"SFCT_2", "dateTimeValue": { "timelinePrecision": "ON", "pointInTimePrecision": "DAY", "utcDateTime": 316310400000, "timeZone": null } } ``` 3. COUNTRY_OF_RESIDENCE ``` { "typeId":"SFCT_3", "value":"GBR" } ``` 4. PLACE_OF_BIRTH ``` { "typeId":"SFCT_4", "value":"GBR" } ``` 5. NATIONALITY ``` { "typeId":"SFCT_5", "value":"GBR" } ``` - Example ORGANISATION secondary fields 1. REGISTERED_COUNTRY ``` { "typeId":"SFCT_6", "value":"GBR" } ``` - Example VESSEL secondary fields 1. IMO_NUMBER ``` { "typeId":"SFCT_7", "value":"1234567" } ``` properties: caseId: type: string maxLength: 512 description: | Case ID provided by the Client or else generated by the system for the Client. This field is not applicable for 'Zero Footprint Screening (ZFS)'. name: type: string description: Name to screen for this Case. maxLength: 1000 providerTypes: type: array description: | Provider Types required to Screen this Case. For 'Zero Footprint Screening (ZFS)', only 'WATCHLIST' is supported. minItems: 1 items: $ref: '#/definitions/ProviderType' caseScreeningState: type: object description: | Mapping from ProviderType to indicate whether Ongoing Screening is enabled for this Case on the specific ProviderType. Supported ProviderTypes: [WATCHLIST], [MEDIA_CHECK]. By default, value will be set from account settings. This field is not applicable for Zero Footprint Screening (ZFS). additionalProperties: type: string customFields: description: | Case Custom Fields. Available custom fields and their definitions can be obtained via `groups/{groupId}/caseTemplate`. Custom fields cannot be used with 'Zero Footprint Screening (ZFS)'. type: array items: $ref: '#/definitions/Field' secondaryFields: description: | Case Secondary Fields. Available secondary fields and their definitions can be obtained via `groups/{groupId}/caseTemplate`. type: array items: $ref: '#/definitions/Field' nameTransposition: type: boolean description: Flag indicating whether name transposition is enabled for the case. example: caseId: Client Case Id name: John Smith providerTypes: - WATCHLIST caseScreeningState: WATCHLIST: INITIAL MEDIA_CHECK: ONGOING customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' nameTransposition: true UpdateCase: type: object description: Defines Case data that can be sent when updating a Case. Extends [AbstractCase](#AbstractCase). allOf: - $ref: '#/definitions/AbstractCase' - type: object required: - name properties: note: type: string description: Note added by the User. maxLength: 1000 example: caseId: Client Case Id name: John Smith providerTypes: - WATCHLIST customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' nameTransposition: true note: Audit note PartialUpdateCase: type: object description: Defines Case data that can be sent when updating a Case partially. Extends [AbstractCase](#AbstractCase). allOf: - $ref: '#/definitions/AbstractCase' - type: object properties: note: type: string description: Note added by the User. maxLength: 1000 example: caseId: Client Case Id name: John Smith providerTypes: - WATCHLIST customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' nameTransposition: true note: Audit note CaseSearchUserSummary: type: object required: - fullName properties: fullName: type: string maxLength: 2001 description: Full name of the User. NewCase: type: object description: Defines Case data that can be sent when creating a new Case. Extends [AbstractCase](#AbstractCase). allOf: - $ref: '#/definitions/AbstractCase' - type: object required: - name - groupId - entityType properties: groupId: type: string maxLength: 255 description: | Group identifier owning this case. The group determines whether the case is screened as Zero Footprint Screnning (ZFS) or not. entityType: type: string description: Case Entity Type Enumeration enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED example: name: John Smith caseId: Client Case Id groupId: Client Group Id entityType: INDIVIDUAL providerTypes: - WATCHLIST customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' ScreeningRequest: type: object description: Defines Case data that can be sent when creating a synchronous screening request for a new Case. Extends [NewCase](#NewCase). allOf: - $ref: '#/definitions/NewCase' - type: object properties: startScreeningDate: type: string format: date-time description: | The starting date from which the records of the case in NameMatcher were indexed. This field is only applicable for Zero Footprint Screening (ZFS). endScreeningDate: type: string format: date-time description: | The ending date from which the records of the case in NameMatcher were indexed. This field is only applicable for Zero Footprint Screening (ZFS). example: name: John Smith caseId: Client Case Id groupId: Client Group Id entityType: INDIVIDUAL providerTypes: - WATCHLIST - MEDIA_CHECK caseScreeningState: WATCHLIST: INITIAL MEDIA_CHECK: ONGOING startScreeningDate: 2020-08-01T15:00:00.003000Z endScreeningDate: 2021-08-02T15:00:00.003000Z customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' CaseScreeningRequest: type: object description: Defines Case Screening Request that could be sent for an existing Case. properties: screeningMode: type: string description: Screening Mode Enumeration. enum: - FULL_SYNC - FULL_ASYNC - DELTA_SYNC - DELTA_ASYNC caseInfo: type: boolean description: Flag indicating whether there will be information about the Case in response. CaseResultSummaries: type: object description: Case Statistics contains the Category and the count for all the results in the Case. properties: totalMandatoryActions: type: integer format: int32 description: The number of mandatory actions on this case totalSubCases: type: integer format: int32 description: Holds a count of the number of child cases mediaCheck: $ref: '#/definitions/MediaCheckResultSummary' watchlist: $ref: '#/definitions/WatchlistResultSummary' clientWatchlist: $ref: '#/definitions/ClientWatchlistResultSummary' MediaCheckResultSummary: type: object description: Match summary for results with provider type MEDIA_CHECK properties: mediaCheckAttachedCount: type: integer format: int64 description: Field contains counter for media check attached mediaCheckReviewRequired: type: boolean description: Flag that indicates that MEDIA_CHECK case should be resolved WatchlistResultSummary: type: object description: Match summary for results with provider type WATCHLIST properties: watchlistTotalMatches: type: integer format: int32 description: Field contains watch list total matches count watchlistUnresolved: type: integer format: int32 description: Field contains count of watch list unresolved watchlistReviewRequired: type: integer format: int32 description: Field contains count of watch list review required categorisedMatches: type: object additionalProperties: type: object additionalProperties: type: integer ClientWatchlistResultSummary: type: object description: Match summary for results with provider type CLIENT_WATCHLIST properties: clientWatchlistTotalMatches: type: integer format: int32 description: Field contains client watch list total matches count clientWatchlistUnresolved: type: integer format: int32 description: Field contains count of client watch list unresolved clientWatchlistReviewRequired: type: integer format: int32 description: Field contains count of client watch list review required ProviderTypeDetails: type: object description: Details about the specific provider type. required: - mediaCheck properties: mediaCheck: $ref: '#/definitions/MediaCheckCaseDetails' MediaCheckCaseDetails: type: object description: Details about the Media-Check settings on a case (e.g., smart filter). required: - smartFilter properties: smartFilter: type: boolean description: | Flag indicating whether smart filter state on the case. The default value fetched from the group setting "Allow users to enable/disable the Smart Filter". Case: type: object description: Defines full Case data returned when retrieving a Case. Extends [NewCase](#NewCase). allOf: - $ref: '#/definitions/NewCase' - type: object properties: caseSystemId: type: string maxLength: 192 description: System generated ID for the Case lifecycleState: type: string description: Case Lifecycle State Enumeration enum: - ARCHIVED - UNARCHIVED assignee: $ref: '#/definitions/UserSummary' creator: $ref: '#/definitions/UserSummary' modifier: $ref: '#/definitions/UserSummary' creationDate: type: string format: date-time description: Case creation date and time modificationDate: type: string format: date-time description: Case modification date and time outstandingActions: type: boolean description: Flag indicating outstanding actions on a Case lastScreenedDatesByProviderType: type: object description: Case screenings date and time by provider type additionalProperties: type: string format: date-time maxLength: 255 description: Date and time by Provider Type providerTypeDetails: $ref: '#/definitions/ProviderTypeDetails' aggregatedResultSummaries: $ref: '#/definitions/CaseResultSummaries' example: name: John Smith caseId: Client Case Id groupId: Client Group Id entityType: INDIVIDUAL providerTypes: - WATCHLIST customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' caseScreeningState: WATCHLIST: INITIAL lifecycleState: ARCHIVED creator: userId: Creator ID fullName: Creator Name status: ACTIVE modifier: userId: Modifier ID fullName: Modifier Name status: ACTIVE creationDate: '2016-02-18T14:00:00Z' modificationDate: '2016-02-18T14:00:00Z' outstandingActions: false lastScreenedDatesByProviderType: WATCHLIST: '2016-02-18T14:00:00Z' providerTypeDetails: mediaCheck: smartFilter: true AbstractField: type: object description: Generic Field representing a Custom Field or a Secondary Field. required: - typeId properties: typeId: type: string description: Type Identifier of this Field maxLength: 255 Field: type: object description: | Holds the value of a Custom Field or a Secondary Field. Valid value type for this field is specified in the corresponding FieldDefinition of CaseTemplateResponse. Extends [AbstractField](#AbstractField). allOf: - $ref: '#/definitions/AbstractField' - type: object properties: value: type: string maxLength: 1000 description: Value for this Field. To be used for fields with [FieldValueType] (#FieldValueType) other than `DATE`. dateTimeValue: type: string format: date-time maxLength: 255 description: DateTime value for this Field. To be used for fields with [FieldValueType] (#FieldValueType) `DATE`. ProviderTypeSummaryResult: type: object description: | Contains enabled in the case provider types and their aggregated screening results. properties: status: type: string description: Case Screening State Enumeration representing type of Screening. enum: - NOT_SCREENED - SCREENED totalMatches: type: integer format: int64 example: 10 description: Total mathes for provider type. reviewRequired: type: integer format: int64 example: 10 description: Review required for provider type. isReviewRequired: type: boolean example: true description: Identifies whether a review is required for the provider type. unresolved: type: integer format: int64 example: 10 description: Unresolved for provider type. UserSummary: type: object required: - userId - fullName - email - status properties: userId: type: string maxLength: 255 description: Identifier of the User fullName: type: string maxLength: 2001 description: Full name of the User firstName: type: string maxLength: 1000 description: First name of the User lastName: type: string maxLength: 1000 description: Last name of the User email: type: string maxLength: 1000 description: Email address of the User status: $ref: '#/definitions/StatusType' uuid: type: string description: AAA UUID of the User. maxLength: 192 loginAccountStatus: description: The status of the User login account. allOf: - $ref: '#/definitions/AccelusUserLoginAccountStatus' lastLoginDate: type: string description: User's last login date and time in 'UTC' timezone. format: date-time AbstractScreeningResult: type: object description: Generic common Result fields returned after a Case is screened required: - referenceId properties: resultId: type: string maxLength: 255 description: Result identifier referenceId: type: string description: The reference ID of the matched Entity maxLength: 255 matchStrength: type: string description: Matched Result Strength enum: - WEAK - MEDIUM - STRONG - EXACT matchScore: type: number description: the exact match score with value rounded to 2 decimal places format: double matchedTerm: type: string description: Matched term for the Result. DEPRECATED in flavour of matchedTerms field maxLength: 1000 matchedTerms: type: array description: List of matched terms for the result with resultId. items: $ref: '#/definitions/MatchedTerm' submittedTerm: type: string description: Submitted term for the Result maxLength: 1000 matchedNameType: type: string description: Watchlist Profile Name Type enumeration. DEPRECATED in flavour of matchedTerms field enum: - PRIMARY - AKA - AKAENHANCED - FKA - DBA - MAIDEN - LANG_VARIATION - PREVIOUS - VEHICLE_ID - LOW_QUALITY_AKA - NATIVE_AKA - DOCUMENT_ID secondaryFieldResults: type: array description: Match results for Case secondary fields. items: $ref: '#/definitions/SecondaryFieldResult' sources: type: array description: | Set of [ProviderSource](#ProviderSource)s, each of which contains this Result's Entity and was used to screen the Case when this Result was last found. items: type: string description: | [ProviderSource] (#ProviderSource) Identifier. categories: type: array description: | Set of [ProviderSourceTypeCategory] (#ProviderSourceTypeCategoryDetail) names of this Result's sources. items: type: string description: | [ProviderSourceTypeCategory] (#ProviderSourceTypeCategoryDetail) Name. creationDate: type: string format: date-time description: Result creation date and time. modificationDate: type: string format: date-time description: Result modification date and time. lastAlertDate: type: string format: date-time description: Last alert date of the matched result term. modifier: description: The modifier of the matched result term. $ref: '#/definitions/UserSummary' resolution: $ref: '#/definitions/Resolution' resultReview: $ref: '#/definitions/Review' Result: type: object description: | Result found after performing a synchronous screening of a Case. This contains the abstract case screening result details plus includes identity documents and important events allOf: - $ref: '#/definitions/AbstractScreeningResult' - type: object required: - referenceId properties: primaryName: type: string description: The primary name associated with the Result maxLength: 255 events: type: array description: List of dates of births and deaths items: $ref: '#/definitions/Event' countryLinks: type: array description: Country links for the Screening Result items: $ref: '#/definitions/CountryLink' identityDocuments: type: array description: List of identity documents from the Result items: $ref: '#/definitions/IdentityDocument' category: type: string description: | The category of the Result, i.e. `POLITICAL - INDIVIDUAL`, `INDIVIDUAL`, `DIPLOMAT`, `TERRORISM`, `CRIME - NARCOTICS`, `CRIME - ORGANIZED`, `CRIME - OTHER`, `CRIME - NARCOTICS`, `CRIME - FINANCIAL` etc. maxLength: 255 providerType: type: string description: Provider Type Enumeration enum: - WATCHLIST - PASSPORT_CHECK - CLIENT_WATCHLIST - MEDIA_CHECK gender: type: string description: Gender Type Enumeration default: UNKNOWN enum: - MALE - FEMALE - UNKNOWN entityCreationDate: type: string format: date-time description: Entity creation date of the result. entityModificationDate: type: string format: date-time description: Entity modification date of the result. pepStatus: type: string description: The PEP Status of the result. enum: - ACTIVE - INACTIVE - UNKNOWN - NOT_AVAILABLE actionTypes: type: array description: Reasons for pending alerts. items: type: string enum: - DATA_ISSUE - RESULT_NOT_FOUND - SCORE_INCREASED - SCORE_DECREASED - PROFILE_UPDATED - PROFILE_UPDATED_C1 - PROFILE_UPDATED_C2 - PROFILE_UPDATED_C3 - PROFILE_UPDATED_C4 - AUTO_RESOLVED_FALSE_PREVIOUS_POSITIVE - GENDER_UPDATED - DATE_OF_BIRTH_UPDATED - COUNTRY_LOCATION_UPDATED - PLACE_OF_BIRTH_UPDATED - NATIONALITY_UPDATED - REGISTERED_COUNTRY_UPDATED - IMO_NUMBER_UPDATED MatchedTerm: type: object description: Matched term of a Result. properties: term: type: string type: type: string description: Enumeration of available matched types. Includes DOCUMENT_ID unlike NameType. enum: - PRIMARY - AKA - AKAENHANCED - FKA - DBA - MAIDEN - LANG_VARIATION - PREVIOUS - VEHICLE_ID - LOW_QUALITY_AKA - NATIVE_AKA - DOCUMENT_ID isPartOfUpdatedResults: type: boolean description: | The flag indicating whether the matched term is still relevant to the case after changes to either case details or admin settings or record details. Please note this field must not be used for filtering ongoing screening updates. MatchedType: type: string description: Enumeration of available matched types. Includes DOCUMENT_ID unlike NameType. enum: - PRIMARY - AKA - AKAENHANCED - FKA - DBA - MAIDEN - LANG_VARIATION - PREVIOUS - VEHICLE_ID - LOW_QUALITY_AKA - NATIVE_AKA - DOCUMENT_ID SecondaryFieldResult: type: object description: | Belongs to a Result and provides the details of the comparison of the Case's secondary field with the corresponding field in the reference data. Extends [AbstractField](#AbstractField). allOf: - $ref: '#/definitions/AbstractField' - type: object required: - field - fieldResult properties: field: description: Matched [Field] (#Field) data. Deprecated in favor of matchedValue and matchedDateTimeValue. $ref: '#/definitions/Field' submittedValue: type: string description: Submitted value for this Secondary Field. Used for fields with [FieldValueType] (#FieldValueType) other than `DATE`. maxLength: 1000 submittedDateTimeValue: type: string format: date-time maxLength: 255 description: Submitted date-time value for this Secondary Field. Used for fields with [FieldValueType] (#FieldValueType) `DATE`. matchedValue: type: string description: Matched value for this Secondary Field. Used for fields with [FieldValueType] (#FieldValueType) other than `DATE`. maxLength: 1000 matchedDateTimeValue: type: string format: date-time maxLength: 255 description: Matched date-time value for this Secondary Field. Used for fields with [FieldValueType] (#FieldValueType) `DATE`. fieldResult: type: string description: Field result enumeration enum: - LINKED - MATCHED - NOT_MATCHED - NOT_RUN - UNKNOWN Review: type: object description: Review details of a Result. properties: reviewRequired: type: boolean description: Flag to indicate Review Required after re-screening the CASE for this result. reviewRequiredDate: type: string format: date-time description: Represents the date and time when this Result was last flagged for review. reviewRemark: type: string description: Review remark added when reviewing this Result. maxLength: 2000 reviewDate: type: string format: date-time description: Represents the date and time when this Result was last reviewed. AbstractResolution: type: object description: Abstract resolution object properties: statusId: type: string description: | Unique status ID defined in Group's resolution toolkit and used when resolving this Result. Get the available status IDs and their details via `groups/{group_id}/resolutionToolkit`. maxLength: 255 riskId: type: string description: | Unique risk ID defined in Group's resolution toolkit and used when resolving this Result. Get the available risk IDs and their details via `groups/{group_id}/resolutionToolkit`. maxLength: 255 reasonId: type: string description: | Unique reason ID defined in Group's resolution toolkit and used when resolving this Result. Get the available reason IDs and their details via `groups/{group_id}/resolutionToolkit`. maxLength: 255 resolutionRemark: type: string description: Resolution remark added when resolving this Result. maxLength: 1000 ResultsResolutionAction: type: object description: | Represents the request details required for resolving Results. Resolution ids (i.e. statusId, riskId) as well as the resultIds of the results to be resolved are required to perform a resolution operation. allOf: - $ref: '#/definitions/AbstractResolution' - type: object required: - resultIds - statusId - riskId - reasonId - resolutionRemark properties: resultIds: type: array description: Identifiers of a set of results linked to one Case. uniqueItems: true items: type: string maxLength: 255 Resolution: type: object description: Resolution details of a Result. allOf: - $ref: '#/definitions/AbstractResolution' - type: object properties: resolutionDate: type: string format: date-time description: Represents the date and time when this Result was last resolved. Group: type: object description: Structure of Groups accessible by user required: - id - name properties: id: type: string description: Group ID maxLength: 255 parentId: type: string description: Parent Group ID maxLength: 255 name: type: string description: Name for the Group maxLength: 255 hasChildren: type: boolean default: false children: type: array description: Child groups items: $ref: '#/definitions/Group' status: $ref: '#/definitions/StatusType' example: id: Group Id parentId: Parent Group ID name: John Smith hasChildren: true children: [] status: ACTIVE CaseTemplateResponse: type: object description: Case template, containing metadata required by the client to construct a valid Case required: - groupScreeningType - groupId properties: groupScreeningType: $ref: '#/definitions/GroupScreeningType' groupId: type: string customFields: type: array items: $ref: '#/definitions/FieldDefinition' secondaryFieldsByProvider: type: object description: | Mapping from ProviderType to SecondaryFieldsByEntity which contains all secondary fields that is available for that ProviderType. additionalProperties: $ref: '#/definitions/SecondaryFieldsByEntity' nameTransposition: description: The indication of whether name transposition screening is available and selected. $ref: '#/definitions/TypeAvailableSelected' mandatoryProviderTypes: type: array items: $ref: '#/definitions/ProviderType' example: groupScreeningType: CASE_MANAGEMENT_AUDIT groupId: Group Id customFields: - typeId: Custom Field Id fieldValueType: TEXT fieldRequired: true secondaryFieldsByProvider: watchlist: secondaryFieldsByEntity: individual: - typeId: GENDER_TYPE_ID fieldFormat: GENDER - typeId: DATE_OF_BIRTH_TYPE_ID fieldFormat: DATE - typeId: PLACE_OF_BIRTH_TYPE_ID fieldFormat: COUNTRY organisation: - typeId: REGISTERED_COUNTRY_TYPE_ID fieldFormat: COUNTRY - typeId: REGISTERED_TEXT_TYPE_ID fieldFormat: DOCUMENT_ID - typeId: REGISTERED_COUNTRY_TYPE_ID fieldFormat: DOCUMENT_ID_COUNTRY - typeId: REGISTERED_TEXT_TYPE_ID fieldFormat: DOCUMENT_ID_TYPE vessel: - typeId: IMO_NUMBER_TYPE_ID fieldFormat: TEXT regExp: '[0-9]{7}' passport-check: secondaryFieldsByEntity: individual: - typeId: PASSPORT_GENDER_TYPE_ID fieldFormat: GENDER - typeId: PASSPORT_ID_NUMBER fieldFormat: TEXT SecondaryFieldsByEntity: type: object description: Wrapper which contains secondary fields grouped by CaseEntityType. required: - secondaryFieldsByEntity properties: secondaryFieldsByEntity: type: object additionalProperties: type: array items: $ref: '#/definitions/FieldDefinition' FieldDefinition: type: object description: | Secondary or Custom Field metadata describing the rules for populating the corresponding Field data when creating or updating a Case. Extends [AbstractField](#AbstractField). allOf: - $ref: '#/definitions/AbstractField' - type: object required: - fieldValueType - label properties: fieldValueType: $ref: '#/definitions/FieldValueType' fieldRequired: type: boolean description: Indicates whether this field is required default: false label: type: string description: Human-readable label for this field maxLength: 1000 regExp: type: string description: Optional regular expression which applies to fields where fieldValueType is TEXT maxLength: 255 ResolutionToolkitResponse: type: object description: Resolution toolkit settings applicable for a Group. required: - groupId properties: groupId: type: string description: ID of the Group to which this resolution toolkit belongs. maxLength: 255 providerType: $ref: '#/definitions/ProviderType' resolutionFields: $ref: '#/definitions/ResolutionFields' resolutionRules: $ref: '#/definitions/ResolutionRules' example: groupId: GROUP_ID providerType: WATCHLIST resolutionFields: statuses: - id: STATUS_ID_1 label: 'FALSE' type: 'FALSE' - id: STATUS_ID_2 label: POSSIBLE type: POSSIBLE - id: STATUS_ID_3 label: POSITIVE type: POSITIVE - id: STATUS_ID_4 label: UNSPECIFIED type: UNSPECIFIED risks: - id: RISK_ID_1 label: MEDIUM type: "null" - id: RISK_ID_2 label: LOW type: "null" - id: RISK_ID_3 label: HIGH type: "null" - id: RISK_ID_4 label: UNKNOWN type: "null" reasons: - id: REASON_ID_1 label: unreasonable type: "null" - id: REASON_ID_2 label: reason type: "null" resolutionRules: STATUS_ID_1: reasons: - REASON_ID_1 - REASON_ID_2 remarkRequired: true reasonRequired: true risks: - RISK_ID_1: - RISK_ID_2: STATUS_ID_2: reasons: [] remarkRequired: false reasonRequired: false risks: [] STATUS_ID_3: reasons: - REASON_ID_2 remarkRequired: false reasonRequired: true risks: - RISK_ID_3: STATUS_ID_4: reasons: - REASON_ID_1 remarkRequired: false reasonRequired: true risks: - RISK_ID_4: - RISK_ID_2: ResolutionRules: type: object description: A collection of [StatusRules] (#StatusRule) keyed by Status ID. additionalProperties: type: object $ref: '#/definitions/StatusRule' StatusRule: type: object description: Represents the rules that should be applied when resolving a Result with a specific Status. required: - reasons - remarkRequired - reasonRequired - risks properties: reasons: type: array description: The IDs for the Reasons that can be used when resolving a Result with a specific Status. items: type: string remarkRequired: type: boolean description: Flag indicating whether a remark is required when resolving a Result with a specific Status. reasonRequired: type: boolean description: Flag indicating whether a reason is required when resolving a Result with a specific Status. risks: type: array description: The IDs for the Risks that can be used when resolving a Result with a specific Status. items: type: string ResolutionFields: type: object description: Describes all resolution fields (statuses, risks and reasons) in detail. required: - statuses - risks - reasons properties: statuses: type: array items: $ref: '#/definitions/ResolutionField' risks: type: array items: $ref: '#/definitions/ResolutionField' reasons: type: array items: $ref: '#/definitions/ResolutionField' ResolutionField: type: object description: Represents the ID, label and type for a Status, a Risk or a Reason. required: - id - label properties: id: type: string description: The ID for the resolution label. label: type: string description: The label for the resolution label. type: $ref: '#/definitions/ResolutionStatusType' ResolutionStatusType: type: string description: Enumeration of resolution Status types. enum: - "POSITIVE" - "POSSIBLE" - "FALSE" - "UNSPECIFIED" CaseSearchResultResponse: type: object description: | Search response containing N cases matched searching criteria. allOf: - $ref: '#/definitions/CaseSummaryFilterResponse' - required: - results properties: cursor: $ref: '#/definitions/Cursor' results: type: array description: | Cases that matched search criteria. No case ID will be returned when using Zero Footprint Screening (ZFS) and it should not be specified in the request either. items: $ref: '#/definitions/CaseSummaryResult' example: searchCriteria: modificationDate>='2016-07-27T00:00:00Z' totalResultCount: 2 sort: columnName: modificationDate order: ASCENDING cursor: cursorId: DnF1ZXJ5VGhlbkZldGNoBQAAAAAANCsbFkRiRXB6SU9tUVRpMTVZc2hER3RHeUEAAAAAADcWIRZVTkdzdTBWWVQtaVpHVGt3Nl9MUV9RAAAAAAALGugWbTM3dzI1aUxTS3VGYXVDbUZyX1RXdwAAAAAACxrpFm0zN3cyNWlMU0t1RmF1Q21Gcl9UV3cAAAAAADQrHBZEYkVweklPbVFUaTE1WXNoREd0R3lB results: - caseSystemId: 45698dc-e17a-fdcv-a8bb-456efcvc8483 caseId: e5928fca-e17a-4aa8-a8bb-d85e224aec46 groupId: lpsc4312-e17a-4aa8-vcs5-66669fd7wwqf modificationDate: 2018-09-28T16:55:05Z assignee: fullName: Assignee Name modifier: fullName: Modifier Name creator: fullName: Creator Name creationDate: 2018-09-28T16:55:05Z caseRating: HIGH - caseSystemId: 45698dc-e17a-fdcv-cdas-6728jiednab5 caseId: e5928fca-43fs-4aa8-a8bb-8974xsdf1258 groupId: edwqdewq-e17a-4aa8-vcs5-78ccdeerf49w modificationDate: 2019-08-28T10:05:15Z assignee: fullName: Assignee Name modifier: fullName: Modifier Name creator: fullName: Creator Name creationDate: 2019-08-28T10:05:15Z caseRating: NOT_RATED CaseSummaryResult: type: object description: | Represents an update on the results of the Case identified by 'caseSystemId' indicating that there are some new or updated results as a result of ongoing screening of this Case. required: - caseSystemId properties: caseSystemId: type: string maxLength: 192 description: System generated ID for the Case. caseId: type: string maxLength: 512 description: Case ID provided by the client or else generated by the system for the client. This field is not applicable for Zero Footprint Screening (ZFS). groupId: type: string maxLength: 255 description: Group identifier owning this case. modificationDate: type: string format: date-time description: Case modification date in ISO 8601 format excluding Week and Ordinal dates. assignee: description: User to whom the case assigned. $ref: '#/definitions/CaseSearchUserSummary' creator: description: Case author. $ref: '#/definitions/CaseSearchUserSummary' modifier: description: Author of recent changes. $ref: '#/definitions/CaseSearchUserSummary' creationDate: type: string format: date-time description: Case creation date in ISO 8601 format excluding Week and Ordinal dates. caseRating: type: string description: Rating of the case. enum: - NO_RISK - LOW - MEDIUM - HIGH - UNKNOWN - NOT_RATED CaseDetailsCollection: type: object description: Container of cases, that is used in scope of creation operation. required: - groupId - providerTypes - cases properties: groupId: type: string description: Group identifier owning the cases. maxLength: 255 providerTypes: type: array description: Array of provider types used in screening the cases. uniqueItems: true minItems: 1 items: $ref: '#/definitions/ProviderType' nameTransposition: type: boolean description: | Flag indicating whether name transposition should be enabled for the cases. The value from the Account settings will be used if not provided. caseScreeningState: type: object description: | Mapping from ProviderType to indicate whether Ongoing Screening is enabled for this Case on the specific ProviderType. Supported ProviderType [WATCHLIST]. By default, value will be set from account settings. additionalProperties: type: string cases: type: array description: | Array of CaseDetails used in creation of cases. The maximum number of cases is configured in account settings. uniqueItems: true minItems: 1 items: $ref: '#/definitions/CaseDetails' example: groupId: Client Group Id providerTypes: - WATCHLIST nameTransposition: true caseScreeningState: WATCHLIST: INITIAL cases: - caseId: Client Case Id entityType: INDIVIDUAL name: John Smith customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' ScreeningStatusRequestCollection: type: object description: | Collection of 'ScreeningStatusRequest'. The maximum number of cases is configured in account settings. properties: screeningStatusRequests: type: array uniqueItems: true description: | Contains 'caseSystemId' and presumptive screening timestamp which should be checked. items: $ref: '#/definitions/ScreeningStatusRequest' providerTypes: type: array description: Provider types for which results are exposed. items: $ref: '#/definitions/ProviderType' example: - screeningStatusRequests: - caseSystemId: Case System ID 1 dateFrom: '2020-10-24T11:40:21.517Z' - caseSystemId: Case System ID 2 dateFrom: '2020-10-24T11:40:21.517Z' - providerTypes: - WATCHLIST - PASSPORT_CHECK ScreeningStatusRequest: type: object description: | Contains 'caseSystemId' and presumptive screening timestamp which should be checked. properties: caseSystemId: type: string description: System-generated ID for a successfully created Case. maxLength: 192 dateFrom: type: string format: date-time description: Date and time of Last Case Screening in ISO 8601 format excluding Week and Ordinal dates. maxLength: 255 ScreeningStatusResponse: type: object description: | Contains status and aggregated screening result for each requested case. If 'requestFromScreenedDate' less than 'lastScreenedDate' then status equals 'NOT_SCREENED' else status equals 'SCREENED'. required: - caseSystemId - screeningStatus - requestFromScreenedDate - providerSummaries properties: caseSystemId: type: string description: System-generated ID for a successfully created Case. maxLength: 192 screeningStatus: type: string description: Case Screening State Enumeration representing type of Screening enum: - NOT_SCREENED - SCREENED requestFromScreenedDate: type: string format: date-time description: Date and time of Last Case Screening in ISO 8601 format excluding Week and Ordinal dates. maxLength: 255 lastScreenedDate: type: string format: date-time description: Date and time of Last performed Case Screening in ISO 8601 format excluding Week and Ordinal dates. maxLength: 255 providerSummaries: type: object description: | Contains enabled for this Case ProviderType(s). Supported ProviderType [WATCHLIST], [CLIENT_WATCHLIST], [MEDIA_CHECK] and [PASSPORT_CHECK]. additionalProperties: $ref: '#/definitions/ProviderTypeSummaryResult' example: - caseSystemId: Case System ID 1 requestFromScreenedDate: '2016-07-27T15:35:10Z' lastScreenedDate: '2016-07-27T15:30:10Z' providerSummaries: WATCHLIST: status: SCREENED totalMatches: 120 reviewRequired: 20 unresolved: 17 PASSPORT_CHECK: isReviewRequired: false - caseSystemId: Case System ID 2 requestFromScreenedDate: '2016-07-27T15:35:10Z' lastScreenedDate: '2016-07-27T15:30:10Z' providerSummaries: WATCHLIST: status: NOT_SCREENED totalMatches: 0 reviewRequired: 0 unresolved: 0 CaseDetails: type: object description: | Representation of a single case that is used for case creation operation. Defines Case data that can be sent when creating a new Case. required: - entityType - name properties: caseId: type: string description: Case ID provided by the client. This is auto-generated by the system if not provided. maxLength: 512 entityType: type: string description: Case Entity Type Enumeration. enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED name: type: string description: Name to screen for this case. maxLength: 1000 customFields: type: array description: | Case Custom Fields. Available custom fields and their definitions can be obtained via `groups/{groupId}/caseTemplate`. items: $ref: '#/definitions/Field' secondaryFields: type: array description: | Case Secondary Fields. Available secondary fields and their definitions can be obtained via `groups/{groupId}/caseTemplate`. items: $ref: '#/definitions/Field' example: caseId: Client Case Id entityType: INDIVIDUAL name: John Smith customFields: - typeId: Custom Field Id 1 value: Reference ID 1234567 - typeId: Custom Field Id 2 value: Deal Id 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' CaseReferenceDetails: type: object description: | Reference representation of a single case that is used for case creation operation. Defines Case data that was saved or not valid. required: - name properties: name: description: Name provided for the Case. type: string maxLength: 1000 caseId: description: Case ID provided by the client. This is auto-generated by the system if not provided. type: string maxLength: 512 caseSystemId: description: System-generated ID for a successfully created Case. type: string maxLength: 192 nameTransposition: description: | Flag indicating whether name transposition is enabled for the Case. type: boolean caseScreeningState: description: | Mapping from ProviderType to indicate whether Ongoing Screening is enabled for this Case on the specific ProviderType. Supported ProviderType [WATCHLIST]. By default, value will be set from account settings. type: object additionalProperties: type: string errors: type: array description: List of validation errors (if any). items: $ref: '#/definitions/Error' example: name: John Smith caseId: Client Case Id caseSystemId: System Case Id nameTransposition: true caseScreeningState: WATCHLIST: INITIAL CaseReference: type: object description: Container of 'caseId' and 'caseSystemId'. required: - caseId - caseSystemId properties: caseSystemId: type: string maxLength: 192 description: System generated ID for the Case. caseId: type: string maxLength: 512 description: Case ID provided by the client or else generated by the system for the client. OngoingScreeningUpdateSearchResponse: type: object description: | Search response containing a collection of `OngoingScreeningUpdate` s. Extends [SearchResponse](#SearchResponse). allOf: - $ref: '#/definitions/SearchResponse' - required: - results properties: results: type: array items: $ref: '#/definitions/OngoingScreeningUpdate' example: searchCriteria: updateDate>='2016-07-27T00:00:00Z' totalResultCount: 45 paginationDetails: currentPage: 1 itemsPerPage: 25 totalItems: 45 results: - caseSystemId: Case System ID 1 updateDate: 2016-07-28T10:05:05Z numberOfNewResults: 1 numberOfReviewRequiredResults: 0 - caseSystemId: Case System ID 2 updateDate: 2016-07-27T15:35:10Z numberOfNewResults: 0 numberOfReviewRequiredResults: 2 OngoingScreeningUpdate: type: object description: | Respresents an update on the results of the `Case` identified by `caseSystemId` indicating that there are some new or updated results as a result of ongoing screening of this `Case`. required: - caseSystemId - updateDate properties: caseSystemId: type: string maxLength: 192 description: System generated ID for the Case updateDate: type: string format: date-time description: Creation date and time of this ongoingScreeningUpdate in ISO 8601 format excluding Week and Ordinal dates. numberOfNewResults: type: integer format: int32 description: | Number of new results added to the Case identified by caseSystemId during the ongoing screening operation that this update belongs to. numberOfUpdatedResults: type: integer format: int32 description: | Number of updates in the existing results of the Case identified by caseSystemId found during the ongoing screening operation that this update belongs to. LinkedCasesRequest: type: object required: - relatedCaseSystemIds properties: relatedCaseSystemIds: type: array description: Related case system IDs. uniqueItems: true minItems: 1 maxItems: 25 items: type: string note: type: string maxLength: 1000 description: Note added by the user. example: relatedCaseSystemIds: - 'relatedCaseSystemId1' - 'relatedCaseSystemId2' - 'relatedCaseSystemId3' note: 'Audit note' CaseRelationshipRequest: type: object description: Request to hold pagination details for listing case relationships. properties: pagination: description: Pagination details $ref: '#/definitions/Pagination' CaseRelationshipResponse: type: object description: The result set of relationships between cases. properties: pagination: description: Pagination details $ref: '#/definitions/PaginationResponseDetails' totalResultCount: type: integer description: The total results count format: int64 results: type: array description: List of relationship identifiers items: $ref: '#/definitions/RelationshipIdentifiers' RelationshipIdentifiers: type: object description: Relationship identifer between cases properties: sourceCaseSystemId: type: string description: CaseSystemId declared as source (primary) case maxLength: 192 targetCaseSystemId: type: string description: CaseSystemId declared as target (subcase) case maxLength: 192 relationshipType: type: string description: Relationship type between cases. enum: - SUBCASE_TO_PRIMARY - PRIMARY_TO_SUBCASE PaginationResponseDetails: type: object description: Pagination details. properties: currentPage: type: integer description: The current page format: int32 itemsPerPage: type: integer description: The number of items per page format: int32 totalItems: type: integer description: Total number of items available format: int64 OngoingScreeningRequest: type: object description: Request containing ongoing screening details required: - providerTypes properties: providerTypes: type: array description: Provider types for which to enable/disable ongoing screening. items: $ref: '#/definitions/OngoingScreeningProviderType' note: type: string maxLength: 1000 description: Note added by the User. CaseRatingRequest: type: object description: The object representing a case rating. required: - caseRating properties: caseRating: type: string description: The case rating types. enum: - NO_RISK - LOW - MEDIUM - HIGH - UNKNOWN - NOT_RATED reason: type: string maxLength: 1000 description: The reason for setting the new case rating type of the case. CaseBulkArchiveRequest: type: object description: A request body on Bulk Update Archive States required: - archive - caseSystemIds properties: archive: type: boolean description: A flag indicating whether to Bulk Archive (`true`) or Unarchive (`false`) Cases. caseSystemIds: type: array description: An array of system generated Ids for the Cases items: type: string description: System generated Id for the Case note: type: string maxLength: 1000 description: Note added by the user. example: archive: true caseSystemIds: - 'caseSystemId1' - 'caseSystemId2' - 'caseSystemId3' note: 'Audit note' CaseBulkAssignRequest: type: object description: A request body on Bulk Update Case Assignments required: - caseSystemIds properties: userId: type: string description: User to whom the cases will be assigned, or `"UNASSIGN"` when unassign action is expected caseSystemIds: type: array description: An array of system generated Ids for the Cases items: type: string description: System generated Id for the Case note: type: string maxLength: 1000 description: Note added by the user. example: userId: "userId" caseSystemIds: - 'caseSystemId1' - 'caseSystemId2' - 'caseSystemId3' note: 'Audit note' CaseBulkDeleteRequest: type: object description: A request body on Bulk Delete Cases required: - caseSystemIds properties: caseSystemIds: type: array description: An array of system generated Ids for the Cases items: type: string description: System generated Id for the Case note: type: string maxLength: 1000 description: Note added by the user. example: caseSystemIds: - 'caseSystemId1' - 'caseSystemId2' - 'caseSystemId3' note: 'Audit note' CaseBulkMoveRequest: type: object description: A request body on Bulk Move Cases required: - groupId - caseSystemIds properties: groupId: type: string description: Group to which the cases will be moved caseSystemIds: type: array description: An array of system generated Ids for the Cases items: type: string description: System generated Id for the Case note: type: string maxLength: 1000 description: Note added by the user. example: groupId: "groupId" caseSystemIds: - 'caseSystemId1' - 'caseSystemId2' - 'caseSystemId3' note: "note" CaseBulkOngoingScreeningRequest: type: object description: A request body on Bulk Update Ongoing Screening States required: - caseScreeningState - caseSystemIds properties: caseScreeningState: type: object description: | Mapping from ProviderType to toggle Ongoing Screening ON/OFF for these Cases on the specific ProviderType. Supported ProviderTypes [WATCHLIST, MEDIA_CHECK]. additionalProperties: type: string caseSystemIds: type: array description: An array of system generated Ids for the Cases items: type: string description: System generated Id for the Case note: type: string maxLength: 1000 description: Note added by the user. example: caseScreeningState: WATCHLIST: INITIAL MEDIA_CHECK: ONGOING caseSystemIds: - 'caseSystemId1' - 'caseSystemId2' - 'caseSystemId3' note: Audit note CaseBulkLinkRequestCollection: type: object description: A request body on Bulk Update Case Links required: - link - relationshipType - caseSystemIds properties: link: type: boolean description: A flag indicating whether to Bulk Link (`true`) or Unlink (`false`) Cases. relationshipType: type: string description: Relationship type between cases. enum: - SUBCASE_TO_PRIMARY - PRIMARY_TO_SUBCASE caseSystemIds: type: array description: An array of case bulk link requests items: $ref: '#/definitions/CaseBulkLinkRequest' note: type: string maxLength: 1000 description: Note added by the user. example: link: true relationshipType: SUBCASE_TO_PRIMARY caseSystemIds: - caseSystemId: 'caseSystemId1' - relatedCaseSystemIds: - 'caseSystemId2' - 'caseSystemId3' - 'caseSystemId4' - caseSystemId: 'caseSystemId5' - relatedCaseSystemIds: - 'caseSystemId6' - 'caseSystemId7' - 'caseSystemId8' note: 'Audit note' CaseBulkLinkRequest: type: object description: Case Bulk Link Request required: - caseSystemId - relatedCaseSystemIds properties: caseSystemId: type: string description: System generated ID for the Case relatedCaseSystemIds: type: array description: An array of system generated Ids for the Cases items: type: string CaseBulkStatus: type: object description: Case Bulk Status required: - caseSystemId - success properties: caseSystemId: type: string description: System generated ID for the Case success: type: boolean description: Indicates the result of Case Archiving / Unarchiving action example: true errors: type: array description: A set of validation errors items: $ref: '#/definitions/Error' CaseBulkResponse: type: object description: Cases Archived / Unarchived Bulk Response required: - statuses properties: statuses: type: array description: A set of results on each Case items: $ref: '#/definitions/CaseBulkStatus' example: statuses: - caseSystemId: 'caseSystemId1' success: true - caseSystemId: 'caseSystemId2' success: true - caseSystemId: 'caseSystemId3' success: false errors: - error: 'CASE_NOT_FOUND' cause: 'API key does not have permission to access the case or case not found.' FieldValueType: type: string description: | Enumerated value formats for a secondary / custom field. - GENDER can be one of enumerated values in `GenderType.UKNOWN/MALE/FEMALE`. - DATE is a Date in ISO 8601 format excluding Week and Ordinal dates. - COUNTRY is a ISO_3166-1_alpha-3 Country Code. All supported country codes can be obtained via `/reference/countries`. - PASSPORT_DOCUMENT_TYPE can be screened by `ProviderType.PASSPORT_CHECK`. - STATE - a State/Country type used by `ProviderType.PASSPORT_CHECK` for nationality and passport issuing state. - TEXT is a string. enum: - COUNTRY - DATE - GENDER - PASSPORT_DOCUMENT_TYPE - STATE - TEXT FieldResult: type: string description: Field result enumeration enum: - LINKED - MATCHED - NOT_MATCHED - NOT_RUN - UNKNOWN GroupScreeningType: type: string description: Group screening type enumeration enum: - CASE_MANAGEMENT_AUDIT - ZERO_FOOTPRINT RelationshipType: type: string description: Relationship type between cases. enum: - SUBCASE_TO_PRIMARY - PRIMARY_TO_SUBCASE OngoingScreeningProviderType: type: string description: Ongoing screening supported provider types enum: - WATCHLIST - MEDIA_CHECK # # Definitions for Profile domain # ============================== # ActionDetail: type: object required: - actionType properties: actionId: type: string actionType: type: string description: Action Detail Type Enumeration enum: - CIVIL_ACTION - CRIMINAL_CONVICTION - ENFORCEMENT - SANCTION comment: type: string endDate: type: string format: date-time files: type: array items: $ref: '#/definitions/FileMeta' publicationType: type: string published: type: string reference: type: string source: $ref: '#/definitions/ProviderSource' startDate: type: string format: date-time text: type: string title: type: string Address: type: object properties: city: type: string country: $ref: '#/definitions/Country' postCode: type: string region: type: string street: type: string AbstractAssociate: type: object description: | The `AbstractAssociate` subclasses corresponding to each type of entity are: * `COUNTRY`: `CountryAssociate` * `INDIVIDUAL`: `IndividualAssociate` * `ORGANISATION`: `OrganisationAssociate` * `VESSEL`: `VesselAssociate` discriminator: associateEntityType required: - associateEntityType - entityType properties: associateEntityType: type: string description: Discriminator field. Might go away in a future major version of the API entityType: type: string description: | Profile Entity Type Enumeration. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` enum: - COUNTRY - INDIVIDUAL - ORGANISATION - VESSEL reversed: type: boolean default: false targetEntityId: type: string targetExternalImportId: type: string type: type: string description: Associate Type Enumeration default: UNKNOWN enum: - ADVISOR - AGENT_REPRESENTATIVE - AFFILIATED_COMPANY - AFFILIATED_ORGANIZATION - AFFILIATED_POSITION - ASSET - ASSISTANT - ASSOCIATE - ASSOCIATED_SPECIAL_INTEREST_PERSON - AUNT - BANKER - BRANCH_OFFICE - BROTHER - BROTHER_IN_LAW - BUSINESS_ASSOCIATE - CHILD - CLIENT - COLLEAGUE - COUSIN - CO_DEFENDANT - DAUGHTER - DAUGHTER_IN_LAW - DIRECTOR - DOC_COMPANY - EMPLOYEE - EMPLOYER - EXECUTIVE - EX_HUSBAND - EX_WIFE - FAMILY - FAMILY_MEMBER - FATHER - FATHER_IN_LAW - FINANCIAL_ADVISOR - FRIEND - FRONT_COMPANY - GRANDDAUGHTER - GRANDFATHER - GRANDMOTHER - GRANDSON - GRAND_CHILD - GROUP_BENEFICIAL_OWNER - HUSBAND - KEY_MEMBER - LEGAL_ADVISOR - MISC - MOTHER - MOTHER_IN_LAW - NEPHEW - NIECE - NOMINEE - OPERATOR - OWNER - PARENT - POLITICAL_ADVISOR - REGISTERED_OWNER - RELATIVE - SAME_SEX_SPOUSE - SENIOR_OFFICIAL - SHAREHOLDER_OWNER - SHIP_MANAGER - SISTER - SISTER_IN_LAW - SON - SON_IN_LAW - SPOUSE - STEP_DAUGHTER - STEP_SON - STEPFATHER - STEPMOTHER - SUBSIDIARY - TECHNICAL_MANAGER - UNCLE - UNKNOWN - UNMARRIED_PARTNER - WIFE targetPrimaryName: type: string creationDate: type: string format: date-time modificationDate: type: string format: date-time updateCategory: type: string description: Entity Update Category Enumeration enum: - C1 - C2 - C3 - C4 - C6 - UNKNOWN category: type: string targetCategories: type: array description: List of names of [ProviderSourceTypeCategoryDetail](#ProviderSourceTypeCategoryDetail) in sources of target Entity. uniqueItems: true items: type: string ContactDetail: type: object required: - contactDetailType properties: contactDetailType: type: string description: Contact Detail Type Enumeration enum: - EMAIL - FAX - URL - VOICE country: $ref: '#/definitions/Country' detail: type: string Country: type: object required: - code - name properties: code: type: string name: type: string CountryAssociate: type: object description: | Associate entity details. Represents Country entity. Extends [AbstractAssociate](#AbstractAssociate). allOf: - $ref: '#/definitions/AbstractAssociate' CountryEntity: required: - entityType type: object allOf: - $ref: '#/definitions/Entity' properties: entityType: type: string description: | Profile Entity Type Enumeration. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` enum: - COUNTRY - INDIVIDUAL - ORGANISATION - VESSEL CountryLink: type: object required: - country - type properties: country: $ref: '#/definitions/Country' countryText: type: string type: type: string description: Country Link Type Enumeration enum: - NATIONALITY - OPERATESIN - POB - POD - REGISTEREDIN - RESIDENT - VESSELFLAG - LOCATION Detail: type: object properties: detailType: type: string description: Detail Type Enumeration default: UNKNOWN enum: - BIOGRAPHY - FUNDING - IDENTIFICATION - NOTE - REPORTS - REGULATION - SANCTION - UNKNOWN text: type: string title: type: string maxLength: 255 Entity: type: object description: | Represents a specific entity - usually corresponding to an individual or an organisation - that can appear as a potential screening result against a `Case`. Synonyms for this concept include "Profile". The `Entity` subclasses corresponding to each type of entity (designated by the `entityType` field below) are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` Notes for Client Watchlist usage: * to add Date of Birth to an Individual entity, please use the `events` array with the "type":"BIRTH" * to add Place of Birth to an Individual entity, please use the `events` array with the "type":"BIRTH" and populate the `Region` field as part of the event `address` object * to add Registered Country to a Vessel entity, please use the `countryLinks` array with the "type":"VESSELFLAG" * to add Registered Country to an Organisation entity, please use the `countryLinks` array with the "type": "REGISTEREDIN" discriminator: entityType required: - entityId - creationDate - names - sources - externalImportId properties: actions: type: array items: $ref: '#/definitions/ActionDetail' active: type: boolean default: false addresses: type: array items: $ref: '#/definitions/Address' associates: type: array items: $ref: '#/definitions/AbstractAssociate' category: type: string comments: type: string contacts: type: array items: $ref: '#/definitions/ContactDetail' countryLinks: type: array items: $ref: '#/definitions/CountryLink' creationDate: type: string format: date-time deletionDate: type: string format: date-time description: type: string details: type: array items: $ref: '#/definitions/Detail' entityId: type: string description: An alphanumeric value including "_" externalImportId: type: string description: An alphanumeric value including "_" files: type: array items: $ref: '#/definitions/FileMeta' identityDocuments: type: array items: $ref: '#/definitions/IdentityDocument' images: type: array items: $ref: '#/definitions/Image' lastAdjunctChangeDate: type: string format: date-time modificationDate: type: string format: date-time names: type: array items: $ref: '#/definitions/Name' previousCountryLinks: type: array items: $ref: '#/definitions/CountryLink' provider: $ref: '#/definitions/Provider' sourceDescription: type: string sourceUris: type: array items: type: string sources: type: array items: $ref: '#/definitions/ProviderSource' subCategory: type: string updateCategory: type: string description: Entity Update Category Enumeration enum: - C1 - C2 - C3 - C4 - C6 - UNKNOWN updatedDates: $ref: '#/definitions/EntityUpdatedDates' weblinks: type: array items: $ref: '#/definitions/Weblink' translatedEntity: allOf: - $ref: '#/definitions/TranslatedEntity' x-wc1-field-extra-annotations: "@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)" TranslatedEntity: type: object description: Representation of translated entity. properties: translationDisclaimer: type: string description: Disclaimer for Translation Response. details: type: array description: A collection of translated entity details. items: $ref: '#/definitions/Detail' EntityDelete: type: object required: - entityId properties: entityId: type: string EntitySupersede: type: object required: - entityId - supersedingEntityId properties: entityId: type: string supersedingEntityId: type: string EntityPurge: type: object required: - entityId properties: entityId: type: string purgedDate: type: string format: date-time EntityUpdatedDates: type: object properties: ageUpdated: type: string format: date-time aliasesUpdated: type: string format: date-time alternativeSpellingUpdated: type: string format: date-time asOfDateUpdated: type: string format: date-time categoryUpdated: type: string format: date-time citizenshipsUpdated: type: string format: date-time companiesUpdated: type: string format: date-time deceasedUpdated: type: string format: date-time dobsUpdated: type: string format: date-time eiUpdated: type: string format: date-time enteredUpdated: type: string format: date-time externalSourcesUpdated: type: string format: date-time firstNameUpdated: type: string format: date-time foreignAliasUpdated: type: string format: date-time furtherInformationUpdated: type: string format: date-time idNumbersUpdated: type: string format: date-time keywordsUpdated: type: string format: date-time lastNameUpdated: type: string format: date-time linkedToUpdated: type: string format: date-time locationsUpdated: type: string format: date-time lowQualityAliasesUpdated: type: string format: date-time passportsUpdated: type: string format: date-time placeOfBirthUpdated: type: string format: date-time positionUpdated: type: string format: date-time ssnUpdated: type: string format: date-time subCategoryUpdated: type: string format: date-time titleUpdated: type: string format: date-time updatecategoryUpdated: type: string format: date-time sicUpdated: type: string format: date-time Event: type: object description: Event related to Entity. required: - type properties: address: description: Address related to Entity. $ref: '#/definitions/Address' allegedAddresses: type: array description: Alleged addresses list. items: $ref: '#/definitions/Address' day: type: integer description: The day of the month on which the event occurred. format: int32 fullDate: type: string description: A text representation of the date according 'ISO 8601' standard when the event occurred. month: type: integer description: The month of the year in which the event occurred. format: int32 type: description: State representing the event in relation to an individual. $ref: '#/definitions/EventType' year: type: integer description: The year in which the event occurred. format: int32 FileMeta: type: object required: - caption - uri properties: caption: type: string uri: type: string tags: type: array description: | Label(s) for the corresponding uri. For example, - PHOTO indicates the page represented by the uri contains images. - PDF indicates the page represented by the uri contains PDFs. items: type: string IdentityDocument: type: object properties: entity: $ref: '#/definitions/Entity' expiryDate: type: string issueDate: type: string issuer: type: string locationType: $ref: '#/definitions/IdentityDocumentLocationType' number: type: string type: type: string IdentityDocumentLocationType: type: object description: | Represents the type of identity document location that includes the type of document, name, country and what type of entity it belongs to. properties: country: $ref: '#/definitions/Country' name: type: string type: type: string entityTypes: type: array items: $ref: '#/definitions/EntityType' CaseEntityType: type: string description: Case entity type enumeration. enum: - INDIVIDUAL - ORGANISATION - VESSEL - UNSPECIFIED EntityType: type: string description: Entity type of the case. enum: - INDIVIDUAL - ORGANISATION - VESSEL - COUNTRY Image: type: object required: - uri properties: caption: type: string height: type: integer format: int32 imageUseCode: type: string uri: type: string tags: type: array description: | Label(s) for the corresponding uri. For example, - PHOTO indicates the page represented by the uri contains images. - PDF indicates the page represented by the uri contains PDFs. items: type: string width: type: integer format: int32 IndividualAssociate: type: object description: | Associate entity details. Represents Individual entity. Extends [AbstractAssociate](#AbstractAssociate). allOf: - $ref: '#/definitions/AbstractAssociate' - properties: age: type: string ageAsOfDate: type: string format: date-time targetDOBs: type: array uniqueItems: true items: type: string IndividualEntity: type: object required: - entityType allOf: - $ref: '#/definitions/Entity' - properties: age: type: string ageAsOfDate: type: string format: date-time events: type: array items: $ref: '#/definitions/Event' gender: $ref: '#/definitions/Gender' isDeceased: type: boolean default: false previousRoles: type: array items: $ref: '#/definitions/Role' roles: type: array items: $ref: '#/definitions/Role' entityType: type: string description: | Profile Entity Type Enumeration. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` enum: - COUNTRY - INDIVIDUAL - ORGANISATION - VESSEL LanguageCode: type: object properties: code: type: string name: type: string MediaCheckResultResolution: description: Resolution details for news articles attached to a case. type: object properties: risk: type: string description: Definition of Media Check attached article risk level example: HIGH reason: description: Free text reason provided when attaching a news article to a case type: string example: It looks like the case we are looking for reviewDate: description: Date when a news article was attached to a case type: string format: date-time MediaCheckBaseFilter: description: Used to filter news search results. type: object properties: publicationDate: $ref: '#/definitions/MediaCheckPublicationDateRange' query: description: User defined boolean query which can be used to narrow news results. type: string example: Theft AND Fraud archivedArticles: description: Indicates databases to return response from. If true and the archive limit on the Media Check group settings is set to 2 or more years, the response will contain results from both databases - the one that includes less than 2 years old articles, and the second one that includes 2 or more years old (archived) articles. By default the response will only include articles that are less than 2 years old. Must always be set to `true`. This field will be deprecated in the future releases. type: boolean default: false example: true reviewRequiredArticles: type: boolean description: | Indicates whether articles that require review or reviewed articles should be included. Review reqired articles are included if this field is not specified (default value). default: true smartFilter: type: boolean description: | Indicates whether filter should be used when searching news articles. Value of the filter field is stored on case or provided by group settings. deduplicatedArticles: description: | Deduplication algorithm to use in MediaCheckBaseFilter. It is possible to not specify value of deduplication algorithm in request and it will be provided by group settings. Possible types of deduplication algorithm are: * STRICT - If articles are the same they are grouped and only the newest one is returned to the user. 'articleSummary' will contain 'duplicatesKey' field. Its value can be used to retrieve duplicated articles using "Retrieve MediaCheck article duplicates" endpoint. * COMPOSITE - If articles are the same and/or similar they are grouped and only the newest one is returned to the user. 'articleSummary' will contain 'duplicatesKey' field. Its value can be used to retrieve duplicated articles using "Retrieve MediaCheck article duplicates" endpoint. * DISABLED - All articles are returned to the user, even if they are the same. type: string enum: - STRICT - COMPOSITE - DISABLED MediaCheckResult: description: Response with Media Check results for a case type: object properties: resolution: description: Case resolution information for Media Check headline result set. $ref: '#/definitions/MediaCheckResultResolution' articleSummary: description: Media Check news article summary. $ref: '#/definitions/MediaCheckArticleSummary' ResultsMediaCheckResolution: description: Response with Media Check results for a case type: object properties: articleId: description: Media Check news article ID. type: string errorCodes: type: array description: Errors generated by validation. items: $ref: '#/definitions/Error' MediaCheckResultsRequest: type: object properties: drilldownKeys: type: array description: Drill down keys for facet navigation. items: type: string baseFilter: $ref: '#/definitions/MediaCheckBaseFilter' pagination: $ref: '#/definitions/MediaCheckResultsPagination' facets: $ref: '#/definitions/MediaCheckFacetsRequest' MediaCheckArticlesMetadataRequest: type: object description: Definition of MediaCheck news articles content request required: - articleIds properties: articleIds: uniqueItems: true maxItems: 200 minItems: 1 type: array description: | MediaCheck articles IDs. Request may contain up to 200 articles. items: type: string MediaCheckRegularFacetResponse: type: object properties: drilldownKey: description: Key of the facet that used for navigation type: string facetLabel: description: Label of the facet type: string articleCount: description: Number of articles within the facet type: integer format: int64 MediaCheckPublicationDatesFacetResponse: type: object allOf: - $ref: '#/definitions/MediaCheckRegularFacetResponse' - properties: selectedCount: type: integer description: Number of articles that are both within `baseFilter.publicationDate` range and this facet's range format: int64 MediaCheckFacetsResponse: type: object description: Facets for article navigation. Use facet's `drilldownKey` to select a facet properties: publicationTypes: type: array items: $ref: '#/definitions/MediaCheckRegularFacetResponse' geographies: type: array items: type: array items: $ref: '#/definitions/MediaCheckRegularFacetResponse' topics: type: array items: $ref: '#/definitions/MediaCheckRegularFacetResponse' topicPhases: type: array items: $ref: '#/definitions/MediaCheckRegularFacetResponse' countries: type: array items: $ref: '#/definitions/MediaCheckRegularFacetResponse' publicationDates: type: array items: $ref: '#/definitions/MediaCheckPublicationDatesFacetResponse' MediaCheckResultsResponse: type: object properties: pageReferences: description: Contains references that allows pagination across headline results for a case. $ref: '#/definitions/MediaCheckResultsPaginationResponse' results: description: Response for Media Check results for a case. type: array items: $ref: '#/definitions/MediaCheckResult' totalResultCount: description: Total number of found news articles type: integer format: int64 example: 89898 facets: description: Contains facets available for navigation. Use facet's `drilldownKey` to select a facet $ref: '#/definitions/MediaCheckFacetsResponse' MediaCheckArticlesMetadataResponse: type: object properties: results: description: Response for Media Check results for a case. type: array items: $ref: '#/definitions/MediaCheckResult' ResultsMediaCheckResolutionResponse: type: object properties: resolutions: description: Response for Media Check results resolutions. type: array items: $ref: '#/definitions/ResultsMediaCheckResolution' MediaCheckPageReference: type: string description: A string token that can be used to paginate across the headline result set. example: eNqrVirOLypRslLycw2PD/GP9/dxUdJRyixJzS0OSC0KSExPVbIyMtBRKkotSy0qBnJKikpTdZQyMkuc80vzgBotLIGwFgA6Vxb3 MediaCheckResultsPagination: description: | Allows users to paginate across the full list of articles returned as part of the result set. The object should have either pageReference field or sort + itemsPerPage fields defined. type: object properties: itemsPerPage: minimum: 1 maximum: 100 default: 100 description: The number of news article headlines returned per page. type: integer format: int32 sort: type: string enum: - NEW_TO_OLD - OLD_TO_NEW default: NEW_TO_OLD pageReference: $ref: '#/definitions/MediaCheckPageReference' MediaCheckResultsPaginationResponse: description: | Contains references that allows pagination across headline results for a case. API consumer can use this object to find pagination options available and send the values as part of MediaCheckResultsPagination in pageReference field. type: object properties: current: $ref: '#/definitions/MediaCheckPageReference' first: $ref: '#/definitions/MediaCheckPageReference' last: $ref: '#/definitions/MediaCheckPageReference' next: $ref: '#/definitions/MediaCheckPageReference' previous: $ref: '#/definitions/MediaCheckPageReference' MediaCheckPublicationDetails: description: News article publisher details. type: object properties: code: description: Unique source code used to identify the publisher. type: string example: LSEG countries: description: List of countries the publisher covers type: array items: type: string example: USA description: description: Publisher description type: string example: Fast, accurate verbatim transcripts languages: description: List of languages the publisher covers. type: array items: type: string example: English name: description: Publisher Name. type: string example: LSEG publicationTypes: description: Publication type. type: array items: type: string example: Broadcast regions: description: List of regions the publisher covers. type: array items: type: string example: North America sectors: description: List of sectors the publisher covers. type: array items: type: string example: Government status: description: Status of the publisher, i.e. active / archived (discontinued). type: string example: active Name: type: object required: - fullName - type properties: fullName: type: string givenName: type: string languageCode: $ref: '#/definitions/LanguageCode' lastName: type: string originalScript: type: string prefix: type: string suffix: type: string type: type: string description: Watchlist Profile Name Type enumeration enum: - PRIMARY - AKA - AKAENHANCED - FKA - DBA - MAIDEN - LANG_VARIATION - PREVIOUS - VEHICLE_ID - LOW_QUALITY_AKA - NATIVE_AKA CaseSummaryFilterResponse: type: object description: Filter the response properties: query: type: string description: | A query filter expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in , and the superset supported by the WC1 API documented in . The query supports next field to specify searching criteria: 'modificationDate' - Time when the case has been modified by the user; 'assignedUserId' - Identifier of the User cases are assigned to; 'groupId' - Identifier of the Group that owns the case. 'creatorUserId' - Identifier of the case author 'modifierUserId' - Identifier of the recent changes author 'creationDate' - Time when the case has been created RSQL/FIQL parser contains some reserved characters: `'"' | "'" | "(" | ")" | ";" | "," | "=" | "!" | "~" | "<" | ">"` If there are reserved characters or white spaces in the query expression, they must be escaped by enclosing them in single or double quotes. If you need to use both single and double quotes inside an argument, then you must escape one of them using `\` (backslash). If you want to use `\` literally, then double it as `\\`. Backslash has a special meaning only inside a quoted argument, not in unquoted argument. Using reserved characters or white spaces without escaping can lead to parsing and execution errors. The query examples: * "query": "example=='TE!ST'" * "query": "example==\\"TE'ST\\"" * "query": "example=='TE\\\\'ST'" Argument can be a single value, or multiple values in parenthesis separated by comma. Value that does not contain any reserved character or a white space can be unquoted, other arguments must be enclosed in single or double quotes. Example: * "query": "example1=='TE\\\\'ST', example2==TEST" sort: type: array description: The sort critieria to apply to the query items: $ref: '#/definitions/SortCriterion' CaseSummaryFilter: type: object description: Defines search criteria, sorting and items count in the response. allOf: - $ref: '#/definitions/CaseSummaryFilterResponse' - properties: cursorOptions: description: The cursorOptions critieria allows specifying count of items in the response. $ref: '#/definitions/CursorOptions' Cursor: type: object description: Identifier which allows retrieving next N cases. required: - cursorId properties: cursorId: type: string description: | Identifier of the cursor returned by the data source and needs to be provided when scrolling to the next page of results. CursorID exists for 60 seconds. CursorOptions: type: object properties: itemsPerPage: type: integer description: Required parameter, with validation min value 1, max value 1000 which allows to define items per page in the response. format: int64 OrganisationAssociate: type: object description: | Associate entity details. Represents Organisation entity. Extends [AbstractAssociate](#AbstractAssociate). allOf: - $ref: '#/definitions/AbstractAssociate' OrganisationEntity: type: object required: - entityType allOf: - $ref: '#/definitions/Entity' properties: entityType: type: string description: | Profile Entity Type Enumeration. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` enum: - COUNTRY - INDIVIDUAL - ORGANISATION - VESSEL Provider: type: object properties: code: type: string identifier: type: string master: type: boolean default: false name: type: string ProviderDetail: type: object allOf: - $ref: '#/definitions/Provider' - type: object properties: sources: type: array description: Sources that belong to this provider. items: $ref: '#/definitions/ProviderSource' ProviderSource: type: object required: - abbreviation - identifier - name - providerSourceStatus - type properties: abbreviation: type: string description: Abbreviated form of this source's `name`. creationDate: type: string format: date-time identifier: type: string description: An alphanumeric value importIdentifier: type: string name: type: string description: Full name of this source. maxLength: 255 provider: description: Provider for this source. $ref: '#/definitions/Provider' providerSourceStatus: type: string description: Provider Source Status Enumeration enum: - ACTIVE - DELETED - HIDDEN regionOfAuthority: type: string subscriptionCategory: type: string description: Subscription Category Type Enumeration default: STANDARD enum: - PREMIUM - STANDARD modificationDate: type: string description: | Modification date of source. This field is updated only when there is a change in either source name or description. This field does not capture any updates to the underlying records that are added/deleted to/from the source. format: date-time description: type: string description: Description of the source. type: $ref: '#/definitions/ProviderSourceType' ProviderSourceType: type: object properties: category: $ref: '#/definitions/ProviderSourceTypeCategoryDetail' identifier: type: string name: type: string ProviderSourceTypeCategoryDetail: type: object properties: description: type: string identifier: type: string maxLength: 255 name: type: string maxLength: 255 IdentityDocumentLocationTypeDataSet: type: object properties: identityDocumentLocationTypes: type: array items: $ref: '#/definitions/IdentityDocumentLocationType' Role: type: object properties: end: type: string location: type: string source: $ref: '#/definitions/ProviderSource' start: type: string title: type: string type: type: string VesselAssociate: type: object description: | Associate entity details. Represents Vessel entity. Extends [AbstractAssociate](#AbstractAssociate). allOf: - $ref: '#/definitions/AbstractAssociate' VesselEntity: type: object allOf: - $ref: '#/definitions/Entity' required: - imo - entityType properties: imo: type: string entityType: type: string description: | Profile Entity Type Enumeration. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` enum: - COUNTRY - INDIVIDUAL - ORGANISATION - VESSEL WatchlistDataSet: type: object properties: entityCreateOrUpdate: type: array items: $ref: '#/definitions/Entity' entityDelete: type: array items: $ref: '#/definitions/EntityDelete' entitySupersede: type: array items: $ref: '#/definitions/EntitySupersede' entityPurge: type: array items: $ref: '#/definitions/EntityPurge' WatchlistResponse: type: object required: - errors properties: errors: type: array items: $ref: '#/definitions/Error' Weblink: type: object properties: caption: type: string uri: type: string tags: type: array description: | Label(s) for the corresponding uri. For example, - PHOTO indicates the page represented by the uri contains images. - PDF indicates the page represented by the uri contains PDFs. - DATE indicates the date when the uri was added to the record. items: type: string StatusType: type: string description: Enumeration of Status types enum: - ACTIVE - INACTIVE - DELETED AccelusUserLoginAccountStatus: type: string description: The status of the User login account. enum: - NOT_REGISTERED - REGISTERED - FIRST_TIME_LOGIN_COMPLETED EventType: type: string description: Event Type Enumeration. enum: - ACQUISTION_DATE - BANKRUPTCY_DATE - BIRTH - CALCULATED_YOB - CESSATION_DATE - COMMENCEMENT_DATE - DEATH - DECEASED_DATE - INCORP_DATE - NATIONALISATION_DATE - PRIVATISATION_DATE - REGISTRATION_DATE - REPORTED_DOB ProfileEntityType: type: string description: | Profile Entity Type Enumeration. The `Entity` subclasses corresponding to each type of entity are: * `COUNTRY` : `CountryEntity` * `INDIVIDUAL` : `IndividualEntity` * `ORGANISATION` : `OrganisationEntity` * `VESSEL` : `VesselEntity` enum: - COUNTRY - INDIVIDUAL - ORGANISATION - VESSEL # # Definitions shared across domains # ================================= # Filter: type: object description: Filter the response properties: query: type: string description: | A query filter expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in , and the superset supported by the WC1 API documented in . RSQL/FIQL parser contains some reserved characters: `'"' | "'" | "(" | ")" | ";" | "," | "=" | "!" | "~" | "<" | ">"` If there are reserved characters or white spaces in the query expression, they must be escaped by enclosing them in single or double quotes. If you need to use both single and double quotes inside an argument, then you must escape one of them using `\` (backslash). If you want to use `\` literally, then double it as `\\`. Backslash has a special meaning only inside a quoted argument, not in unquoted argument. Using reserved characters or white spaces without escaping can lead to parsing and execution errors. The query examples: * "query": "example=='TE!ST'" * "query": "example==\\"TE'ST\\"" * "query": "example=='TE\\\\'ST'" Argument can be a single value, or multiple values in parenthesis separated by comma. Value that does not contain any reserved character or a white space can be unquoted, other arguments must be enclosed in single or double quotes. Example: * "query": "example1=='TE\\\\'ST', example2==TEST" sort: type: array description: The sort critieria to apply to the query items: $ref: '#/definitions/SortCriterion' pagination: $ref: '#/definitions/Pagination' SortCriterion: type: object description: Sort specification properties: columnName: type: string description: The field to sort on order: type: string description: The sort order enum: - ASCENDING - DESCENDING SearchResponse: type: object description: Common fields used in search responses. These fields are included in response types, and objects of this type are not returned directly. required: - totalResultCount properties: query: type: string sort: type: array description: The sort critieria to apply to the query items: $ref: '#/definitions/SortCriterion' pagination: $ref: '#/definitions/PaginationResponse' totalResultCount: type: integer format: int64 Pagination: type: object description: Inbound - the pagination to apply to the query. required: - currentPage - itemsPerPage properties: currentPage: type: integer format: int32 itemsPerPage: type: integer format: int32 PaginationResponse: type: object description: Outbound - used to describe paginated partial result sets allOf: - $ref: '#/definitions/Pagination' - properties: totalItems: type: integer format: int64 Error: type: object required: - error - cause properties: error: type: string cause: type: string objectId: type: string Assignee: type: object required: - userId properties: userId: type: string maxLength: 255 description: Identifier of the assignee user. note: type: string maxLength: 1000 description: Note added by the user. # # Enumerations shared across domains # ================================== # AuditEventActionType: type: string description: Type of action that caused the audit event to be created. enum: - NEW_CASE - SCREENED_CASE - ASSIGN_CASE - NEW_MATCH - NEW_NOTE - CHANGE_CASE_OWNER - UPDATE_CASE_OWNER - CHANGE_CASE_LIFECYCLE_STATE - CHANGE_CASE_SCREENING_STATE - EDITED_CASE - MIGRATION - REVIEW_RESULT - RESOLVE_RESULT - VERIFY_PASSPORT_DETAILS - EDD_REPORT_REQUESTED_CASE - DELETE_CASE - NEW_CLIENT - NEW_GROUP - UPDATE_GROUP - UPDATE_GROUP_STATUS - UPDATE_CLIENT_STATUS - DELETE_GROUP - UPDATE_GROUP_MEMBERSHIP - UPDATE_GROUP_AUTO_RESOLUTION - UPDATE_GROUP_CUSTOM_FIELDS - UPDATE_GROUP_RESOLUTION_TOOLKIT - UPDATE_GROUP_TIMEZONE - UPDATE_GROUP_EMAIL_SCHEDULE - UPDATE_CLIENT_SETTINGS - UPDATE_GROUP_SUBSCRIPTION_SETTINGS - UPDATE_GROUP_SCREENING_SETTINGS - UPDATE_GROUP_PRODUCT_ENTITLEMENTS - CREATE_ROLE - UPDATE_ROLE - NEW_USER - UPDATE_USER - UPDATE_USER_ROLES - UPDATE_USER_MEMBERSHIP - UPDATE_USER_STATUS - DELETE_USER - NEW_PARENT_CASE - ADD_CHILD_CASE - UNLINK_CHILD_CASE - MERGE_CASE - ADD_TO_PARENT_CASE - UNLINK_PARENT_CASE - CHILD_CASE_TRANSFERRED_OUT - CHILD_CASE_TRANSFERRED_IN - MOVE_CHILD_TO_ANOTHER_PARENT - ARCHIVE_PARENT_CASE - UNARCHIVE_PARENT_CASE - ARCHIVE_CHILD_CASE - UNARCHIVE_CHILD_CASE - DELETE_CHILD_CASE - PARENT_CASE_DETAILS_CHANGED - NEW_PARENT_CASE_NOTE - CHANGED_CASE_MEDIA_CHECK_OGS_PREFERENCE - CHANGED_CASE_MEDIA_CHECK_SMART_FILTER_PREFERENCE - CHANGE_CASE_RATING AuditEventSourceType: type: string description: | Enumeration of available audit event sources types. Possible types of audit event sources are: * DESKTOP - Signifies the event is originating from DESKTOP/UI * DESKTOP_BULK - Signifies the event is originating from DESKTOP/UI Bulk actions * API - Signifies the event is originating from API * API_BULK - Signifies the event is originating from API Bulk actions * DESKTOP_BATCH - Signifies the event is originating from DESKTOP/UI Batch screening * API_BATCH - Signifies the event is originating from API Batch screening via saveAndScreen endpoint * OGS - Signifies the event is originating from ongoing screening * UNKNOWN - Signifies the event source is unknown enum: - DESKTOP - DESKTOP_BULK - API - API_BULK - DESKTOP_BATCH - API_BATCH - OGS - UNKNOWN AuditEntityType: type: string description: Entity type of the object that the audit event belongs to. enum: - CASE ProviderType: type: string description: Provider Type Enumeration enum: - WATCHLIST - PASSPORT_CHECK - CLIENT_WATCHLIST - MEDIA_CHECK Gender: type: string description: Gender Type Enumeration default: UNKNOWN enum: - MALE - FEMALE - UNKNOWN CaseScreeningState: type: string description: Case Screening State Enumeration representing type of Screening enum: - INITIAL - ONGOING - ANONYMOUS StatedGender: type: string description: Stated gender Type Enumeration default: UNSPECIFIED enum: - MALE - FEMALE - UNSPECIFIED # # Definitions for mediacheck domain # ================================= # RiskDefinition: type: string description: Definition of Media Check attached article risk level example: HIGH MediaCheckContentRequest: type: object description: Definition of MediaCheck news articles content request required: - articleIds properties: articleIds: maxItems: 200 minItems: 1 uniqueItems: true type: array description: | MediaCheck articles IDs. Request may contain up to 200 unique articles. items: type: string MediaCheckFacetsRequest: type: object description: Facets for MediaCheckResultsRequest properties: publicationType: $ref: '#/definitions/MediaCheckRegularFacetRequest' topicPhase: $ref: '#/definitions/MediaCheckRegularFacetRequest' geography: $ref: '#/definitions/MediaCheckRegularFacetRequest' topic: $ref: '#/definitions/MediaCheckRegularFacetRequest' country: $ref: '#/definitions/MediaCheckRegularFacetRequest' publicationDate: $ref: '#/definitions/MediaCheckPublicationDateFacetRequest' MediaCheckRegularFacetRequest: type: object description: Facets for MediaCheckResultsRequest properties: limit: minimum: 1 maximum: 100 description: Maximum number of items to return type: integer format: int32 MediaCheckPublicationDateFacetRequest: type: object description: Publication date facet request for navigation by search results through publication date. MediaCheckPublicationDateRange: type: object description: Date range when the article was published. properties: min: type: string format: date-time description: Start date and time the article was published in ISO 8601 format excluding Week and Ordinal dates. max: type: string format: date-time description: End date and time when the article was published in ISO 8601 format excluding Week and Ordinal dates. MediaCheckResultsContentResponse: type: object description: Response with MediCheck news articles content properties: results: type: array description: MediaCheck news article content and summary items: $ref: '#/definitions/MediaCheckResultsContent' example: results: - articleContent: content: Article content copyrightHolder: "Copyright holder" copyrightNotice: "Copyright notice" articleSummary: articleId: "am2_newsroom_nNRAazy6q1|20191002T112015,757+0000" articleFound: true contentType: "newsroom" language: "English" publicationDate: "2019-10-02T11:20:18.498Z" publication: code: "DEUEUR" name: "Publication name" status: description: languages: [] regions: - "Europe" publicationTypes: [] sectors: [] author: topics: - "Article Topic" countries: - "Netherlands" - "Russia" title: "Article title" snippet: "" wordCount: 1655 phases: - "Article Phase" MediaCheckResultsContent: type: object description: Response with MediaCheck news articles content and summary properties: articleContent: description: MediaCheck news article content $ref: '#/definitions/MediaCheckArticleContent' articleSummary: description: MediaCheck news article summary $ref: '#/definitions/MediaCheckArticleSummary' MediaCheckArticleContent: type: object description: MediaCheck news article content properties: content: description: Contents of the MediaCheck news article type: string copyrightHolder: description: Copyright holder of MediaCheck news article type: string copyrightNotice: description: Copyright notice of the MediaCheck news article type: string MediaCheckArticleSummary: description: | MediaCheck news article summary type: object properties: articleId: description: Unique news article identifier type: string example: am2_newsroom_nNRA9oi5ww|20190423T153322,620+0000 articleFound: description: Specifies whether article with the specified id is still available in the database. type: boolean default: true example: true author: description: Article Author type: string example: Mark Twain contentType: description: Specifies content type, either internet (URL) or licensed (NEWSROOM) type: string example: NEWSROOM countries: description: List of countries the news article is tagged with type: array items: type: string example: "USA" duplicatesKey: description: A hash of the news article content which could be used to find similar news articles type: string example: 20190830_190c8483ce6671d338768ef40e2574d1e814f858 language: description: Content language type: string example: "English" publicationDate: description: Article publication date type: string format: date-time snippet: description: A summary extracted from the lead paragraph of the article, typically first 450 characters. type: string example: | Companies operating virtual assets must submit the transaction reports of clients that by their behavior could be related to illicit money. publication: description: Information about MediaCheck news article issuer $ref: '#/definitions/MediaCheckPublicationDetails' title: description: Article title/headline type: string example: They must report virtual asset operations topics: description: List of risk topics the news article is tagged with type: array items: type: string example: Fraud wordCount: description: Article word count type: integer format: int32 example: 432 phases: description: List of risk phases the news article is tagged with type: array items: type: string example: Conviction MRZGenerationRequest: description: | PassportCheck Machine Readable Zone (MRZ) data request type: object required: - givenName - lastName - gender - dateOfBirth - issuingState - nationality - identificationNumber - dateOfExpiry - documentType properties: givenName: description: Name as in identifying document type: string maxLength: 1000 example: Name lastName: description: Surname as in identifying document type: string maxLength: 1000 example: Surname gender: type: string description: Stated gender Type Enumeration default: UNSPECIFIED enum: - MALE - FEMALE - UNSPECIFIED dateOfBirth: description: Date of birth according ISO 8601 standard type: string format: date example: "2019-01-02" issuingState: description: Code of state that issued identifying document type: string example: GBR nationality: description: Code of nationality as in identifying document type: string example: GBS identificationNumber: description: Number of identifying document type: string maxLength: 1000 example: 123456789 dateOfExpiry: description: Expiry date of identifying document according ISO 8601 standard type: string format: date example: "2019-01-02" documentType: type: string description: Passport Type Enumeration default: PASSPORT enum: - PASSPORT - ID1 - ID2 MRZGenerationResponse: description: | PassportCheck Machine Readable Zone (MRZ) data response type: object properties: lines: type: array description: List of MRZ lines items: type: string isConformICAO: description: | Flag indicating if MRZ data conform to ICAO requirements. Field can be absent if compliance information is not available. type: boolean CaseRatingResponse: description: | Retrieved case rating for a Case data response. type: object properties: caseRating: type: string description: The case rating types. enum: - NO_RISK - LOW - MEDIUM - HIGH - UNKNOWN - NOT_RATED reason: type: string maxLength: 1000 description: The reason for setting the new case rating type of the case. createdDate: type: string format: date-time description: The date and time the case was created. createdBy: type: string description: The user who created the Case rating. SmartFilterResponse: description: | Retrieved smart filter state on a Case. type: object properties: smartFilter: type: boolean description: | Flag indicating whether smart filter state on the case. The default value fetched from the group setting "Allow users to enable/disable the Smart Filter". ArticlesReviewDate: type: object description: Date and time when all articles were reviewed. required: - dateReviewed properties: dateReviewed: type: string format: date-time description: Case modification date and time. example: dateReviewed: 2019-05-14T11:55:19.038000Z MediaCheckDuplicatesRequest: type: object description: Request containing deduplication hash to retrieve article duplicatates. properties: deduplicationHash: description: Hash string containing deduplication configuration. type: string PepDetailsRequest: type: object description: A request containing defined the sort order for retrieved PEP roles details. properties: sort: description: | The sort criteria to apply to the response. The list of supported fields: * `status` * `roleTermStartDate` * `roleTermEndDate` $ref: '#/definitions/SortCriterion' example: sort: columnName: roleTermStartDate order: ASCENDING PepDetailsResponse: type: object description: Retrieves detailed information for "Politically Exposed Person (PEP)" category by given record ID. properties: sort: description: The sort criteria applied to the response. $ref: '#/definitions/SortCriterion' pepStatus: type: string description: | Enumeration of available PEP status types relating to individuals. enum: - ACTIVE - INACTIVE - UNKNOWN - NOT_AVAILABLE updatedDates: description: PEP details' state change dates. $ref: '#/definitions/PepUpdatedDates' roleDetails: type: array uniqueItems: true description: Role detail set. items: $ref: '#/definitions/RoleDetails' example: sort: columnName: roleTermStartDate order: ASCENDING pepStatus: ACTIVE updatedDates: pepStatusUpdated: '2011-01-04' pepRolesUpdated: '2021-01-04' roleDetails: - title: Title_1 level: Level_1 position: Position_1 biography: Biography_1 status: UNKNOWN roleTermStartDate: '2011-01-04' roleTermEndDate: '2020-01-04' - title: Title_2 level: Level_2 position: Position_2 biography: Biography_2 status: FORMER roleTermStartDate: '2021-01-04' roleTermEndDate: PepUpdatedDates: type: object description: Represents PEP details' state change dates. properties: pepStatusUpdated: type: string format: date description: Last update date for PEP status. pepRolesUpdated: type: string format: date description: Last update date for PEP roles. example: pepStatusUpdated: '2011-01-04' pepRolesUpdated: '2021-01-04' RoleDetails: type: object description: Represents the role details. properties: title: type: string description: Role title. level: type: string description: Role level. position: type: string description: Individuals position. biography: type: string description: Individuals biography. status: description: Role status. $ref: '#/definitions/RoleStatusType' roleTermStartDate: type: string format: date description: Representation of term start date. roleTermEndDate: type: string format: date description: Representation of term end date. example: pepStatusUpdated: '2011-01-04' pepRolesUpdated: '2021-01-04' RoleStatusType: type: string description: Enumeration of available role status types. enum: - CURRENT - FORMER - UNKNOWN CasePreferenceType: type: string description: Enumeration of case preference types. enum: - MEDIA_CHECK_OGS - MEDIA_CHECK_OGS_COUNT - MEDIA_CHECK_SMART_FILTER - RISK_RATING SearchParameterCollection: type: object description: This object containing various search filter parameters that are available to the User. properties: freeTextParameters: type: array description: A set of free text query parameters. uniqueItems: true items: $ref: '#/definitions/QuerySearchParameter' predefinedParameters: type: array description: A set of filter parameters with predefined values. uniqueItems: true items: allOf: - $ref: '#/definitions/FilterSearchParameter' example: freeTextParameters: - fields: - caseName - caseId type: QUERY valueType: STRING predefinedParameters: - fields: - caseSystemId type: FILTER valueType: STRING - fields: - creationDate - modificationDate type: FILTER valueType: DATE_TIME - fields: - primaryCase - nameTransposition type: FILTER valueType: STRING availableValues: - false - true - fields: - secondaryFieldCountryLocation type: FILTER valueType: STRING availableCodes: - code: ABW label: Aruba - fields: - groupId type: FILTER valueType: STRING availableIds: - id: groupId label: Group Name AbstractSearchParameter: type: object description: | An abstract search parameter object that serves as the base for specific parameter types. It has a discriminator based on the type field to distinguish between different parameter types. discriminator: type required: - fields - type - valueType properties: fields: type: array description: An array of field identifiers to which the configuration applies. items: type: string type: $ref: '#/definitions/SearchParameterType' valueType: $ref: '#/definitions/SearchParameterValueType' SearchParameterType: type: string description: An enumeration of search parameter types used to categorize parameters. enum: - QUERY - FILTER SearchParameterValueType: type: string description: An enumeration of data types used for filter selected values. enum: - STRING - DATE_TIME - BOOLEAN QuerySearchParameter: type: object description: Represents free text query parameters. Inherits from [AbstractSearchParameter](#AbstractSearchParameter). allOf: - $ref: '#/definitions/AbstractSearchParameter' FilterSearchParameter: type: object description: | Represents filter configuration and values available for filtering cases with specific values. **Note:** The 'availableValues', and 'availableItems' fields in this model are optional and are populated based on the set of 'fields'. allOf: - $ref: '#/definitions/AbstractSearchParameter' - type: object properties: availableValues: type: array description: An array of strings representing available values for filtering. items: type: string availableItems: type: object description: An array of objects containing key-label pairs where the keys are used as values to search against a specific field. additionalProperties: type: string ItemIdentifier: type: object description: Represents the details (ID and label) of an individual item value. properties: id: type: string description: A string identifier for the item value. label: type: string description: A string label for the item value. AbstractCaseSearchModel: type: object description: | Request model used to search within, sort across, paginate through, and filter down the set of Cases. A model contains 'query', 'filter' expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in , and the superset supported by the WC1 API documented in . RSQL/FIQL parser contains some reserved characters: `'"' | "'" | "(" | ")" | ";" | "," | "=" | "!" | "~" | "<" | ">"` If there are reserved characters or white spaces in the query expression, they must be escaped by enclosing them in single or double quotes. If you need to use both single and double quotes inside an argument, then you must escape one of them using `\` (backslash). If you want to use `\` literally, then double it as `\\`. Backslash has a special meaning only inside a quoted argument, not in unquoted argument. Using reserved characters or white spaces without escaping can lead to parsing and execution errors. The query examples: * "query": "example=='TE!ST'" * "query": "example==\\"TE'ST\\"" * "query": "example=='TE\\\\'ST'" Argument can be a single value, or multiple values in parenthesis separated by comma. Value that does not contain any reserved character or a white space can be unquoted, other arguments must be enclosed in single or double quotes. Example: * "query": "example1=='TE\\\\'ST', example2==TEST" properties: query: type: string description: | A string containing the search query. **Note:** To find the available search fields, check for fields with 'QUERY' type in the `GET /reference/searchFilters` endpoint. filter: type: string description: | A string containing filter criteria. **Note:** To find the available search fields, check for fields with 'FILTER' type in the `GET /reference/searchFilters` endpoint. detailLevel: description: The detail level of the search response. $ref: '#/definitions/CaseDetailLevel' sort: type: array description: | An array of sorting criteria. The list of available sort parameter names: - 'primaryName' - sort by the primary name for the Case; - 'caseId' - sort by the unique identifier for the Case; - 'caseSystemId' - sort by the system-generated ID for the Case; - 'creationDate' - sort by the time when the Case has been created; - 'modificationDateByUser' - sort by the time when the Case has been modified by the User; - 'modificationDateBySystem' - sort by the time when the Case has been modified by the system; - 'lastScreenedDate' - sort by the time when the Case was last screened; - 'primaryCase' - sort by the total child Cases count contained within the Case; - 'nameTransposition' - sort by the name transposition state for the Case; - 'lifecycleState' - sort by the lifecycle state for the Case; - 'watchlistCaseScreeningState' - sort by the World-Check ongoing screening state for the Case; - 'mediaCheckCaseScreeningState' - sort by the Media-Check ongoing screening state for the Case; - 'entityType' - sort by the entity type for the Case; - 'caseRating' - sort by the rating for the Case; - 'mandatoryActions' - sort by the number of mandatory actions on this Case; - 'watchlistUnresolved' - sort by the count of unresolved matches with the provider type 'WATCHLIST'; - 'watchlistReviewRequired' - sort by the count of matches with the provider type 'WATCHLIST' that require review; - 'clientWatchlistUnresolved' - sort by the count of unresolved matches with the provider type 'CLIENT_WATCHLIST'; - 'clientWatchlistReviewRequired' - sort by the count of matches with the provider type 'CLIENT_WATCHLIST' that require review; - 'mediaCheckReviewRequired' - sort by the count of matches with the provider type 'MEDIA_CHECK' that require review; - 'secondaryFieldCountryLocation' - sort by the country location or registered country secondary field value; - 'secondaryFieldNationality' - sort by the citizenship secondary field value; - 'secondaryFieldPlaceOfBirth' - sort by the place of birth secondary field value; - 'groupId' - sort by the name of the Group owning the Case; - 'creatorUserId' - sort by the full name of the User who created the Case; - 'modifierUserId' - sort by the full name of the User who modified the Case; - 'assigneeUserId' - sort by the full name of the User the Case is currently assigned to. items: $ref: '#/definitions/SortCriterion' CaseSearchRequest: type: object description: Request model used to search within, sort across, paginate through, and filter down the set of Cases. allOf: - $ref: '#/definitions/AbstractCaseSearchModel' - type: object properties: pagination: description: Request model that includes pagination options. $ref: '#/definitions/PaginationReferenceRequest' example: query: primaryName==Smith and caseId=in=(John, James) filter: providerType==WATCHLIST and entityType=in=(UNSPECIFIED, INDIVIDUAL) and creationDate=RANGE=(2023-01-01, 2023-05-31) detailLevel: CASE_AND_RESULTS_AND_AGGREGATED_RESULTS sort: - columnName: primaryName order: DESCENDING - columnName: providerType order: ASCENDING pagination: itemsPerPage: 25 pageReference: Reference ID of the requested page CaseDetailLevel: type: string description: | Enumeration that defines the detail level of the search response: - 'CASE': The search response will provide full Case details. - 'CASE_AND_RESULTS': The search response will include Сase details and Result summary related to this Case. - 'CASE_AND_AGGREGATED_RESULTS': The search response will provide full Case details with an aggregated Result summary, summarizing data from primary and sub-cases. - 'CASE_AND_RESULTS_AND_AGGREGATED_RESULTS': The search response will provide full Case details with a Result and aggregated(summarizing data from primary and sub-cases) summaries. enum: - CASE - CASE_AND_RESULTS - CASE_AND_AGGREGATED_RESULTS - CASE_AND_RESULTS_AND_AGGREGATED_RESULTS PaginationReferenceRequest: type: object description: Request model for defining pagination options. properties: itemsPerPage: type: integer description: The number of items to return per page. format: int32 pageReference: type: string description: A reference to a specific page. CaseSearchResponse: type: object description: A response model containing a result set of searched Cases with the requested details. allOf: - $ref: '#/definitions/AbstractCaseSearchModel' - type: object description: Response model that includes pagination details and an array of case details. properties: pagination: $ref: '#/definitions/PaginationReferenceResponse' results: type: array items: $ref: '#/definitions/CaseDetailed' example: query: primaryName==Smith and caseId=in=(John, James) filter: providerType==WATCHLIST and entityType=in=(UNSPECIFIED, INDIVIDUAL) and creationDate=RANGE=(2023-01-01, 2023-05-31) detailLevel: CASE_AND_RESULTS_AND_AGGREGATED_RESULTS sort: - columnName: primaryName order: DESCENDING - columnName: providerType order: ASCENDING pagination: itemsPerPage: 1 totalItems: 3 pageReferences: previous: Reference ID of the previous page current: Reference ID of the current page next: Reference ID of the next page results: - caseId: Client Case ID name: John Smith providerTypes: - WATCHLIST customFields: - typeId: Custom Field ID 1 value: Reference ID 1234567 - typeId: Custom Field ID 2 value: Deal ID 1234567 secondaryFields: - typeId: SFCT_1 value: MALE - typeId: SFCT_2 dateTimeValue: '1990-11-20' groupId: Client Group ID entityType: INDIVIDUAL caseSystemId: System-generated ID caseScreeningState: WATCHLIST: INITIAL lifecycleState: ARCHIVED creator: userId: Creator ID firstName: Creator first name lastName: Creator last name fullName: Creator full name email: Creator email status: ACTIVE modifier: userId: Modifier ID firstName: Modifier first name lastName: Modifier last name fullName: Modifier full name email: Modifier email status: ACTIVE assignee: userId: Assignee ID firstName: Assignee first name lastName: Assignee last name fullName: Assignee full name email: Assignee email status: ACTIVE creationDate: '2016-02-18T14:00:00Z' modificationDate: '2016-02-18T14:00:00Z' lastScreenedDate: '2016-02-18T14:00:00Z' modificationDateBySystem: '2016-02-18T14:00:00Z' modificationDateByUser: '2016-02-18T14:00:00Z' lastAuditEventActivity: SCREENED_CASE caseRating: NOT_RATED primaryCase: true nameTransposition: true outstandingActions: false batches: - id: Batch ID label: Batch Name noOfExcludedResults: 1 noOfAutoResolvedResults: 2 resultSummaries: totalMandatoryActions: 1 totalSubCases: 1 mediaCheck: mediaCheckAttachedCount: 1 mediaCheckReviewRequired: true watchlist: watchlistTotalMatches: 1 watchlistUnresolved: 2 watchlistReviewRequired: 3 categorisedMatches: "watchlistUnresolvedBySubCategory": "Other Bodies": 1 "Law Enforcement": 2 "PEP": 3 "Special Interest Categories": 4 "Regulatory Enforcement": 5 "Sanctions": 6 "watchlistReviewRequiredBySubCategory": "Other Bodies": 1 "Law Enforcement": 2 "PEP": 3 "Special Interest Categories": 4 "Regulatory Enforcement": 5 "Sanctions": 6 clientWatchlist: clientWatchlistTotalMatches: 1 clientWatchlistUnresolved: 2 clientWatchlistReviewRequired: 3 aggregatedResultSummaries: totalMandatoryActions: 2 totalSubCases: 2 mediaCheck: mediaCheckAttachedCount: 2 mediaCheckReviewRequired: true watchlist: watchlistTotalMatches: 2 watchlistUnresolved: 3 watchlistReviewRequired: 4 categorisedMatches: "watchlistUnresolvedBySubCategory": "Other Bodies": 2 "Law Enforcement": 3 "PEP": 4 "Special Interest Categories": 5 "Regulatory Enforcement": 6 "Sanctions": 7 "watchlistReviewRequiredBySubCategory": "Other Bodies": 2 "Law Enforcement": 3 "PEP": 4 "Special Interest Categories": 5 "Regulatory Enforcement": 6 "Sanctions": 7 clientWatchlist: clientWatchlistTotalMatches: 2 clientWatchlistUnresolved: 3 clientWatchlistReviewRequired: 4 PaginationReferenceResponse: type: object description: Response model containing pagination details. properties: itemsPerPage: type: integer description: The number of items per page. format: int32 totalItems: type: integer description: The total number of items available. format: int64 pageReferences: description: Pagination details including items per page, total items, and page references. $ref: '#/definitions/PageReference' PageReference: type: object description: Model representing references to previous and next pages. properties: previous: type: string description: A reference to the previous page. current: type: string description: A reference to the current page. next: type: string description: A reference to the next page. CaseDetailed: type: object description: | Defines complete Case data returned during a search operation. This model provides detailed information about a Case. properties: caseId: type: string description: | The unique identifier for the Case, which can be provided by the Client or generated by the system. This field is not applicable for 'Zero Footprint Screening (ZFS)'. maxLength: 1000 name: type: string description: The name used for screening this Case. maxLength: 1000 providerTypes: type: array description: | The provider types required to screen this Case. For 'Zero Footprint Screening (ZFS)', only 'WATCHLIST' and 'CLIENT_WATCHLIST' are supported. minItems: 1 items: $ref: '#/definitions/ProviderType' customFields: type: array description: | Custom fields associated with this Case. Definitions for available custom fields can be obtained via `GET /groups/{groupId}/caseTemplate` endpoint. Custom fields cannot be used with 'Zero Footprint Screening (ZFS)'. items: $ref: '#/definitions/Field' secondaryFields: type: array description: | Secondary fields associated with this Case. Definitions for available secondary fields can be obtained via `GET /groups/{groupId}/caseTemplate` endpoint. items: $ref: '#/definitions/Field' groupId: type: string description: | The identifier of the group that owns this Case. The group determines whether the case is screened as 'Zero Footprint Screening (ZFS)' or not. maxLength: 255 entityType: $ref: '#/definitions/CaseEntityType' caseSystemId: type: string description: The system-generated ID for the Case. maxLength: 1000 caseScreeningState: type: object description: | A mapping from [ProviderType](#ProviderType) to indicate whether ongoing screening is enabled for this case on the specific [ProviderType](#ProviderType). By default, the value is set from account settings. additionalProperties: type: string lifecycleState: type: string description: Case Lifecycle State Enumeration. enum: - ARCHIVED - UNARCHIVED creator: $ref: '#/definitions/UserSummary' modifier: $ref: '#/definitions/UserSummary' assignee: $ref: '#/definitions/UserSummary' creationDate: type: string description: The date and time when the Case was created. format: date-time modificationDate: type: string description: The date and time when the Case was last modified. format: date-time lastScreenedDate: type: string description: The date and time when the Case was last screened. format: date-time modificationDateBySystem: type: string description: The date and time of the last modification to the Case by the system. format: date-time modificationDateByUser: type: string description: The date and time of the last modification to the Case by a User. format: date-time lastAuditEventActivity: type: string description: Type of action that caused the audit event to be created. caseRating: type: string description: Rating of the case. enum: - NO_RISK - LOW - MEDIUM - HIGH - UNKNOWN - NOT_RATED primaryCase: type: boolean description: A flag indicating whether this is a parent Case. nameTransposition: type: boolean description: A flag indicating whether name transposition is enabled for the Case. outstandingActions: type: boolean description: A flag indicating outstanding actions on a Case. batches: type: array description: The owning batch of the Case. items: $ref: '#/definitions/ItemIdentifier' noOfExcludedResults: type: integer description: The number of results that have been excluded from the result set due to auto-resolution rules. format: int32 noOfAutoResolvedResults: type: integer description: The number of results that have been auto-resolved as 'False' due to auto-resolution rules. format: int32 resultSummaries: $ref: '#/definitions/CaseResultSummaries' aggregatedResultSummaries: $ref: '#/definitions/CaseResultSummaries' AsyncReportRequest: type: object description: | A model contains 'query', 'filter', 'reportFilter', 'customAttributes' expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in , and the superset supported by the WC1 API documented in . RSQL/FIQL parser contains some reserved characters: `'"' | "'" | "(" | ")" | ";" | "," | "=" | "!" | "~" | "<" | ">"` If there are reserved characters or white spaces in the query expression, they must be escaped by enclosing them in single or double quotes. If you need to use both single and double quotes inside an argument, then you must escape one of them using `\` (backslash). If you want to use `\` literally, then double it as `\\`. Backslash has a special meaning only inside a quoted argument, not in unquoted argument. Using reserved characters or white spaces without escaping can lead to parsing and execution errors. Argument can be a single value, or multiple values in parenthesis separated by comma. Value that does not contain any reserved character or a white space can be unquoted, other arguments must be enclosed in single or double quotes. **Example:** * "query": "example1=='TE\\\\'ST', example2==TEST" required: - query - filter - sort - reportFilter - reportType properties: query: type: string description: | The query string used for fetching the source data for the report. The query supports next field to specify searching criteria: - 'caseId' - Case ID provided by the client; The query examples: * "query": "example=='TE!ST'" * "query": "example==\\"TE'ST\\"" * "query": "example=='TE\\\\'ST'" * "query": "example==\"TEST DATA\"" filter: type: string description: | The filters to be applied on the dataset returned by using the query. The filter supports next field to specify searching criteria: - 'caseSystemId': Case System ID generated by the system for the client; The filter examples: * "filter": "example=='TE!ST'" * "filter": "example==\\"TE'ST\\"" * "filter": "example=='TE\\\\'ST'" * "filter": "example==\"TEST DATA\"" reportType: description: The report type specifies the type of the report, like case dossier, case summary etc. $ref: '#/definitions/ReportType' reportName: type: string description: Name for the report. If not provided, system will generate the name for the report based on the type of report. reportFilter: type: string description: | The filters to be applied on the record level dataset. The reportFilter supports next field to specify searching criteria: * 'providerType': Array of provider types used in record level filtration and does not have default providerType value. * 'includeUnresolvedMatches': represents the boolean value for the record level filtration and default value is false. * 'includePositiveMatches': represents the boolean value for the record level filtration and default value is false. * 'includePossibleMatches': represents the boolean value for the record level filtration and default value is false. * 'includeFalseMatches': represents the boolean value for the record level filtration and default value is false. * 'includeUnspecifiedMatches': represents the boolean value for the record level filtration and default value is false. * 'includeAudit': represents the boolean value for the record level filtration and default value is true. * 'includePassportCheck': represents the boolean value for the record level filtration and default value is false. * 'includeMediaCheckFullArticles': represents the boolean value for the record level filtration and default value is false. * 'includeMediaCheckHeadlines': represents the boolean value for the record level filtration and default value is false. **Note:** The record filters – 'includeUnresolvedMatches', 'includePositiveMatches', 'includePossibleMatches', 'includeFalseMatches' & 'includeUnspecifiedMatches', allow for the export of the full matched records in addition to the Case Dossier Report. This selection does not affect the summary of all matched records included in the Case Dossier Report. The other filters 'includeMediacheckHeadlines', 'includeMediacheckArticles', 'includePassportCheck' & 'includeAudit' are applicable for the inclusion or exclusion of these sections in the Case Dossier report. The report Level Filter examples: example 1: To generate a case dossier PDF report for the matched World-Check records with multiple record filters along with the additional filter sections namingly 'includePassportCheck', 'includeMediaCheckFullArticles' or 'includeMediaCheckHeadlines', 'includeAudit'. ``` { "reportFilter": "(includeUnresolvedMatches==true; includePositiveMatches==true; includePossibleMatches==true; includeFalseMatches==true; includeUnspecifiedMatches==true; providerType==WATCHLIST), (includePassportCheck==true), (includeMediaCheckFullArticles==true), (includeMediaCheckHeadlines==true), (includeAudit==true)" } ``` example 2: To generate a case dossier PDF report for the matched World-Check or Client-Watchlist records with multiple record filters along with the additional filter sections namingly 'includePassportCheck', 'includeMediaCheckFullArticles' or 'includeMediaCheckHeadlines'. ``` { "reportFilter": "(includeUnresolvedMatches==true; includePositiveMatches==true; includePossibleMatches==true; providerType==WATCHLIST), (includeFalseMatches==true; includeUnspecifiedMatches==true; providerType==CLIENT_WATCHLIST), (includePassportCheck==true), (includeMediaCheckFullArticles==true), (includeMediaCheckHeadlines==true)"; } ``` example 3: To generate a case dossier PDF report which includes only filter sections like 'includePassportCheck', 'includeAudit', 'includeMediaCheckFullArticles' or 'includeMediaCheckHeadlines' without the matched World-Check or Client-Watchlist records. ``` { "reportFilter": "includePassportCheck==true, includeAudit==true, includeMediaCheckFullArticles==true, includeMediaCheckHeadlines==true"; } ``` customAttributes: type: string description: | Custom attributes for the reports (specific to the type of the report). E.g. notes for case dossier report. The Custom attributes examples: * "customAttributes": "note==data". * "customAttributes": "note=='note is custom attribute'". * "customAttributes": "note==\"note is custom attribute\"". sort: type: array description: The sort criteria applied to the response. items: $ref: '#/definitions/SortCriterion' example: query: caseId==SomeCustomCaseId filter: caseSystemId==SomeCaseSystemId reportType: CASE_DOSSIER reportName: Report Name reportFilter: includeUnresolvedMatches==false;providerType==WATCHLIST customAttributes: note==data sort: - columnName: caseId order: ASCENDING ReportType: type: string description: The type of report. enum: - CASE_DOSSIER AsyncReportResponse: type: object description: Represents the Async Report Response which contains report ID. allOf: - $ref: '#/definitions/AsyncReportRequest' - type: object required: - reportId properties: reportId: type: string description: The response containing 'reportId', which is retrieved by processing case dossier report request. example: query: caseId==SomeCustomCaseId filter: caseSystemId==SomeCaseSystemId reportType: CASE_DOSSIER reportName: Report Name reportFilter: includeUnresolvedMatches==false;providerType==WATCHLIST customAttributes: note==data sort: - columnName: caseId order: ASCENDING reportId: Report ID ReportStatus: type: object required: - reportId - reportName - progressStatus - reportType properties: reportId: type: string description: Report ID for which the data needs to be fetched. reportName: type: string description: Name for the report. If not provided, system will generate the name for the report based on the type of report. progressStatus: description: Represents the status of the report for the specified 'reportId'. $ref: '#/definitions/ReportProgressStatus' reportType: description: The report type specifies the type of the report, like case dossier, case summary etc. $ref: '#/definitions/ReportType' startDate: type: string description: Represents the start date of the report. format: date-time completionDate: type: string description: Represents the completion date of the report. format: date-time deletionDate: type: string description: Represents the deletion date of the report. format: date-time summary: description: Summary of the report. $ref: '#/definitions/ReportSummary' example: reportId: Report ID reportName: Report Name progressStatus: COMPLETED reportType: CASE_DOSSIER startDate: 2019-08-28T10:05:15Z completionDate: deletionDate: summary: processedCount: 13.0 progressPercentage: 50.0 ReportProgressStatus: type: string description: | The real-time progress status of report during download. - COMPLETED - Report is successfully generated. - IN_PROGRESS - Report generation is in progress. - FAILED - Report failed to generate. Contact helpdesk for more details. - WAITING - Report is waiting in queue and yet to be processed. - UNKNOWN - Report status is unknown. Contact helpdesk for more details. - CANCELLED - Report request has been cancelled. enum: - COMPLETED - IN_PROGRESS - FAILED - WAITING - UNKNOWN - CANCELLED ReportSummary: type: object required: - processedCount - progressPercentage properties: processedCount: type: integer description: Represents number of records processed. format: int32 progressPercentage: type: integer description: Represents progress percentage of records processed. format: int32 PaginatedReportStatusesResponse: type: object required: - paginationDetails - reports properties: paginationDetails: $ref: '#/definitions/PaginationDetails' reports: type: array items: $ref: '#/definitions/ReportStatus' example: paginationDetails: currentPage: 1 itemsPerPage: 1 totalItems: 1 reports: - reportId: Report ID reportName: Report Name progressStatus: COMPLETED reportType: CASE_DOSSIER startDate: 2019-08-28T10:05:15Z completionDate: deletionDate: summary: processedCount: 13.0 progressPercentage: 50.0 PaginationDetails: type: object required: - currentPage - itemsPerPage - totalItems properties: currentPage: type: integer description: Represents the current page number of the case dossier report. format: int32 itemsPerPage: type: integer description: Represents the items per page in case dossier report. format: int32 totalItems: type: integer description: Represents the total item count in case dossier report. format: int64 ReportErrorResponse: type: object required: - errorDetails properties: errorDetails: type: array items: $ref: '#/definitions/ReportError' example: errorDetails: - objectId: Error ID objectType: Error Type errorDescription: Error Description ReportError: type: object required: - objectId - objectType - errorDescription properties: objectId: type: string description: Id of the object which has failed to process. objectType: type: string description: The type of the object that failed to process. errorDescription: type: string description: The details about the error.