White-Label UI

Debitura's branded onboarding experience for your clients.

Overview

The white-label referral UI handles client-facing flows that require user interaction:

• Onboarding — New clients complete company details and sign agreements
• Linking approval — Existing clients approve connection to your platform
• Contract signing — Sign or refresh the Standard Debt Collection Agreement (SDCA)
• Power of Attorney — Sign jurisdiction-specific PoA documents

These flows are hosted by Debitura but branded with your logo, colors, and fonts.

When It's Used

The white-label UI is triggered when:

Scenario	API Response	Action
New client needs onboarding	202 Accepted	Present onboarding URL
Existing client needs to approve link	409 ClientExistsNeedsLinking	Present approval URL
Case blocked by missing contract	422 with solutionUrl	Present signing URL
Case blocked by missing PoA	422 with solutionUrl	Present PoA signing URL

URL Structure

URLs are returned by the Referral Partner API and Customer API:

https://referral.debitura.com/companydetails/{linkId}
https://app.debitura.com/referralpartner/approve?token={approvalToken}
https://referral.debitura.com/ContractUpgrade/Sign/{linkId}
https://referral.debitura.com/PowerOfAttorney/Sign/{linkId}?collectionPartnerId={partnerId}

Adding Return URLs

Redirect clients back to your platform after completing a flow:

{baseUrl}?returnUrl=https://yourapp.com/done

URL Encoding Required

If your return URL contains query parameters, encode it:

const returnUrl = encodeURIComponent('https://yourapp.com/done?status=complete');
const fullUrl = `${onboardingUrl}?returnUrl=${returnUrl}`;

After completion, the user sees a "Go Back to Your App" button that links to your return URL.

Branding

Your white-label appearance is configured during partner onboarding:

Element	Configuration
Logo	Uploaded to Debitura
Background color	Hex code (e.g., #EF683C)
Font color	Optional override
Font family	Optional override

Verify your branding via the /me endpoint:

{
  "companyName": "Your Platform",
  "logoUrl": "https://debiturapublicassets.blob.core.windows.net/...",
  "backgroundColorCode": "#EF683C"
}

Handling Signing Flows

When a case is blocked by a missing signature, the API returns 422 with a solutionUrl:

{
  "businessErrors": [
    {
      "type": "MissingPowerOfAttorney",
      "message": "Power of attorney not signed with partner X.",
      "solutionUrl": "https://referral.debitura.com/sign-poa/..."
    }
  ]
}

Recommended handling:

1. Show a clear in-app message: "Action required before submitting this case"
2. Open the solutionUrl (or redirect the client)
3. After signing completes, retry the case submission

This can happen at any time—first case in a new jurisdiction, contract updates, or PoA renewal. Build it as a reusable flow.

Important Notes

• Debitura does not send emails for referral partner flows. You must present URLs to your clients.
• Link requests expire after 7 days if not approved.
• Test environment uses testreferral.debitura.com instead of referral.debitura.com.

Related

• Client Onboarding — Full onboarding workflow
• Environments — Test vs production URLs
• Error Handling — Understanding 422 responses