Smile · Schema
IncomeEstimator List Response
CompanyEmployment VerificationCredit ScoringKYCFraud PreventionPhilippines
Properties
| Name | Type | Description |
|---|---|---|
| code | object | |
| message | object | |
| requestId | object | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-income-estimator-list-response-schema.json",
"title": "IncomeEstimator List Response",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/getsmileapi-income-estimators-alpha-api-openapi.yml#/components/schemas/IncomeEstimatorListResponse",
"type": "object",
"properties": {
"code": {
"$ref": "#/$defs/ObjectMetadataRefCode"
},
"message": {
"$ref": "#/$defs/ObjectMetadataRefMessage"
},
"requestId": {
"$ref": "#/$defs/ObjectMetadataRefRequestID"
},
"data": {
"type": "object",
"properties": {
"nextCursor": {
"$ref": "#/$defs/ObjectNextCursor"
},
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/IncomeEstimator"
}
}
}
}
},
"$defs": {
"Consent": {
"type": "object",
"required": [
"consentedAt",
"consentedWith"
],
"properties": {
"type": {
"type": "string",
"description": "The internal name of your consent document (e.g. \"Terms and Conditions\" or \"Privacy Policy\"); your own reference label"
},
"version": {
"type": "string",
"description": "Your internal version identifier for this consent document (e.g. \"1.0.0\")"
},
"consentedAt": {
"allOf": [
{
"$ref": "#/$defs/RefDateTime"
}
],
"description": "The date and time the subject accepted your consent document, typically when they tapped \"I agree\" in your app. Not the time of this API call. Use ISO 8601 format, e.g. \"2024-04-14T09:30:24Z\""
},
"consentedWith": {
"type": "string",
"description": "The exact text of the button or checkbox the user clicked to give consent, e.g. \"I agree to the Terms and Conditions\""
},
"consentTemplateId": {
"type": "string",
"description": "ID of a stored Consent Template. Retrieve from the Developer Portal or GET /consentTemplates. Overrides any inline fields above when provided."
}
}
},
"IncomeEstimator": {
"type": "object",
"required": [
"id",
"createdAt",
"status",
"requestMeta"
],
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the IncomeEstimator."
},
"createdAt": {
"$ref": "#/$defs/RefDateTime"
},
"status": {
"type": "string",
"description": "The current status of the IncomeEstimator.",
"enum": [
"PROCESSING",
"ERROR",
"COMPLETED"
]
},
"resultCode": {
"type": "string",
"description": "The final result code of the IncomeEstimator.",
"enum": [
"SUCCESS",
"NO_DATA",
"SYSTEM_ERROR",
"SERVICE_UNAVAILABLE"
]
},
"resultMessage": {
"type": "string",
"description": "A detailed description of the final result of the IncomeEstimator."
},
"requestMeta": {
"$ref": "#/$defs/IncomeEstimatorPostRequest"
},
"result": {
"$ref": "#/$defs/IncomeEstimatorResult"
}
}
},
"IncomeEstimatorIncome": {
"type": "object",
"required": [
"monthlyMin",
"monthlyMax",
"currency",
"tier"
],
"properties": {
"monthlyMin": {
"type": "number",
"description": "The estimated minimum monthly income."
},
"monthlyMax": {
"type": "number",
"description": "The estimated maximum monthly income."
},
"currency": {
"$ref": "#/$defs/RefCurrency"
},
"tier": {
"type": "string",
"description": "A convenience label for presenting the estimated income tier in a user interface. Use `probability` as the primary decisioning signal.",
"enum": [
"LOW",
"MIDDLE",
"HIGH"
]
}
}
},
"IncomeEstimatorPostRequest": {
"type": "object",
"required": [
"consent",
"templateId",
"emailAddress",
"countryCode"
],
"properties": {
"consent": {
"$ref": "#/$defs/Consent"
},
"templateId": {
"type": "string",
"description": "Fixed template ID for this request. The value must be `tpl-incomeestimator-001`.",
"enum": [
"tpl-incomeestimator-001"
]
},
"emailAddress": {
"type": "string",
"format": "email",
"description": "The email address of the subject."
},
"countryCode": {
"$ref": "#/$defs/RefCountry"
}
}
},
"IncomeEstimatorResult": {
"type": "object",
"required": [
"income",
"probability",
"certainty",
"modelVersion"
],
"properties": {
"income": {
"$ref": "#/$defs/IncomeEstimatorIncome"
},
"probability": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "The raw probability produced by the model that the subject is a High earner. Use this value as the primary decisioning signal."
},
"certainty": {
"type": "string",
"description": "A categorical measure of how far `probability` is from the decision boundary of 0.5. A higher certainty means the probability is farther from 0.5; this field is not another probability.",
"enum": [
"HIGH",
"MEDIUM",
"LOW"
]
},
"modelVersion": {
"type": "string",
"description": "The version of the model used to produce the result."
}
}
},
"ObjectMetadataRefCode": {
"type": "string",
"title": "ObjectMetadataRefCode",
"description": "Request status code",
"enum": [
"OK",
"CREATED",
"INVALID_CREDENTIALS",
"INVALID_PARAMETERS",
"INVALID_TOKEN",
"UNAUTHORIZED_ACCESS",
"MISSING_RESOURCE",
"REQUEST_LIMIT_EXCEEDED",
"SERVER_ERROR",
"UNSUPPORTED_METHOD",
"SERVER_UNAVAILABLE",
"TIME_LIMIT_EXCEEDED"
],
"x-internal": false
},
"ObjectMetadataRefMessage": {
"type": "string",
"title": "ObjectMetadataRefMessage",
"description": "Message response to the request",
"x-internal": false
},
"ObjectMetadataRefRequestID": {
"type": "string",
"title": "ObjectMetadataRefRequestID",
"description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.",
"x-internal": false
},
"ObjectNextCursor": {
"title": "ObjectNextCursor",
"type": "string",
"description": "The next cursor value that can be used in the following query.",
"x-internal": false
},
"RefCountry": {
"type": [
"string",
"null"
],
"title": "Country ISO Codes",
"enum": [
"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
],
"description": "2 character alpha ISO-3166 codes"
},
"RefCurrency": {
"type": "string",
"title": "Currency ISO Codes",
"description": "Currency in 3 character alpha ISO 4217",
"enum": [
"AFN",
"DZD",
"ARS",
"AMD",
"AWG",
"AUD",
"AZN",
"BSD",
"BHD",
"THB",
"PAB",
"BBD",
"BYN",
"BZD",
"BMD",
"VES",
"BOB",
"BRL",
"BND",
"BGN",
"BIF",
"CAD",
"CVE",
"KYD",
"GHS",
"XOF",
"XAF",
"XPF",
"CLP",
"COP",
"KMF",
"CDF",
"BAM",
"NIO",
"CRC",
"HRK",
"CZK",
"GMD",
"DKK",
"MKD",
"DJF",
"STD",
"DOP",
"VND",
"XCD",
"EGP",
"SVC",
"ETB",
"EUR",
"FKP",
"FJD",
"HUF",
"GIP",
"HTG",
"PYG",
"GNF",
"GYD",
"HKD",
"UAH",
"ISK",
"INR",
"IRR",
"IQD",
"JMD",
"JOD",
"KES",
"PGK",
"LAK",
"EEK",
"KWD",
"MWK",
"AOA",
"MMK",
"GEL",
"LVL",
"LBP",
"ALL",
"HNL",
"SLL",
"LRD",
"LYD",
"SZL",
"LTL",
"LSL",
"MGA",
"MYR",
"TMT",
"MUR",
"MZN",
"MXN",
"MDL",
"MAD",
"NGN",
"ERN",
"NAD",
"NPR",
"ANG",
"ILS",
"RON",
"TWD",
"NZD",
"BTN",
"KPW",
"NOK",
"PEN",
"MRO",
"TOP",
"PKR",
"MOP",
"UYU",
"PHP",
"GBP",
"BWP",
"QAR",
"GTQ",
"ZAR",
"OMR",
"KHR",
"MVR",
"IDR",
"RUB",
"RWF",
"SHP",
"SAR",
"RSD",
"SCR",
"SGD",
"SBD",
"KGS",
"SOS",
"TJS",
"LKR",
"SDG",
"SRD",
"SEK",
"CHF",
"SYP",
"BDT",
"WST",
"TZS",
"KZT",
"TTD",
"MNT",
"TND",
"TRY",
"AED",
"UGX",
"CLF",
"USD",
"UZS",
"VUV",
"KRW",
"YER",
"JPY",
"CNY",
"ZMW",
"ZWL",
"PLN"
]
},
"RefDateTime": {
"type": "string",
"title": "Date and Time string",
"format": "date-time",
"description": "Date and time"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/getsmileapi-income-estimator-list-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.