Recover API Reference

Introduction#

The TrueAccord Recover REST API allows you to interact with your Recover account programmatically. Currently, it allows you to upload customers and amounts to be recovered from them and query their most recent status.

All the requests to the API must be done over HTTPS.

Endpoint#

The endpoint for the TrueAccord Recover API is: https://api.trueaccord.com/api/v1/

Authentication#

You authenticate to the TrueAccord Recover API by providing your API key as a username using HTTP Basic Authentication. The password part is ignored.

Example:

curl https://api.trueaccord.com/api/v1/customers/ -u $YOUR_KEY:

The -u option in curl sets the username and password for HTTP basic auth. Following it comes your API key and a colon that prevents curl from asking you for a password.

note

You must keep the colon (":") after your API key, as this represents a password which is being left blank.

You can also query the API in the browser with the same endpoint, https://api.trueaccord.com/api/v1/customers/. You'll be asked to provide a username and password in a pop-up alert. Copy-paste your API key into the username field, leave the password blank, and click the "Sign In" button. You'll see the JSON response in the browser window.

Headers#

X-TA-CREDITOR#

X-TA-CREDITOR

If your user account and its API key are associated with multiple creditors, you must include a custom header in your request for all /customer/ endpoints.  Add the following header: --header "X-TA-CREDITOR: $RELEVANT_CREDITOR_ID".  

If you fail to include this header, the request will fail with a status 403 error. See Recover Error Codes for more information.

If you're account is just associated with a single creditor, you do NOT need to include the X-TA-CREDITOR header.

Customers Endpoints#

These endpoints deal with modifying information about Customers, i.e. those who owe money that TrueAccord attempts to collect.

See the Customer datatype for more information on the Customer object.

Add Customers#

One or more customers can be added in a single request. The request payload contains a list of Customers under the key "customers".

POST https://api.trueaccord.com/api/v1/customers/

Add Customers Query Parameters#

ParamTypeRequiredAdditional Information
addDebtsIfPossibleBooleanFlag to add new debts to customers in the request for customers that have already been placed.

Add Customers Request Body#

KeyTypeRequiredAdditional Information
customersArray of CustomersInclude at least one Customer in the array.
Adding Customers Example Request JSON Payload
{
"customers": [
{
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"addresses": [
{
"streetLine1": "101 N First St",
"streetLine2": "",
"city": "San Jose",
"state": "CA",
"zipcode": "99999",
"countryCode": "US",
"types" : [ "HOME" ]
}
],
"phones": [
{
"phoneNumber": "650-999-9999",
"types" : [ "CELL" ]
}
],
"emails": [
{
"email": "john@example.com",
"types" : [ "WORK" ]
},
{
"email": "john1977@gmail.com"
}
],
"reference": "MyRef",
"debts": [
{
"biller": "ArtsieStuff",
"product": "Oil Painting",
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialFees": {
"amount": 132,
"currency": "USD"
},
"transactionId": "MyTransId",
"transactionIp": "192.168.14.30",
"transactionTimestamp": 1385148285937,
"defaultTimestamp": 1388563200000,
"postChargeOffInformation" : {
"chargeOffTimestamp" : 1388563200000,
"balanceAtChargeOff" : {
"amount": 14567,
"currency": "USD"
},
"feesAccruedSinceChargeOff" : {
"amount": 14567,
"currency": "USD"
},
"interestAccruedSinceChargeOff" : {
"amount": 14567,
"currency": "USD"
},
"totalPaidSinceChargeOff" : {
"amount": 14567,
"currency": "USD"
}
},
"clientFields": [{
"key": "key1",
"value": "val1"}
],
"itemizationTimestamp" : 1385148285937,
"initialPaymentsAndCredits" : {
"amount" : 1000,
"currency": "USD"
},
"isInitialPrincipalBeforePaymentsAndCredits" : true
}
]
}
],
"addDebtsIfPossible": true
}

Add Customers Responses#

200 OK#

The customers in the response will mirror those of your request but with an additional meta field that can be used in the future to reference the customer objects you have created.

KeyTypeRequiredAdditional Info
customersArray of CustomersNew customers added to the system.
duplicatedReferencesArray of Duplicated ReferencesIf there are any duplicated customers in the query that have been placed before, their references will appear in the response under the duplicatedReferences field.
customersWithAddedDebtsArray of CustomersIf addDebtsIfPossible is flagged in the request, the response will mirror your request with new customers, and also include a separate field for existing customers that had new debts added: customersWithAddedDebts.
Add Customers 200 OK Response Example - Add New Customers and Duplicated References
{
"customers": [
{
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"reference": "WowAReference",
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"addresses": [
{
"state": "CA",
"streetLine1": "101 N First St",
"zipcode": "99999",
"streetLine2": "",
"types": [
"HOME"
],
"city": "San Jose",
"countryCode": "US"
}
],
"emails": [
{
"email": "john@example.com",
"types": [
"WORK"
]
},
{
"email": "john1977@gmail.com"
}
],
"phones": [
{
"phoneNumber": "650-999-9999",
"types": [
"CELL"
]
}
],
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"meta": {
"isPrimary": false,
"lastModified": 1626447440161,
"versionInfo": {
"versionNumber": 0,
"userAccountId": "abcdefghijklmnop"
},
"timeCreated": 1626447440161,
"id": "f9b41cf2bfdc423fa51636a9394b74a4",
"isActive": true
},
"debts": [
{
"biller": "ArtsieStuff",
"initialFees": {
"amount": 132,
"currency": "USD"
},
"postChargeOffInformation": {
"balanceAtChargeOff": {
"amount": 14567,
"currency": "USD"
},
"feesAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"chargeOffTimestamp": 1388563200000,
"totalPaidSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"interestAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
}
},
"creditorId": "bf5903bb58cb352d441a9816e01ca09c",
"status": "PendingApproval",
"accountNumber": "4766780984752",
"type": "DEBT_TYPE_NONE",
"meta": {
"isPrimary": false,
"lastModified": 1626447440148,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1626447440148,
"id": "16537b04a2734f07ab4ebb82f2fe90de",
"isActive": true
},
"defaultTimestamp": 1388577600000,
"itemizationTimestamp" : 1385148285937,
"initialPaymentsAndCredits" : {
"amount" : 1000,
"currency": "USD"
},
"isInitialPrincipalBeforePaymentsAndCredits" : true,
"clientFields": [
{
"key": "key1",
"value": "val1"
}
],
"transactionIp": "192.168.14.30",
"initialCosts": {
"amount": 0,
"currency": "USD"
},
"product": "Oil Painting",
"chargeOffStatus": "NONE",
"transactionTimestamp": 1385148285937,
"personId": "f9b41cf2bfdc423fa51636a9394b74a4",
"transactionId": "WowATransId",
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"creditor": {
"brand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"meta": {
"id": "bf5903bb58cb352d441a9816e01ca09c"
},
"originalBrand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"creditorSettings": {
"creditorTimeZone": "PST",
"isFirstPartyRelationship": false,
"servicingType": "RECOVERY"
},
"companyName": "iTable",
"policy": {
"isAchEnabled": true
},
"industry": "",
"clientName": "iTable"
},
"paymentPlanId": "",
"oosWrittenDisclosure": "The law limits how long you can be sued on a debt. Because of the age of your debt,\nwe will not sue you for it, and we will not report it to any credit\nreporting agency.",
"isTimebarCompliant": false,
"locationCreated": {
"physical": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
}
},
"placementType": "ORIGINAL",
"isPreLegal": false,
"balanceDetails": {
"principal": {
"amount": 14567,
"currency": "USD"
},
"overcharges": {
"amount": 0,
"currency": "USD"
},
"isSettledInFull": false,
"costs": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 132,
"currency": "USD"
},
"interest": {
"amount": 0,
"currency": "USD"
}
},
"specialUiTreatment": "NONE",
"unsettledPaymentsAmount": {
"amount": 0,
"currency": "USD"
},
"internalConfiguration": {
"showSpecialDisputeTreatment": true
},
"balance": {
"amount": 14699,
"currency": "USD"
},
"accruedInterest": {
"amount": 0,
"currency": "USD"
},
"balanceDetailsAtPlacement": {
"principal": {
"amount": 14567,
"currency": "USD"
},
"interest": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 132,
"currency": "USD"
},
"costs": {
"amount": 0,
"currency": "USD"
}
},
"availablePaymentMethods": {
"creditCard": true,
"debitCard": true,
"check": true
},
"effectiveMaxDiscountPercent": {
"overrideType": "NO_OVERRIDE",
"maxDiscountPercent": 30,
"minSettlementPercent": 70
},
"transactionIdLast4": "nsId",
"communicationsInformation": {
"hadInitialCommunication": false
},
"minSettlementPercent": 70,
"maxDiscountPercent": 30,
"recentTransactionInfo": {},
"initialTotal": {
"amount": 14699,
"currency": "USD"
},
"accountNumberForDisplay": "nsId"
}
],
"isAddressInNewYorkCity": false
}
],
"duplicatedReferences": [
{
"reference": "LookAReference",
"transactionId": "LookATransId"
}
]
}

Add Customers 200 OK Response Example - Only Duplicated References
{
"duplicatedReferences": [
{
"reference": "155780663968-CbzcTXGaAtpW1"
}
]
}

Add Customers 200 OK Response Example - Existing Customer with Added Debts
{
"customersWithAddedDebts": [
{
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"reference": "LookAReference",
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"addresses": [
{
"state": "CA",
"streetLine1": "101 N First St",
"zipcode": "99999",
"streetLine2": "",
"types": ["HOME"],
"city": "San Jose",
"countryCode": "US"
}
],
"emails": [
{
"email": "john@example.com",
"types": ["WORK"]
},
{
"email": "john1977@gmail.com"
}
],
"phones": [
{
"phoneNumber": "650-999-9999",
"types": ["CELL"]
}
],
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"debts": [
{
"biller": "ArtsieStuff",
"initialFees": {
"amount": 132,
"currency": "USD"
},
"postChargeOffInformation": {
"balanceAtChargeOff": {
"amount": 14567,
"currency": "USD"
},
"feesAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"chargeOffTimestamp": 1388563200000,
"totalPaidSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"interestAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
}
},
"creditorId": "bf5903bb58cb352d441a9816e01ca09c",
"status": "PendingApproval",
"accountNumber": "4741594710484",
"type": "DEBT_TYPE_NONE",
"meta": {
"isPrimary": false,
"lastModified": 1626448344983,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1626448344983,
"id": "918729bcc6ba4639ba55485115bfb5b3",
"isActive": true
},
"defaultTimestamp": 1388577600000,
"itemizationTimestamp" : 1385148285937,
"initialPaymentsAndCredits" : {
"amount" : 1000,
"currency": "USD"
},
"isInitialPrincipalBeforePaymentsAndCredits" : true,
"clientFields": [
{
"key": "key1",
"value": "val1"
}
],
"transactionIp": "192.168.14.30",
"initialCosts": {
"amount": 0,
"currency": "USD"
},
"product": "Oil Painting",
"chargeOffStatus": "NONE",
"transactionTimestamp": 1385148285937,
"personId": "17326913566d46a1a8be78916f93559c",
"transactionId": "YetAnotherTransId",
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"creditor": {
"brand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"meta": {
"id": "bf5903bb58cb352d441a9816e01ca09c"
},
"originalBrand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"creditorSettings": {
"creditorTimeZone": "PST",
"isFirstPartyRelationship": false,
"servicingType": "RECOVERY"
},
"companyName": "iTable",
"policy": {
"isAchEnabled": true
},
"industry": "",
"clientName": "iTable"
},
"paymentPlanId": "",
"oosWrittenDisclosure": "The law limits how long you can be sued on a debt. Because of the age of your debt,\nwe will not sue you for it, and we will not report it to any credit\nreporting agency.",
"isTimebarCompliant": false,
"locationCreated": {
"physical": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
}
},
"placementType": "ORIGINAL",
"isPreLegal": false,
"balanceDetails": {
"principal": {
"amount": 14567,
"currency": "USD"
},
"overcharges": {
"amount": 0,
"currency": "USD"
},
"isSettledInFull": false,
"costs": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 132,
"currency": "USD"
},
"interest": {
"amount": 0,
"currency": "USD"
}
},
"specialUiTreatment": "NONE",
"unsettledPaymentsAmount": {
"amount": 0,
"currency": "USD"
},
"internalConfiguration": {
"showSpecialDisputeTreatment": true
},
"balance": {
"amount": 14699,
"currency": "USD"
},
"accruedInterest": {
"amount": 0,
"currency": "USD"
},
"balanceDetailsAtPlacement": {
"principal": {
"amount": 14567,
"currency": "USD"
},
"interest": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 132,
"currency": "USD"
},
"costs": {
"amount": 0,
"currency": "USD"
}
},
"availablePaymentMethods": {
"creditCard": true,
"debitCard": true,
"check": true
},
"effectiveMaxDiscountPercent": {
"overrideType": "NO_OVERRIDE",
"maxDiscountPercent": 30,
"minSettlementPercent": 70
},
"transactionIdLast4": "nsId",
"communicationsInformation": {
"hadInitialCommunication": false
},
"minSettlementPercent": 70,
"maxDiscountPercent": 30,
"recentTransactionInfo": {},
"initialTotal": {
"amount": 14699,
"currency": "USD"
},
"accountNumberForDisplay": "nsId"
}
]
}
],
}

Add Customers V2#

One or more customers can be added in a single request. The request payload contains a list of Customers under the key "customers". Use of V2 is recommended over V1, as it mirrors the request with results or errors per account.

POST https://api.trueaccord.com/api/v1/customersBatch/

Add Customers V2 Query Parameters#

Request body parameters available:

KeyTypeRequiredAdditional Info
addDebtsIfPossibleBooleanIf true, add new debts to customers in the request if they have already been placed.
Adding Customers V2 Example Request
{
"customers": [
{
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"addresses": [
{
"streetLine1": "101 N First St",
"streetLine2": "",
"city": "San Jose",
"state": "CA",
"zipcode": "99999",
"countryCode": "US",
"types" : [ "HOME" ]
}
],
"phones": [
{
"phoneNumber": "650-999-9999",
"types" : [ "CELL" ]
}
],
"emails": [
{
"email": "john@example.com",
"types" : [ "WORK" ]
},
{
"email": "john1977@gmail.com"
}
],
"reference": "MyRef",
"debts": [
{
"biller": "ArtsieStuff",
"product": "Oil Painting",
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialFees": {
"amount": 132,
"currency": "USD"
},
"transactionId": "MyTransId",
"transactionIp": "192.168.14.30",
"transactionTimestamp": 1385148285937,
"defaultTimestamp": 1388563200000,
"postChargeOffInformation" : {
"chargeOffTimestamp" : 1388563200000,
"balanceAtChargeOff" : {
"amount": 14567,
"currency": "USD"
},
"feesAccruedSinceChargeOff" : {
"amount": 14567,
"currency": "USD"
},
"interestAccruedSinceChargeOff" : {
"amount": 14567,
"currency": "USD"
},
"totalPaidSinceChargeOff" : {
"amount": 14567,
"currency": "USD"
}
},
"clientFields": [{
"key": "key1",
"value": "val1"}
],
"itemizationTimestamp" : 1385148285937,
"initialPaymentsAndCredits" : {
"amount" : 1000,
"currency": "USD"
},
"isInitialPrincipalBeforePaymentsAndCredits" : true
}
]
}
],
"addDebtsIfPossible": true
}"

Add Customers V2 Responses#

200 OK#

In the case where the request succeeds, the response will mirror your request but with an additional meta field that can be used in the future to reference the customer objects you have created.

If there are any duplicate references/transaction ids or any other issues with a placed customer, it will be visible in the response with the flag isError .

If addDebtsIfPossible is flagged, the response will mirror your request with new customers, and also include a flag for isAddedDebt if an existing customer had another debt placed.

KeyTypeRequiredAdditional Info
responsesArray of objectsArray that aligns with the request. Contains Customer V2 Responses and Customer V2 Errors. but if there was an error posting a certain customer, replaces that customer with an error message.
Customer V2 Response#
KeyTypeRequiredAdditional Info
customerCustomerThe customer that is added.
isAddedDebtBoolean
Customer V2 Error#
KeyTypeRequiredAdditional Info
isErrorBooleanIs true if there is an error. Can be used to programmatically identify when dealing with error.
errorErrorInformation about the error returned.
Adding Customers V2 200 OK Response Example - Add Customer and Duplicate Error
{
"responses": [
{
"customer": {
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"addresses": [
{
"streetLine1": "101 N First St",
"streetLine2": "",
"city": "San Jose",
"state": "CA",
"zipcode": "99999",
"countryCode": "US",
"types": [
"HOME"
]
}
],
"phones": [
{
"phoneNumber": "650-999-9999",
"types": [
"CELL"
]
}
],
"emails": [
{
"email": "john@example.com",
"types": [
"WORK"
]
},
{
"email": "john1977@gmail.com"
}
],
"reference": "MyRef",
"debts": [
{
"biller": "ArtsieStuff",
"product": "Oil Painting",
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialFees": {
"amount": 132,
"currency": "USD"
},
"transactionId": "MyTransId",
"transactionIp": "192.168.14.30",
"transactionTimestamp": 1385148285937,
"defaultTimestamp": 1388563200000,
"itemizationTimestamp" : 1385148285937,
"initialPaymentsAndCredits" : {
"amount" : 1000,
"currency": "USD"
},
"isInitialPrincipalBeforePaymentsAndCredits" : true,
"postChargeOffInformation": {
"chargeOffTimestamp": 1388563200000,
"balanceAtChargeOff": {
"amount": 14567,
"currency": "USD"
},
"feesAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"interestAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"totalPaidSinceChargeOff": {
"amount": 14567,
"currency": "USD"
}
},
"clientFields": [
{
"key": "key1",
"value": "val1"
}
]
}
]
},
"isAddedDebt": true
},
{
"error": {
"errorCode": "104",
"message": "Duplicated transactionId.",
"reference": "1234",
"transactionId": "MyTransId"
},
"isError": true
}
]
}

Adding Customers V2 200 OK Response Example - Only Duplicate Error
{
"responses": [
{
"isError": true,
"error": {
"errorCode": "409",
"message": "Duplicated transaction id.",
"reference": "MyRef",
"transactionId": "MyTransId"
}
}
]
}

List Customers#

GET https://api.trueaccord.com/api/v1/customers/

Returns a paginated list of Customer objects you created, along with current status information.

List Customers Query Parameters#

KeyTypeRequiredAdditional Info
countIntegerNumber of results to return. Limited to at most 100.
offsetIntegerZero-based. Used when more than 100 results to display further results.
startTimeTimestampOnly returns customers after this time.
endTimeTimestampOnly returns customers before this time.

List Customers Responses#

200 OK#
KeyTypeRequiredAdditional Info
customersArray of CustomersThe customers returned by query.
totalResultsIntegerTotal number of results for the query. Can be useful for pagination in combination with count and offset query parameters.
Listing Customers Example Response - 200 OK
{
"totalResults": 1,
"customers": [
{
"meta": {
"id": "3ef84ff19ddc",
"isActive": true,
"isPrimary": false,
"timeCreated": 1385695523047,
"lastModified": 1385695523047
},
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"addresses": [
{
"streetLine1": "101 N First St",
"streetLine2": "",
"city": "San Jose",
"state": "CA",
"zipcode": "99999",
"countryCode": "US"
}
],
"phones": [
{
"phoneNumber": "650-999-9999"
}
],
"emails": [
{
"email": "john@example.com"
},
{
"email": "john1977@gmail.com"
}
],
"reference": "MyRef",
"debts": [
{
"meta": {
"id": "f32962a52aeb",
"isActive": true,
"isPrimary": false,
"timeCreated": 1385695523047,
"lastModified": 1385695523047
},
"biller": "ArtsieStuff",
"product": "Oil Painting",
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialFees": {
"amount": 132,
"currency": "USD"
},
"transactionId": "MyTransId",
"transactionIp": "192.168.14.30",
"transactionTimestamp": 1385148285937,
"defaultTimestamp": 1388563200000,
"accountNumber": "47994372839",
"balance": {
"amount": 14699,
"currency": "USD"
},
"status": "New"
}
]
}
]
}

List Customers by Creditor Reference ID#

info

This section technically refers to the same endpoints as List Customer Responses. However, a separate section has been created for it due to the unique and important behavior of the reference query parameter.

This will return a customer object specified by your internal reference number.

For one reference:

GET https://api.trueaccord.com/api/v1/customers/?reference={CreditorReferenceId}

For multiple references:

GET https://api.trueaccord.com/api/v1/customers/?reference={CreditorReferenceId_00},{CreditorReferenceId_01},...,{CreditorReferenceId_99}

List Customer by Creditor Reference ID Query Parameters#

KeyTypeRequiredAdditional Info
referencecomma separated stringsCreditor's customer references. Separate multiple references with commas. Max number of references to include is 100.
countIntegerNumber of results to return. Limited to at most 100.
offsetIntegerZero-based. Used when more than 100 results to display further results.
startTimeTimestampOnly returns customers after this time.
endTimeTimestampOnly returns customers before this time.

List Customers by Creditor Reference ID Responses#

200 OK#
KeyTypeRequiredAdditional Info
customersArray of CustomersThe customers returned by query.
totalResultsIntegerTotal number of results for the query. Can be useful for pagination in combination with count and offset query parameters.
List Customers by Creditor Reference ID 200 OK Response Example

Request endpoint: https://api.trueaccord.com/api/v1/customers/?reference=E=>7IzDYM

Response Body:

{
"customers": [
{
"businesses": [
{
"meta": {
"isPrimary": true,
"lastModified": 1618853327549,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327549,
"id": "ac3809bbb87f56e84fd730eb0d948bcf",
"isActive": true
},
"name": "Curae; Phasellus Ltd"
}
],
"reference": "E=>7IzDYM",
"name": {
"firstName": "Cecilia",
"lastName": "Snyder"
},
"addresses": [
{
"state": "OR",
"meta": {
"isPrimary": true,
"lastModified": 1618853327541,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327541,
"id": "39722cbbf8b91a4b9045c5e6175f1001",
"isActive": true
},
"streetLine1": "Ap #934-120 Ante Rd.",
"zipcode": "28033",
"city": "Portland",
"countryCode": "US"
}
],
"emails": [
{
"meta": {
"isPrimary": true,
"lastModified": 1618853327547,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327547,
"id": "4c9326bb9805fa8f85882c12eae724ce",
"isActive": true
},
"email": "cecilia.snyder@isp.com"
},
{
"meta": {
"isPrimary": false,
"lastModified": 1618853327569,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327569,
"id": "f0c62e118427f5948aefa5c428c43c93",
"isActive": true
},
"email": "cecilia353@aol.com"
}
],
"phones": [
{
"meta": {
"isPrimary": true,
"lastModified": 1618853327539,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327539,
"id": "73d51abbd89cb8196f0efb6892f94d68",
"isActive": true
},
"phoneNumber": "353-719-8146"
},
{
"meta": {
"isPrimary": false,
"lastModified": 1618853327569,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327569,
"id": "fccc2c35f0b84609e5f12c55dd85aba8",
"isActive": true
},
"phoneNumber": "353-719-8147"
}
],
"dateOfBirth": {
"day": 22,
"month": 3,
"year": 1985
},
"meta": {
"isPrimary": false,
"lastModified": 1618853328092,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853328092,
"id": "e54db7d751316935960ee7adc12857f2",
"isActive": true
},
"debts": [
{
"biller": "biller_0",
"initialFees": {
"amount": 0,
"currency": "USD"
},
"postChargeOffInformation": {
"chargeOffTimestamp": 1606557600000
},
"creditorId": "bf5903bb58cb352d441a9816e01ca09c",
"status": "InPaymentPlan",
"accountNumber": "43756429154",
"type": "DEBT_TYPE_NONE",
"meta": {
"isPrimary": false,
"lastModified": 1618853327596,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1603906010851,
"id": "99170fbb183477a35a94c9bf390b7702",
"isActive": true
},
"defaultTimestamp": 1609495200000,
"accountOpenTimestamp": 1607421600000,
"transactionIp": "127.0.0.1",
"initialCosts": {
"amount": 0,
"currency": "USD"
},
"product": "product_0",
"chargeOffStatus": "NONE",
"personId": "e54db7d751316935960ee7adc12857f2",
"transactionId": "839580621",
"initialInterest": {
"amount": 6494,
"currency": "USD"
},
"initialPrincipal": {
"amount": 90223,
"currency": "USD"
},
"paymentOffers": {
"availableSettlement": {
"settlementPercent": 30
},
"highlightedPpConfiguration": {
"numberOfInstallments": 3,
"frequency": "MONTHLY",
"settlementPercent": 25
},
"availablePpConfigurations": [
{
"numberOfInstallments": 3,
"frequency": "MONTHLY",
"settlementPercent": 25
},
{
"numberOfInstallments": 6,
"frequency": "MONTHLY",
"settlementPercent": 20
},
{
"numberOfInstallments": 9,
"frequency": "MONTHLY",
"settlementPercent": 15
}
],
"debtId": "99170fbb183477a35a94c9bf390b7702",
"disallowCustomPlans": false,
"meta": {
"isPrimary": false,
"lastModified": 1618853327609,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1617730010851,
"id": "741443f2d7674423b63e6711cc02c9d3",
"isActive": true
}
},
"creditor": {
"brand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"meta": {
"id": "bf5903bb58cb352d441a9816e01ca09c"
},
"originalBrand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"creditorSettings": {
"creditorTimeZone": "PST",
"isFirstPartyRelationship": false,
"servicingType": "RECOVERY"
},
"companyName": "iTable",
"policy": {
"isAchEnabled": true
},
"industry": "",
"clientName": "iTable"
},
"paymentPlanId": "4541dabab8dc500ff9ee6a46aada2f38",
"isTimebarCompliant": true,
"locationCreated": {
"physical": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
}
},
"placementType": "ORIGINAL",
"isPreLegal": false,
"balanceDetails": {
"principal": {
"amount": 70881,
"currency": "USD"
},
"overcharges": {
"amount": 0,
"currency": "USD"
},
"isSettledInFull": false,
"costs": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 0,
"currency": "USD"
},
"interest": {
"amount": 6494,
"currency": "USD"
}
},
"specialUiTreatment": "NONE",
"unsettledPaymentsAmount": {
"amount": 0,
"currency": "USD"
},
"internalConfiguration": {
"showSpecialDisputeTreatment": false
},
"balance": {
"amount": 77375,
"currency": "USD"
},
"accruedInterest": {
"amount": 0,
"currency": "USD"
},
"balanceDetailsAtPlacement": {
"principal": {
"amount": 90223,
"currency": "USD"
},
"interest": {
"amount": 6494,
"currency": "USD"
},
"fees": {
"amount": 0,
"currency": "USD"
},
"costs": {
"amount": 0,
"currency": "USD"
}
},
"availablePaymentMethods": {
"creditCard": true,
"debitCard": true,
"check": true
},
"calculatedPaymentOffers": {
"delayedOneTimePayment": {
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 77375,
"currency": "USD"
},
"discount": {
"amount": 0,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 1
},
"discountPercent": 0,
"settlementPercent": 100,
"numberOfInstallments": 1,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"percentOfCurrentBalance": 100,
"installmentAmount": {
"amount": 77375,
"currency": "USD"
},
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"isSif": false
},
"settlementConstraints": {
"min": {
"percent": 70,
"amount": {
"amount": 54162,
"currency": "USD"
}
},
"max": {
"percent": 100,
"amount": {
"amount": 77375,
"currency": "USD"
}
},
"settlementsAvailable": true
},
"disallowCustomPlans": false,
"availablePlans": [
{
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 25792,
"currency": "USD"
},
"discount": {
"amount": 0,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 3
},
"discountPercent": 0,
"settlementPercent": 100,
"numberOfInstallments": 3,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"percentOfCurrentBalance": 100,
"installmentAmount": {
"amount": 25792,
"currency": "USD"
},
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"isSif": false
},
{
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 12896,
"currency": "USD"
},
"discount": {
"amount": 0,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 6
},
"discountPercent": 0,
"settlementPercent": 100,
"numberOfInstallments": 6,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"percentOfCurrentBalance": 100,
"installmentAmount": {
"amount": 12896,
"currency": "USD"
},
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"isSif": false
},
{
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 8598,
"currency": "USD"
},
"discount": {
"amount": 0,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 9
},
"discountPercent": 0,
"settlementPercent": 100,
"numberOfInstallments": 9,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"percentOfCurrentBalance": 100,
"installmentAmount": {
"amount": 8598,
"currency": "USD"
},
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"isSif": false
}
],
"highlightedPlan": {
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 25792,
"currency": "USD"
},
"discount": {
"amount": 0,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 3
},
"discountPercent": 0,
"settlementPercent": 100,
"numberOfInstallments": 3,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"percentOfCurrentBalance": 100,
"installmentAmount": {
"amount": 25792,
"currency": "USD"
},
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"isSif": false
}
},
"effectiveMaxDiscountPercent": {
"overrideType": "NO_OVERRIDE",
"maxDiscountPercent": 30,
"minSettlementPercent": 70
},
"transactionIdLast4": "0621",
"communicationsInformation": {
"hadInitialCommunication": false
},
"minSettlementPercent": 70,
"maxDiscountPercent": 30,
"recentTransactionInfo": {
"lastPaymentDate": {
"day": 3,
"month": 4,
"year": 2021
},
"lastPaymentAmount": {
"amount": 9671,
"currency": "USD"
}
},
"initialTotal": {
"amount": 96717,
"currency": "USD"
},
"accountNumberForDisplay": "0621"
}
],
"isAddressInNewYorkCity": false
}
],
"totalResults": 1
}

Get One Customer#

GET https://api.trueaccord.com/api/v1/customers/{customerId}

Returns the Customer object with the given customerId.

The customer id appears in the meta field of the Customer object that was returned to you when you added the customer. The ids also appear in the list customers response.

Get One Customer Responses#

200 OK#

The response body is a Customer object, with the Metadata populated for all relevant fields.

Get One Customer 200 OK Response ExampleRequest Endpoint: `https://api.trueaccord.com/api/v1/customers/abcdefghijklmnop`

Response body:

{
"businesses": [
{
"name": "Some Comp.",
"url": "http://www.company.com"
}
],
"reference": "MyRef",
"name": {
"firstName": "John",
"middleName": "M",
"lastName": "Groom"
},
"addresses": [
{
"state": "CA",
"streetLine1": "101 N First St",
"zipcode": "99999",
"streetLine2": "",
"types": ["HOME"],
"city": "San Jose",
"countryCode": "US"
}
],
"emails": [
{
"email": "john@example.com",
"types": ["WORK"]
},
{
"email": "john1977@gmail.com"
}
],
"phones": [
{
"phoneNumber": "650-999-9999",
"types": ["CELL"]
}
],
"dateOfBirth": {
"day": 7,
"month": 2,
"year": 1994
},
"meta": {
"isPrimary": false,
"lastModified": 1624459680086,
"versionInfo": {
"versionNumber": 0,
"userAccountId": "abcdefghijklmnop"
},
"timeCreated": 1624459680086,
"id": "ffb88fc262714b9b952aab04fceef815",
"isActive": true
},
"debts": [
{
"biller": "ArtsieStuff",
"initialFees": {
"amount": 132,
"currency": "USD"
},
"postChargeOffInformation": {
"balanceAtChargeOff": {
"amount": 14567,
"currency": "USD"
},
"feesAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"chargeOffTimestamp": 1388563200000,
"totalPaidSinceChargeOff": {
"amount": 14567,
"currency": "USD"
},
"interestAccruedSinceChargeOff": {
"amount": 14567,
"currency": "USD"
}
},
"creditorId": "bf5903bb58cb352d441a9816e01ca09c",
"status": "PendingApproval",
"accountNumber": "4748579232244",
"type": "DEBT_TYPE_NONE",
"meta": {
"isPrimary": false,
"lastModified": 1624459680039,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1624459680039,
"id": "27810c31088f47ec86e8d6956251b084",
"isActive": true
},
"defaultTimestamp": 1388577600000,
"clientFields": [
{
"key": "key1",
"value": "val1"
}
],
"transactionIp": "192.168.14.30",
"initialCosts": {
"amount": 0,
"currency": "USD"
},
"product": "Oil Painting",
"chargeOffStatus": "NONE",
"transactionTimestamp": 1385148285937,
"personId": "ffb88fc262714b9b952aab04fceef815",
"transactionId": "MyTransId",
"initialInterest": {
"amount": 0,
"currency": "USD"
},
"initialPrincipal": {
"amount": 14567,
"currency": "USD"
},
"creditor": {
"brand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"meta": {
"id": "bf5903bb58cb352d441a9816e01ca09c"
},
"originalBrand": {
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"name": "iTable",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"meta": {
"isPrimary": false,
"lastModified": 1618853327379,
"versionInfo": {
"versionNumber": 0
},
"timeCreated": 1618853327379,
"id": "",
"isActive": true
},
"address": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
},
"type": "DOING_BUSINESS_AS"
},
"creditorSettings": {
"creditorTimeZone": "PST",
"isFirstPartyRelationship": false,
"servicingType": "RECOVERY"
},
"companyName": "iTable",
"policy": {
"isAchEnabled": true
},
"industry": "",
"clientName": "iTable"
},
"paymentPlanId": "",
"oosWrittenDisclosure": "The law limits how long you can be sued on a debt. Because of the age of your debt,\nwe will not sue you for it, and we will not report it to any credit\nreporting agency.",
"isTimebarCompliant": false,
"locationCreated": {
"physical": {
"state": "CA",
"streetLine1": "148 Townsend",
"zipcode": "94107",
"streetLine2": "Suite #26",
"city": "San Francisco",
"countryCode": "US"
}
},
"placementType": "ORIGINAL",
"isPreLegal": false,
"balanceDetails": {
"principal": {
"amount": 14567,
"currency": "USD"
},
"overcharges": {
"amount": 0,
"currency": "USD"
},
"isSettledInFull": false,
"costs": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 132,
"currency": "USD"
},
"interest": {
"amount": 0,
"currency": "USD"
}
},
"specialUiTreatment": "NONE",
"unsettledPaymentsAmount": {
"amount": 0,
"currency": "USD"
},
"internalConfiguration": {
"showSpecialDisputeTreatment": true
},
"balance": {
"amount": 14699,
"currency": "USD"
},
"accruedInterest": {
"amount": 0,
"currency": "USD"
},
"balanceDetailsAtPlacement": {
"principal": {
"amount": 14567,
"currency": "USD"
},
"interest": {
"amount": 0,
"currency": "USD"
},
"fees": {
"amount": 132,
"currency": "USD"
},
"costs": {
"amount": 0,
"currency": "USD"
}
},
"availablePaymentMethods": {
"creditCard": true,
"debitCard": true,
"check": true
},
"effectiveMaxDiscountPercent": {
"overrideType": "NO_OVERRIDE",
"maxDiscountPercent": 30,
"minSettlementPercent": 70
},
"transactionIdLast4": "nsId",
"communicationsInformation": {
"hadInitialCommunication": false
},
"minSettlementPercent": 70,
"maxDiscountPercent": 30,
"recentTransactionInfo": {},
"initialTotal": {
"amount": 14699,
"currency": "USD"
},
"accountNumberForDisplay": "nsId"
}
],
"isAddressInNewYorkCity": false
}

Add Contact Information to a Customer#

PATCH https://api.trueaccord.com/api/v1/customers/{customerId}

This will add the addresses, emails and phones in the request to the customer. Does not replace existing data.

Add Contact Information to a Customer Request Body#

If you do not want to add all addresses, phones, and emails, you can just add as relevant. None of the fields are required.

KeyTypeRequiredAdditional Info
addressesArray of Customer Addresses
phonesArray of Customer Phones
emailsArray of Customer Emails
Add Contact Information to a Customer Request Body Example
{
"addresses": [
{
"streetLine1": "101 N First St",
"streetLine2": "",
"city": "San Jose",
"state": "CA",
"zipcode": "99999",
"countryCode": "US"
}
],
"phones": [
{
"phoneNumber": "650-999-9999"
}
],
"emails": [
{
"email": "john@example.com"
},
{
"email": "john1977@example.com"
}
]
}

Add Contact Information to a Customer Responses#

200 OK#

The response is a full Customer object for the customer with the customerId in the URL parameter, including the contact information added in the request body.

Note that the response includes Metadata.

Add Contact Information to a Customer 200 OK Response Example
{
"dateOfBirth": {
"day": 22,
"month": 3,
"year": 1985
},
"emails": [
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": true,
"id": "4c9326bb9805fa8f85882c12eae724ce",
"timeCreated": 1618853327547,
"lastModified": 1618853327547,
"isActive": true
},
"email": "cecilia.snyder@isp.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "f0c62e118427f5948aefa5c428c43c93",
"timeCreated": 1618853327569,
"lastModified": 1618853327569,
"isActive": true
},
"email": "cecilia353@aol.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "ae4f24909f854ed2abdfcd15a796ac71",
"timeCreated": 1626816065553,
"lastModified": 1626816065553,
"isActive": true
},
"email": "john@example.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "2feae01170e94b259ecac4d64733ff50",
"timeCreated": 1626816065556,
"lastModified": 1626816065556,
"isActive": true
},
"email": "john1977@example.com"
}
],
"reference": "E=>7IzDYM",
"name": {
"firstName": "Cecilia",
"lastName": "Snyder"
},
"businesses": [
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": true,
"id": "ac3809bbb87f56e84fd730eb0d948bcf",
"timeCreated": 1618853327549,
"lastModified": 1618853327549,
"isActive": true
},
"name": "Curae; Phasellus Ltd"
}
],
"addresses": [
{
"zipcode": "28033",
"streetLine1": "Ap #934-120 Ante Rd.",
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": true,
"id": "39722cbbf8b91a4b9045c5e6175f1001",
"timeCreated": 1618853327541,
"lastModified": 1618853327541,
"isActive": true
},
"countryCode": "US",
"city": "Portland",
"state": "OR"
},
{
"zipcode": "99999",
"streetLine1": "101 N First St",
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "18dd5a4f3e4c4b87b90209e49d2fb6b4",
"timeCreated": 1626816065573,
"lastModified": 1626816065573,
"isActive": true
},
"streetLine2": "",
"countryCode": "US",
"city": "San Jose",
"state": "CA"
}
],
"meta": {
"versionInfo": {
"versionNumber": 1,
"userAccountId": "deadbeefdeadbeefdeadbeefdeadbeef"
},
"isPrimary": false,
"id": "e54db7d751316935960ee7adc12857f2",
"timeCreated": 1618853327501,
"lastModified": 1626816065766,
"isActive": true
},
"phones": [
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": true,
"id": "73d51abbd89cb8196f0efb6892f94d68",
"timeCreated": 1618853327539,
"lastModified": 1618853327539,
"isActive": true
},
"phoneNumber": "353-719-8146"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "fccc2c35f0b84609e5f12c55dd85aba8",
"timeCreated": 1618853327569,
"lastModified": 1618853327569,
"isActive": true
},
"phoneNumber": "353-719-8147"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "a4bef9012cba4515951a127a91aa58eb",
"timeCreated": 1626816065570,
"lastModified": 1626816065570,
"isActive": true
},
"phoneNumber": "6509999999"
}
],
"debts": [
{
"chargeOffStatus": "NONE",
"initialPrincipal": {
"amount": 90223,
"currency": "USD"
},
"biller": "biller_0",
"accountNumber": "43756429154",
"accountOpenTimestamp": 1607421600000,
"creditorId": "bf5903bb58cb352d441a9816e01ca09c",
"personId": "e54db7d751316935960ee7adc12857f2",
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "99170fbb183477a35a94c9bf390b7702",
"timeCreated": 1603906010851,
"lastModified": 1618853327596,
"isActive": true
},
"defaultTimestamp": 1609495200000,
"initialInterest": {
"amount": 6494,
"currency": "USD"
},
"type": "DEBT_TYPE_NONE",
"postChargeOffInformation": {
"chargeOffTimestamp": 1606557600000
},
"initialCosts": {
"amount": 0,
"currency": "USD"
},
"product": "product_0",
"transactionIp": "127.0.0.1",
"transactionId": "839580621",
"status": "InPaymentPlan",
"initialFees": {
"amount": 0,
"currency": "USD"
},
"creditor": {
"creditorSettings": {
"creditorTimeZone": "PST",
"isFirstPartyRelationship": false,
"servicingType": "RECOVERY"
},
"originalBrand": {
"type": "DOING_BUSINESS_AS",
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"name": "iTable",
"address": {
"zipcode": "94107",
"streetLine1": "148 Townsend",
"streetLine2": "Suite #26",
"countryCode": "US",
"city": "San Francisco",
"state": "CA"
},
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "",
"timeCreated": 1618853327379,
"lastModified": 1618853327379,
"isActive": true
}
},
"meta": {
"id": "bf5903bb58cb352d441a9816e01ca09c"
},
"brand": {
"type": "DOING_BUSINESS_AS",
"description": "iTable is revolutionizing the world.",
"websiteUrl": "http://www.itable.com",
"logoUrl": "http://localhost:9000/static/img/email_logo.png",
"name": "iTable",
"address": {
"zipcode": "94107",
"streetLine1": "148 Townsend",
"streetLine2": "Suite #26",
"countryCode": "US",
"city": "San Francisco",
"state": "CA"
},
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "",
"timeCreated": 1618853327379,
"lastModified": 1618853327379,
"isActive": true
}
},
"policy": {
"isAchEnabled": true
},
"industry": "",
"companyName": "iTable",
"clientName": "iTable"
},
"balanceDetails": {
"costs": {
"amount": 0,
"currency": "USD"
},
"interest": {
"amount": 6494,
"currency": "USD"
},
"overcharges": {
"amount": 0,
"currency": "USD"
},
"principal": {
"amount": 70881,
"currency": "USD"
},
"fees": {
"amount": 0,
"currency": "USD"
},
"isSettledInFull": false
},
"maxDiscountPercent": 30,
"internalConfiguration": {
"showSpecialDisputeTreatment": true
},
"transactionIdLast4": "0621",
"accountNumberForDisplay": "0621",
"accruedInterest": {
"amount": 0,
"currency": "USD"
},
"paymentOffers": {
"highlightedPpConfiguration": {
"numberOfInstallments": 3,
"frequency": "MONTHLY",
"settlementPercent": 25
},
"availablePpConfigurations": [
{
"numberOfInstallments": 3,
"frequency": "MONTHLY",
"settlementPercent": 25
},
{
"numberOfInstallments": 6,
"frequency": "MONTHLY",
"settlementPercent": 20
},
{
"numberOfInstallments": 9,
"frequency": "MONTHLY",
"settlementPercent": 15
}
],
"availableSettlement": {
"settlementPercent": 30
},
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "741443f2d7674423b63e6711cc02c9d3",
"timeCreated": 1617730010851,
"lastModified": 1618853327609,
"isActive": true
},
"disallowCustomPlans": false,
"debtId": "99170fbb183477a35a94c9bf390b7702"
},
"balance": {
"amount": 77375,
"currency": "USD"
},
"calculatedPaymentOffers": {
"highlightedPlan": {
"installmentAmount": {
"amount": 25792,
"currency": "USD"
},
"settlementPercent": 100,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"discountPercent": 0,
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"numberOfInstallments": 3,
"percentOfCurrentBalance": 100,
"isSif": false,
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 25792,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 3,
"discount": {
"amount": 0,
"currency": "USD"
}
}
},
"settlementConstraints": {
"min": {
"percent": 70,
"amount": {
"amount": 54162,
"currency": "USD"
}
},
"max": {
"percent": 100,
"amount": {
"amount": 77375,
"currency": "USD"
}
},
"settlementsAvailable": true
},
"availablePlans": [
{
"installmentAmount": {
"amount": 25792,
"currency": "USD"
},
"settlementPercent": 100,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"discountPercent": 0,
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"numberOfInstallments": 3,
"percentOfCurrentBalance": 100,
"isSif": false,
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 25792,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 3,
"discount": {
"amount": 0,
"currency": "USD"
}
}
},
{
"installmentAmount": {
"amount": 12896,
"currency": "USD"
},
"settlementPercent": 100,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"discountPercent": 0,
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"numberOfInstallments": 6,
"percentOfCurrentBalance": 100,
"isSif": false,
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 12896,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 6,
"discount": {
"amount": 0,
"currency": "USD"
}
}
},
{
"installmentAmount": {
"amount": 8598,
"currency": "USD"
},
"settlementPercent": 100,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"discountPercent": 0,
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"numberOfInstallments": 9,
"percentOfCurrentBalance": 100,
"isSif": false,
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 8598,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 9,
"discount": {
"amount": 0,
"currency": "USD"
}
}
}
],
"disallowCustomPlans": false,
"delayedOneTimePayment": {
"installmentAmount": {
"amount": 77375,
"currency": "USD"
},
"settlementPercent": 100,
"savingsAmount": {
"amount": 0,
"currency": "USD"
},
"discountPercent": 0,
"totalToPay": {
"amount": 77375,
"currency": "USD"
},
"numberOfInstallments": 1,
"percentOfCurrentBalance": 100,
"isSif": false,
"amountOfBalance": {
"amount": 77375,
"currency": "USD"
},
"application": {
"amountToPay": {
"amount": 77375,
"currency": "USD"
},
"paymentAmount": {
"amount": 77375,
"currency": "USD"
},
"frequency": "MONTHLY",
"numberOfInstallments": 1,
"discount": {
"amount": 0,
"currency": "USD"
}
}
}
},
"placementType": "ORIGINAL",
"paymentPlanId": "4541dabab8dc500ff9ee6a46aada2f38",
"balanceDetailsAtPlacement": {
"principal": {
"amount": 90223,
"currency": "USD"
},
"interest": {
"amount": 6494,
"currency": "USD"
},
"fees": {
"amount": 0,
"currency": "USD"
},
"costs": {
"amount": 0,
"currency": "USD"
}
},
"availablePaymentMethods": {
"creditCard": true,
"debitCard": true,
"check": true
},
"specialUiTreatment": "NONE",
"isPreLegal": false,
"communicationsInformation": {
"hadInitialCommunication": false
},
"unsettledPaymentsAmount": {
"amount": 0,
"currency": "USD"
},
"isTimebarCompliant": true,
"minSettlementPercent": 70,
"initialTotal": {
"amount": 96717,
"currency": "USD"
},
"locationCreated": {
"physical": {
"zipcode": "94107",
"streetLine1": "148 Townsend",
"streetLine2": "Suite #26",
"countryCode": "US",
"city": "San Francisco",
"state": "CA"
}
},
"effectiveMaxDiscountPercent": {
"overrideType": "NO_OVERRIDE",
"maxDiscountPercent": 30,
"minSettlementPercent": 70
},
"recentTransactionInfo": {
"lastPaymentDate": {
"day": 3,
"month": 4,
"year": 2021
},
"lastPaymentAmount": {
"amount": 9671,
"currency": "USD"
}
}
}
],
"isAddressInNewYorkCity": false
}

400 Bad Request - Improperly Formatted Data#

If any parts of the contact information are not properly formatted, the API returns a status 400 error with more information about why the data was not formatted correctly.

The response body is a Error object.

Add Contact Information to a Customer 400 Bad Request Response Example
{
"code": 102,
"msg": "Invalid phone number found.",
"errorInfo": null
}

Edit Contact Information for a Customer#

PUT https://api.trueaccord.com/api/v1/customers/CUSTOMER_ID

This endpoint lets you change the name, date of birth, and language preference of the customer. It lets you insert, enable, and disable emails, phones, and addresses associated with the customer.

This is a PUT endpoint and so any information in the payload will be treated as the source of truth. Prior to calling this endpoint, please do a GET request to pull down the most recent information using the Get One Customer endpoint.

To disable an email/phone/address do not send it in the payload. To enable or insert an email/phone/address send the information in the payload. The difference between enabling and inserting is that enabling implies that the email/phone/address was already stored in our system.

Disabled emails/phones/addresses are kept in the system, and are visible in the response objects, with the meta.isActive set to false.

Edit Contact Information for a Customer Request Body#

KeyTypeRequiredAdditional Info
nameCustomer Name
languagePreferenceLanguage EnumNote that the Language put here in languagePreference does not need to match with the language put in languagePreferred. However, it is recommended to align these for data consistency.
languagePreferredCustomer Language Preferred
addressesArray of Customer AddressesAt least one address is required.
phonesArray of Customer Phones
emailsArray of Customer EmailsAt least one email is required.
Language#
EnumNotes
ENGLISH
SPANISH
FRENCH
MANDARIN
RUSSIAN
HAITIAN_CREOLE
BENGALI
ITALIAN
ARABIC
KOREAN
POLISH
CANTONESE
OTHER
Customer Language Preferred#
KeyTypeRequiredAdditional Info
languageLanguage Enum
languageChannelEnumOne of:
  • "PHONE"
  • "SELF_SERVICE"
  • "OTHER"
languageDateDate
Edit Demographic Information for a Customer Request Body Example
{
"name": {
"firstName": "John",
"lastName": "Example"
},
"dateOfBirth": {
"day": 12,
"month": 11,
"year": 1997
},
"languagePreference": "FRENCH",
"languagePreferred": {
"language": "FRENCH",
"languageChannel": "SELF_SERVICE",
"languageDate": {
"day": 22,
"month": 10,
"year": 2020
}
},
"addresses": [
{
"state": "CA",
"city": "City",
"streetLine1": "St",
"zipcode": "Zip",
"countryCode": "US"
},
{
"state": "CA",
"city": "City2",
"streetLine1": "St2",
"zipcode": "Zip2",
"countryCode": "US"
}
],
"phones": [
{
"phoneNumber": "1234567891"
},
{
"phoneNumber": "1234567892"
},
{
"phoneNumber": "1234567893"
}
],
"emails": [
{
"email": "john1@example.com"
},
{
"email": "john3@example.com"
}
]
}

Edit Contact Information for a Customer Responses#

200 OK#

Response returns the full Customer object with updated information for the customer associated with the request. The response includes Metadata as applicable.

Edit Contact Information for a Customer 200 OK Response Example
{
"dateOfBirth": {
"day": 12,
"month": 11,
"year": 1997
},
"emails": [
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "4c9326bb9805fa8f85882c12eae724ce",
"timeCreated": 1618853327547,
"lastModified": 1618853327547,
"isActive": false
},
"email": "cecilia.snyder@isp.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "f0c62e118427f5948aefa5c428c43c93",
"timeCreated": 1618853327569,
"lastModified": 1618853327569,
"isActive": false
},
"email": "cecilia353@aol.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "ae4f24909f854ed2abdfcd15a796ac71",
"timeCreated": 1626816065553,
"lastModified": 1626816065553,
"isActive": false
},
"email": "john@example.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "2feae01170e94b259ecac4d64733ff50",
"timeCreated": 1626816065556,
"lastModified": 1626816065556,
"isActive": false
},
"email": "john1977@example.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "94a4567c24c24c20b0523f6df8fd6562",
"timeCreated": 1626816588371,
"lastModified": 1626816588371,
"isActive": false
},
"email": "john21@example.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "c58e3607ff0f4eeda2449a8866d97264",
"timeCreated": 1626816588371,
"lastModified": 1626816588371,
"isActive": false
},
"email": "john1988@example.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "4b52164960fb42e49c6f1b8418195c36",
"timeCreated": 1626816875146,
"lastModified": 1626816875146,
"isActive": true
},
"email": "john1@example.com"
},
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": false,
"id": "38a23974a21b4fe9976f85e604a88720",
"timeCreated": 1626816875146,
"lastModified": 1626816875146,
"isActive": true
},
"email": "john3@example.com"
}
],
"reference": "E=>7IzDYM",
"languagePreferred": {
"language": "FRENCH",
"languageChannel": "SELF_SERVICE",
"languageDate": {
"day": 22,
"month": 10,
"year": 2020
}
},
"name": {
"firstName": "John",
"lastName": "Example"
},
"businesses": [
{
"meta": {
"versionInfo": {
"versionNumber": 0
},
"isPrimary": true,
"id": "ac3809bbb87f56e84fd730eb0d948bcf",
"timeCreated": 1618853327549,
"lastModified"