This guide outlines the steps to create a case in our system. Each step involves specific API calls and data handling procedures. Follow these steps sequentially to ensure successful case creation.
1

Select or create insurance contacts

Use the Insurance Contacts endpoints to find existing contacts or create new ones required for this case.
2

Select or create an insured or insured group

Use the Insureds and Insured Groups endpoints to either create a new insured or insured group, or find an existing one. Use the insured ID in the case creation step.
3

Select a program

Select a program via the Programs endpoints to obtain the program ID. Additionally, retrieve available certificate holders, asset types and service types associated with the program for use in the case creation step.
4

Create a case

Create the case with the Cases endpoints. This is where you define the core attributes of the case, including the insureds, the program under which the case is issued, the associated insurance contacts, and the certificate holders.
5

Fetch required fields by asset type

Before creating assets, fetch the required fields using the Asset Types endpoints. You will need the asset type ID and the case ID or program ID for this step.
6

Create assets

Create the assets for the case using the Assets endpoints.
If the case is post-close, you will need to provide all the required fields. For pre-close cases, providing the address field is the minimum requirement.
7

Create documents (optional)

Documents are not required to create or publish a case. Skip this step entirely unless you are attaching documents — and when the case’s providingDocuments is false, it does not apply at all.
If you are attaching documents, use the Documents endpoints to request signed upload URLs, upload the files, and register the documents on the case.
8

Publish the case

As the final step in the process, publishing the case is crucial. Use the publish action on the Cases endpoints to make the case available for further processing.
Browse all endpoints, parameters and example responses in the API Reference.