Create Customers in Bulk

cURL

curl --request POST \
  --url https://sandbox.veritusagent.ai/api/v1/customers/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customers": [
    {
      "externalId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "primaryPhone": "<string>",
      "address": {
        "zip": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "middleName": "<string>",
      "secondaryPhone": "<string>",
      "ssnLastFour": "<string>",
      "dateOfBirth": "<string>",
      "collections": {
        "totalBalance": 1,
        "principalBalance": 1,
        "originalCreditor": "<string>",
        "accruedInterestAmount": 1,
        "chargeOffDate": "2023-12-25",
        "firstDelinquencyDate": "2023-12-25",
        "settlementAggregationRate": 1,
        "originalAccountNumber": "<string>",
        "itemizationBalance": 1,
        "postItemizationInterest": 1,
        "postItemizationFees": 1,
        "postItemizationCredits": 1,
        "postItemizationPayments": 1,
        "productType": "<string>",
        "originalProductType": "<string>"
      }
    }
  ]
}
'

{
  "requestId": "838be160-334c-47aa-a559-d92d5cdc2ef4",
  "success": true,
  "data": {
    "summary": {
      "total": 2,
      "succeeded": 1,
      "failed": 1
    },
    "results": [
      {
        "externalId": "CUST-123456",
        "success": false,
        "error": "Customer with external ID 'CUST-123456' already exists"
      },
      {
        "success": true,
        "customer": {
          "id": "7ff34749-ddef-4a1f-8568-296a2240a6cc",
          "externalId": "CUST-987654",
          "firstName": "Johnny",
          "middleName": "Fuji",
          "lastName": "Appleseed",
          "email": "[email protected]",
          "primaryPhone": "+14153334444",
          "secondaryPhone": null,
          "ssnLastFour": "5345",
          "dateOfBirth": "1990-01-21",
          "address": {
            "line1": "123 Main St",
            "line2": "Suite 200",
            "city": "San Francisco",
            "state": "CA",
            "zip": "94131"
          },
          "collections": {
            "principalBalance": 5000,
            "originalCreditor": "ABC Bank",
            "accruedInterestAmount": 250.5,
            "totalBalance": 5250.5,
            "chargeOffDate": "2023-01-15",
            "firstDelinquencyDate": "2022-06-01"
          },
          "createdAt": "2025-10-23T05:38:45.468Z"
        }
      }
    ]
  }
}

POST

customers

bulk

cURL

curl --request POST \
  --url https://sandbox.veritusagent.ai/api/v1/customers/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customers": [
    {
      "externalId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "primaryPhone": "<string>",
      "address": {
        "zip": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "middleName": "<string>",
      "secondaryPhone": "<string>",
      "ssnLastFour": "<string>",
      "dateOfBirth": "<string>",
      "collections": {
        "totalBalance": 1,
        "principalBalance": 1,
        "originalCreditor": "<string>",
        "accruedInterestAmount": 1,
        "chargeOffDate": "2023-12-25",
        "firstDelinquencyDate": "2023-12-25",
        "settlementAggregationRate": 1,
        "originalAccountNumber": "<string>",
        "itemizationBalance": 1,
        "postItemizationInterest": 1,
        "postItemizationFees": 1,
        "postItemizationCredits": 1,
        "postItemizationPayments": 1,
        "productType": "<string>",
        "originalProductType": "<string>"
      }
    }
  ]
}
'

{
  "requestId": "838be160-334c-47aa-a559-d92d5cdc2ef4",
  "success": true,
  "data": {
    "summary": {
      "total": 2,
      "succeeded": 1,
      "failed": 1
    },
    "results": [
      {
        "externalId": "CUST-123456",
        "success": false,
        "error": "Customer with external ID 'CUST-123456' already exists"
      },
      {
        "success": true,
        "customer": {
          "id": "7ff34749-ddef-4a1f-8568-296a2240a6cc",
          "externalId": "CUST-987654",
          "firstName": "Johnny",
          "middleName": "Fuji",
          "lastName": "Appleseed",
          "email": "[email protected]",
          "primaryPhone": "+14153334444",
          "secondaryPhone": null,
          "ssnLastFour": "5345",
          "dateOfBirth": "1990-01-21",
          "address": {
            "line1": "123 Main St",
            "line2": "Suite 200",
            "city": "San Francisco",
            "state": "CA",
            "zip": "94131"
          },
          "collections": {
            "principalBalance": 5000,
            "originalCreditor": "ABC Bank",
            "accruedInterestAmount": 250.5,
            "totalBalance": 5250.5,
            "chargeOffDate": "2023-01-15",
            "firstDelinquencyDate": "2022-06-01"
          },
          "createdAt": "2025-10-23T05:38:45.468Z"
        }
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

customers

object[]

required

Array of customers to create.

Show child attributes

customers.externalId

string

required

The ID of the customer in your system.

customers.firstName

string

required

The first name of the customer.

customers.lastName

string

required

The last name of the customer.

customers.email

string

required

The email address of the customer.

customers.primaryPhone

string

required

The primary phone number of the customer. (E.164 format)

customers.address

object

required

The address of the customer.

Show child attributes

customers.address.zip

string

required

The zip code of the address. Use 5 digits (12345) or 9 digits (12345-1234) format.

customers.address.line1

string

The first line of the address.

customers.address.line2

string

The second line of the address (e.g., apartment, suite, unit number).

customers.address.city

string

The city of the address.

customers.address.state

string

The state of the address.

customers.middleName

string

The middle name of the customer.

customers.secondaryPhone

string

The secondary phone number of the customer. (E.164 format)

customers.ssnLastFour

string

The last four digits of the customer's Social Security Number. Required for collections customers.

Required string length: 4

customers.dateOfBirth

string

The date of birth of the customer. YYYY-MM-DD format. Required for collections customers.

customers.collections

object

Required for customers with collections. If set, you must also provide ssnLastFour and dateOfBirth.

Show child attributes

customers.collections.totalBalance

number

required

The total balance of the customer's collections.

Required range: x >= 0

customers.collections.principalBalance

number | null

The principal balance amount.

Required range: x >= 0

customers.collections.originalCreditor

string | null

The name of the original creditor.

customers.collections.accruedInterestAmount

number | null

The amount of accrued interest.

Required range: x >= 0

customers.collections.chargeOffDate

string<date> | null

The date when the account was charged off.

customers.collections.firstDelinquencyDate

string<date> | null

The date of the first delinquency. (ISO-8601 format: YYYY-MM-DD).

customers.collections.settlementAggregationRate

number | null

The settlement aggregation rate.

Required range: x >= 0

customers.collections.originalAccountNumber

string | null

The original account number.

customers.collections.itemizationBalance

number | null

The itemization balance amount.

Required range: x >= 0

customers.collections.postItemizationInterest

number | null

Interest accrued after itemization.

Required range: x >= 0

customers.collections.postItemizationFees

number | null

Fees accrued after itemization.

Required range: x >= 0

customers.collections.postItemizationCredits

number | null

Credits applied after itemization.

Required range: x >= 0

customers.collections.postItemizationPayments

number | null

Payments made after itemization.

Required range: x >= 0

customers.collections.productType

string | null

The current product type.

customers.collections.originalProductType

string | null

The original product type.

Response

Bulk customer creation response. Contains arrays of successful and failed customer creations.

requestId

string<uuid>

required

The request identifier.

success

boolean

required

Whether the bulk operation completed successfully.

data

object

required

Results of the bulk customer creation.

Show child attributes

data.summary

object

required

Summary statistics for the bulk operation.

Show child attributes

data.summary.total

integer

required

Total number of customers in the request.

data.summary.succeeded

integer

required

Number of customers successfully created.

data.summary.failed

integer

required

Number of customers that failed to create.

data.results

(Success Result · object | Failure Result · object)[]

required

Array of results for each customer creation attempt, in the same order as the request.

Success Result
Failure Result

Show child attributes

data.results.success

enum<boolean>

required

Indicates successful customer creation.

Available options:

true,

false

data.results.customer

object

required

The created customer object.

Show child attributes

data.results.customer.id

string<uuid>

required

The ID of the customer.

data.results.customer.externalId

string

required

The ID of the customer in your system.

data.results.customer.firstName

string

required

The first name of the customer.

data.results.customer.lastName

string

required

The last name of the customer.

data.results.customer.email

string

required

The email address of the customer.

data.results.customer.primaryPhone

string

required

The primary phone number of the customer. (E.164 format)

data.results.customer.address

object

required

The address of the customer.

Show child attributes

data.results.customer.address.zip

string

required

The zip code of the address. Use 5 digits (12345) or 9 digits (12345-1234) format.

data.results.customer.address.line1

string

The first line of the address.

data.results.customer.address.line2

string

The second line of the address (e.g., apartment, suite, unit number).

data.results.customer.address.city

string

The city of the address.

data.results.customer.address.state

string

The state of the address.

data.results.customer.middleName

string

The middle name of the customer.

data.results.customer.secondaryPhone

string

The secondary phone number of the customer. (E.164 format)

data.results.customer.ssnLastFour

string

The last four digits of the customer's Social Security Number. Required for collections customers.

Required string length: 4

data.results.customer.dateOfBirth

string

The date of birth of the customer. YYYY-MM-DD format. Required for collections customers.

data.results.customer.createdAt

string<date-time>

Timestamp when the customer was created. ISO-8601 format.

Update Customer Create Call

⌘I

Customers

Calls

Drip Campaigns

Webhooks

Authorizations

Body

Response