LSEG World-Check One Case API is one of 15 APIs that London Stock Exchange Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include KYC, Screening, Compliance, and Cases. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes
30 operations
across 24 paths,
and defines 99 schemas.
It is described by OpenAPI 3.2.0, at version 2.61.0.
Requests are made against a single base URL, https://api-worldcheck.refinitiv.com/v2.
The identity and technical contract details declared by the specification.
TranslatedEntity
object
Representation of translated entity.
2 properties
CaseBulkMoveRequest
object
A request body on Bulk Move Cases
3 properties
2 required
EntityUpdatedDates
object
29 properties
ContactDetail
object
3 properties
1 required
CaseSearchResponse
object
A response model containing a result set of searched Cases with the requested details.
ProviderSource
object
12 properties
5 required
PaginationReferenceRequest
object
Request model for defining pagination options.
2 properties
PaginationReferenceResponse
object
Response model containing pagination details.
3 properties
AccelusUserLoginAccountStatus
string
The status of the User login account.
OngoingScreeningUpdateSearchResponse
object
Search response containing a collection of OngoingScreeningUpdate s. Extends [SearchResponse](SearchResponse).
IdentityDocument
object
7 properties
Country
object
2 properties
2 required
CaseBulkOngoingScreeningRequest
object
A request body on Bulk Update Ongoing Screening States
3 properties
2 required
Error
object
3 properties
2 required
ProviderSourceTypeCategoryDetail
object
3 properties
Case
object
Defines full Case data returned when retrieving a Case. Extends [NewCase](NewCase).
ScreeningRequest
object
Defines Case data that can be sent when creating a synchronous screening request for a new Case. Extends [NewCase](NewCase).
Weblink
object
3 properties
EventType
string
Event Type Enumeration.
ResultsResolutionAction
object
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 ar…
ItemIdentifier
object
Represents the details (ID and label) of an individual item value.
2 properties
IdentityDocumentLocationType
object
Represents the type of identity document location that includes the type of document, name, country and what type of entity it belongs to.
4 properties
MediaCheckResultSummary
object
Match summary for results with provider type MEDIACHECK
2 properties
ProviderType
string
Provider Type Enumeration
AbstractCaseSearchModel
object
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 w…
4 properties
OngoingScreeningRequest
object
Request containing ongoing screening details
2 properties
1 required
Name
object
8 properties
2 required
NewCase
object
Defines Case data that can be sent when creating a new Case. Extends [AbstractCase](AbstractCase).
CaseBulkResponse
object
Cases Archived / Unarchived Bulk Response
1 property
1 required
CaseBulkLinkRequest
object
Case Bulk Link Request
2 properties
2 required
Entity
object
Represents a specific entity - usually corresponding to an individual or an organisation - that can appear as a potential screening result against a Case. Syno…
30 properties
5 required
ActionDetail
object
12 properties
1 required
FileMeta
object
3 properties
2 required
ScreeningStatusRequestCollection
object
Collection of 'ScreeningStatusRequest'. The maximum number of cases is configured in account settings.
2 properties
AbstractField
object
Generic Field representing a Custom Field or a Secondary Field.
1 property
1 required
CaseEntityType
string
Case entity type enumeration.
ScreeningStatusRequest
object
Contains 'caseSystemId' and presumptive screening timestamp which should be checked.
2 properties
Result
object
Result found after performing a synchronous screening of a Case. This contains the abstract case screening result details plus includes identity documents and…
Address
object
5 properties
EntityType
string
Entity type of the case.
PageReference
object
Model representing references to previous and next pages.
3 properties
CaseSummaryFilterResponse
object
Filter the response
2 properties
CursorOptions
object
1 property
Provider
object
4 properties
Cursor
object
Identifier which allows retrieving next N cases.
1 property
1 required
ProviderTypeSummaryResult
object
Contains enabled in the case provider types and their aggregated screening results.
5 properties
Event
object
Event related to Entity.
7 properties
1 required
CaseBulkStatus
object
Case Bulk Status
3 properties
2 required
AbstractAssociate
object
The AbstractAssociate subclasses corresponding to each type of entity are: COUNTRY: CountryAssociate INDIVIDUAL: IndividualAssociate ORGANISATION: Organisation…
12 properties
2 required
OngoingScreeningUpdate
object
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 screen…
4 properties
2 required
UserSummary
object
9 properties
4 required
MediaCheckCaseDetails
object
Details about the Media-Check settings on a case (e.g., smart filter).
1 property
1 required
CaseDetailsCollection
object
Container of cases, that is used in scope of creation operation.
5 properties
3 required
CaseBulkDeleteRequest
object
A request body on Bulk Delete Cases
2 properties
1 required
CaseScreeningRequest
object
Defines Case Screening Request that could be sent for an existing Case.
2 properties
ScreeningResultCollection
object
Contains an array of Watchlist Screening Result objects from a synchronous screening operation.
21 properties
5 required
CaseBulkLinkRequestCollection
object
A request body on Bulk Update Case Links
4 properties
3 required
OngoingScreeningProviderType
string
Ongoing screening supported provider types
Filter
object
Filter the response
3 properties
SortCriterion
object
Sort specification
2 properties
CountryLink
object
3 properties
2 required
CaseScreeningResultCollection
object
Contains an array of Watchlist Screening Result objects from a synchronous screening operation.
2 properties
SearchResponse
object
Common fields used in search responses. These fields are included in response types, and objects of this type are not returned directly.
4 properties
1 required
CaseDetailLevel
string
Enumeration that defines the detail level of the search response: - 'CASE': The search response will provide full Case details. - 'CASEANDRESULTS': The search…
SecondaryFieldResult
object
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 [Abstr…
AbstractCase
object
Defines Case data that can be sent when creating or updating a Case. Note that availability and definitions of 'customFields' and 'secondaryFields' should be o…
7 properties
CaseBulkAssignRequest
object
A request body on Bulk Update Case Assignments
3 properties
1 required
Resolution
object
Resolution details of a Result.
CaseSearchResultResponse
object
Search response containing N cases matched searching criteria.
CaseSearchRequest
object
Request model used to search within, sort across, paginate through, and filter down the set of Cases.
ProviderSourceType
object
3 properties
AbstractScreeningResult
object
Generic common Result fields returned after a Case is screened
17 properties
1 required
CaseDetails
object
Representation of a single case that is used for case creation operation. Defines Case data that can be sent when creating a new Case.
5 properties
2 required
CaseSummaryResult
object
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 scree…
9 properties
1 required
CaseDetailed
object
Defines complete Case data returned during a search operation. This model provides detailed information about a Case.
28 properties
Detail
object
3 properties
UpdateCase
object
Defines Case data that can be sent when updating a Case. Extends [AbstractCase](AbstractCase).
1 property
CaseReference
object
Container of 'caseId' and 'caseSystemId'.
2 properties
2 required
ProviderTypeDetails
object
Details about the specific provider type.
1 property
1 required
CaseResultSummaries
object
Case Statistics contains the Category and the count for all the results in the Case.
5 properties
AbstractResolution
object
Abstract resolution object
4 properties
CaseBulkArchiveRequest
object
A request body on Bulk Update Archive States
3 properties
2 required
ScreeningStatusResponse
object
Contains status and aggregated screening result for each requested case. If 'requestFromScreenedDate' less than 'lastScreenedDate' then status equals 'NOTSCREE…
5 properties
4 required
PaginationResponse
object
Outbound - used to describe paginated partial result sets
Review
object
Review details of a Result.
4 properties
CaseReferenceDetails
object
Reference representation of a single case that is used for case creation operation. Defines Case data that was saved or not valid.
6 properties
1 required
ResultsReview
object
Entity to set the review remark of supplied result IDs
2 properties
2 required
Assignee
object
2 properties
1 required
StatusType
string
Enumeration of Status types
LanguageCode
object
2 properties
ClientWatchlistResultSummary
object
Match summary for results with provider type CLIENTWATCHLIST
3 properties
Pagination
object
Inbound - the pagination to apply to the query.
2 properties
2 required
Field
object
Holds the value of a Custom Field or a Secondary Field. Valid value type for this field is specified in the corresponding FieldDefinition of CaseTemplateRespon…
WatchlistResultSummary
object
Match summary for results with provider type WATCHLIST
4 properties
PartialUpdateCase
object
Defines Case data that can be sent when updating a Case partially. Extends [AbstractCase](AbstractCase).
1 property
CaseSearchUserSummary
object
1 property
1 required
CaseSummaryFilter
object
Defines search criteria, sorting and items count in the response.
Image
object
6 properties
1 required
MatchedTerm
object
Matched term of a Result.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs London Stock Exchange Group publishes across the network.