Kaizen Scrubbing API (11.2.1)

To get integration keys, go to Settings > API Keys

Languages
Servers
Mock server

https://kaizen-api-gateway-public.redocly.app/_mock/openapi/

Production Server

https://kaizen.vertebratechnologies.com/apiGateway/

Debt Settlement

Endpoints related to settlement matching

Operations

Upload data for debt relief matching

Request

Uploads an array of debt data for matching. Includes extensive validation and authorization via headers.

Security
IntegrationAuth or IntegrationSecret or TunnelID or MerchantID
Headers
tunnel_idstringrequired
integration_apikeystringrequired
integration_secretstringrequired
merchant_idstringrequired
Bodyapplication/jsonrequired
userstring(email)required

Kaizen email of the user uploading data

Example: "debtor@example.com"
settlementFloornumberrequired

Minimum settlement floor

Example: 60
dataArray of objects<= 500 itemsrequired

Array of settlement data

data[].​emailstring(email)required
Example: "john@gmail.com"
data[].​first_namestringrequired
Example: "john"
data[].​last_namestringrequired
Example: "doe"
data[].​phonestringrequired

10-digit phone number

Example: "XXXXXXXXXX"
data[].​principal_amountstringrequired
Example: "209.23"
data[].​amount_paidstring
Example: "90.20"
data[].​due_since_datestringrequired

Date in MM/DD/YYYY format

Example: "12/20/2019"
data[].​debt_typestringrequired
Enum"Credit Card Debt""Personal Loans""Auto Loans""Payday Loans""Student Loans""Medical Debt""Utility Bills""Cell Phone Bills""Rent Arrears""Mortgage Deficiency Balances"
Example: "Credit Card Debt"
data[].​credit_scorestring
Example: "700"
data[].​dobstring

Date of birth in MM/DD/YYYY format

Example: "10/20/2001"
data[].​internalIDstring

An id used by your internal team (correlation ID)

Example: "ROT-23092"
data[].​address1string
Example: "89 Brendan Lane"
data[].​address2string
Example: ""
data[].​citystring
Example: "Los Angeles"
data[].​statestring
Example: "CA"
data[].​zipstring
Example: "89 Brendan Lane"
data[].​is_judgmentstring
Enum"TRUE""true""false""FALSE"
Example: "TRUE"
curl -i -X POST \
  https://kaizen-api-gateway-public.redocly.app/_mock/openapi/uploadScrubData \
  -H 'Content-Type: application/json' \
  -H 'integration_apikey: YOUR_API_KEY_HERE' \
  -H 'integration_secret: string' \
  -H 'merchant_id: string' \
  -H 'tunnel_id: string' \
  -d '{
    "user": "debtor@example.com",
    "settlementFloor": 60,
    "data": [
      {
        "email": "john@gmail.com",
        "first_name": "john",
        "last_name": "doe",
        "phone": "XXXXXXXXXX",
        "principal_amount": "209.23",
        "amount_paid": "90.20",
        "due_since_date": "12/20/2019",
        "debt_type": "Credit Card Debt",
        "credit_score": "700",
        "dob": "10/20/2001",
        "internalID": "ROT-23092",
        "address1": "89 Brendan Lane",
        "address2": "",
        "city": "Los Angeles",
        "state": "CA",
        "zip": "89 Brendan Lane",
        "is_judgment": "TRUE"
      }
    ]
  }'

Responses

Successful upload

Bodyapplication/json
messagestring
Example: "Success"
promptstring
Example: ""
successful_optionsinteger
Example: 3
total_optionsinteger
Example: 100
success_ratenumber
Example: 3
Response
application/json
{
  "message": "Success",
  "prompt": "",
  "successful_options": 3,
  "total_options": 100,
  "success_rate": 3
}

Get paginated data of your uploaded data

Request

Get an array (500 at a time) of debt data you've uploaded, or specify an id.

Security
IntegrationAuth or IntegrationSecret or TunnelID or MerchantID
Headers
tunnel_idstringrequired
integration_apikeystringrequired
integration_secretstringrequired
merchant_idstringrequired
Bodyapplication/jsonrequired
userstring(email)required

Kaizen email of the user uploading data

Example: "debtor@example.com"
pagenumber(number)

Pagination, will default to 0 if not provided

Example: 0
specific_idstring(string)

Id of a specific dataset

Example: 0
curl -i -X POST \
  https://kaizen-api-gateway-public.redocly.app/_mock/openapi/getScrubData \
  -H 'Content-Type: application/json' \
  -H 'integration_apikey: YOUR_API_KEY_HERE' \
  -H 'integration_secret: string' \
  -H 'merchant_id: string' \
  -H 'tunnel_id: string' \
  -d '{
    "user": "debtor@example.com",
    "page": 0,
    "specific_id": 0
  }'

Responses

Successful upload

Bodyapplication/json
messagestring
Example: "Success"
promptstring
Example: ""
dataArray of arrays
Example: [{"uid":"0d666c71-396b-4a7e-3283-9dfe36745bfd0","merchantID":"928398932-0dcc-c81a-f28086","address1":"22 Arizona St","address2":"Apt 9","city":"Phoenix","state":"AZ","zip":"90010","debt_type":"Medical Sample","amount_paid":"30000","email":"jim.lee@example.com","first_name":"","last_name":"","phone":"123-456-7890","amountDue":"120900","principal":"120000","status":"marketing_in_progress","credit_score":"Not Provided","internal_id":"Not Provided","dob":"Not Provided","date_uploaded":{"_seconds":1733279908,"_nanoseconds":7250000},"settlementFloor":"32"}]
Response
application/json
{
  "message": "Success",
  "prompt": "",
  "data": [
    { … }
  ]
}

Update data for debt relief matching

Request

Update an array of debt data for matching. Must include valid uid with each data object.

Security
IntegrationAuth or IntegrationSecret or TunnelID or MerchantID
Headers
tunnel_idstringrequired
integration_apikeystringrequired
integration_secretstringrequired
merchant_idstringrequired
Bodyapplication/jsonrequired
userstring(email)required

Kaizen email of the user uploading data

Example: "debtor@example.com"
dataArray of objects<= 500 itemsrequired

Array of settlement data

data[].​uidstring(string)required
Example: "9238923098430-923840923"
data[].​emailstring(email)
Example: "john@gmail.com"
data[].​first_namestring
Example: "john"
data[].​last_namestring
Example: "doe"
data[].​phonestring

10-digit phone number

Example: "XXXXXXXXXX"
data[].​amountDuestring
Example: "10.20"
data[].​principal_amountstring
Example: "209.23"
data[].​amount_paidstring
Example: "90.20"
data[].​due_since_datestring

Date in MM/DD/YYYY format

Example: "12/20/2019"
data[].​debt_typestring
Enum"Credit Card Debt""Personal Loans""Auto Loans""Payday Loans""Student Loans""Medical Debt""Utility Bills""Cell Phone Bills""Rent Arrears""Mortgage Deficiency Balances"
Example: "Credit Card Debt"
data[].​credit_scorestring
Example: "700"
data[].​dobstring

Date of birth in MM/DD/YYYY format

Example: "10/20/2001"
data[].​internalIDstring

An id used by your internal team (correlation ID)

Example: "ROT-23092"
data[].​address1string
Example: "89 Brendan Lane"
data[].​address2string
Example: ""
data[].​citystring
Example: "Los Angeles"
data[].​statestring
Example: "CA"
data[].​zipstring
Example: "89 Brendan Lane"
data[].​is_judgmentstring
Enum"TRUE""true""false""FALSE"
Example: "TRUE"
curl -i -X POST \
  https://kaizen-api-gateway-public.redocly.app/_mock/openapi/updateScrubData \
  -H 'Content-Type: application/json' \
  -H 'integration_apikey: YOUR_API_KEY_HERE' \
  -H 'integration_secret: string' \
  -H 'merchant_id: string' \
  -H 'tunnel_id: string' \
  -d '{
    "user": "debtor@example.com",
    "data": [
      {
        "uid": "9238923098430-923840923",
        "email": "john@gmail.com",
        "first_name": "john",
        "last_name": "doe",
        "phone": "XXXXXXXXXX",
        "amountDue": "10.20",
        "principal_amount": "209.23",
        "amount_paid": "90.20",
        "due_since_date": "12/20/2019",
        "debt_type": "Credit Card Debt",
        "credit_score": "700",
        "dob": "10/20/2001",
        "internalID": "ROT-23092",
        "address1": "89 Brendan Lane",
        "address2": "",
        "city": "Los Angeles",
        "state": "CA",
        "zip": "89 Brendan Lane",
        "is_judgment": "TRUE"
      }
    ]
  }'

Responses

Successful upload

Bodyapplication/json
messagestring
Example: "Success"
promptstring
Example: ""
successful_optionsinteger
Example: 3
total_optionsinteger
Example: 100
success_ratenumber
Example: 3
Response
application/json
{
  "message": "Success",
  "prompt": "",
  "successful_options": 3,
  "total_options": 100,
  "success_rate": 3
}