Skip to main content

Create collection case

POST 
/cases

Creates a new collection case for debt collection.

Test Mode:

  • Set isTest=true to create a test case (case IS created in the database but marked as test data)
  • Test cases are excluded from production metrics and can be easily filtered or deleted
  • Use test mode for integration testing and development

Debtor Rules:

  • debtor.type must be "Company" or "Private"
    • Company → debtor.name is mandatory (company name)
    • Private → debtor.name is mandatory (person's full name)

Geographic Rules:

  • debtor.countryAlpha2 (ISO 3166-1 alpha-2) is always required
  • debtor.state is a free-text region description
  • For US debtors: debtor.stateAlpha2 (two-letter state code) is also required – debtor.state is ignored in that scenario

Optional Parameters:

  • creditorDivisionId - Assign case to a specific division (for multi-division creditors)
  • collectionPartnerId - Override automatic partner assignment with a specific collection partner
  • skipDebituraVerification - Skip internal verification steps (advanced use)
  • skipCreationEmails - Suppress email notifications to debtor and partners
  • ignoreContractRequirements - Bypass contract validation checks (requires special permissions)

Error Responses:

  • 400: Field validation errors (returns JSON object with field names as keys and error arrays as values)
  • 422: Business rule violations (returns BusinessErrorResponseApiDTO with type, message, and solutionUrl)
  • 500: Server errors

Request​

Responses​

Case created