How to use Name transposition in World-Check One API for screening?

@Prabhjyot

Name Transposition is now available in version 2 of the API.

In order to use name transposition, first the user needs to make sure that their WC1 account has name transposition functionality on their account.

Once this has been enabled, the client can use the below payload to ask the API server to include the name transposition in the screening criteria.

Name Transposition can be used for the below endpoints:

1. SEQ-screen-sync-simple: Perform Synchronous Screening:

POST: https://rms-world-check-one-api-pilot.thomsonreuters.com/v2/cases/screeningRequest

2. SEQ-case-create: Save a case:

PUT: https://rms-world-check-one-api-pilot.thomsonreuters.com/v2/cases

3. SEQ-case-update: Update a case:

PUT: https://rms-world-check-one-api-pilot.thomsonreuters.com/v2/cases/{{case-system-id}}

The user can tell the API server to use name transposition in their screening criteria by just including the JSON line "nameTransposition": "True" in the JSON payload for the above 3 endpoints.

Here is a simple payload to test.

{
 "groupId": "{{Enter your group-id}}",
 "entityType": "INDIVIDUAL",
 "providerTypes": ["WATCHLIST"],
 "name": "Vladimir putin",
 "nameTransposition": "True", #Tells the API server to name transpose
 "secondaryFields": [],
 "customFields": []
}

Name Transposition for Bulk screening :

4. SEQ-case-save-and-screen-cases: Save and screen multiple cases: This endpoint allow the user to screen multiple entities via a single endpoint, with a maximum of upto 50 entities in a single request.

For this endpoint, the payload will be different from the above 3 endpoints. Please find the JSON payload for this endpoint below:

POST: https://rms-world-check-one-api-pilot.thomsonreuters.com/v2/cases/saveAndScreen

{
 "groupId": "{{Enter your group-id}}",
 "providerTypes": ["WATCHLIST"],
 "nameTransposition": true, #Enables Name Transposition for all the cases in the request payload.
 "caseScreeningState": {
  "WATCHLIST": "INITIAL"
 },
 "cases": [{
  "entityType": "ORGANISATION",
  "name": "SmithCorporation"
 }, {
  "entityType": "INDIVIDUAL",
  "name": "John Smith"
 }]
}