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

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
otkachova avatar image
5 ●2 ●2 ●3

API. Missed customFields in the response to "SEQ-pre-group-case-template: Get the case template for a group" request.

The custom-fields-1, custom-fields-2, custom-fields-3 required to the SEQ-screen-sync-individual: Perform Synchronous Screening: Individual request cannot be retrieved from customFields in the response to the "SEQ-pre-group-case-template: Get the case template for a group".

Could you assist me how to get custom-fields-1, custom-fields-2, custom-fields-3?

Used environment: Postmen

The logs:

{"groupId":"0a3687cf-6523-1d64-994c-e13c000002c8","groupScreeningType":"CASE_MANAGEMENT_AUDIT","customFields":[],"secondaryFieldsByProvider":{"watchlist":{"secondaryFieldsByEntity":{"individual":[{"typeId":"SFCT_1","fieldValueType":"GENDER","regExp":null,"fieldRequired":false,"label":"GENDER"},{"typeId":"SFCT_2","fieldValueType":"DATE","regExp":null,"fieldRequired":false,"label":"DATE_OF_BIRTH"},{"typeId":"SFCT_3","fieldValueType":"COUNTRY","regExp":null,"fieldRequired":false,"label":"COUNTRY_LOCATION"},{"typeId":"SFCT_4","fieldValueType":"COUNTRY","regExp":null,"fieldRequired":false,"label":"PLACE_OF_BIRTH"},{"typeId":"SFCT_5","fieldValueType":"COUNTRY","regExp":null,"fieldRequired":false,"label":"NATIONALITY"}],"vessel":[{"typeId":"SFCT_7","fieldValueType":"TEXT","regExp":"[0-9]{7}","fieldRequired":false,"label":"IMO_NUMBER"}],"organisation":[{"typeId":"SFCT_6","fieldValueType":"COUNTRY","regExp":null,"fieldRequired":false,"label":"REGISTERED_COUNTRY"}]}},"passportCheck":{"secondaryFieldsByEntity":{"individual":[{"typeId":"SFCT_8","fieldValueType":"TEXT","regExp":".{0,1000}","fieldRequired":true,"label":"PASSPORT_GIVEN_NAMES"},{"typeId":"SFCT_9","fieldValueType":"TEXT","regExp":".{0,1000}","fieldRequired":true,"label":"PASSPORT_LAST_NAME"},{"typeId":"SFCT_10","fieldValueType":"GENDER","regExp":null,"fieldRequired":true,"label":"PASSPORT_GENDER"},{"typeId":"SFCT_11","fieldValueType":"STATE","regExp":null,"fieldRequired":true,"label":"PASSPORT_ISSUING_STATE"},{"typeId":"SFCT_12","fieldValueType":"STATE","regExp":null,"fieldRequired":true,"label":"PASSPORT_NATIONALITY"},{"typeId":"SFCT_13","fieldValueType":"DATE","regExp":null,"fieldRequired":true,"label":"PASSPORT_DATE_OF_BIRTH"},{"typeId":"SFCT_14","fieldValueType":"PASSPORT_DOCUMENT_TYPE","regExp":null,"fieldRequired":true,"label":"PASSPORT_DOCUMENT_TYPE"},{"typeId":"SFCT_15","fieldValueType":"TEXT","regExp":"^[a-zA-Z0-9<]{0,1000}$","fieldRequired":true,"label":"PASSPORT_ID_NUMBER"},{"typeId":"SFCT_16","fieldValueType":"DATE","regExp":null,"fieldRequired":true,"label":"PASSPORT_DATE_OF_EXPIRY"}]}}},"mandatoryProviderTypes":["WATCHLIST"]}

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

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

1 Answer

Upvote
Accepted
Mehran.Ahmed Khan avatar image
2.4k ●5 ●5 ●5

@otkachova

Hi,

World-Check One provides the functionality of passing custom fields as part of your request payload for our customers to track additional details at their end, the custom fields are solely for use at your end, the fields that you set will not contribute in screening against World-Check one data,

Below is an example payload with a custom filed for your reference,

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{ "groupId": "{ {group-id}}", "entityType": "INDIVIDUAL", "providerTypes": [ "WATCHLIST" ], "name": "Donald Trump", "customFields": [{ "typeId": "CUSTO_9" }, { "value": "Bc1234" } ], "secondaryFields": [{ "typeId": "SFCT_1", "value": "MALE" }, { "typeId": "SFCT_2", "dateTimeValue": "1961-12" }, { "typeId": "SFCT_3", "value": "USA" }, { "typeId": "SFCT_4", "value": "USA" }, { "typeId": "SFCT_5", "value": "ABW" } ] }

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

For a custom filed you will have to define you own typeID and its curresponding value compared to the secondary fields that World-Check One provides in your case template.

If you wish to not include custom fields in your request payload you can just delete them from your request payload and pass the request.

Let me know if this resolves your issue and feel free to reach out if you need further assistance on this.

Regards,

Mehran Khan

icon clock
10 |1500

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

Click below to post an Idea Post Idea