SMsmileapi
Income Estimators (Alpha)

Create IncomeEstimator

Changed on

Create an IncomeEstimator object.

This endpoint requires consent, templateId, emailAddress, and countryCode.

Supported template

Template IDCountryRequired parameters
tpl-incomeestimator-001PHconsent, templateId, emailAddress, countryCode

Field rules

  • templateId must be tpl-incomeestimator-001.
  • emailAddress must be a valid email address.
  • countryCode identifies the country or region of the subject.

Interpreting the result

  • probability is the raw model probability that the subject is a High earner. Use it as the primary decisioning signal.
  • certainty indicates how far probability is from the decision boundary of 0.5. It is not another probability.
  • tier is a convenience label intended for presentation in your user interface.

Sandbox Test Values

ParameterValueExpected Response
countryCodePH
emailAddressgpalomero1234@smileapi.ioresultCode = SUCCESS
post/incomes/alpha/incomeestimators

Request

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

Request body

templateId'tpl-incomeestimator-001' required

Fixed template ID for this request. The value must be tpl-incomeestimator-001.

emailAddressstring email required

The email address of the subject.

countryCode'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RS' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'XT' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'null' nullable required

2 character alpha ISO-3166 codes

Example request

{
  "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"
}

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": {
    "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

      added to the / request property allOf list

    • breaking

      the / request property type changed from string to no type, and format from date-time to no format

    • 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