Customers

Create customers (original method)

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

post/customers/

Request

Base URL
https://api.trueaccord.com/api/v1
Auth
none declared
TypeScript
https://skmtc.dev/trueaccord/apis/trueaccord-api/docs/customers/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

addDebtsIfPossibleboolean

Optional boolean flag to add new debts to customers in the request if they have already been placed.

Example request

{
  "customers": [
    {
      "dateOfBirth": {
        "day": 6,
        "month": 4,
        "year": 2012
      },
      "addresses": [
        {
          "streetLine1": "101 N First St",
          "streetLine2": "Apt 2",
          "city": "San Jose",
          "state": "CA",
          "zipcode": "55555",
          "countryCode": "US"
        }
      ],
      "emails": [
        {
          "email": "example@trueaccord.com"
        }
      ],
      "comments": [
        {
          "comment": "Transaction failed due to insufficient funds."
        }
      ],
      "reference": "MyRef",
      "debts": [
        {
          "initialPrincipal": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialInterest": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialFees": {
            "amount": 30000,
            "currency": "USD"
          },
          "postChargeOffInformation": {
            "balanceAtChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "feesAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "interestAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "totalPaidSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            }
          }
        }
      ],
      "ssn": "123456789"
    }
  ],
  "customersWithAddedDebts": [
    {
      "dateOfBirth": {
        "day": 6,
        "month": 4,
        "year": 2012
      },
      "addresses": [
        {
          "streetLine1": "101 N First St",
          "streetLine2": "Apt 2",
          "city": "San Jose",
          "state": "CA",
          "zipcode": "55555",
          "countryCode": "US"
        }
      ],
      "emails": [
        {
          "email": "example@trueaccord.com"
        }
      ],
      "comments": [
        {
          "comment": "Transaction failed due to insufficient funds."
        }
      ],
      "reference": "MyRef",
      "debts": [
        {
          "initialPrincipal": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialInterest": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialFees": {
            "amount": 30000,
            "currency": "USD"
          },
          "postChargeOffInformation": {
            "balanceAtChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "feesAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "interestAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "totalPaidSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            }
          }
        }
      ],
      "ssn": "123456789"
    }
  ]
}

Response

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 duplicated customers in the query that have been placed before, their references will appear in the response under the duplicatedReferences field.

If addDebtsIfPossible is flagged, the response will mirror your request with new customers, and also include a separate field for existing customers that had new debts added, customersWithAddedDebts.

addDebtsIfPossibleboolean

Optional boolean flag to add new debts to customers in the request if they have already been placed.

Example response

{
  "meta": {
    "id": "3ef84ff19ddc",
    "isActive": true
  },
  "customers": [
    {
      "meta": {
        "id": "3ef84ff19ddc",
        "isActive": true
      },
      "dateOfBirth": {
        "day": 6,
        "month": 4,
        "year": 2012
      },
      "addresses": [
        {
          "streetLine1": "101 N First St",
          "streetLine2": "Apt 2",
          "city": "San Jose",
          "state": "CA",
          "zipcode": "55555",
          "countryCode": "US"
        }
      ],
      "emails": [
        {
          "email": "example@trueaccord.com"
        }
      ],
      "comments": [
        {
          "comment": "Transaction failed due to insufficient funds."
        }
      ],
      "reference": "MyRef",
      "debts": [
        {
          "initialPrincipal": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialInterest": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialFees": {
            "amount": 30000,
            "currency": "USD"
          },
          "postChargeOffInformation": {
            "balanceAtChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "feesAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "interestAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "totalPaidSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            }
          }
        }
      ],
      "ssn": "123456789"
    }
  ],
  "customersWithAddedDebts": [
    {
      "meta": {
        "id": "3ef84ff19ddc",
        "isActive": true
      },
      "dateOfBirth": {
        "day": 6,
        "month": 4,
        "year": 2012
      },
      "addresses": [
        {
          "streetLine1": "101 N First St",
          "streetLine2": "Apt 2",
          "city": "San Jose",
          "state": "CA",
          "zipcode": "55555",
          "countryCode": "US"
        }
      ],
      "emails": [
        {
          "email": "example@trueaccord.com"
        }
      ],
      "comments": [
        {
          "comment": "Transaction failed due to insufficient funds."
        }
      ],
      "reference": "MyRef",
      "debts": [
        {
          "initialPrincipal": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialInterest": {
            "amount": 30000,
            "currency": "USD"
          },
          "initialFees": {
            "amount": 30000,
            "currency": "USD"
          },
          "postChargeOffInformation": {
            "balanceAtChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "feesAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "interestAccruedSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            },
            "totalPaidSinceChargeOff": {
              "amount": 30000,
              "currency": "USD"
            }
          }
        }
      ],
      "ssn": "123456789"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.