Skip to main content
GET
Get debtor status

Authorizations

collectwise_key
string
header
required

Active, unexpired API key belonging to an active organization. Optional organization/key signing and organization IP restrictions also apply; see API Access.

Headers

x-cw-timestamp
string

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

Pattern: ^(0|[1-9][0-9]*)$
x-cw-signature
string

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Pattern: ^v1=[0-9a-f]{64}$

Path Parameters

debtorId
string
required

Unique identifier of the debtor

Response

Debtor status retrieved successfully

debtorId
string
required

Unique identifier of the debtor

status
enum<string>
required

Current status of the debtor

Available options:
Potential,
Subscription,
Partial,
Paid,
Deleted,
Paid Creditor Directly,
Deceased,
Filed Bankruptcy