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

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
3 0 1 1

What is a Group ID in WC1 API? How is the OGS call considered with the number of searches?

What is Group ID in WC1 API system? When I tried using the postman collection API and ran a API call. Group ID details were filled automatically. Will it the same way when the call is done in WC1 Live system?

With the number of searches allowed with OGS, lets say if we have around 5000 names to be screened using OGS API option, will that be considered as a single API call or it will considered for 5000 API calls in WC1 system.

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.

1 Answer

Upvotes
Accepted
4.5k 4 8 8

@ramya.varrier,

Thank you for your query.

Groups in World-Check can be created for separation of Admin settings and the restuls are returned according to the group settings. You may refer to the following link to get more details on Group Administration.

Group-id is manditory for screening a case. The group-id is filled automatically in postman, the same will not happen in your application. You will have to fetch the group details and then use the group-id which you want to use for screening.

As of now you can screen a single name using 1 API call, for enabling the OGS on the same, you will have to use another API call. So you will have to use 5000 screening request to screen the case and another 5000 API calls to enable OGS.

We do have version 2 release later this month, which will provide the functionality to bulk screen the cases with maximum of 50 entities / cases in 1 API call and it will also have the feature to enable the case for OGS using the same API call. This would help you to cut down on the total number of API calls.

Please let us know if you have further queries related to it.

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.