Profile details after case is created

rudy.seidinger

Hello.

We have started implementing integration with your API and this integration requires us to have available some specific profile properties such as primaryName, birthDate, gender and locations and specific match information (referenceId, matchStrength, matchedTerm, ...)

When we first create the case for synchronous screening, via the POST /cases/screeningRequest endpoint, we receive all (profile and match) required information back for each of the matches found.

The problem for us happens afterwards. After revisiting the case, we use GET /cases/{caseSystemId} to retrieve the created case. This request's response includes partial information previously included about the profiles on the request above, such as referenceId, matchStrength and matchedTerm, but it doesn't include other crucial information for us, such as primaryName, birthDate or gender.

I understand that the only way of retrieving this additional information is through, then, performing an additional request for each one of the profiles to GET /reference/profile/{id}.

Is this correct or do we have a less intrusive way of retrieving these profiles information in batch or something similar? Is there a better workflow for retrieving the same information retrieved by the synchronous screening again?

Thank you

Irfan.Khan

@rudy.seidinger

GET /cases/{caseSystemId} is an API call to fetch the case details only but not the match details of the case.

Please use the API call "SEQ-case-investigate-results: Get screening results" : GET cases/{{case-system-id}}/results to fetch the screening results of the case whose results you would like to view. Please be sure to use the correct case system Id to query the results.

When you request this API call, you may see less information that the endpoint "POST /cases/screeningRequest " but you should have most of the attributes you are looking for.

To fetch the complete profile of a match, there is no batch way of pulling all the WC profiles of all the matches of a case in a single API call. You will have to extract the referenceId of all the matches and repeatedly call the API "GET:reference/profile/{{worldcheck-profile-id}}" for each of the extracted referenceId/profile Id.

rudy.seidinger

Thank you @Irfan.Khan. I can confirm we're actually using the GET cases/{{case-system-id}}/results to fetch the created case, my mistake on mentioning the other one...

Unfortunately, it doesn't have the information we require, so additional requests to the Profile API are needed, as you said.