Sign in

d0dcc5024bd1

latestOpenAPI 3.0.42026-08-104969330.3 KB
Cases

Activate a case from PendingVerification

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.

post/cases/{id}/start

Path parameters

idstring uuid required

Request body

welcomeMessagestring required

Welcome message sent to the creditor upon case activation. This message is included in the email notification sent to the creditor and posted in the case chat.

userIdstring uuid nullable

ID of the team member who is sending this welcome message and activating the case. Used to attribute the chat message and email communication. Must be a valid user ID from GET /users. Returns 400 if the user is not found in your team. Deprecated: use UserEmail instead. At least one of UserId or UserEmail must be provided.

userEmailstring email nullable

Email address of the team member who is sending this welcome message and activating the case. Must correspond to an active member of your team. Preferred over UserId. At least one of UserEmail or UserId must be provided.

collectionPartnerReferencestring nullable

Your internal reference number for this case (optional). Stored on the case and visible in the partner portal.

assignedUserIdstring uuid nullable

ID of the team member to assign as the case handler (optional). Can be the same as UserId or a different team member. Must be a valid user ID from GET /users. Returns 400 if the user is not found in your team. Deprecated: use AssignedUserEmail instead.

assignedUserEmailstring email nullable

Email address of the team member to assign as the case handler (optional). Must correspond to an active member of your team. Preferred over AssignedUserId.

interestFeesnumber double

Interest fees on this case, in the case currency. Defaults to 0.00 if not provided.

reminderFeesnumber double

Reminder fees on this case, in the case currency. Defaults to 0.00 if not provided.

collectionFeesnumber double

Collection fees on this case, in the case currency. Defaults to 0.00 if not provided.

Example request

{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "welcomeMessage": "We have received your case and will begin collection proceedings. You will receive regular updates on progress.",
  "collectionPartnerReference": "GET-2025-0042",
  "assignedUserId": null,
  "interestFees": 0,
  "reminderFees": 100,
  "collectionFees": 0
}

Response

Case activated successfully

caseIdstring uuid

The case ID.

caseReferencestring nullable

The Debitura case reference (e.g. 'Q8OAXF3W').

statusstring nullable

The new lifecycle status of the case.

activatedAtstring date-time

UTC timestamp when the case was activated.

collectionPartnerReferencestring nullable

Your internal reference number for this case, if provided.