Create Customer

cURL

curl --request POST \
  --url https://sandbox.veritusagent.ai/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "96b887fb-9371-4515-b51e-28434f58dd7e",
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "CUST-12345",
    "firstName": "John",
    "middleName": "Christopher",
    "lastName": "Doe",
    "email": "[email protected]",
    "primaryPhone": "+12025551234",
    "secondaryPhone": "+12025555678",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "Washington",
      "state": "DC",
      "zip": "20001"
    },
    "collections": {
      "principalBalance": 5000,
      "originalCreditor": "ABC Bank",
      "accruedInterestAmount": 250.5,
      "totalBalance": 5250.5,
      "chargeOffDate": "2023-01-15",
      "firstDelinquencyDate": "2022-06-01",
      "settlementAggregationRate": 0.65,
      "originalAccountNumber": "4111111111111111",
      "itemizationBalance": 5000,
      "postItemizationInterest": 150.25,
      "postItemizationFees": 100.25,
      "postItemizationCredits": 50,
      "postItemizationPayments": 200,
      "productType": "Credit Card",
      "originalProductType": "Visa Signature"
    },
    "ssnLastFour": "1234",
    "dateOfBirth": "1985-03-15"
  }
}

POST

customers

cURL

curl --request POST \
  --url https://sandbox.veritusagent.ai/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "96b887fb-9371-4515-b51e-28434f58dd7e",
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "CUST-12345",
    "firstName": "John",
    "middleName": "Christopher",
    "lastName": "Doe",
    "email": "[email protected]",
    "primaryPhone": "+12025551234",
    "secondaryPhone": "+12025555678",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "Washington",
      "state": "DC",
      "zip": "20001"
    },
    "collections": {
      "principalBalance": 5000,
      "originalCreditor": "ABC Bank",
      "accruedInterestAmount": 250.5,
      "totalBalance": 5250.5,
      "chargeOffDate": "2023-01-15",
      "firstDelinquencyDate": "2022-06-01",
      "settlementAggregationRate": 0.65,
      "originalAccountNumber": "4111111111111111",
      "itemizationBalance": 5000,
      "postItemizationInterest": 150.25,
      "postItemizationFees": 100.25,
      "postItemizationCredits": 50,
      "postItemizationPayments": 200,
      "productType": "Credit Card",
      "originalProductType": "Visa Signature"
    },
    "ssnLastFour": "1234",
    "dateOfBirth": "1985-03-15"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

externalId

string

required

The ID of the customer in your system.

firstName

string

required

The first name of the customer.

lastName

string

required

The last name of the customer.

string

required

The email address of the customer.

primaryPhone

string

required

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

address

object

required

The address of the customer.

Show child attributes

address.zip

string

required

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

address.line1

string

The first line of the address.

address.line2

string

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

address.city

string

The city of the address.

address.state

string

The state of the address.

middleName

string

The middle name of the customer.

secondaryPhone

string

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

ssnLastFour

string

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

Required string length: 4

dateOfBirth

string

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

collections

object

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

Show child attributes

collections.totalBalance

number

required

The total balance of the customer's collections.

Required range: x >= 0

collections.principalBalance

number | null

The principal balance amount.

Required range: x >= 0

collections.originalCreditor

string | null

The name of the original creditor.

collections.accruedInterestAmount

number | null

The amount of accrued interest.

Required range: x >= 0

collections.chargeOffDate

string<date> | null

The date when the account was charged off.

collections.firstDelinquencyDate

string<date> | null

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

collections.settlementAggregationRate

number | null

The settlement aggregation rate.

Required range: x >= 0

collections.originalAccountNumber

string | null

The original account number.

collections.itemizationBalance

number | null

The itemization balance amount.

Required range: x >= 0

collections.postItemizationInterest

number | null

Interest accrued after itemization.

Required range: x >= 0

collections.postItemizationFees

number | null

Fees accrued after itemization.

Required range: x >= 0

collections.postItemizationCredits

number | null

Credits applied after itemization.

Required range: x >= 0

collections.postItemizationPayments

number | null

Payments made after itemization.

Required range: x >= 0

collections.productType

string | null

The current product type.

collections.originalProductType

string | null

The original product type.

Response

Customer response

string<uuid>

required

The ID of the customer.

externalId

string

required

The ID of the customer in your system.

firstName

string

required

The first name of the customer.

lastName

string

required

The last name of the customer.

string

required

The email address of the customer.

primaryPhone

string

required

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

address

object

required

The address of the customer.

Show child attributes

address.zip

string

required

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

address.line1

string

The first line of the address.

address.line2

string

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

address.city

string

The city of the address.

address.state

string

The state of the address.

middleName

string

The middle name of the customer.

secondaryPhone

string

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

ssnLastFour

string

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

Required string length: 4

dateOfBirth

string

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

Update Customer

⌘I

Customers

Calls

Drip Campaigns

Webhooks

Authorizations

Body

Response