accountNumberstring required
Account number used to uniquely identify each customer. Only last four digits are shown in our content. Avoid sending credit card PANs.
accountNamespacestring required
Differentiates accounts across geographic regions or business units. In combination with accountNumber, the accountNamespace creates a two-part identifier (key) in our system.
accountRelationship'SIGNER' required
The account relationship of the person named in this placement. Must be SIGNER.
accountOpenDatestring required
The date the account was originally opened (mm/dd/yyyy)
brandIdstring uuid required
An ID for the brand to be represented. This enables different first-party theming for different brands under one client relationship.
productType'AUTO' | 'BNPL' | 'CARD' | 'DDA' | 'FITNESS' | 'HEL' | 'HELOC' | 'PRESETTLEMENT' | 'POSTSETTLEMENT' | 'POSTCHARGEOFF' | 'UNSECURED' | 'UTILITY' required
Product type of the account. Used to select Product specific email templates.
productDescriptionstring required
This identifies the financial product to the consumer in content. Sample sentence: "you have a delinquent balance on your [productDescription]."
dateAssignedstring required
The date the account was placed with Retain (mm/dd/yyyy)
expectedRetractionDatestring required
An estimated date that the account will be retracted from TrueAccord (based on charge off, or other business rule). This enables additional monitoring and reporting (mm/dd/yyyy)
email1string email required
Customer email address - primary.
email2string email
Customer email address - additional.
email3string email
Customer email address - additional.
telephone1string required
First telephone number for the customer (in a 10-digit format e.g. 8666112731)
telephoneType1'HOME' | 'WORK' | 'CELL' | 'FAX' | 'BUSINESS' required
Type of the first telephone number
telephoneSMSConsent1'YES' | 'NO' required
Indicates whether client has consent for SMS communications with this customer, at this number.
telephoneVMConsent1'YES' | 'NO'
Indicates whether client has consent for Voicemail Drop communications with this customer, at this number.
telephone2string
Second telephone number for the customer (in a 10-digit format e.g. 8666112731)
telephoneType2'HOME' | 'WORK' | 'CELL' | 'FAX' | 'BUSINESS'
Type of the second telephone number
telephoneSMSConsent2'YES' | 'NO'
Indicates whether client has consent for SMS communications with this customer, at this number.
telephoneVMConsent2'YES' | 'NO'
Indicates whether client has consent for Voicemail Drop communications with this customer, at this number.
telephone3string
Third telephone number for the customer (in a 10-digit format e.g. 8666112731)
telephoneType3'HOME' | 'WORK' | 'CELL' | 'FAX' | 'BUSINESS'
Type of the third telephone number
telephoneSMSConsent3'YES' | 'NO'
Indicates whether client has consent for SMS communications with this customer, at this number.
telephoneVMConsent3'YES' | 'NO'
Indicates whether client has consent for Voicemail Drop communications with this customer, at this number.
addressLine1string required
The first line of the address for the customer. Include building number and street name. Separate from ‘addressLine2’, ‘city’, ‘state’ and ‘zipcode’.
addressLine2string
The second line of the address for the customer. Include apartment or suite number. Separate from ‘addressLine1’, ‘city’, ‘state’ and ‘zipcode’.
addressLine3string
The third line of the address for the customer. Separate from ‘addressLine1’, ‘addressLine2’, ‘city’, ‘state’ and ‘zipcode’.
addressType'HOME' | 'WORK' required
The type of address transmitted in this record (ex. HOME, WORK)
citystring required
The city for the customer.
statestring required
The state code for the customer as two-letter abbreviation (e.g. CA, NY, etc.).
zipcodestring required
The 5 digit ZIP code for the customer.
totalAmountDueinteger
The total amount that the customer owes on the account (Total Delinquent Amount + Current Amount Due). Amount is in cents.
currentAmountDueinteger
Amount currently due for this billing period (ignoring Delinquent Amount). Amount is in cents.
currentBalanceinteger
The entire balance of the account, regardless of Total Amount Due in this billing period. Amount is in cents.
totalDelinquentAmountinteger required
The amount currently delinquent on the account. Amount is in cents.
delinquencyDatestring required
Date that account became delinquent (this is the Due Date of the last missed payment in the content) (mm/dd/yyyy)
cyclesDelinquentinteger required
The numbers of cycles that the account is delinquent (number > 0). Used to select Cycle specific email templates.
campaignIdstring uuid
An ID referencing the Campaigns communication this customer is targeted for. Client Success Manager or Implementation Manager will provide you with the relevant ID(s) to use.
displayAccountNumberLast4string
Alternate 4 digit display number that will be used in Content if using the last 4 digits of provided Account Number will not be useful/recognizable to customers.
customerNumberstring
Optional number used to group accounts for the identified Customer, if required.
originalCreditorstring
Name of the original creditor for accounts that were previously owned by a different creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types.
currentCreditorstring
Name of current creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types.
originalAccountNumberstring
Last four digits of the Original Account Number that was assigned by original creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types.