World-Check One API async Screening Steps
For successful screening of the entity types such as individuals, organizations, vessels and unspecified do the following steps. These are identified as the best sequence of API calls to screen the case.
Step 1) SEQ-pre-groups: Get my top-level groups
This API is used to find the group ID that you would like to select to screen a case. The response of this API call can be cached if you are planning not to delete group IDs from WC1 UI but it is always recommended to call this every day. If there are any changes in the groups' section in the UI, you must call this API to get the list of updated group IDs. See the Client Administrator Getting Started Guide in the Documentation tab for more information on how to create and delete groups.
Step 2) SEQ-pre-group-case-template: Get the case template for a group
The case template is basically a blueprint which contains the custom fields and secondary fields that you can use while calling the SEQ-case-create-individual: Save a case: Individual/SEQ-case-create-organization: Save a case: Organization/SEQ-case-create-vessel: Save a case: Vessel/SEQ-case-create-unspecified: Save a case: Unspecified. When you call the API SEQ-pre-group-case-template: Get the case template for a group, it provides you with all the custom fields and secondary fields that can be used to screen an individual or an organization. You can include them in the API SEQ-case-create to make your screening more accurate. These custom fields and secondary fields correspond to the ones available in the WC1 UI. You can add custom fields or remove custom fields using the UI and this will be reflected in the response of the API SEQ-pre-group-case-template.
Step 3) SEQ-pre-country-list: Get the ISO country list
This provides a list of country ISO that can be used in the SEQ-case-create-individual: Save a case: Individual/SEQ-case-create-organization: Save a case: Organization to fill the secondary fields like Nationality, Place of birth (for individuals) and registered country (for organizations). This API call can be cached but it is not recommended to cache for a long time as the data may later.
Step 4) SEQ-case-create-individual: Save a case: Individual/SEQ-case-create-organization: Save a case: Organization/SEQ-case-create-vessel: Save a case: Vessel/SEQ-case-create-unspecified: Save a case: Unspecified
Call this API to save the case and to get the case ID and system case ID.
Step 5) SEQ-screen-async: Screen a case
This API call finally screens the case using the system case ID obtained after saving the case. The response code received is “201 Created” with no content, that means the case has been added to the queue and will be screened eventually.
Step 6) SEQ-case-audit: Retrieve the audit log for a case
Call this API to retrieve the audit details of the case. If the response body of this API contains a key “actionType” and its value “SCREENED_CASE”, it means that the case has been screened and the user can proceed to see the matches populated due to screening in step 5. This API has a filter in its payload which can be used to get only specific information about the case. Refer the API documentation in the Documentation tab to know more about how to use this API.
Step 7) SEQ-case-investigate-results: Get screening results
Call this API to get the screening results of the case using the system case Id.
Step 8) SEQ-case-investigate-world-check-profile: Get a World-Check profile
This API enables you to pull the World Check profile of the matches/results found in step 4. This helps you to make an informed decision about resolving hits.