Monitoring case file status

Once a case file has been created and sent for signing, it progresses through various stages. To ensure your system is always up-to-date and can trigger necessary subsequent business logic, you need an effective way to monitor the status of these case files.

The case file statuses possible values are described below.

// Case file statuses

// 0 : 'new' 
// 1 : 'pending' 
// 2 : 'rejected' 
// 3 : 'deleted' 
// 4 : 'signed' 
// 5 : 'completed' 
// 6 : 'failed'
// 7 : 'expired'
// 8 : 'anonymized'

Strategies for receiving status updates

Webhooks (Recommended)

Webhooks provide a reactive, efficient, and real-time mechanism for status monitoring. With this strategy, you register a specific URL with our system. When a significant event occurs (e.g., a case file is completed), we notify you instantly by sending a data payload to your registered URL. This eliminates the need for constant checking, making it the most resource-friendly and robust choice for production environments.

Polling

Polling is a proactive method where your system initiates the request to check the current status of a case file. This involves repeatedly calling a specific API endpoint at regular intervals to see if the status has changed. While simpler to implement initially, polling can lead to inefficient resource use (for both your system and ours) and may result in a slight delay in receiving status updates.