Create IncomeEstimator

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
emailAddress[email protected]resultCode = SUCCESS
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
consent
object
required
string
enum
required

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

Allowed:
string
required

The email address of the subject.

string | null
enum
required

2 character alpha ISO-3166 codes

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json