Debitura Referral Partner API
For platforms embedding collection as a referral. Setting up clients, previewing cases, tracking revenue share, and minting bearer tokens through OAuth operations. 22 operations across 17 paths, OpenAPI 3.0.4 with 81 component schemas. Authenticates with an API key in the XApiKey header.
This API exposes 22 operations across 17 paths, organized into 9 resource areas, and defines 81 schemas. It is described by OpenAPI 3.0.4, at version v1.
Requests are made against a single base URL, https://referral-api.debitura.com.
22 operations
17 paths
81 schemas
2 DELETE11 GET8 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Debitura Referral Partner API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as XApiKey (ApiKey).
By default, every request must be authenticated.
ApiKey— Referral Partner API Key (use XApiKey header)
Paths & Operations 22
Across 17 paths, the API surfaces 22 operations — 2 DELETE, 11 GET, 8 POST, 1 PUT. They span 9 resource areas: Cases, Clients, Coverage, FilterOptions, OAuth, PreviewCases, ReferralPartners, Reporting, Webhooks. Each is listed below with its method, path, parameters, and response codes.
Cases 3
Cases
GET
/cases
List cases for referral partner clients
GET
/cases/{id}
Get case detail with potential revenue breakdown
POST
/cases/{caseId}/files
Upload a file to a case. Optionally posts a system chat message to notify the collection partner.
Clients 7
Clients
POST
/clients
Create and onboard a new client
GET
/clients
List all linked clients
GET
/clients/{externalTenantId}
Get client by external tenant ID
DELETE
/clients/{externalTenantId}
Reset a client (test environment only)
GET
/clients/{externalTenantId}/is-deletable
Check if a client can be deleted (test environment only)
POST
/clients/{externalTenantId}/withdraw
Withdraw an attributed client
POST
/clients/{externalTenantId}/kyc-verification
Submit KYC verification for a client
Coverage 1
Coverage
GET
/coverage
List all jurisdiction coverage
FilterOptions 1
Referral Partners
GET
/referral-partner/filter-options
Get available filter options for cases and earnings
OAuth 1
POST
/oauth/token
Get OAuth access token
PreviewCases 1
Cases
POST
/cases/preview
Preview case pricing
ReferralPartners 1
Referral Partners
GET
/me
Get authenticated partner information
Reporting 1
Reporting
GET
/reporting/transactions
Get transaction-level revenue data
Webhooks 6
GET
/v1/Webhooks
Get all webhooks for the authenticated referral partner
POST
/v1/Webhooks
Create a new webhook subscription
GET
/v1/Webhooks/{id}
Get a specific webhook by ID
PUT
/v1/Webhooks/{id}
Update an existing webhook subscription
DELETE
/v1/Webhooks/{id}
Delete a webhook subscription
POST
/v1/Webhooks/test
Trigger a test webhook event (test environment only)
Schemas 81
The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto (37 properties), Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateCollectionCaseRequestApiViewModel (20 properties), Debitura.Web.ReferralPartnerApi.Models.Cases.GetCaseDetailResponse (19 properties), Debitura.Web.ReferralPartnerApi.Models.Cases.CaseItem (18 properties). Each schema is shown below with its type and property counts.
Debitura.Domain.Model.Base.PageData
object
Paging metadata describing a paged result set.
5 properties
Debitura.Domain.Model.CollectionPartnerLogics.CollectionPartners.SurveyCadenceMode
integer
Controls which surveys are generated for cases assigned to this collection partner.
Debitura.Domain.Model.Core.InvoicePayments.PlatformInvoicingStatus
integer
Tracks the invoicing lifecycle for platform fees charged to collection partners.
Debitura.Domain.Model.Creditors.CreditorKycVerifications.CreditorKycVerificationStatus
string
Partner/staff-settable review status for a Debitura.Domain.Model.Creditors.CreditorKycVerifications.CreditorKycVerification record. Distinct from the ReferralP…
Debitura.Domain.Model.InvoicePayments.Payouts.Enums.PayoutCommissionPaymentStatus
integer
Debitura.Domain.Model.ReferralPartners.Enums.InvoicingTriggerMode
string
Controls what condition triggers a referral partner's payout to become "ready to invoice" Debitura for their referral fee. Per-partner override; see Debitura.D…
Debitura.Domain.Model.ReferralPartners.Enums.ReferralInvoicingStatus
integer
Tracks the invoicing and payment status for referral fees owed to referral partners. This is separate from collection partner invoicing (PlatformInvoicingStatu…
Debitura.Domain.Model.Webhooks.Dtos.CreateWebhookRequest
object
Request to create a new webhook subscription.
3 properties
2 required
Debitura.Domain.Model.Webhooks.Dtos.UpdateWebhookRequest
object
Request to update an existing webhook subscription.
5 properties
Debitura.Domain.Model.Webhooks.Dtos.WebhookDto
object
Represents a webhook subscription configuration.
9 properties
Debitura.Domain.Services.CaseValidation.CaseValidationItemDto
object
A single creditor-facing action item within Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto.
2 properties
Debitura.Domain.Services.CaseValidation.CaseValidationLeanDto
object
Lean validation summary exposed on list endpoints of the External Customer API and Collection Partner API. Contains only Debitura.Domain.Services.CaseValidatio…
1 property
Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto
object
Sanitized, creditor-safe projection of a case's current validation status. Safe to expose on any external surface — never contains Rationale, InternalValidatio…
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.AssignedUserDto
object
Represents the creditor team member assigned to a case.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BankAccountDto
object
Bank account information for partner API. Full details provided as partners need this to: 1. Provide payment instructions to debtors (when debtor pays client d…
16 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorApiDTO
object
Represents a business error in the API response.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorResponseApiDTO
object
Response returned when business rule violations prevent case creation.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CollectionPartnerDto
object
V1 Collection Partner DTO for external partner APIs
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CreditorDivisionDto
object
Creditor division information for external partner APIs. Represents a specific division or department within a creditor organization.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CreditorDto
object
Creditor (client) information for external partner APIs. Represents the party that the debtor owes money to.
11 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.DebtorDto
object
V1 Debtor DTO for external partner APIs. The debtor is the party that owes the debt.
13 properties
2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceAllocationOutstandingDto
object
Additive external-API read model. Per-bucket outstanding on the debt ledger, produced by the payment allocation engine (bucket total minus Σ active stored allo…
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto
object
V1 Invoice DTO for external partner APIs
37 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.JurisdictionDto
object
Geographic jurisdiction information for the case.
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.PricingPreviewDto
object
Estimated pricing for the case, including age-based surcharges.
6 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateCollectionCaseRequestApiViewModel
object
20 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.PreviewCaseRequestApiViewModel
object
Request model for previewing case eligibility, partner assignment, and required actions before actually creating a collection case. This endpoint allows you to…
8 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.PreviewDebtorDto
object
Simplified debtor information for case preview. Only includes the minimum fields required for partner routing and eligibility checking.
3 properties
2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.SigningHandoffDto
object
Partner-facing handoff metadata for a creditor's pending signing chain. Returned on POST /cases responses (422 with pending-signing errors, or 200 with AllowPe…
1 property
Debitura.Web.ExternalApi.Contracts.V1.Errors.ApiErrorResponseDto
object
Generic structured error response for API endpoints. Dual-write design: existing fields (Debitura.Web.ExternalApi.Contracts.V1.Errors.ApiErrorResponseDto.Error…
3 properties
Debitura.Web.ReferralPartnerApi.Models.AccessTokens.AccessTokenResponse
object
Response containing a short-lived JWT bearer token for accessing the Customer API.
5 properties
Debitura.Web.ReferralPartnerApi.Models.AccessTokens.CreateAccessTokenRequest
object
Request to generate a short-lived access token for accessing the Customer API on behalf of a linked client.
1 property
1 required
Debitura.Web.ReferralPartnerApi.Models.Cases.CaseClientInfo
object
Client (creditor) info with referral-partner-specific ExternalTenantId.
4 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CaseDebtorInfo
object
Debtor info for the case.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CaseItem
object
A debt collection case as seen by a referral partner. Follows the same field conventions as InvoiceDto (ExternalApi.Contracts) but scoped to what referral part…
18 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CasePotentialRevenue
object
Breakdown of potential revenue if the full case amount is collected. All amounts are in USD; percentages are displayed as whole numbers (e.g. 9.5 = 9.5%).
7 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CasesSummary
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.ClientContacts
object
Contact information for a client, including the original onboarding user, the company office email, and all other users linked to the creditor.
3 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.ContactUser
object
A user contact associated with a creditor.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.GetCaseDetailResponse
object
Response model for retrieving a single case with potential revenue breakdown. Extends CaseItem fields with revenue data for referral partners.
19 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.GetCasesResponse
object
Response model for listing cases linked to a referral partner
3 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.LifecycleBreakdown
object
4 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.PendingActionDto
object
A single pending action that may need to be completed before cases can be successfully submitted. Returned as part of the structured PendingActions array on th…
3 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.PendingActionType
string
Type of action that may need to be completed by the creditor before (or as part of) submitting cases via the referral partner API. New values may be added in f…
Debitura.Web.ReferralPartnerApi.Models.Cases.ReferralPartnerPreviewCaseResponse
object
Response from the Referral Partner pricing preview endpoint. Returns eligibility, jurisdiction, estimated success fee pricing, and any actions that the credito…
7 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.CaseCreationFailure
object
Represents a failed case creation attempt during multi-case client creation.
6 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientCaseStats
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientCreatedResponse
object
11 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientDeletableResponse
object
Response indicating whether a client can be deleted.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientDetailsDto
object
9 properties
3 required
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientUserDto
object
3 properties
2 required
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientsSummary
object
5 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ConflictResponse
object
Response returned when a conflict occurs during client creation
3 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.CreateClientRequest
object
4 properties
3 required
Debitura.Web.ReferralPartnerApi.Models.Clients.CreditorDto
object
8 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.GetClientsResponse
object
Response model for listing clients linked to a referral partner
3 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.KycStatus
string
KYC (Know Your Customer) verification status for a client linked to a referral partner. Captures three distinct states that a simple boolean cannot express. Wi…
Debitura.Web.ReferralPartnerApi.Models.Clients.KycVerificationDto
object
6 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.MultiCaseResult
object
Result of creating multiple cases during client creation. Groups successful and failed case creation attempts.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.OnboardingLinksDto
object
1 property
Debitura.Web.ReferralPartnerApi.Models.Clients.SubmitKycVerificationRequest
object
3 properties
3 required
Debitura.Web.ReferralPartnerApi.Models.Clients.UserDto
object
4 properties
Debitura.Web.ReferralPartnerApi.Models.Coverages.CoverageItemApiDTO
object
7 properties
Debitura.Web.ReferralPartnerApi.Models.Coverages.PartnerCoverageApiDTO
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.ReferralPartners.FilterOptionCarveoutPartner
object
2 properties
Debitura.Web.ReferralPartnerApi.Models.ReferralPartners.FilterOptionCountry
object
2 properties
Debitura.Web.ReferralPartnerApi.Models.ReferralPartners.GetFilterOptionsResponse
object
Response model for the filter-options endpoint, providing distinct filter values available for the authenticated referral partner's cases and earnings.
2 properties
Debitura.Web.ReferralPartnerApi.Models.ReferralPartners.ReferralPartnerResponse
object
Response containing referral partner information including styling configuration.
13 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.CaseInfo
object
5 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.ClientInfo
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.EarningsInfo
object
7 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.PaymentInfo
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.RecognitionInfo
object
2 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.RevenueBreakdown
object
14 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.StatusInfo
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.TransactionItem
object
8 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.TransactionRevenueStage
integer
The 7-stage revenue lifecycle used by Debitura.Web.ReferralPartnerApi.Models.Reporting.RevenueBreakdown — one value per bucket, in the same order/naming as the…
Debitura.Web.ReferralPartnerApi.Models.Reporting.TransactionsResponse
object
Response model for transactions list
3 properties
Debitura.Web.ReferralPartnerApi.Models.Reporting.TransactionsSummary
object
2 properties
Debitura.Web.ReferralPartnerApi.Models.Webhooks.TriggerTestWebhookRequest
object
7 properties
1 required
Debitura.Web.ReferralPartnerApi.Models.Webhooks.TriggerTestWebhookResponse
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Debt Collection#Debt Recovery#Fintech#Webhook
Where this information came from
This is an independent, third-party profile of Debitura Referral Partner API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.