How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Debitura Clients API is one of 20 APIs that Debitura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://referral-api.debitura.com.

7 operations 5 paths 34 schemas 1 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://customer-api.debitura.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Debitura Clients 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 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Clients 7

Clients

POST
/clients
Create and onboard a new client
body → 201202400409422500
GET
/clients
List all linked clients
9 params → 200400500
GET
/clients/{externalTenantId}
Get client by external tenant ID
1 param → 200404500
DELETE
/clients/{externalTenantId}
Reset a client (test environment only)
1 param → 204403404500
GET
/clients/{externalTenantId}/is-deletable
Check if a client can be deleted (test environment only)
1 param → 200403404500
POST
/clients/{externalTenantId}/withdraw
Withdraw an attributed client
1 param → 204404409500
POST
/clients/{externalTenantId}/kyc-verification
Submit KYC verification for a client
3 params body → 201404500

Schemas 34

The contract defines 34 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.Cases.BankAccountDto (16 properties), Debitura.Web.ExternalApi.Contracts.V1.Cases.DebtorDto (13 properties). Each schema is shown below with its type and property counts.

Debitura.Web.ReferralPartnerApi.Models.Clients.ClientsSummary
object
5 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.GetClientsResponse
object
Response model for listing clients linked to a referral partner
3 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.CollectionPartnerDto
object
V1 Collection Partner DTO for external partner APIs
5 properties
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.Web.ExternalApi.Contracts.V1.Cases.AssignedUserDto
object
Represents the creditor team member assigned to a case.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateCollectionCaseRequestApiViewModel
object
20 properties 1 required
Debitura.Web.ReferralPartnerApi.Models.Clients.KycVerificationDto
object
6 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.ReferralPartnerApi.Models.Clients.CreateClientRequest
object
4 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.ReferralPartnerApi.Models.Clients.ClientUserDto
object
3 properties 2 required
Debitura.Web.ReferralPartnerApi.Models.Clients.SubmitKycVerificationRequest
object
3 properties 3 required
Debitura.Web.ReferralPartnerApi.Models.Clients.CreditorDto
object
8 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.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.ReferralPartnerApi.Models.Clients.ClientCaseStats
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientCreatedResponse
object
11 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorResponseApiDTO
object
Response returned when business rule violations prevent case creation.
2 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.ExternalApi.Contracts.V1.Cases.BusinessErrorApiDTO
object
Represents a business error in the API response.
3 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ConflictResponse
object
Response returned when a conflict occurs during client creation
3 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientDeletableResponse
object
Response indicating whether a client can be deleted.
2 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.InvoiceDto
object
V1 Invoice DTO for external partner APIs
37 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.ClientDetailsDto
object
9 properties 3 required
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.ReferralPartnerApi.Models.Clients.UserDto
object
4 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.Domain.Model.Base.PageData
object
Paging metadata describing a paged result set.
5 properties
Debitura.Web.ReferralPartnerApi.Models.Clients.OnboardingLinksDto
object
1 property
Debitura.Domain.Model.CollectionPartnerLogics.CollectionPartners.SurveyCadenceMode
integer
Controls which surveys are generated for cases assigned to this collection partner.
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

debitura-clients-api-openapi.yml Raw ↑

Other APIs Debitura publishes across the network.

Debitura Cases API
Debitura Contracts API
Debitura Coverage API
Debitura Divisions API
Debitura Filter Options API
Debitura Ingestion Jobs API
Debitura Managed Cases API
Debitura Me API
Debitura O Auth API
Debitura Payments API
Debitura Preview Cases API
Debitura Referral Partners API
Where this information came from

This is an independent, third-party profile of Debitura Clients 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.