Income Detection

Income detection analyses a customer’s bank transactions to automatically identify their primary source of income, typical pay cycle, and consistency of deposits. This feature provides a simple and reliable way to confirm employment income without requiring extra input from the partner, returning the income source name along with a confidence score that reflects how certain the system is about the detection.

Detect income from existing transactions

post

Detect the customer's income using previously uploaded transactions.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstringRequired

The email of the customer.

Responses

200

Employer detection result

application/json

401

Unauthorized

404

Customer or transactions not found

post

/api/v2/partner/income/verify

HTTPcURLJavaScriptPython

POST /api/v2/partner/income/verify HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "email": "[email protected]"
}

{
  "employerName": "ACME LTD",
  "confidence": 0.94,
  "payCycle": "monthly",
  "typeOfIncome": "regular_salary",
  "lastPaidAmount": "GBP 3350.0",
  "lastPaidAt": "2025-08-30T09:15:00Z"
}