Skip to content

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

Sapphire Distribution Partners

Operations

Upload data for kaizen sapphire

Request

Uploads an array of debt data for as leads for Kaizen Sapphire. 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"
ref_idstringrequired

Your ref_id as per your contract

Example: "OPAN"
referenceMerchantstringrequired

reference merchant id, this is the same as your merchantID

Example: "9340849324-2kskd-29382-sdkns"
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[].​debt_amountstringrequired
Example: "209.23"
data[].​debt_amount_collection_accountsstring
Example: "90.20"
data[].​productTypestringrequired
Enum"tax-relief""personal-loan""debt-relief""other-need-help"
Example: "tax-relief"
data[].​credit_scorestring
Example: "700"
data[].​dobstring

Date of birth in MM/DD/YYYY format

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

An id used by your internal team (correlation ID)

Example: "ROT-23092"
data[].​ready_to_sellbooleanrequired

if it is ready to be sold immediately

Example: true
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[].​metaStringstring
Example: "{string: hello}"
curl -i -X POST \
  https://kaizen-api-gateway-public.redocly.app/_mock/openapi/uploadSapphireLead \
  -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",
    "ref_id": "OPAN",
    "referenceMerchant": "9340849324-2kskd-29382-sdkns",
    "data": [
      {
        "email": "john@gmail.com",
        "first_name": "john",
        "last_name": "doe",
        "phone": "XXXXXXXXXX",
        "debt_amount": "209.23",
        "debt_amount_collection_accounts": "90.20",
        "productType": "tax-relief",
        "credit_score": "700",
        "dob": "10/20/2001",
        "internal_reference": "ROT-23092",
        "ready_to_sell": true,
        "address1": "89 Brendan Lane",
        "address2": "",
        "city": "Los Angeles",
        "state": "CA",
        "zip": "89 Brendan Lane",
        "metaString": "{string: hello}"
      }
    ]
  }'

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
}