Skip to main content
DELETE
cURL
Looks up a customer by reference ID, scoped to the company identified by your API key, and returns the customer object on success. Returns 404 if no customer with that reference ID exists for your company.

What this does not do

This endpoint does not hard-delete the customer record, and it does not cascade: loans, call history, and scheduled communications (calls, texts, emails) are left untouched. To stop outreach to a customer, set doNotCall, doNotText, or doNotEmail via Update a Customer instead.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

ID of customer to delete

Response

Customer response

id
string
required

Unique identifier for the customer. This is your customer reference and should match your internal system's ID.

firstName
string
required

The first name of the customer

lastName
string
required

The last name of the customer

email
string<email> | null

Customer email address

birthday
string<date> | null

Customer birthday in YYYY-MM-DD format

ssnLastFour
string | null

Last 4 digits of SSN

timezone
string | null

Timezone of the customer (IANA timezone name, e.g., 'America/New_York', 'America/Los_Angeles')

phoneNumber
string | null

Phone number of the customer

streetAddress1
string | null

Street address line 1

streetAddress2
string | null

Street address line 2 (optional)

city
string | null

City name

state
string | null

State code (e.g., NY, CA)

zipCode
string | null

ZIP/postal code

doNotCall
boolean | null

Do not call the customer

doNotText
boolean | null

Do not text the customer

doNotEmail
boolean | null

Do not email the customer

bankruptcy
boolean | null

Whether the customer has an active bankruptcy compliance status

debtConsolidation
boolean | null

Whether the customer has an active debt-management or debt-consolidation compliance status

deceased
boolean | null

Whether the customer has an active deceased compliance status

militaryStatus
boolean | null

Whether the customer has an active military or servicemember compliance status

Whether threatened legal action has been reported. This is not attorney representation and has no attorney-representation hold.

isTest
boolean | null

Indicates if this is a test customer

taskType
string | null

Type of tasks created for the customer's automated call schedule

externalMetadata
object | null

Additional custom metadata about the customer