Skip to main content
GET
Get debtor

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the debtor in this request.

Response

acting_as
enum<string>
required

Whether the debtor incurred the obligation as a consumer or in a business capacity.

  • consumer - consumer
  • business - business
Available options:
consumer,
business
addresses
object[]
required
read-only

Postal addresses associated with the debtor. API submissions are limited to 5 entries.

bank_accounts
object[]
required
read-only

Known bank accounts belonging to the debtor. API submissions are limited to 10 entries.

communication_channels
object[]
required
read-only

Email addresses and telephone numbers for the debtor. API submissions are limited to 10 entries.

created_at
string<date-time>
required
read-only

Time at which the debtor was created.

events
object[]
required
read-only

Stored contextual events associated with this resource.

id
string<uuid>
required
read-only

Stable identifier of this debtor.

Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.

People or organizations legally representing the debtor. API submissions are limited to 10 entries.

metadata
object[]
required
read-only

Stored metadata entries; duplicate types remain separate entries.

organization
object | null
required

Organization identity for a business debtor.

person
object | null
required

Natural-person identity for a consumer or sole proprietor.

updated_at
string<date-time>
required
read-only

Time at which the debtor was last updated.

your_reference
string | null
required
read-only

Your reference for this debtor.