Debitura Customer API
For creditors. Uploading B2B and B2C invoices to collection, then tracking cases, contracts, payments and tasks through recovery. 53 operations across 44 paths, OpenAPI 3.0.4 with 81 component schemas. Authenticates with an API key in the XApiKey header or a bearer token. Carries webhooks with a paired test-webhook and test-case surface.
This API exposes 53 operations across 44 paths, organized into 12 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://customer-api.debitura.com.
53 operations
44 paths
81 schemas
4 DELETE31 GET1 PATCH16 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Debitura Customer API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as XApiKey (ApiKey).
It accepts HTTP bearer tokens (JWT) (Bearer).
By default, every request must be authenticated.
ApiKey— This is for clients who manage their own account. They can get the API key in the platform and set it as the 'XApiKey' in the header.Bearer— This is for referral partners, who are sending in clients to the platform. They get the bearer token from the referral partner Api and can be inserted here.
Paths & Operations 53
Across 44 paths, the API surfaces 53 operations — 4 DELETE, 31 GET, 1 PATCH, 16 POST, 1 PUT. They span 12 resource areas, including Cases, Contracts, Coverage, Divisions, Me, Payments, Tasks, TestCases, and 4 more. Each is listed below with its method, path, parameters, and response codes.
Cases 20
Cases
POST
/cases
Create collection case
GET
/cases
List collection cases
POST
/cases/preview
Preview case eligibility and requirements
GET
/cases/{id}
Fetch case by ID
GET
/cases/by-creditor-reference/{creditorReference}
Fetch case by creditor reference
GET
/cases/{id}/contract-status
Get contract signing status for a case
GET
/cases/case-reference/{caseReference}
Fetch case by reference
GET
/cases/{id}/timeline
Fetch case timeline
GET
/cases/{id}/chats
Fetch case chats
POST
/cases/{id}/chats
Send a chat message
GET
/cases/{id}/payments
Fetch case payments
POST
/cases/{id}/files
Upload a file to a case
GET
/cases/{id}/files
Get case files
GET
/cases/{id}/quote-requests
List quote requests for a case
GET
/cases/{id}/quote-requests/{quoteRequestId}
Get quote request details
GET
/cases/{id}/quote-requests/{quoteRequestId}/quotes
List quotes for a quote request
GET
/cases/{id}/quote-requests/{quoteRequestId}/quotes/{quoteId}
Get quote details
GET
/cases/{id}/exclusive-period
Get exclusive collection period chain
GET
/cases/{id}/validation
Get full validation detail for a case
GET
/cases/{id}/tasks
List tasks for a case
Contracts 1
Debt-collection contract status and signing URLs for your account.
GET
/contracts/debt-collection/status
Get debt collection contract status
Coverage 5
Jurisdiction coverage — query which countries and debt types Debitura can collect in, and check case eligibility.
GET
/coverage
List all jurisdiction coverage
GET
/coverage/{id}
Get jurisdiction coverage by ID
GET
/coverage/searchdeprecated
[DEPRECATED] Search for jurisdiction coverage
GET
/coverage/:searchdeprecated
[DEPRECATED] Search for jurisdiction coverage
POST
/coverage/check-eligibility
Check case eligibility and get assigned partner
Divisions 7
Divisions
POST
/divisions
Create a new division.
GET
/divisions
List divisions for the authenticated creditor.
GET
/divisions/{id}
Get a single division by ID.
PUT
/divisions/{id}
Update a division.
DELETE
/divisions/{id}
Delete a division.
POST
/divisions/{id}/archive
Archive a division.
POST
/divisions/{id}:archive
Archive a division.
Me 1
Authenticated account — verify your API key and retrieve the current creditor profile.
GET
/me
Verifies the provided authentication and returns the current Creditor profile
Payments 2
Payments
GET
/Payments
List payments
GET
/Payments/{id}
Fetch payment by ID
Tasks 1
Tasks
GET
/tasks
List your open tasks
TestCases 3
Test Cases
POST
/test/cases/{id}/advance
Advance a test case to a known lifecycle state.
DELETE
/test/cases/{id}
Hard-delete a single test case by ID.
DELETE
/test/cases
Hard-delete all test cases with the given tag.
TestWebhooks 1
Test Webhooks
POST
/test/webhooks/fire
Fire a named webhook event type for a test case.
Users 1
Users
GET
/users
Lists team members belonging to the authenticated creditor.
WebhookEvents 2
Webhook event log — list dispatched events for a case and replay individual deliveries.
GET
/webhooks/events
List webhook events dispatched for a case.
POST
/webhooks/events/{id}/replay
Replay a specific webhook event.
Webhooks 9
Manage webhook subscriptions and inspect the delivery event log. Create subscriptions to receive real-time notifications for case lifecycle events, payments, and chats. Use GET /w…
POST
/webhooks
Create a new webhook subscription.
GET
/webhooks
List all webhook subscriptions for the authenticated creditor.
GET
/webhooks/{id}
Get a single webhook subscription by ID.
PATCH
/webhooks/{id}
Update an existing webhook subscription.
DELETE
/webhooks/{id}
Delete a webhook subscription.
POST
/webhooks/{id}/test
Send a test event to the webhook endpoint.
POST
/webhooks/{id}:test
Send a test event to the webhook endpoint.
POST
/webhooks/{id}/replaydeprecated
[Deprecated] This endpoint is misnamed and does not actually replay events. Use GET /webhooks/events?caseId={id} to inspect delivery history, then POST /webhooks/events/{eventId}/replay to re-deliver…
POST
/webhooks/{id}:replaydeprecated
[Deprecated] This endpoint is misnamed and does not actually replay events. Use GET /webhooks/events?caseId={id} to inspect delivery history, then POST /webhooks/events/{eventId}/replay to re-deliver…
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.ExternalApi.Contracts.V1.Leads.LeadDetailDto (17 properties), Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteDto (17 properties). Each schema is shown below with its type and property counts.
Debitura.Domain.Model.Base.PageData
object
5 properties
Debitura.Domain.Model.CollectionPartnerLogics.CollectionPartners.SurveyCadenceMode
integer
Debitura.Domain.Model.CommunicationCenter.Chats.ChatRole
integer
Debitura.Domain.Model.Webhooks.Dtos.CreateWebhookRequest
object
3 properties
2 required
Debitura.Domain.Model.Webhooks.Dtos.UpdateWebhookRequest
object
5 properties
Debitura.Domain.Model.Webhooks.Dtos.WebhookDto
object
9 properties
Debitura.Domain.Services.CaseValidation.CaseValidationItemDto
object
2 properties
Debitura.Domain.Services.CaseValidation.CaseValidationLeanDto
object
1 property
Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto
object
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.AdvanceTestCaseResponse
object
Response from POST /test/cases/{id}/advance.
2 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.CaseContractStatusApiDTO
object
Contract signing status for a case, showing SDCA and PoA status with signing URLs.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CaseTimelineResponse
object
Response envelope for GET /cases/{id}/timeline. Wraps the chronological event list with case-level context that cannot be expressed as a single timeline entry.
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CollectionPartnerDto
object
V1 Collection Partner DTO for external partner APIs
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.ContractItemDto
object
Status of an individual contract (SDCA, PoA, or Pricing Appendix).
3 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.ExclusivePeriodDto
object
Full exclusive collection period chain for a case. Returned by GET /cases/{id}/exclusive-period.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.ExclusivePeriodExtensionDto
object
A single extension event in the exclusive period chain.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.FireWebhookResponse
object
Result of the POST /test/webhooks/fire endpoint.
3 properties
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.InvoiceListDto
object
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.JurisdictionDto
object
Geographic jurisdiction information for the case.
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.PartnerAssignmentDto
object
Information about the collection partner assigned to this case.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.PreviewCaseResponseApiViewModel
object
Response from previewing a case, showing eligibility, partner assignment, required actions, and pricing estimates.
1 property
Debitura.Web.ExternalApi.Contracts.V1.Cases.PreviewResultDto
object
Detailed preview result for a case submission.
9 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.AdvanceTestCaseRequest
object
Request to advance a test case to a known lifecycle state.
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateCollectionCaseRequestApiViewModel
object
20 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.FireWebhookRequest
object
Request body for POST /test/webhooks/fire.
3 properties
2 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.RequiredActionDto
object
An action required before the case can be submitted (e.g., signing a contract).
4 properties
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.Cases.TimelineActorDto
object
Represents the actor (person or system) that performed a timeline action.
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.TimelineItemDto
object
5 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Chats.ChatDto
object
8 properties
Debitura.Web.ExternalApi.Contracts.V1.Chats.SendChatRequest
object
Request to send a chat message on a case.
3 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Divisions.CreateDivisionRequestDto
object
9 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Divisions.DivisionCountryDto
object
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Divisions.DivisionDto
object
13 properties
Debitura.Web.ExternalApi.Contracts.V1.Divisions.DivisionListDto
object
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Divisions.UpdateDivisionRequestDto
object
9 properties
3 required
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.ExternalApi.Contracts.V1.Files.CaseFileDto
object
10 properties
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadDetailDto
object
V1 Lead detail DTO for external customer APIs (detailed view)
17 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadDto
object
V1 Lead DTO for external customer APIs (summary view)
15 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadListDto
object
V1 Lead list response for external customer APIs
1 property
1 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteDetailDto
object
V1 Lead Quote detail DTO for external customer APIs (detailed view)
14 properties
5 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteDto
object
V1 Lead Quote DTO for external customer APIs (summary view)
17 properties
4 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteListDto
object
V1 Lead Quote list response for external customer APIs
1 property
1 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuotePricingDto
object
Nested pricing details for a lead quote
6 properties
Debitura.Web.ExternalApi.Contracts.V1.Payments.PaymentDto
object
9 properties
4 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.PaymentRelatedInvoiceDto
object
3 properties
2 required
Debitura.Web.ExternalApi.Contracts.V1.Tasks.TaskActionDto
object
A machine-readable hint pointing at the existing API call that resolves a task, e.g. { "method": "POST", "path": "/cases/{caseId}/chats" } for a chat-driven ta…
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Tasks.TaskDto
object
A creditor-facing action item ("task") — something the platform needs the client to do before a case can proceed (e.g. reply to a chat, sign a contract, assign…
14 properties
Debitura.Web.ExternalApi.Contracts.V1.Tasks.TaskListDto
object
Paged list of tasks, returned by GET /tasks.
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Users.CollectionPartnerUserDto
object
A user belonging to the authenticated collection partner's team. Use the Debitura.Web.ExternalApi.Contracts.V1.Users.CollectionPartnerUserDto.Id as the assigne…
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Users.UserListDto
object
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Users.UserRelationDto
object
6 properties
1 required
Debitura.Web.ExternalCustomerAPI.Models.Coverages.CaseEligibilityRequestApiDTO
object
Request for checking case eligibility and getting partner/PoA status.
5 properties
4 required
Debitura.Web.ExternalCustomerAPI.Models.Coverages.CaseEligibilityResponseApiDTO
object
Response for case eligibility check - returns exact partner + PoA status.
5 properties
Debitura.Web.ExternalCustomerAPI.Models.Coverages.CollectionContractStatusApiDTO
object
5 properties
Debitura.Web.ExternalCustomerAPI.Models.Coverages.CoverageItemApiDTO
object
Coverage information for a single jurisdiction. BREAKING CHANGE: Partners is now an array - may contain multiple partners with different conditions.
7 properties
Debitura.Web.ExternalCustomerAPI.Models.Coverages.JurisdictionInfoApiDTO
object
Jurisdiction information
5 properties
Debitura.Web.ExternalCustomerAPI.Models.Coverages.PartnerCoverageApiDTO
object
Partner coverage details including conditions and PoA status.
8 properties
Debitura.Web.ExternalCustomerAPI.Models.Coverages.PartnerInfoApiDTO
object
Partner information
2 properties
Debitura.Web.ExternalCustomerAPI.Models.Coverages.PowerOfAttorneyStatusApiDTO
object
Power of Attorney status (shared DTO for check-eligibility and coverage endpoints).
5 properties
Debitura.Web.ExternalCustomerAPI.Models.Me.CreditorMeApiDTO
object
10 properties
1 required
Debitura.Web.ExternalCustomerAPI.Models.Payments.Dtos.PaymentListApiDTO
object
2 properties
1 required
Debitura.Web.ExternalCustomerAPI.Models.Webhooks.Dtos.ReplayEventResultDto
object
Result of replaying a specific webhook event.
3 properties
Debitura.Web.ExternalCustomerAPI.Models.Webhooks.Dtos.ReplayResultDto
object
Result of a webhook event replay operation.
1 property
Debitura.Web.ExternalCustomerAPI.Models.Webhooks.Dtos.TestResultDto
object
Result of a webhook test delivery.
6 properties
Debitura.Web.ExternalCustomerAPI.Models.Webhooks.Dtos.WebhookEventDto
object
Represents a recorded webhook delivery event.
10 properties
Debitura.Web.ExternalCustomerAPI.Models.Webhooks.Requests.ReplayRequestDto
object
Request to replay events from a specific timestamp.
1 property
1 required
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Debt Collection#Accounts Receivable#Invoicing#Payments#Webhook
Where this information came from
This is an independent, third-party profile of Debitura Customer 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.