For a deeper look into our World Check One API, look into:

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
35 12 18 20

API Call for online screen check

We intend sending the customer’s name and address info and expect to get a case-id and result back.We have looked through the documentation for the specific call but are unsure as to what API call we need to make. Can you help us identify the specific API we need to call and point us to the correct place in the documentation.

world-checkworld-check-one
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Upvotes
Accepted
408 3 4 5

Please refer to following 2 sections from the documents that you would have downloaded from thsi portal.

- Sequence diagrams available in documentation\uml\images\sequence. This gives details on sequence of what API calls to make for screening.

- Schema information provided in file - thomson-reuters-world-check-one-api.v1.yaml in api-schema folder. This will provide detains on what should be the standards followed before sending requests.

Ideally your series of API calls can be following:

1) SEQ-1a: Get my top-level groups: This is to get your group details against which you will be screening.

2) SEQ-1c: Get the case template for a group : This is to extract the format of the request in which you shold be sending the requests.

3) SEQ-2a: Check caseId availability : Each customer search will be unique and will have a case ID. This is to check if this caseId is not already avialable.

4) SEQ-2c: Save a case: Individual : Send a request for screening.

5) SEQ-4a: Screen a case : Screen the case

6) SEQ-5b: Get screening results : Get results. Let me know if this is ok or you need more information.

icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Upvotes
3.1k 18 7 7

Hi @John Williams,

There is no API request to search by any location information other than by Country.

However, currently here's how to search for address information for a case.

You first create a case (SEQ-2c) sending the name and country information (secondary fields).

Then call (SEQ-4a) the cases/{ {case-system-id}}/screeningRequest to get a list of matches.

To further investigate the matches by address (street, city, postal code, etc..) :

Call (SEQ-5b) cases/{ {case-system-id}}/results, find the match(es) with their case-id, case-system-id, worldcheck-profile-id.

Then call (SEQ-5c) reference/profile/{ {worldcheck-profile-id}} with the cases/{ {case-system-id}}/results referenceId from the name matches and then review the addresses fields in the return request.

Hope this helps,

Brian

"addresses": [
    {
      "city": "Boston",
      "country": {
        "code": "USA",
        "name": "UNITED STATES"
      },
      "postCode": "02210",
      "region": "Massachusetts",
      "street": "22 Thomson Place"
    },
    {
      "city": "St Paul",
      "country": {
        "code": "USA",
        "name": "UNITED STATES"
      },
      "postCode": "55123",
      "region": "Minnesota",
      "street": "610 Opperman Dr"
    },
]

Like 0 Add comment Share

icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.