Skip to main content

Preview case eligibility and requirements

POST 

/cases/preview

Preview what would happen if you submitted a case, without actually creating it.

What This Endpoint Returns:

  • IsEligible - Whether the case can be submitted (partner available)
  • PartnerAssignment - Which collection partner would handle the case
  • RequiredActions - What contracts/documents need to be signed before submission
    • Standard Debt Collection Agreement (SDCA)
    • Power of Attorney (PoA) for the assigned partner
  • PricingPreview - Estimated success fee with age-based surcharges
  • Jurisdiction - Geographic details

Use This To:

  1. Check if a jurisdiction is supported before submitting
  2. Determine which documents need signing before case creation
  3. Get signing URLs to guide users through required actions
  4. Estimate pricing including age surcharges

Required Fields:

  • AmountToRecover - Total principal amount
  • CurrencyCode - ISO 4217 currency code (e.g., 'DKK', 'EUR', 'USD')
  • Debtor.Type - 'Company' or 'Private'
  • Debtor.CountryAlpha2 - ISO 3166-1 alpha-2 country code
  • Debtor.StateAlpha2 - Required for US cases only (e.g., 'CA', 'NY')

Optional Fields (Multi-Invoice Age Pricing):

  • AmountToRecoverOver12Months - Portion over 12 months overdue
  • AmountToRecoverOver24Months - Portion over 24 months overdue (Both must be provided together if used)

Solution URLs Are Context-Aware:

  • Bearer token (referral partner) → referral onboarding URLs
  • XApiKey (creditor) → standard creditor app URLs

Important Notes:

  • This endpoint does NOT create a case - it only previews what would happen
  • The preview uses the same eligibility logic as POST /cases
  • If multiple partners match (system limitation), the first match is returned
  • All required actions must be completed before calling POST /cases

Example Workflow:

1. POST /cases/preview → Check eligibility and get signing URLs
2. User completes required actions (signs SDCA, signs PoA)
3. POST /cases → Create the actual case

Request

Responses

Preview completed