--- title: "Add Accounts" method: POST path: "/inbound/v1/placement" tags: ["Account Placements"] --- # Add Accounts `POST /inbound/v1/placement` ## Request - Base URL: `https://virtserver.swaggerhub.com/felipediazc/integration/0.0.2` - URL: `https://virtserver.swaggerhub.com/felipediazc/integration/0.0.2/inbound/v1/placement` - Auth: API key in header `X-API-KEY` - TypeScript: (a function with typed inputs; its response is checked against the schema) Account placements and updates. When an account is placed, we will immediately start communications with the account, and will cease communications when the account is retracted. A maximum of 175 accounts/records can be placed in a single request. ## Request body - PlacementInformation[] - `accountNumber` string, required: Account number used to uniquely identify each customer. Only last four digits are shown in our content. Avoid sending credit card PANs. - `accountNamespace` string, 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. - `accountOpenDate` string, required: The date the account was originally opened (mm/dd/yyyy) - `brandId` string, 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. - `productDescription` string, required: This identifies the financial product to the consumer in content. Sample sentence: "you have a delinquent balance on your [productDescription]." - `dateAssigned` string, required: The date the account was placed with Retain (mm/dd/yyyy) - `expectedRetractionDate` string, 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) - `firstName` string, required: Customer First Name - `lastName` string, required: Customer Last Name - `middleName` string: Customer Middle Name. - `email1` string, email, required: Customer email address - primary. - `email2` string, email: Customer email address - additional. - `email3` string, email: Customer email address - additional. - `telephone1` string, 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. - `telephone2` string: 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. - `telephone3` string: 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. - `addressLine1` string, required: The first line of the address for the customer. Include building number and street name. Separate from ‘addressLine2’, ‘city’, ‘state’ and ‘zipcode’. - `addressLine2` string: The second line of the address for the customer. Include apartment or suite number. Separate from ‘addressLine1’, ‘city’, ‘state’ and ‘zipcode’. - `addressLine3` string: 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) - `city` string, required: The city for the customer. - `state` string, required: The state code for the customer as two-letter abbreviation (e.g. CA, NY, etc.). - `zipcode` string, required: The 5 digit ZIP code for the customer. - `totalAmountDue` integer: The total amount that the customer owes on the account (Total Delinquent Amount + Current Amount Due). Amount is in cents. - `currentAmountDue` integer: Amount currently due for this billing period (ignoring Delinquent Amount). Amount is in cents. - `currentBalance` integer: The entire balance of the account, regardless of Total Amount Due in this billing period. Amount is in cents. - `totalDelinquentAmount` integer, required: The amount currently delinquent on the account. Amount is in cents. - `delinquencyDate` string, required: Date that account became delinquent (this is the Due Date of the last missed payment in the content) (mm/dd/yyyy) - `cyclesDelinquent` integer, required: The numbers of cycles that the account is delinquent (number > 0). Used to select Cycle specific email templates. - `campaignId` string, 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. - `displayAccountNumberLast4` string: 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. - `customerNumber` string: Optional number used to group accounts for the identified Customer, if required. - `originalCreditor` string: 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. - `currentCreditor` string: Name of current creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types. - `originalAccountNumber` string: 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. ## Response `200` Payload was successfully parsed - refer to message for additional information - InboundAPIResponse200 - `ClientId` string, required: Client Id - `Status` string, required: Response status (SUCCESS) - `Message` string, required: Message description - `ProcessedRecords` integer, required: Number or records processed ## Other responses - `400`: Bad request - refer to message and/or FailedRecords for additional information. Requests can fail for a variety of reasons, e.g. invalid JSON formatting, invalid or required fields not being present. - `500`: Internal server error - an error occurred while processing the request. ## Changes - **2023-08-01** `22d6fde0b534`: 3 info - added the new optional request property `items/telephoneVMConsent1` - added the new optional request property `items/telephoneVMConsent2` - added the new optional request property `items/telephoneVMConsent3` - **2023-06-26** `82f94b7996e6`: 1 breaking, 1 info - removed the enum value `BUSINESS` of the request property `items/addressType` - added the new `WORK` enum value to the request property `items/addressType` - **2023-05-16** `8a19069a1bb6`: 2 breaking, 11 warning, 25 info - added the new required request property `items/brandId` - removed the enum value `COSIGNER` of the request property `items/accountRelationship` - removed the request property `items/brandID` - removed the request property `items/lastPaymentAmount` - …34 more - **2022-06-06** `2e947a46e3e5`: 3 breaking, 3 info - added the new required request property `items/productDescription` - the request property `items/telephoneSMSConsent1` became required - the request property `items/telephoneType1` became required - added the new `BNPL` enum value to the request property `items/productType` - …2 more - **2022-06-03** `53402ea03c77`: 9 info - added the new optional request property `items/campaignId` - added the new optional request property `items/telephoneSMSConsent1` - added the new optional request property `items/telephoneSMSConsent2` - added the new optional request property `items/telephoneSMSConsent3` - …5 more [Operation history](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/changes/inbound/v1/placement/post.md) --- [API](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api.md) - [All operations](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/revisions/22d6fde0b534?raw)