SMsmileapi
Income Estimators (Alpha)

List IncomeEstimators

Changed on

List all IncomeEstimator objects.

get/incomes/alpha/incomeestimators

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/incomes/alpha/incomeestimators
  • Auth
    HTTP basic

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

idstring

Filter IncomeEstimator objects by a specific IncomeEstimator ID.

startDatestring date

Filter IncomeEstimator objects by the start date and time of the request range.

endDatestring date

Filter IncomeEstimator objects by the end date and time of the request range.

emailAddressstring email

Filter IncomeEstimator objects by a specific email address.

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "id": "ind-1234567890",
        "createdAt": "2021-04-14T09:30:24Z",
        "requestMeta": {
          "consent": {
            "type": "Terms and Conditions",
            "version": "1.0.0",
            "consentedAt": "2021-04-14T09:30:24Z",
            "consentedWith": "I agree to the terms and conditions"
          },
          "templateId": "tpl-incomeestimator-001",
          "emailAddress": "gpalomero1234@smileapi.io",
          "countryCode": "PH"
        },
        "result": {
          "income": {
            "monthlyMin": 50000,
            "monthlyMax": 100000,
            "currency": "PHP",
            "tier": "HIGH"
          },
          "probability": 0.7388,
          "certainty": "MEDIUM",
          "modelVersion": "1.0.0"
        }
      }
    ]
  }
}

Changes

  • v1a68faef4b017Revision changes
    • breaking

      the ///// response's property type changed from string to no type, and format from date-time to no format for status

    • info

      added to the ///// response property allOf list for the response status

  • v13bcbeecafbabRevision changes
    • info

      endpoint added