COcollectwise

Create multiple debtors

Changed on

Creates multiple debtor records in bulk

post/debtors

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/debtors
  • Auth
    API key in header collectwise_key

Headers

x-cw-timestampstring

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.

x-cw-signaturestring

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.

Request body

debtorNamestring required

Full name of the debtor

totalUnpaidDebtnumber float required

Total amount of unpaid debt

delinquencyDatestring date required

Date when the debt became delinquent

phoneNumberstring required

Contact phone number of the debtor

emailstring email required

Email address of the debtor

callbackNumberstring

Callback phone number

productOrServicestring required

Name of the product or service delivered to the debtor

creditorNamestring required

Name of the creditor

creditorEmailstring email

Email address of the creditor

accountNumberstring

Account number associated with the debt

addressstring

Street address of the debtor

citystring

City of the debtor

statestring

State of the debtor

zipCodestring

ZIP code of the debtor

countystring

County of the debtor

ssnstring

Social Security Number of the debtor

lastPayDatestring date

Date of the last payment made by the debtor

chargeOffDatestring date

Date when the debt was charged off, if applicable

interestDuenumber float

Amount of interest due on the debt

principalDuenumber float

Amount of principal due on the debt

otherFeesnumber float

Other fees associated with the debt

amountPaidnumber float

Total amount paid by the debtor so far

paymentLinkstring

Link where the debtor can pay their balance, included in outreach. Accepts a full URL or a domain (e.g., https://example.com/pay or www.example.com).

customWorkflowIDstring

Custom workflow identifier for the debtor

agentNamestring

Name of the agent to attribute workflow enrollment to

customizationstring

Custom instructions for AI collection workflow (e.g., tone, channel preferences, frequency). If not provided, the system will generate an optimal collection flow.

Response

Bulk debtor creation response

Example response

{
  "failedDebtors": [
    {
      "error": {
        "code": 400,
        "message": "Invalid input: debtorName is required"
      }
    }
  ]
}

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status