Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Refinitiv Cases API

Case creation, screening, retrieval, update, and deletion operations for entity screening against the World-Check database.

Refinitiv Cases API is one of 45 APIs that Refinitiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.refinitiv.com.

4 operations 2 paths 5 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.refinitiv.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Refinitiv Cases API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained from the /auth/oauth2/v1/token endpoint. Access tokens are valid for five minutes.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Cases 4

Case creation, screening, retrieval, update, and deletion operations for entity screening against the World-Check database.

POST
/cases/screeningRequest
Create Case with Synchronous Screening
createCaseAndScreen body → 200400401403
GET
/cases/{caseSystemId}
Get Case Details
getCase 1 param → 200401404
PUT
/cases/{caseSystemId}
Update an Existing Case
updateCase 1 param body → 200400401404
DELETE
/cases/{caseSystemId}
Delete a Case
deleteCase 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ScreeningRequest (8 properties), Case (8 properties), ScreeningResult (8 properties), CaseUpdateRequest (3 properties). Each schema is shown below with its type and property counts.

ScreeningResponse
object
3 properties
ScreeningResult
object
8 properties
Case
object
8 properties
CaseUpdateRequest
object
3 properties
ScreeningRequest
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

refinitiv-cases-api-openapi.yml Raw ↑

Other APIs Refinitiv publishes across the network.

Refinitiv Data Library for Python
Refinitiv Data Library for .NET
Refinitiv Data Platform Libraries
Eikon Data API
Refinitiv Real-Time WebSocket API
Refinitiv Real-Time SDK - Java
Refinitiv Real-Time SDK - C/C++
Refinitiv News API
Refinitiv ESG API
LSEG DataScope Select - SOAP API
LSEG Tick History REST API
Datastream Web Service API