Each example shows a complete GraphQL request, the variables sent with it, and the response the API returns. GraphQL allows you to specify which fields are returned for your query, so these examples can be adjusted with more of fewer fields based on the schema.
Send every request as a POST to the /graphql endpoint of your environment, with an access token as described in Tokens.
Getting started
- Identify the authenticated API client - Confirm your credentials work and discover which organizations you can access.
Creating cases
- Create a case for individuals - Open a case for new and previously verified individuals.
- Create a case for a new entity - Open a case for an entity that has not been verified before.
- Create a case for a new entity with a registration authority - Open a case for a German, US or Canadian company, specifying its registration authority.
- Create a case for an existing entity - Open a case for a previously verified entity.
Case status
- Submit a draft case - Move a draft case to in progress.
- Complete a case - Mark a case as completed.
- Rework a case - Move a case back to in progress.
- Abandon a case - Mark a case as abandoned.
Querying cases
- Query a case - Fetch a case with its organization, office, individuals and entities.
- Read verification results - Find the verification decision for each individual and entity on a case.
- Read a risk assessment - Fetch the risk level and completed risk assessment for a case.
- Search cases - Find cases matching a search term, one page at a time.
- Fetch the next page of cases - Continue a search using the cursor from the previous page.
Updating cases
- Add individuals to a case - Add new individuals to an existing case.
- Add a note to a case - Add a note to an existing case.
- Update a case reference - Change the client-assigned reference on a case.
Assigning users
- List users - Find the users in your organization and offices that can be assigned to cases.
- Assign users when creating a case - Open a case with users already assigned to it.
- Assign users by email when creating a case - Open a case with users assigned by their email addresses.
- Assign users to an existing case - Assign more users to a case without changing its current assignees.
- Unassign users from a case - Unassign users from a case without changing its other assignees.
Webhooks
- Subscribe to webhook events - Receive events when cases change.
- Add a webhook subscription target - Receive events for the whole organization or an office.
- Remove a webhook subscription target - Stop receiving events for an organization or office.
- Delete a webhook subscription - Stop receiving webhook events.
Profiles
- Query an individual profile - Fetch the profile that links every record of an individual across cases.
- Query an entity profile - Fetch the profile that links every record of an entity across cases.
- Search individual profiles - Find individual profiles by name, email or phone.
- Search entity profiles - Find entity profiles by name or identifier.
- Turn on ongoing monitoring - Monitor a profile for new screening hits.
- Turn off ongoing monitoring - Stop monitoring a profile for new screening hits.
- Deactivate a profile - Mark a profile as inactive.
- Reactivate a profile - Mark an inactive profile as active again.
Custom fields Preview
- List custom fields - Find the custom fields your organization has defined and the records they apply to.
- Read custom field values - Fetch the custom field values on a case or profile.
- Set custom fields when creating a case - Open a case with custom fields set on it and on its individuals’ profiles.
- Set a custom field on a case - Replace the value of one custom field on a case.
- Set a custom field on a profile - Replace the value of one custom field on an individual or entity profile.
- Clear a custom field - Remove the value of a custom field from a case or profile.
- Search cases by custom field - Find cases with particular custom field values.
- Search profiles by custom field - Find individual or entity profiles with particular custom field values.
