Skip to main content

​
Can I create a case without it starting to process immediately?

Yes. By default, creating a case will automatically start processing all its associated checks. You can override this behavior by setting start: false in your POST /api/cases/ request. This creates the case and checks in a pending state. You can then trigger processing later by making a POST request to the /api/cases/{id}/start/ endpoint. This is useful for workflows where you need to add more checks or data before processing begins.

​
How do I use documents with cases and checks?

You can create checks and cases with pre-uploaded documents. The workflow is:
  1. Upload documents first using POST /api/documents/. You can link it to a customer_id for reusable documents.
  2. Create your case or check and reference the document IDs by including a document_ids array in your request.
  3. The documents will be automatically linked.
For cases, you can also link documents to individual checks within the checks array. Documents can be associated with a Case, Check, or Customer, but only one at a time. Here’s a guide:
  • Link to a Case: For general documents related to the entire workflow. This is the recommended starting point.
  • Link to a Check: For documents specific to one check, like a proof of address. This can lead to faster, more focused processing.
  • Link to a Customer: For documents you want to reuse across multiple cases for the same customer.
When uploading, you must provide exactly one of case_id, check_id, or customer_id.

​
How long does processing take?

Sphinx is fast, but not instant. Here are some typical processing times:
  • AML Checks: A set of watchlist checks (Sanctions, PEPs, Adverse Media) on an individual usually takes about 90 seconds.
  • Full KYB: A full Know Your Business (KYB) investigation can take around 4 minutes.
Times are estimates and can vary with system load and case complexity.

​
How does the API interaction model work?

Cases act as containers, but most API interactions happen at the Check level. You create a Case, then add Checks to it. The processing and results are primarily managed through Check objects.

​
How granular should my checks be?

A Check represents a single verification, alert, or hit. For complex investigations like KYB, each distinct part of the process (e.g., verifying a UBO, checking web presence) should be a separate Check within the Case. Never combine multiple hits into a single check.

​
Are documents always required for a check?

No. For example, a sanctions screening can be performed using only the name and date of birth from the Customer object, without any supporting documents. The alert details (for example, for a sanctions hit it would be the personal details and potentially a link to the source) are required though.

​
How does data deletion work?

Sphinx supports the right to be forgotten via the delete_after field on Customer, Case, Check, and Document objects. Set delete_after to an integer representing the number of days until deletion (max 365). For immediate deletion after processing, use delete_after: 0. Once scheduled, deletion cannot be cancelled.