Skip to main content

Activate a case from PendingVerification

POST 
/cases/:id/start

Transitions a case from PendingVerification → Active, officially accepting it for debt collection.

Prerequisites:

  • The case must be in PendingVerification status (returns 400 otherwise)
  • The case must not require custom terms (non-standard agreement). Cases outside the standard pre-legal scope — where the claim type is not an unpaid invoice or loan repayment, or where a dispute exists — require negotiation in the partner portal and cannot be activated via this API (returns 400 with a descriptive error).
  • The userId must be a valid user ID from GET /users belonging to your team (returns 400 if not found)
  • The assignedUserId, if provided, must also be a valid user ID from GET /users belonging to your team (returns 400 if not found)

What happens on activation:

  1. Case lifecycle transitions to Active
  2. A welcome message is sent to the creditor via email notification, attributed to the user identified by userId
  3. The welcome message is posted as a chat message in the case thread, attributed to the user identified by userId
  4. Any pending verification tasks are automatically resolved

Fee fields: The interestFees, reminderFees, and collectionFees fields update the corresponding fee amounts on the case, in the case currency. Default to 0.00 if not provided.

userId vs assignedUserId: userId is required and identifies who is sending the welcome message (the actor). assignedUserId is optional and identifies who the case is assigned to for ongoing handling. They can be the same person or different team members. Use GET /users to retrieve valid user IDs.

Request​

Responses​

Case activated successfully