World-Check Verify (1.0.0)

World-Check Verify provides a stateless, real-time screening solution designed for easy integration into your existing onboarding or transaction workflows. The API provides:

The ability to screen entity names, with or without secondary fields such as date of birth for individuals, country of registration for organisations, etc.
The ability to retrieve matched watchlist record details.
Access to reference data that can be used for screening purposes.

© 2025 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 LSEG World-Check Verify.

screen

Screen names and secondary identifiers

Use this endpoint to screen names and secondary identifiers of an entity against the selected datasets.

To perform initial (full) screen, send the request with necessary screening data of the entity without "startScreeningDate". This will perform a full screen against selected datasets.

To perform delta screening (screening against new and updated data since the entity was last screened), you may store the index date from the response "lastIndexDatesByCheckType" and give this date value in the "startScreeningDate" field as part the request. Ensure the name and other details given in the request are same as the initial screen.

Note: If the settings or the entity details have been changed since the last screen, then it is recommended to perform a full screen, as the delta screen may not capture all the updates.

Note: In names and secondary fields where free text is allowed, any symbol is allowed except control characters like '\n' (new line) and '\t' (tab). Additionally, using operator words even when combined with an apostrophe, for example the below combinations, may cause an error 403 to be returned:

String ‘AND (String)
String ‘OR (String)
String ‘AND NOT (String)
String ‘OR NOT (String)
String ‘AND AS (String)
String ‘OR AS (String)

header Parameters

Authorization required	string The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).
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)
Date required	string The date and time at which the message was originated in 'RFC 1123' format.

Request Body schema: application/json

Screen payload.

required	Array of objects (Name) [ 1 .. 3 ] items [ items ] Represents names to be screened.
groupId required	string <= 255 characters Group identifier. The settings of this group will be used for screening.
entityType required	string (ScreeningEntityType) Enum: "INDIVIDUAL" "ORGANISATION" "VESSEL" "UNSPECIFIED" Entity type enumeration.
checkTypes required	Array of strings (ProviderType) 1 items unique Items Value: "WORLD_CHECK" Check types required for screening.
	Array of objects (Field) <= 24 items [ items ] Secondary fields.
nameTransposition	boolean Enable this option when screening a name of 2 or more parts and are unsure of the order. Only applicable for Individuals.
startScreeningDate	string <date-time> The request will be screened against records that are published "from" the given date. This date must be in 'ISO 8601' format and less than the current date.

Responses

Error Code	Message
INVALID_NAME	Names are mandatory and must be less than 1000 characters.
PRIMARY_NAMES_COUNT_NOT_ALLOWED	Names must have one PRIMARY name.
INVALID_ENTITY_TYPE	Entity type is mandatory and must be one of: INDIVIDUAL, ORGANISATION, VESSEL, UNSPECIFIED and must be compatible with each check type used in screening.
INVALID_CHECK_TYPE	Check types are invalid and must include at least WATCHLIST.
INVALID_GENDER	Gender secondary field values must be one of: UNSPECIFIED, FEMALE, MALE.
INVALID_DATE_OF_BIRTH	Date of birth secondary field values must be a valid date not containing any time fields. These dates are not allowed to be in the future or more than 150 years in the past.
INVALID_COUNTRY_LOCATION	Country location secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_PLACE_OF_BIRTH	Place of birth secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_NATIONALITY	Nationality secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_REGISTERED_COUNTRY	Registered country secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_IMO_NUMBER	IMO number secondary field values must be a seven-digit number.
SECONDARY_FIELDS_NOT_ALLOWED	Provided secondary fields must be compatible with the used entity type and check type. Available secondary fields for each pair of check type and entity type are provided in the group's case template.
INVALID_MESSAGE_FIELD_FORMAT	Message field '{field name}' has an invalid value.
DUPLICATE_SECONDARY_FIELD_NOT_ALLOWED	Secondary field types must not be duplicated for each combination of check and entity type.
COUNTRY_LOCATION_MAXIMUM_VALUES_EXCEEDED	Country location secondary field count exceeded the allowed limit.
NATIONALITY_MAXIMUM_VALUES_EXCEEDED	Nationality secondary field count exceeded the allowed limit.
INVALID_MESSAGE_FORMAT	Message body is not well-formed.
NAME_TRANSPOSITION_NOT_ALLOWED	Name Transposition is not enabled on this account. Please contact your World-Check Verify Client Administrator.
INVALID_DOCUMENT_ID_COMPONENTS	The provided Document ID components have an invalid or incompatible value(s).
INVALID_DOCUMENT_ID	Document IDs cannot be null or empty and must contain less than 1000 characters.
INVALID_DOCUMENT_ID_NUMBER	Document IDs cannot be null or empty and must contain less than 1000 characters.
INVALID_DOCUMENT_ID_COUNTRY	Document ID Country secondary field values must be a valid ISO_3166-1_alpha-3 country code. Available secondary fields for each pair of check type and entity type are provided in the identity document location types.
INVALID_DOCUMENT_ID_TYPE	Document ID Type secondary field has an invalid value. Available secondary fields for each pair of check type and entity type are provided in the identity document location types.
DUPLICATE_DOCUMENT_ID_DETAIL_TYPE	Document ID details must include only a single occurrence of each detail type.
INVALID_START_SCREENING_DATE	The provided start screening date is invalid.
DOCUMENT_ID_MAXIMUM_VALUES_EXCEEDED	Document Id secondary field count exceeded the allowed limit.
FIELD_VALIDATION_ERROR	Validation Error on field: {field name} with message: {error message}.

Error Code	Message
PERMISSION_DENIED	You don't have the correct permissions. Please contact the helpdesk for more details.

Error Code	Message
NO_INFO_IN_SYSTEM	The expected information does not exist in the system.

Request samples

Content type

application/json

{"names": [{"type": "PRIMARY",
"title": "string",
"fullName": "string",
"givenNames": ["string"
],
"lastNames": ["string"
],
"languageCode": {"code": "str",
"name": "string"
}
}
],
"groupId": "string",
"entityType": "INDIVIDUAL",
"checkTypes": ["WORLD_CHECK"
],
"secondaryFields": [{"type": "GENDER",
"details": [{"type": "GENDER",
"value": "MALE"
}
]
}
],
"nameTransposition": true,
"startScreeningDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"names": [{"type": "PRIMARY",
"title": "string",
"fullName": "string",
"givenNames": ["string"
],
"lastNames": ["string"
],
"languageCode": {"code": "str",
"name": "string"
}
}
],
"checkTypes": ["WORLD_CHECK"
],
"groupId": "string",
"entityType": "INDIVIDUAL",
"secondaryFields": [{"type": "GENDER",
"details": [{"type": "GENDER",
"value": "MALE"
}
]
}
],
"nameTransposition": true,
"startScreeningDate": "2019-08-24T14:15:22Z",
"lastIndexDatesByCheckType": {"property1": "2019-08-24T14:15:22Z",
"property2": "2019-08-24T14:15:22Z"
},
"requestor": {"userId": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"email": "string",
"status": "ACTIVE"
},
"results": [{"referenceId": "referenceId",
"checkType": "WORLD_CHECK",
"matchStrength": "STRONG",
"matchScore": 98.76,
"matchedTerms": [{"matchedTerm": "John Doe",
"matchedTermType": "PRIMARY",
"submittedTerm": "Jon Doe",
"submittedTermType": "PRIMARY",
"matchStrength": "STRONG",
"matchScore": 98.5,
"matchedDate": "2021-06-15T00:00:00Z"
}
],
"secondaryFieldResults": [{"typeId": "GENDER",
"submittedDetails": {"type": "GENDER",
"value": "MALE"
},
"matchedDetails": {"type": "GENDER",
"value": "MALE"
},
"fieldResult": "MATCHED"
}
],
"sources": ["source 1"
],
"sourceCategories": ["category"
],
"names": [{"nameDetails": [{"defaultName": true,
"type": "PRIMARY",
"nonLatinName": false,
"languageCode": {"code": "EN",
"name": "English"
},
"details": [{"type": "FULL_NAME",
"value": "John Doe",
"sources": ["source 1"
]
}
]
}
]
}
],
"dates": [{"dateDetails": [{"type": "DATE_OF_BIRTH",
"value": "2019-08-28T10:05:15Z",
"sources": ["source 1"
]
}
]
}
],
"locations": [{"locationDetails": [{"type": "COUNTRY_LOCATION",
"details": [{"type": "FREE_TEXT",
"value": "United States"
}
],
"country": {"code": "US",
"name": "United States",
"sources": ["source 1"
]
}
}
]
}
],
"identifications": [{"identificationDetails": [{"type": "PASSPORT",
"name": "US Passport",
"expiryDate": "2019-08-28T10:05:15Z",
"issueDate": "2019-08-28T10:05:15Z",
"issuer": "United States",
"idCategory": {"type": "IDCAT_INDIV_ID",
"name": "Individual Identification"
},
"entityTypes": ["Human"
],
"issuingCountry": {"code": "US",
"name": "United States"
},
"value": "value",
"sources": ["source 1"
]
}
]
}
],
"recordType": {"value": "COUNTRY",
"recordSubTypes": [{"value": "STATE"
}
]
},
"recordCategories": [{"type": "Financial",
"value": "High Risk",
"details": [{"type": "Subcategory",
"value": "Risk Level 5"
}
]
}
],
"genders": [{"genderDetails": [{"value": "MALE",
"sources": ["source 1"
]
}
]
}
],
"recordDates": [{"type": "INITIAL_PUBLISHED_DATE",
"value": "2021-05-20T00:00:00Z"
}
],
"pepStatus": {"status": "ACTIVE",
"inactivePeriod": 5
}
}
]
}

groups

Get all groups for the identified users.

If no query parameters are given, then by default the response will show all the hierarchy including all the descendant groups.

query Parameters

showAllChildGroups

required

boolean

If set to false, shows only high-level groups and 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

Error Code	Message
PERMISSION_DENIED	You don't have the correct permissions. Please contact the helpdesk for more details.

Error Code	Message
NO_INFO_IN_SYSTEM	The expected information does not exist in the system.

Request samples

HttpResponse<String> response = Unirest.get("https://api.ap.risk.lseg.com/zfs/v1/groups?showAllChildGroups=SOME_BOOLEAN_VALUE")
  .asString();

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"parentId": "string",
"children": false,
"status": "ACTIVE",
"childGroups": [{ }
]
}
]

references

Get array of countries with country codes and country names.

Get array of countries with '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

Error Code	Message
PERMISSION_DENIED	You don't have the correct permissions. Please contact the helpdesk for more details.

Error Code	Message
NO_INFO_IN_SYSTEM	The expected information does not exist in the system.

Request samples

HttpResponse<String> response = Unirest.get("https://api.ap.risk.lseg.com/zfs/v1/references/countries")
  .asString();

Response samples

Content type

application/json

{"countries": [{"code": "str",
"name": "string"
}
]
}

Get identity document location types.

Get each identity document location type, that refers to a specific country and entity type.

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

Error Code	Message
INVALID_NAME	Names are mandatory and must be less than 1000 characters.
PRIMARY_NAMES_COUNT_NOT_ALLOWED	Names must have one PRIMARY name.
INVALID_ENTITY_TYPE	Entity type is mandatory and must be one of: INDIVIDUAL, ORGANISATION, VESSEL, UNSPECIFIED and must be compatible with each check type used in screening.
INVALID_CHECK_TYPE	Check types are invalid and must include at least WATCHLIST.
INVALID_GENDER	Gender secondary field values must be one of: UNSPECIFIED, FEMALE, MALE.
INVALID_DATE_OF_BIRTH	Date of birth secondary field values must be a valid date not containing any time fields. These dates are not allowed to be in the future or more than 150 years in the past.
INVALID_COUNTRY_LOCATION	Country location secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_PLACE_OF_BIRTH	Place of birth secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_NATIONALITY	Nationality secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_REGISTERED_COUNTRY	Registered country secondary field values must be a valid ISO_3166-1_alpha-3 country code.
INVALID_IMO_NUMBER	IMO number secondary field values must be a seven-digit number.
SECONDARY_FIELDS_NOT_ALLOWED	Provided secondary fields must be compatible with the used entity type and check type. Available secondary fields for each pair of check type and entity type are provided in the group's case template.
INVALID_MESSAGE_FIELD_FORMAT	Message field '{field name}' has an invalid value.
DUPLICATE_SECONDARY_FIELD_NOT_ALLOWED	Secondary field types must not be duplicated for each combination of check and entity type.
COUNTRY_LOCATION_MAXIMUM_VALUES_EXCEEDED	Country location secondary field count exceeded the allowed limit.
NATIONALITY_MAXIMUM_VALUES_EXCEEDED	Nationality secondary field count exceeded the allowed limit.
INVALID_MESSAGE_FORMAT	Message body is not well-formed.
NAME_TRANSPOSITION_NOT_ALLOWED	Name Transposition is not enabled on this account. Please contact your World-Check Verify Client Administrator.
INVALID_DOCUMENT_ID_COMPONENTS	The provided Document ID components have an invalid or incompatible value(s).
INVALID_DOCUMENT_ID	Document IDs cannot be null or empty and must contain less than 1000 characters.
INVALID_DOCUMENT_ID_NUMBER	Document IDs cannot be null or empty and must contain less than 1000 characters.
INVALID_DOCUMENT_ID_COUNTRY	Document ID Country secondary field values must be a valid ISO_3166-1_alpha-3 country code. Available secondary fields for each pair of check type and entity type are provided in the identity document location types.
INVALID_DOCUMENT_ID_TYPE	Document ID Type secondary field has an invalid value. Available secondary fields for each pair of check type and entity type are provided in the identity document location types.
DUPLICATE_DOCUMENT_ID_DETAIL_TYPE	Document ID details must include only a single occurrence of each detail type.
INVALID_START_SCREENING_DATE	The provided start screening date is invalid.
DOCUMENT_ID_MAXIMUM_VALUES_EXCEEDED	Document Id secondary field count exceeded the allowed limit.
FIELD_VALIDATION_ERROR	Validation Error on field: {field name} with message: {error message}.

Error Code	Message
PERMISSION_DENIED	You don't have the correct permissions. Please contact the helpdesk for more details.

Error Code	Message
NO_INFO_IN_SYSTEM	The expected information does not exist in the system.

Request samples

HttpResponse<String> response = Unirest.get("https://api.ap.risk.lseg.com/zfs/v1/references/identity-documents")
  .asString();

Response samples

Content type

application/json

{"identityDocumentLocationTypes": [{"country": {"code": "str",
"name": "string"
},
"name": "string",
"type": "string",
"entityTypes": ["COUNTRY"
]
}
]
}

Get a record by its ID

Get a record by its ID. This service returns a specific subclass of 'Entity', depending on its particular 'RecordEntityType' discriminator field. Please note in the context of World-Check Verify, 'Record' and 'Entity' are synonymous concepts.

The 'Entity' subclasses corresponding to each type of entity are:

'COUNTRY' : 'CountryEntity'
'INDIVIDUAL' : 'IndividualEntity'
'ORGANISATION' : 'OrganisationEntity'
'VESSEL' : 'VesselEntity'

path Parameters

id

required

string

Record 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

Error Code	Message
INVALID_RECORD_ID	Error code to be returned when the record id is invalid (e.g., because no identifier prototype is registered for namespace aggregate).
ENTITY_REMOVED	Error code to be returned when Entity was removed (deleted or purged).

Error Code	Message
PERMISSION_DENIED	You don't have the correct permissions. Please contact the helpdesk for more details.

Error Code	Message
NO_INFO_IN_SYSTEM	The expected information does not exist in the system.

Request samples

HttpResponse<String> response = Unirest.get("https://api.ap.risk.lseg.com/zfs/v1/references/records/%7Bid%7D")
  .asString();

Response samples

Content type

application/json

Example

IndividualEntity

{"entityType": "IndividualEntity",
"referenceId": "string",
"recordStatus": {"value": "string",
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"recordDates": [{"type": "INITIAL_PUBLISHED_DATE",
"value": "2019-08-24T14:15:22Z"
}
],
"recordType": {"value": "COUNTRY",
"recordSubTypes": [{"value": "string",
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"categories": [{"type": "string",
"value": "string",
"details": [{"type": "string",
"value": "string"
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"lastPublishedUpdateCategory": "UNKNOWN",
"dates": {"dateDetails": [{"type": "ACQUISTION_DATE",
"value": "string",
"sources": ["string"
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"locations": {"locationDetails": [{"type": "AFFILIATION",
"details": [{"type": "FREE_TEXT",
"value": "string"
}
],
"country": {"code": "str",
"name": "string"
},
"sources": ["string"
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"names": {"nameDetails": [{"defaultName": true,
"type": "PRIMARY",
"nonLatinName": true,
"languageCode": {"code": "str",
"name": "string"
},
"details": [{"type": "FULL_NAME",
"value": "Dr James Abrahams",
"sources": ["Provider1"
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"provider": {"code": "string",
"identifier": "string",
"master": false,
"name": "string"
},
"identifications": {"identificationDetails": [{"type": "string",
"name": "string",
"expiryDate": "string",
"issueDate": "string",
"issuer": "string",
"idCategory": {"type": "string",
"name": "string"
},
"entityTypes": ["string"
],
"issuingCountry": {"code": "str",
"name": "string"
},
"value": "string",
"sources": ["string"
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"connections": {"connectionDetails": [{"entityType": "COUNTRY",
"referenceId": "string",
"connectionType": "ADVISOR",
"recordDates": [{"type": "INITIAL_PUBLISHED_DATE",
"value": "2019-08-24T14:15:22Z"
}
],
"lastPublishedUpdateCategory": "UNKNOWN",
"recordType": {"value": "COUNTRY",
"recordSubTypes": [{"value": "string",
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"categories": [{"type": "string",
"value": "string",
"details": [{"type": "string",
"value": "string"
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"connectionSourceCategories": ["string"
],
"names": {"nameDetails": [{"defaultName": true,
"type": "PRIMARY",
"nonLatinName": true,
"languageCode": {"code": "str",
"name": "string"
},
"details": [{"type": "FULL_NAME",
"value": "Dr James Abrahams",
"sources": ["Provider1"
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"sources": [{"abbreviation": "ABC",
"identifier": "Provider Source ID",
"creationDate": "2023-01-25T14:00:00Z",
"modificationDate": "2023-02-12T14:00:00Z",
"name": "Provider Source",
"providerSourceStatus": "ACTIVE",
"regionOfAuthority": "Region",
"description": "Description.",
"type": {"providerSourceCategory": "Sanctions",
"providerSourceCategoryDescription": "Description",
"providerSourceType": "Explicit Sanctions",
"providerSourceTypeDescription": "Description"
}
}
],
"furtherInformation": {"details": [{"detailType": "BIOGRAPHY",
"text": "string",
"title": "string"
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"sourceReferenceLinks": {"sourceReferenceLinkDetails": [{"uri": "string",
"tags": ["string"
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
},
"translatedEntity": {"translationDisclaimer": "string",
"details": [{"detailType": "BIOGRAPHY",
"text": "string",
"title": "string"
}
]
},
"statuses": [{"type": "string",
"value": "string",
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"genders": [{"genderDetails": [{"value": "MALE",
"sources": ["string"
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
]
}
],
"roles": {"roleDetails": [{"role": "string",
"level": "string",
"position": "string",
"biography": "string",
"status": "CURRENT",
"effectiveFrom": "2019-08-24T14:15:22Z",
"effectiveTo": "2019-08-24T14:15:22Z",
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
],
"changeHistory": [{"lastPublishedDate": "2019-08-24T14:15:22Z",
"lastPublishedUpdateCategory": "string"
}
]
}
}

Get a list of 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

Error Code	Message
NO_INFO_IN_SYSTEM	The expected information does not exist in the system.

Request samples

HttpResponse<String> response = Unirest.get("https://api.ap.risk.lseg.com/zfs/v1/references/providers")
  .asString();

Response samples

Content type

application/json

[{"identifier": "cnp_7",
"code": "trwc",
"name": "World Check",
"master": true,
"sources": [{"abbreviation": "OFAC-CAR",
"creationDate": "2014-05-14T17:01:08.000Z",
"modificationDate": "2023-04-29T18:29:20.000Z",
"identifier": "b_trwc_OFAC-CAR",
"name": "USA - OFAC-CAR - OFAC SDN List - Central African Republic",
"providerSourceStatus": "ACTIVE",
"regionOfAuthority": "USA",
"description": "OFAC SDN List entries designated pursuant to Executive Order relating to Central African Republic.",
"type": {"providerSourceCategory": "Sanctions",
"providerSourceCategoryDescription": "Description",
"providerSourceType": "Explicit Sanctions",
"providerSourceTypeDescription": "Description"
}
}
]
}
]