{ "opencollection": "1.0.0", "info": { "name": "London Stock Exchange Group LSEG World-Check One Api-Info Case API", "version": "2.61.0" }, "items": [ { "info": { "name": "Case", "type": "folder" }, "items": [ { "info": { "name": "London Stock Exchange Group Check if a given caseId is available for use", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/caseIdentifiers", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseId", "value": "", "type": "query", "description": "Id to check if it is available to use as a caseId" } ] }, "docs": "caseIds must be unique within each Client. If any Group under a Client has a Case with a particular caseId,\nthat caseId cannot be reused on another Case within the same Client. This endpoint allows the user to check\nif a given caseId is available to use when creating or updating a Case.\n" }, { "info": { "name": "London Stock Exchange Group Return the CaseReference (caseId, caseSystemId) for a caseId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/caseReferences", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseId", "value": "", "type": "query", "description": "Case ID provided by the client or else generated by the system for the client" } ] }, "docs": "Returns the CaseReference containing the caseId and caseSystemId pair for an existing Case with the given caseId.\nThis is useful if only the caseId is known but caseSystemId is required by other endpoints such as\n`GET /cases/{caseSystemId}`.\n" }, { "info": { "name": "London Stock Exchange Group Create a new case", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Creates a new Case for asynchronous screening. Synchronous screening on the dedicated ZFS gateway host\nvia `/cases/screeningRequest` should be used instead of this for Zero Footprint Screening (ZFS).\n\n**Info about available secondary fields can be found [here](#tag/groups/operation/getCaseTemplateForGroup).**\n" }, { "info": { "name": "London Stock Exchange Group Perform synchronous screening for a new case", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/screeningRequest", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Perform synchronous screening for a new case.\n\nThis endpoint can perform a synchronous screening for a set of valid case details and, if provided,\nset the ongoing screening (OGS) state for the given provider types. The supported provider types for setting\nthe OGS state are WATCHLIST and MEDIA_CHECK. They both can be set to either INITIAL (OGS disabled) or ONGOING\n(OGS enabled) state. You cannot set the OGS state when using Zero Footprint Screening (ZFS) groups.\n\nThe returned result collection co" }, { "info": { "name": "London Stock Exchange Group Fetch Full Case Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cases/:caseSystemId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" }, { "name": "aggregatedSummary", "value": "", "type": "query", "description": "Flag to enable aggregated summary for case" } ] }, "docs": "Returns full details of the Case identified by the given 'caseSystemId'.\n\n**Note:** A delay of up to 40s after Case is screened is recommended while fetching full Case details with\n aggregated summaries, although a delay of up to 5s would work in most of the cases. If aggregated\n summaries return nil stats, a responsible retry mechanism with a maximum of five retries is\n recommended for the Cases where stats are expected.\n" }, { "info": { "name": "London Stock Exchange Group Update an existing Case by its caseSystemId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cases/:caseSystemId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" } ] }, "docs": "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.\nFor 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 incl" }, { "info": { "name": "London Stock Exchange Group Partial update an existing Case by its caseSystemId", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/cases/:caseSystemId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" }, { "name": "screen", "value": "", "type": "query", "description": "Screen mode" } ] }, "docs": "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.\nIf non-empty fields are not sent they will be left untouched.\nCase screening results related to the value provided in Screen query parameter.\nCalling the endpoint without any change in the existing case payload, but retained query parameter screen=SYNC, works as synchronous re-screening.\n\n**Note:** The maximum number of World-Check screenings (inclu" }, { "info": { "name": "London Stock Exchange Group Delete a Case", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cases/:caseSystemId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" } ] }, "docs": "Delete a Case identified by the given caseSystemId. The case must be first archived in order to delete it.\nThe user must be active and have delete permissions. The client must have delete functionality enabled.\n\n**Note:** After successful deletion, a corresponding audit with actionType 'DELETE_CASE' will be saved for the case. \n All other audits for this case will be deleted within 15 minutes.\n" }, { "info": { "name": "London Stock Exchange Group Request full or delta screening for an existing Case.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/:caseSystemId/screeningRequest", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case." } ] }, "docs": "Make a request for screening of the Case identified by the given caseSystemId.\n\nScreening could be synchronous or asynchronous operation. The type of Screening could be full or delta.\n\nIn the case of asynchronous Screening result will return immediately. As a result of this call, \nthe screening request will be queued to be processed. When this request has been processed, there will be a new \n`SCREENED_CASE` audit event that can be queried via `/cases/{caseSystemId}/auditEvents` and then the resu" }, { "info": { "name": "London Stock Exchange Group Enable OGS for a Case.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cases/:caseSystemId/ongoingScreening", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case." } ] }, "docs": "Enable Ongoing Screening for the Case identified by the given caseSystemId. This will schedule the Case\nto be re-screened periodically by the system.\nIn order to enable Ongoing Screening for multiple or specific provider type fill out an optional request body\nwith provider types for which to enable Ongoing Screening. If no request body provided Ongoing Screening request\nwill be performed for WATCHLIST provider type.\n" }, { "info": { "name": "London Stock Exchange Group Disable OGS for a Case.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cases/:caseSystemId/ongoingScreening", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case." } ] }, "docs": "Disable Ongoing Screening for the Case identified by the given caseSystemId.\nIn order to disable Ongoing Screening for multiple or specific provider type fill out an optional request body\nwith provider types for which to disable Ongoing Screening. If no request body provided Ongoing Screening request\nwill be performed for WATCHLIST provider type.\n" }, { "info": { "name": "London Stock Exchange Group Archive a Case.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cases/:caseSystemId/archive", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" } ] }, "docs": "Archive the Case identified by the given caseSystemId. This will put the case into a state from\nwhich it can be either unarchived or deleted.\nThe user must be active and have the archive permission.\n" }, { "info": { "name": "London Stock Exchange Group Unarchive a Case", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cases/:caseSystemId/archive", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" } ] }, "docs": "Unarchive the Case identified by the given caseSystemId.\nThe user must be active and have the archive permission.\n" }, { "info": { "name": "London Stock Exchange Group Bulk Update Archive States", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/bulk/archive", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Bulk Update Archive States of cases identified by the given `caseSystemIds`. The arhive states are updated \naccording to the value specified in the `\"archive\"` field: if set to `true` then all the cases will be updated \nwith the \"archive\" state, otherwise, the \"unarchived\" state will be used.\n\nIn response, the user receives a summary (`\"statuses\"`) of the archiving operation for each case.\n\n*Example HTTP response* below, shows the following summary:\n\n 1. The first case with `\"caseSystemId1\"` ha" }, { "info": { "name": "London Stock Exchange Group Bulk Update Case Assignments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/bulk/assign", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Bulk Update Case Assignments, where `Case`s are identified by the given `caseSystemIds` and assignee `User` \nis identified by the given `userId` (in case of assigning action). The case assignements are updated according \nto the value specified in the `\"userId\"` field: if set to `null` or is absent then the bulk unassigning action \nhappens, otherwise, the bulk assigning to the `User` identified by the given `userId` action \nis performed.\n\nIn response, the user receives a summary (`\"statuses\"`) of" }, { "info": { "name": "London Stock Exchange Group Bulk Delete Cases", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/bulk/delete", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Bulk Delete Cases identified by the given `caseSystemIds`. The cases must be first archived in order to delete them.\nThe user must be active and have delete permissions. The client must have delete functionality enabled.\n\nIn response, the user receives a summary (`\"statuses\"`) of the archiving operation for each case.\n\n*Example HTTP response* below, shows the following summary:\n\n 1. The first case with `\"caseSystemId1\"` has been deleted successfully.\n 2. The second case with `\"caseSystemId2\"` " }, { "info": { "name": "London Stock Exchange Group Bulk Move Cases Between Groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/bulk/move", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Bulk Move Cases identified by the given `caseSystemIds` to the `Group` identified by the given `groupId`.\nThe user must be active and have move cases between groups permissions. The client must have move cases functionality enabled.\nThe current Group and the destination Group should contain identical custom fields. Cases can not be moved to ZFS group.\n\nIn response, the user receives a summary (`\"statuses\"`) of the moving cases operation for each case.\n\n*Example HTTP response* below, shows the fo" }, { "info": { "name": "London Stock Exchange Group Bulk Update Ongoing Screening States", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/bulk/ongoingScreening", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Bulk Update Ongoing Screening (OGS) States of cases with provided `caseSystemIds` and `ProviderType`s specified in \n`caseScreeningState`. Ongoing screening can be performed for MEDIA_CHECK and WATCHLIST provider types.\nThe user must be active and have CASE_OGS permissions.\n\nIn response, the user receives a summary (`\"statuses\"`) of the World-Check/Media-Check Ongoing Screening operation for each case.\n\n*Example HTTP response* below, shows the following summary:\n\n 1. Watchlist Ongoing Screening " }, { "info": { "name": "London Stock Exchange Group Bulk Update Case Links", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/bulk/link", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Bulk Update Case Links for `Case`s with provided `caseSystemIds` and `relationshipTypes` specified in \n`relationshipType` field. The case links are updated according to the value specified in the \"link\" field: \nif set to `true` then the link bulk action happens, otherwise, the unlinking is performed.\n\nIn response, the user receives a summary (`\"statuses\"`) of the Link/Unlink operation for each case.\n\n*Example HTTP response* below, shows the following summary:\n\n 1. The first case with `\"caseSyst" }, { "info": { "name": "London Stock Exchange Group Get collection of Results for a Case by its caseSystemId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cases/:caseSystemId/results", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for a Case" } ] }, "docs": "Return a collection of Results for the Case identified by the given caseSystemId.\nThe response may contain Special Interest Categories (SIC) records that depends on the user subscription type. This helps in SIC risk analysis:\nIf a user has subscription type is Premium or Premium Plus, the keywords for SIC subcategories provided in the \"sources\" field and full value of\nSIC keywords code in the \"categories\" field.\nIf a user has a Standard subscription type then the \"categories\" field will not cont" }, { "info": { "name": "London Stock Exchange Group Add a review remark to the specified result IDs for the given case", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cases/:caseSystemId/results/review", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" } ] }, "docs": "Add a review remark to the specified result IDs for the given case." }, { "info": { "name": "London Stock Exchange Group Resolves a list of results.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cases/:caseSystemId/results/resolution", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case." } ] }, "docs": "Resolves a list of results for the Case identified by the given caseSystemId.\nThe endpoint for the resolution toolkit '/groups/{groupId}/resolutionToolkit' provides the resolution rules\nto be applied when resolving results of any [Case](#Case) within a specific [Group](#Group).\n\nAny resultIds which relate to records that have been removed from World-Check One can only be resolved as FALSE.\n" }, { "info": { "name": "London Stock Exchange Group Get ongoing screening updates.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/ongoingScreeningUpdates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Get ongoing screening updates for all `Case` objects that are visible to the current user and are flagged for\nongoing screening.\n\nFilter and sort the ongoing screening updates in the response by:\n\n **updateDate**: The date and time of this ongoing screening update in ISO 8601 format (excluding Week and\n Ordinal dates). Required.\n\n **providerType**: Ongoing screening provider type to query for results. Optional.\n\n e.g. Filter body that specifies the page size to be `50` and queries the first" }, { "info": { "name": "London Stock Exchange Group Assign the Case to a User.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cases/:caseSystemId/assignee", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case." } ] }, "docs": "Assign the Case to a User. '/users' endpoint provides the active users\nthat a Case can be assigned to.\n" }, { "info": { "name": "London Stock Exchange Group Unassign a Case.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cases/:caseSystemId/assignee", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" } ], "params": [ { "name": "caseSystemId", "value": "", "type": "path", "description": "System generated ID for the Case" } ] }, "docs": "Once you have assigned the case to the User, you can now unassign the same case." }, { "info": { "name": "London Stock Exchange Group Search for Cases based on specified criteria using filter or query parameters.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/search", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Search for Cases based on specified criteria using filter or query parameters.\n\nThis endpoint allows you to find cases that match your search criteria. \nYou can provide these criteria through the [CaseSearchRequest](#CaseSearchRequest) object, which includes 'query' and 'filter' fields. \nExpressions in 'query' and 'filter' must adhere to the Atom Feed Item Query Language (FIQL), \nwhich is documented in [RFC 4288](https://tools.ietf.org/html/rfc4288) and the superset supported by the WC1 API, \nas" }, { "info": { "name": "London Stock Exchange Group User activity monitoring. Initial request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/summaries", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Return a collection of Cases that were modified by users in particular date range.\nEndpoint allow to initiate search and retrieve the first page of result set.\nThe query supports next field to specify searching criteria:\n\n'modificationDate' - Time when the case has been modified by the user;\n\n'assignedUserId' - Identifier of the User cases are assigned to;\n\n'groupId' - Identifier of the Group that owns the case;\n\n'creatorUserId' - Identifier of the case author;\n\n'modifierUserId' - Identifier of " }, { "info": { "name": "London Stock Exchange Group User activity monitoring. Subsequent request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/summaries/cursor", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "Continue loading result sets by cursor ID retrieved from POST/cases/summaries.\n\n**Note:** Cursor lifespan keeps extending if the cursor is accessed within its current lifespan.\n For example, once the cursor-id is generated using `POST /cases/summaries` endpoint, its lifespan is 60secs\n from there. Within that 60secs, if `POST /cases/summaries/cursor` endpoint is called, it extends the\n lifespan of the cursor to another 60secs from the point that call is made – and so o" }, { "info": { "name": "London Stock Exchange Group Save and screen multiple cases.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/saveAndScreen", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "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).\nIn response, the caller receives a summary of the creation operation for each case.\n\n*Example HTTP response* below, shows the following summary:\n\n 1. The first case has been created successfully.\n 2. The second case has not been created successfully because it does not meet the validation criteria;\n \"errors\" and \"cause\" fields" }, { "info": { "name": "London Stock Exchange Group Retrieve case screening status and aggregated result for multiple cases.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cases/screeningStatus", "headers": [ { "name": "Authorization", "value": "" }, { "name": "Date", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" } ] }, "docs": "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).\nIn response, the caller receives a status and aggregated screening results for each case.\n\n**Example HTTP response**\n\n```\n Response example returned for request not containing \"providerTypes\" field.\n [\n {\n \"caseSystemId\": \"Case System ID 1\",\n \"screeningStatus\": \"SCREENED\",\n \"requestFromScreenedD" } ] } ], "bundled": true }