Documentation Powered by Redocly

LSEG World-Check One API (1.6.0)

LSEG World-Check One API Q&A: c3r.api1@lseg.com URL: https://community.developers.refinitiv.com/index.html License: Commercial Terms of Service

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.

    © 2018 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.

Refer to the LSEG Developer Portal for additional documentation on the World-Check One API.

zfs

Operations for the ZFS domain.

Get Map of country codes and country names.

Get Map of 'ISO-3166-1 alpha-3' country codes and country names in English.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/reference/countries")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get a profile by its 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'
path Parameters
profileId
required
string

Profile identifier.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/reference/profile/%7BprofileId%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
Example
{
  • "actions": [
    ],
  • "active": false,
  • "addresses": [
    ],
  • "associates": [
    ],
  • "category": "string",
  • "comments": "string",
  • "contacts": [
    ],
  • "countryLinks": [
    ],
  • "creationDate": "2019-08-24T14:15:22Z",
  • "deletionDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "details": [
    ],
  • "entityId": "string",
  • "entityType": "CountryEntity",
  • "externalImportId": "string",
  • "files": [
    ],
  • "identityDocuments": [
    ],
  • "images": [
    ],
  • "lastAdjunctChangeDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "names": [
    ],
  • "previousCountryLinks": [
    ],
  • "provider": {
    },
  • "sourceDescription": "string",
  • "sourceUris": [
    ],
  • "sources": [
    ],
  • "subCategory": "string",
  • "updateCategory": "UNKNOWN",
  • "updatedDates": {
    },
  • "weblinks": [
    ]
}

Create or update a provider source.

Create or update a provider source for uploading entity records to. An example usage would be for a client watchlist.

path Parameters
identifier
required
string

Unique identifier for this provider source. Has to be alphanumeric.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Provider source details.

abbreviation
required
string <= 255 characters

Abbreviated form of this source's 'name'.

identifier
required
string <= 255 characters ^[\sa-zA-Z0-9]*$

An alphanumeric value.

name
required
string <= 255 characters

Full name of this source.

providerSourceStatus
required
string (ProviderSourceStatus)
Enum: "ACTIVE" "DELETED" "HIDDEN"

Provider source status enumeration.

required
object (ProviderSourceType)

Details about the Provider's source type.

creationDate
string <date-time>

Creation date and time.

importIdentifier
string

An import identifier of the source.

object (Provider)

Details about the Provider.

regionOfAuthority
string

Region of the Provider's authority.

subscriptionCategory
string (SubscriptionCategory)
Default: "STANDARD"
Enum: "PREMIUM" "STANDARD"

Subscription category type enumeration.

Responses

Request samples

Content type
application/json
{
  • "abbreviation": "ABC",
  • "creationDate": "2023-01-25T14:00:00Z",
  • "identifier": "Provider Source ID",
  • "importIdentifier": "Provider Source Import ID",
  • "name": "Provider Source",
  • "provider": {
    },
  • "providerSourceStatus": "ACTIVE",
  • "regionOfAuthority": "Region",
  • "subscriptionCategory": "PREMIUM",
  • "type": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Maintain your Watchlist data.

Maintain your Watchlist data using the following supported entity actions.

  • 'entityCreateOrUpdate' - Add a new entity to your Watchlist or replace it 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.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

A collection of maintenance actions to be performed on your Watchlist.

Array of objects (Entity) [ items ]

A list of Create or Update actions.

Array of objects (EntityDelete) [ items ]

A list of Delete actions.

Array of objects (EntitySupersede) [ items ]

A list of Supersede actions.

Array of objects (EntityPurge) [ items ]

A list of Purge actions.

Responses

Request samples

Content type
application/json
{
  • "entityCreateOrUpdate": [
    ],
  • "entityDelete": [
    ],
  • "entitySupersede": [
    ],
  • "entityPurge": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get all the top-level Groups with their immediate descendants.

Get all the top-level Groups with their immediate descendants.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Get a specified Group including its immediate descendants.

Get a specified Group including its immediate descendants.

path Parameters
groupId
required
string

Group ID under which we wish to retrieve the Group containing its immediate descendants.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "id": "Group ID",
  • "name": "John Smith",
  • "parentId": "Parent Group ID",
  • "hasChildren": true,
  • "status": "ACTIVE",
  • "children": [ ]
}

Get the CaseTemplate for the given Group.

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
path Parameters
groupId
required
string

The Group ID under which we wish to manage Cases and perform screening.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D/caseTemplate")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "groupId": "Group ID",
  • "groupScreeningType": "CASE_MANAGEMENT_AUDIT",
  • "customFields": [
    ],
  • "secondaryFieldsByProvider": {
    }
}

Perform a synchronous screening for a new Case.

Perform a synchronous screening for a given Case. This endpoint can perform a synchronous screening for a set of valid Case details. The returned result collection contains the regular Case result details plus identity documents and important events. Synchronous screening on the dedicated 'ZFS' gateway host should be used to perform 'Zero Footprint Screening (ZFS)'. 'ZFS' is enabled by specifying a 'ZFS' group ID in the body and is available for 'Zero-footprint API' Customers only.

Note: The maximum number of World-Check screenings (including initial, rescreening, and 'ZFP' ones) that a Client can perform in an hour is limited.

Info about available secondary fields can be found here.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets ('8-bit' bytes).

Request Body schema: application/json

Screening Request.

name
required
string <= 1000 characters

Name to screen for this Case.

providerTypes
required
Array of strings (ProviderType) non-empty
Items Enum: "WATCHLIST" "PASSPORT_CHECK" "MEDIA_CHECK" "CLIENT_WATCHLIST"

Provider Types required to Screen this case. For 'Zero Footprint Screening (ZFS)', only 'WATCHLIST' and 'CLIENT_WATCHLIST' are supported.

groupId
required
string <= 255 characters

Group identifier owning this Case. The group determines whether the Case is screened as 'Zero Footprint Screnning (ZFS)' or not.

entityType
required
string (CaseEntityType)
Enum: "INDIVIDUAL" "ORGANISATION" "VESSEL" "UNSPECIFIED"

Case entity type enumeration.

caseId
string <= 512 characters

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)'.

Array of objects (Field) [ items ]

Case Custom Fields. Available custom fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint. Custom fields cannot be used with 'Zero Footprint Screening (ZFS)'.

Array of objects (Field) [ items ]

Case Secondary Fields. Available secondary fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint.

Responses

Request samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ],
  • "groupId": "Client Group ID",
  • "entityType": "INDIVIDUAL"
}

Response samples

Content type
application/json
{
  • "caseId": "string",
  • "results": [
    ]
}

api-info

Operations for the API info domain.

Get information about the Public API.

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.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/apiInfo")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "version": "1.6.0",
  • "systemDateTime": "2022-07-26T11:46:28.131Z",
  • "apiDocumentationLink": "wc1-api.documentation.com"
}

reference

Operations for the reference domain.

Get Map of country codes and country names.

Get Map of 'ISO-3166-1 alpha-3' country codes and country names in English.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/reference/countries")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get a list of available providers and their sources.

Get a list of all available providers and their sources.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/reference/providers")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Get a profile by its 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'
path Parameters
profileId
required
string

Profile identifier.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/reference/profile/%7BprofileId%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
Example
{
  • "actions": [
    ],
  • "active": false,
  • "addresses": [
    ],
  • "associates": [
    ],
  • "category": "string",
  • "comments": "string",
  • "contacts": [
    ],
  • "countryLinks": [
    ],
  • "creationDate": "2019-08-24T14:15:22Z",
  • "deletionDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "details": [
    ],
  • "entityId": "string",
  • "entityType": "CountryEntity",
  • "externalImportId": "string",
  • "files": [
    ],
  • "identityDocuments": [
    ],
  • "images": [
    ],
  • "lastAdjunctChangeDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "names": [
    ],
  • "previousCountryLinks": [
    ],
  • "provider": {
    },
  • "sourceDescription": "string",
  • "sourceUris": [
    ],
  • "sources": [
    ],
  • "subCategory": "string",
  • "updateCategory": "UNKNOWN",
  • "updatedDates": {
    },
  • "weblinks": [
    ]
}

group

Operations for the group domain.

Get all the top-level Groups with their immediate descendants.

Get all the top-level Groups with their immediate descendants.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Get a specified Group including its immediate descendants.

Get a specified Group including its immediate descendants.

path Parameters
groupId
required
string

Group ID under which we wish to retrieve the Group containing its immediate descendants.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "id": "Group ID",
  • "name": "John Smith",
  • "parentId": "Parent Group ID",
  • "hasChildren": true,
  • "status": "ACTIVE",
  • "children": [ ]
}

Get the CaseTemplate for the given Group.

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
path Parameters
groupId
required
string

The Group ID under which we wish to manage Cases and perform screening.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D/caseTemplate")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "groupId": "Group ID",
  • "groupScreeningType": "CASE_MANAGEMENT_AUDIT",
  • "customFields": [
    ],
  • "secondaryFieldsByProvider": {
    }
}

Get the resolution toolkit for the given Group.

Get the resolution toolkit for the given Group, used to construct a valid resolution request(s) on the results for a Case belonging to the given Group 'groupId'.

path Parameters
groupId
required
string

ID of the Group to which the resolution toolkit belongs.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D/resolutionToolkit")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "groupId": "Group ID",
  • "providerType": "WATCHLIST",
  • "resolutionFields": {
    },
  • "resolutionRules": {
    }
}

Get the resolution toolkit for a specific provider type for the given Group.

Get the resolution toolkit 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'.

path Parameters
groupId
required
string

ID of the Group to which the resolution toolkit belongs.

providerType
required
string

Provider type for which the resolution toolkit applies.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D/resolutionToolkits/%7BproviderType%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "groupId": "Group ID",
  • "providerType": "WATCHLIST",
  • "resolutionFields": {
    },
  • "resolutionRules": {
    }
}

Get all the ResolutionToolkits for the given Group.

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.

path Parameters
groupId
required
string

ID of the Group to which the resolution toolkits belong.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/groups/%7BgroupId%7D/resolutionToolkits")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

case

Operations for the case domain.

Check if a given 'caseId' is available for use.

The '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.

query Parameters
caseId
required
string

The ID to check if it is available to use as a 'caseId'.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.head("https://api-worldcheck.refinitiv.com/v1/caseIdentifiers?caseId=SOME_STRING_VALUE")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Returns the CaseReference containing the 'caseId' and 'caseSystemId' pair for an existing Case with the given 'caseId'.

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} endpoint.

query Parameters
caseId
required
string

Case ID provided by the Client or else generated by the system for the Client.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/caseReferences?caseId=SOME_STRING_VALUE")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "caseId": "Case ID",
  • "caseSystemId": "Case System ID"
}

Create a new case.

Creates a new Case for asynchronous screening. Synchronous screening on the dedicated 'ZFS' gateway host via POST /cases/screeningRequest should be used instead of this for 'Zero Footprint Screening (ZFS)'.

Info about available secondary fields can be found here.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Case to be created.

name
required
string <= 1000 characters

Name to screen for this Case.

providerTypes
required
Array of strings (ProviderType) non-empty
Items Enum: "WATCHLIST" "PASSPORT_CHECK" "MEDIA_CHECK" "CLIENT_WATCHLIST"

Provider Types required to Screen this case. For 'Zero Footprint Screening (ZFS)', only 'WATCHLIST' and 'CLIENT_WATCHLIST' are supported.

groupId
required
string <= 255 characters

Group identifier owning this Case. The group determines whether the Case is screened as 'Zero Footprint Screnning (ZFS)' or not.

entityType
required
string (CaseEntityType)
Enum: "INDIVIDUAL" "ORGANISATION" "VESSEL" "UNSPECIFIED"

Case entity type enumeration.

caseId
string <= 512 characters

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)'.

Array of objects (Field) [ items ]

Case Custom Fields. Available custom fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint. Custom fields cannot be used with 'Zero Footprint Screening (ZFS)'.

Array of objects (Field) [ items ]

Case Secondary Fields. Available secondary fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint.

Responses

Request samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ],
  • "groupId": "Client Group ID",
  • "entityType": "INDIVIDUAL"
}

Response samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ],
  • "groupId": "Client Group ID",
  • "entityType": "INDIVIDUAL",
  • "caseSystemId": "Case System ID",
  • "caseScreeningState": "INITIAL",
  • "lifecycleState": "ARCHIVED",
  • "creator": {
    },
  • "modifier": {
    },
  • "assignee": {
    },
  • "creationDate": "2016-02-18T14:00:00Z",
  • "modificationDate": "2016-02-18T14:00:00Z",
  • "outstandingActions": false
}

Perform a synchronous screening for a new Case.

Perform a synchronous screening for a given Case. This endpoint can perform a synchronous screening for a set of valid Case details. The returned result collection contains the regular Case result details plus identity documents and important events. Synchronous screening on the dedicated 'ZFS' gateway host should be used to perform 'Zero Footprint Screening (ZFS)'. 'ZFS' is enabled by specifying a 'ZFS' group ID in the body and is available for 'Zero-footprint API' Customers only.

Note: The maximum number of World-Check screenings (including initial, rescreening, and 'ZFP' ones) that a Client can perform in an hour is limited.

Info about available secondary fields can be found here.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets ('8-bit' bytes).

Request Body schema: application/json

Screening Request.

name
required
string <= 1000 characters

Name to screen for this Case.

providerTypes
required
Array of strings (ProviderType) non-empty
Items Enum: "WATCHLIST" "PASSPORT_CHECK" "MEDIA_CHECK" "CLIENT_WATCHLIST"

Provider Types required to Screen this case. For 'Zero Footprint Screening (ZFS)', only 'WATCHLIST' and 'CLIENT_WATCHLIST' are supported.

groupId
required
string <= 255 characters

Group identifier owning this Case. The group determines whether the Case is screened as 'Zero Footprint Screnning (ZFS)' or not.

entityType
required
string (CaseEntityType)
Enum: "INDIVIDUAL" "ORGANISATION" "VESSEL" "UNSPECIFIED"

Case entity type enumeration.

caseId
string <= 512 characters

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)'.

Array of objects (Field) [ items ]

Case Custom Fields. Available custom fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint. Custom fields cannot be used with 'Zero Footprint Screening (ZFS)'.

Array of objects (Field) [ items ]

Case Secondary Fields. Available secondary fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint.

Responses

Request samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ],
  • "groupId": "Client Group ID",
  • "entityType": "INDIVIDUAL"
}

Response samples

Content type
application/json
{
  • "caseId": "string",
  • "results": [
    ]
}

Get ongoing screening updates.

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.

e.g. Filter body that specifies the page size to be '50' and queries the first page of ongoing screening updates occurred since '2016-07-26T00:00:00Z' sorted by 'updateDate' in 'DESCENDING' order:

{
  "query": "updateDate>='2016-07-26T00:00:00Z'",
  "sort": [
    {
      "columnName": "updateDate",
      "order": "DESCENDING"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "itemsPerPage": 50
  }
}
header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Filter and sort the ongoing screening updates in the response.

query
string

A query filter expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in https://tools.ietf.org/html/draft-nottingham-atompub-fiql-00, and the superset supported by the WC1 API documented in https://github.com/jirutka/rsql-parser.

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"
Array of objects (SortCriterion) [ items ]

The sort criteria to apply to the query.

object (Pagination)

Inbound - used to describe paginated partial result sets.

Responses

Request samples

Content type
application/json
{
  • "query": "fieldName>='2016-07-27T00:00:00Z'",
  • "sort": [
    ],
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "query": "updateDate>='2016-07-27T00:00:00Z'",
  • "sort": [
    ],
  • "totalResultCount": 45,
  • "pagination": {
    },
  • "results": [
    ]
}

User activity monitoring. Initial request.

Return a collection of Cases that were modified by Users in particular date range. Endpoint allows 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 POST /cases/summaries/cursor endpoint.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

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.

query
string

A query filter expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in https://tools.ietf.org/html/draft-nottingham-atompub-fiql-00, and the superset supported by the WC1 API documented in https://github.com/jirutka/rsql-parser. 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"
Array of objects (SortCriterion) [ items ]

Details of sorting on a specific column.

object (CursorOptions)

Used to indicate items per page.

Responses

Request samples

Content type
application/json
{
  • "query": "modificationDate>=2021-01-01T00:00:00.000Z",
  • "sort": [
    ],
  • "cursorOptions": {
    }
}

Response samples

Content type
application/json
{
  • "cursor": {
    },
  • "query": "modificationDate>='2016-07-27T00:00:00Z'",
  • "sort": [
    ],
  • "totalResultCount": 2,
  • "results": [
    ]
}

User activity monitoring. Subsequent request.

Continue loading result sets by the Cursor ID retrieved from POST /cases/summaries.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Request to continue cases retrieval.

required
object (Cursor)

Identifier which allows retrieving next N Cases.

Responses

Request samples

Content type
application/json
{
  • "cursor": {
    }
}

Response samples

Content type
application/json
{
  • "cursor": {
    },
  • "query": "modificationDate>='2016-07-27T00:00:00Z'",
  • "sort": [
    ],
  • "totalResultCount": 2,
  • "results": [
    ]
}

Return the Case for the given 'caseSystemId'.

Returns the Case identified by the given 'caseSystemId'.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ],
  • "groupId": "Client Group ID",
  • "entityType": "INDIVIDUAL",
  • "caseSystemId": "Case System ID",
  • "caseScreeningState": "INITIAL",
  • "lifecycleState": "ARCHIVED",
  • "creator": {
    },
  • "modifier": {
    },
  • "assignee": {
    },
  • "creationDate": "2016-02-18T14:00:00Z",
  • "modificationDate": "2016-02-18T14:00:00Z",
  • "outstandingActions": false
}

Update an existing Case by its 'caseSystemId'.

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.

Info about available secondary fields can be found here.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Update Case.

name
required
string <= 1000 characters

Name to screen for this Case.

providerTypes
required
Array of strings (ProviderType) non-empty
Items Enum: "WATCHLIST" "PASSPORT_CHECK" "MEDIA_CHECK" "CLIENT_WATCHLIST"

Provider Types required to Screen this case. For 'Zero Footprint Screening (ZFS)', only 'WATCHLIST' and 'CLIENT_WATCHLIST' are supported.

caseId
string <= 512 characters

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)'.

Array of objects (Field) [ items ]

Case Custom Fields. Available custom fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint. Custom fields cannot be used with 'Zero Footprint Screening (ZFS)'.

Array of objects (Field) [ items ]

Case Secondary Fields. Available secondary fields and their definitions can be obtained via GET groups/{groupId}/caseTemplate endpoint.

Responses

Request samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ]
}

Response samples

Content type
application/json
{
  • "caseId": "Client Case ID",
  • "name": "John Smith",
  • "providerTypes": [
    ],
  • "customFields": [
    ],
  • "secondaryFields": [
    ],
  • "groupId": "Client Group ID",
  • "entityType": "INDIVIDUAL",
  • "caseSystemId": "Case System ID",
  • "caseScreeningState": "INITIAL",
  • "lifecycleState": "ARCHIVED",
  • "creator": {
    },
  • "modifier": {
    },
  • "assignee": {
    },
  • "creationDate": "2016-02-18T14:00:00Z",
  • "modificationDate": "2016-02-18T14:00:00Z",
  • "outstandingActions": false
}

Delete a Case.

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.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.delete("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Request the initial screening for a Case in asynchronous mode.

Make a request for screening of the Case identified by the given 'caseSystemId'. The screening request is an asynchronous operation, and returns 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 POST /cases/{caseSystemId}/auditEvents and then the results can be retrieved via GET /cases/{caseSystemId}/results.

Note: The maximum number of World-Check screenings (including initial, rescreening, and ZFP ones) that a Client can perform in an hour is limited.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.post("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/screeningRequest")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Enable OGS for a Case.

Enable Ongoing Screening for the Case identified by the given 'caseSystemId'. This will schedule the Case to be re-screened periodically by the system.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.put("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/ongoingScreening")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Disable OGS for a Case.

Disable Ongoing Screening for the Case identified by the given 'caseSystemId'.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.delete("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/ongoingScreening")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Archive a Case.

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.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.put("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/archive")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Unarchive a Case.

Unarchive the Case identified by the given 'caseSystemId'. The user must be active and have the archive permission.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.delete("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/archive")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Assign the Case to a User.

Assign the Case to a User. The GET /users endpoint provides the active users that a Case can be assigned to.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

User to whom the case will be assigned.

userId
required
string <= 255 characters

Identifier of the assignee user.

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Unassigns a Case with the 'caseSystemId' only if it's assigned to a 'User'.

Unassigns a Case with identified by the given 'caseSystemId' only if it's assigned to a 'User'.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.delete("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/assignee")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Get collection of Results for a Case by its 'caseSystemId'.

Return a collection of Results for the Case identified by the given 'caseSystemId'.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/cases/%7BcaseSystemId%7D/results")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]

Add a review remark to the specified result IDs for the given Case.

Add a review remark to the specified result IDs for the given Case.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Object representing the IDs to be reviewed, and the review remark.

resultIds
required
Array of strings unique

Result IDs of the case we are wishing to review.

remark
required
string

The review remark we wish to assign to the supplied result IDs.

Responses

Request samples

Content type
application/json
{
  • "resultIds": [
    ],
  • "remark": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Resolves a list of results.

Resolves a list of results for the Case identified by the given 'caseSystemId'. The endpoint for the resolution toolkit GET /groups/{groupId}/resolutionToolkit provides the resolution rules to be applied when resolving results of any Case within a specific Group.

Any 'resultIds' which relate to records that have been removed from World-Check One can only be resolved as 'FALSE'.

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Represents the request details required for resolving Results.

Note: Fields 'reasonId' and 'resolutionRemark' are required if they are specified accordingly in the configuration settings.

statusId
required
string <= 255 characters

Unique status ID defined in Group's resolution toolkit and used when resolving this Result. Get the available status IDs and their details via GET /groups/{groupId}/resolutionToolkit endpoint.

riskId
required
string <= 255 characters

Unique risk ID defined in Group's resolution toolkit and used when resolving this Result. Get the available risk IDs and their details via GET /groups/{groupId}/resolutionToolkit endpoint.

resultIds
required
Array of strings unique [ items <= 255 characters ]

Identifiers of a set of results linked to one Case.

reasonId
string <= 255 characters

Unique reason ID defined in Group's resolution toolkit and used when resolving this Result. Get the available reason IDs and their details via GET /groups/{groupId}/resolutionToolkit endpoint.

resolutionRemark
string <= 1000 characters

Resolution remark added when resolving this Result.

Responses

Request samples

Content type
application/json
{
  • "statusId": "string",
  • "riskId": "string",
  • "reasonId": "string",
  • "resolutionRemark": "string",
  • "resultIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

audit

Operations for the audit domain.

Get a filtered list of AuditEvents for a Case by its 'caseSystemId'.

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

path Parameters
caseSystemId
required
string

System generated ID for the Case.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Filter the AuditEvents in the response.

query
string

A query filter expression, which is written in a superset of the Atom Feed Item Query Language (FIQL). The FIQL is documented in https://tools.ietf.org/html/draft-nottingham-atompub-fiql-00, and the superset supported by the WC1 API documented in https://github.com/jirutka/rsql-parser.

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"
Array of objects (SortCriterion) [ items ]

The sort criteria to apply to the query.

object (Pagination)

Inbound - used to describe paginated partial result sets.

Responses

Request samples

Content type
application/json
{
  • "query": "fieldName>='2016-07-27T00:00:00Z'",
  • "sort": [
    ],
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "query": "eventDate>='2016-07-27T00:00:00Z'",
  • "sort": [
    ],
  • "totalResultCount": 1,
  • "pagination": {
    },
  • "results": [
    ]
}

client-watchlist

Operations for the watchlist domain.

Create or update a provider source.

Create or update a provider source for uploading entity records to. An example usage would be for a client watchlist.

path Parameters
identifier
required
string

Unique identifier for this provider source. Has to be alphanumeric.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

Provider source details.

abbreviation
required
string <= 255 characters

Abbreviated form of this source's 'name'.

identifier
required
string <= 255 characters ^[\sa-zA-Z0-9]*$

An alphanumeric value.

name
required
string <= 255 characters

Full name of this source.

providerSourceStatus
required
string (ProviderSourceStatus)
Enum: "ACTIVE" "DELETED" "HIDDEN"

Provider source status enumeration.

required
object (ProviderSourceType)

Details about the Provider's source type.

creationDate
string <date-time>

Creation date and time.

importIdentifier
string

An import identifier of the source.

object (Provider)

Details about the Provider.

regionOfAuthority
string

Region of the Provider's authority.

subscriptionCategory
string (SubscriptionCategory)
Default: "STANDARD"
Enum: "PREMIUM" "STANDARD"

Subscription category type enumeration.

Responses

Request samples

Content type
application/json
{
  • "abbreviation": "ABC",
  • "creationDate": "2023-01-25T14:00:00Z",
  • "identifier": "Provider Source ID",
  • "importIdentifier": "Provider Source Import ID",
  • "name": "Provider Source",
  • "provider": {
    },
  • "providerSourceStatus": "ACTIVE",
  • "regionOfAuthority": "Region",
  • "subscriptionCategory": "PREMIUM",
  • "type": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Maintain your Watchlist data.

Maintain your Watchlist data using the following supported entity actions.

  • 'entityCreateOrUpdate' - Add a new entity to your Watchlist or replace it 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.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Content-Type
required
string

The media type of the request (e.g., 'application/json').

Content-Length
required
integer

The length of the request body in octets (8-bit bytes).

Request Body schema: application/json

A collection of maintenance actions to be performed on your Watchlist.

Array of objects (Entity) [ items ]

A list of Create or Update actions.

Array of objects (EntityDelete) [ items ]

A list of Delete actions.

Array of objects (EntitySupersede) [ items ]

A list of Supersede actions.

Array of objects (EntityPurge) [ items ]

A list of Purge actions.

Responses

Request samples

Content type
application/json
{
  • "entityCreateOrUpdate": [
    ],
  • "entityDelete": [
    ],
  • "entitySupersede": [
    ],
  • "entityPurge": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

user

Operations for the user domain.

Get a list of active users in the client's account.

Get a list of active users in the client's account.

header Parameters
Authorization
required
string

The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).

Date
required
string

The date and time at which the message was originated in 'RFC 1123' format.

Responses

Request samples 

HttpResponse<String> response = Unirest.get("https://api-worldcheck.refinitiv.com/v1/users")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("Date", "SOME_STRING_VALUE")
  .asString();

Response samples

Content type
application/json
[
  • {
    }
]