# Smile API Documentation > One Trusted Source for Employment Data in Asia! The Smile API provides employment and income data from a single API. ## Guides - [Onboarding FAQs](https://docs.getsmileapi.com/docs/onboarding-faqs.md) - [Pass Rate Improvement Guide](https://docs.getsmileapi.com/docs/pass-rate-improvement-guid-1.md) - [Implementation & Go-Live](https://docs.getsmileapi.com/docs/customer-verification-implementation.md) - [Implementation & Go-live](https://docs.getsmileapi.com/docs/credit-decisioning-implementation.md) - [Product FAQs](https://docs.getsmileapi.com/docs/faqs.md) - [Guideline for Blacklist](https://docs.getsmileapi.com/docs/guideline-for-blacklist.md) - [Guideline for Footprints Product](https://docs.getsmileapi.com/docs/footprint-products.md) - [Guideline for MAW4](https://docs.getsmileapi.com/docs/guideline-for-maw4-product.md) - [Guideline for MAW](https://docs.getsmileapi.com/docs/guideline-for-maw-product.md) - [Guideline for Borrower Screening](https://docs.getsmileapi.com/docs/guideline-for-borrower-screening.md) - [Guideline for Blacklist](https://docs.getsmileapi.com/docs/guideline-for-blacklist-1.md) - [Guideline for Income Estimator](https://docs.getsmileapi.com/docs/guideline-for-income-estimator.md): Estimate a user's income tier using behavioral signals ## API Reference - [Getting Started](https://docs.getsmileapi.com/reference/chapter-1.md) - [Understanding the API](https://docs.getsmileapi.com/reference/chapter-2.md) - [Event Notifications](https://docs.getsmileapi.com/reference/chapter-3.md) - [Version Management](https://docs.getsmileapi.com/reference/api-versioning.md) - [Quota Management](https://docs.getsmileapi.com/reference/quota-management.md) - [Consent Templates](https://docs.getsmileapi.com/reference/consent-templates.md) - [Create Consent Template](https://docs.getsmileapi.com/reference/create-consent-template.md): Create a consent template - [List Consent Templates](https://docs.getsmileapi.com/reference/list-consent-templates.md): List consent templates - [Delete Consent Template](https://docs.getsmileapi.com/reference/delete-consent-template.md): Delete a consent template - [Users](https://docs.getsmileapi.com/reference/users.md) - [List Users](https://docs.getsmileapi.com/reference/list-users-1.md): List users from the Smile Network. - [Create User](https://docs.getsmileapi.com/reference/create-user-1.md): Create a user in the Smile Network. - [View User](https://docs.getsmileapi.com/reference/get-user-1.md): View a particular user profile. - [View User Session Payload](https://docs.getsmileapi.com/reference/get-user-session-payload.md): Retrieve the payload data for a specific user session - [Reset User Session](https://docs.getsmileapi.com/reference/reset-user-session.md): Clean the payload data for a specific user session - [Tokens](https://docs.getsmileapi.com/reference/tokens.md) - [Refresh Token](https://docs.getsmileapi.com/reference/create-token-1.md): Refresh a token for a user - [Webhooks](https://docs.getsmileapi.com/reference/webhooks.md) - [List Webhooks](https://docs.getsmileapi.com/reference/list-webhooks.md): List all webhook endpoints. - [Create Webhook](https://docs.getsmileapi.com/reference/create-webhook.md): Create a webhook endpoint. - [View Webhook](https://docs.getsmileapi.com/reference/get-webhook.md): View a webhook endpoint. - [Delete Webhook](https://docs.getsmileapi.com/reference/delete-webhook.md): Delete a webhook endpoint. - [List Tasks](https://docs.getsmileapi.com/reference/list-tasks.md): List the user's tasks. - [View Task](https://docs.getsmileapi.com/reference/get-task.md): View a user's task by ID. - [Getting Started](https://docs.getsmileapi.com/reference/getting-started-wink.md) - [Providers](https://docs.getsmileapi.com/reference/providers.md) - [List Providers](https://docs.getsmileapi.com/reference/list-providers.md): Get a list of employment data providers from the Smile Network. - [Get Provider](https://docs.getsmileapi.com/reference/get-provider-1.md): Get a data provider from the Smile Network. - [Invite Templates](https://docs.getsmileapi.com/reference/invite-templates.md) - [List Invite Templates](https://docs.getsmileapi.com/reference/list-invite-templates.md): Get the list of invite templates. - [Create Invite Template](https://docs.getsmileapi.com/reference/create-invite-template.md): Create an invite template. - [Get Invite Template](https://docs.getsmileapi.com/reference/get-invite-template.md): Get invite template. - [Update Invite Template](https://docs.getsmileapi.com/reference/update-invite-template.md): Update invite template. - [Delete Invite Template](https://docs.getsmileapi.com/reference/delete-invite-template.md): Delete invite template. - [Accounts](https://docs.getsmileapi.com/reference/accounts.md) - [List Accounts](https://docs.getsmileapi.com/reference/list-accounts-1.md): List a list of user accounts. - [View Account](https://docs.getsmileapi.com/reference/get-account-1.md): View a user's particular account information. - [Revoke Account](https://docs.getsmileapi.com/reference/delete-account.md): Delete a user's particular account information including the related data. - [View Account Payload](https://docs.getsmileapi.com/reference/get-account-payload.md): View a user's particular account payload. - [Generate account export](https://docs.getsmileapi.com/reference/generate-account-export.md): Generate a particular account export. - [Disable Monitor](https://docs.getsmileapi.com/reference/disable-account-monitor.md): disable monitor account data. - [Invites](https://docs.getsmileapi.com/reference/invites.md) - [List Invites](https://docs.getsmileapi.com/reference/list-invites.md): List the list of invites sent out to users. - [Create Invite](https://docs.getsmileapi.com/reference/create-invite.md): Create and send an invite to a user - [View Invite](https://docs.getsmileapi.com/reference/get-invite.md): View invite sent to users by ID. - [List Invite Logs](https://docs.getsmileapi.com/reference/list-invite-log.md): List invite log. - [Identities](https://docs.getsmileapi.com/reference/identities.md) - [List Identities](https://docs.getsmileapi.com/reference/list-identities-1.md): Get a user's identity profiles from employment data sources. - [Get Identity](https://docs.getsmileapi.com/reference/get-identity-1.md): Get the user's identity profile by ID. - [Estimated Incomes](https://docs.getsmileapi.com/reference/estimated-incomes.md) - [List Estimated Incomes](https://docs.getsmileapi.com/reference/list-eincomes.md): List users' estimated income from contribution- and transaction-based data sources. This data set contains derived income amounts from a variety of sources such as social security contributions, annual salary calculations, and computed earnings from transactions in various platforms. *Estimated Incomes is currently in alpha.* - [View Estimated Income](https://docs.getsmileapi.com/reference/get-eincomes.md): View the user's estimated incomes by ID. - [Ratings](https://docs.getsmileapi.com/reference/ratings.md) - [List Ratings](https://docs.getsmileapi.com/reference/list-ratings-1.md): List the user's ratings from employment data sources. - [View Rating](https://docs.getsmileapi.com/reference/get-rating-1.md): View a user's ratings by ID. - [Employments](https://docs.getsmileapi.com/reference/employments.md) - [List Employments](https://docs.getsmileapi.com/reference/list-employments-1.md): Get the user's previous employments. - [Get Employment](https://docs.getsmileapi.com/reference/get-employment-1.md): Get a user's employment by ID. - [Documents](https://docs.getsmileapi.com/reference/documents.md) - [List Documents](https://docs.getsmileapi.com/reference/list-documents-1.md): List the user's documents from employment data sources. - [View Document](https://docs.getsmileapi.com/reference/get-document-1.md): View a user's document by ID. - [Contributions](https://docs.getsmileapi.com/reference/contributions.md) - [List Contributions](https://docs.getsmileapi.com/reference/list-contributions.md): Get the user's social security contributions from employment data sources. - [Get Contribution](https://docs.getsmileapi.com/reference/get-contribution.md): Get the user's contribution by ID. - [Liabilities](https://docs.getsmileapi.com/reference/liabilities.md) - [List Liabilities](https://docs.getsmileapi.com/reference/list-liabilities.md): List user liabilities from employment data sources. - [Get Liability](https://docs.getsmileapi.com/reference/get-liabilities.md): Get the user's liabilities by ID. - [Incomes](https://docs.getsmileapi.com/reference/incomes.md) - [List Incomes](https://docs.getsmileapi.com/reference/list-incomes-1.md): List the user's incomes from employment data sources. - [View Income](https://docs.getsmileapi.com/reference/get-income-1.md): View the user's income by ID. - [Transactions](https://docs.getsmileapi.com/reference/transactions.md) - [List Transactions](https://docs.getsmileapi.com/reference/list-transactions-1.md): Get the user's transactions from employment data sources. - [Get Transaction](https://docs.getsmileapi.com/reference/get-transaction-1.md): Get a user's transaction by ID. - [Insights](https://docs.getsmileapi.com/reference/insights.md) - [List insights](https://docs.getsmileapi.com/reference/list-insights.md): List insights from data sources. - [View Insight](https://docs.getsmileapi.com/reference/get-feature-insight.md): View the user's insight by ID. - [Links](https://docs.getsmileapi.com/reference/links.md) - [List links](https://docs.getsmileapi.com/reference/list-links.md): List links from data sources. - [View Link](https://docs.getsmileapi.com/reference/get-link.md): View the Account's link result by ID. - [Getting Started](https://docs.getsmileapi.com/reference/getting-started-signals.md) - [Exploratory Pilots](https://docs.getsmileapi.com/reference/exploratory-pilots.md) - [Smile Shield](https://docs.getsmileapi.com/reference/smile-shield.md): Data Dictionary for Smile Shield - [MAW Features](https://docs.getsmileapi.com/reference/maw-features.md) - [Income Estimator](https://docs.getsmileapi.com/reference/income-estimator.md) - [Blacklists](https://docs.getsmileapi.com/reference/blacklists.md) - [Create Blacklist1](https://docs.getsmileapi.com/reference/create-alpha-blacklist.md): ## Create a **Blacklist** object. This endpoint requires the following input parameters: `consent`, `mobileNumber`, `templateId`, and `countryCode`. ### Default Behavior - If `templateId` is **not provided**, it defaults to `tpl-blk002001`. - If `countryCode` is **omitted**, it defaults to `PH`. ### Supported Template | Template ID | Region | Required Parameters | |--------------------------------------------------------------|--------------|--------------------------------------------------------| | `tpl-blk002001` | PH (default) | `consent`, `mobileNumber`, `countryCode`, `templateId` | | `blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e` (deprecated) | PH (default) | `consent`, `mobileNumber`, `countryCode`, `templateId` | ### Field Rules - `templateId` is optional; if missing, the system uses `tpl-blk002001`. - `countryCode` is also optional; if omitted, it defaults to `PH`. ### Sandbox Test Values | Parameter | Value | Expected Response | |-----------------|------------------|----------------------------------------| | `mobileNumber` | `639559991234` | | | `countryCode` | `PH` | `resultCode = SUCCESS`, `hit = true` | For all other valid mobile number and country code combinations, the response will return: `resultCode = SUCCESS`, but `hit = false`. - [List Blacklists](https://docs.getsmileapi.com/reference/list-alpha-blacklists.md): List all Blacklists. - [View Blacklist](https://docs.getsmileapi.com/reference/get-alpha-blacklist.md): View Blacklist by unique ID. - [Borrower Behavior (MAW3)](https://docs.getsmileapi.com/reference/borrower-behavior.md) - [Data Dictionary - Mexico Borrower Behavior](https://docs.getsmileapi.com/reference/borrower-behavior-mx-data-dictionary.md) - [Data Dictionary - Philippines Borrower Behavior](https://docs.getsmileapi.com/reference/borrower-behavior-ph-data-dictionary.md) - [Data Dictionary - Indonesia Borrower Behavior](https://docs.getsmileapi.com/reference/borrower-behavior-id-data-dictionary.md): Data Dictionary for Borrower Behavior Indonesia - [Create Maw3](https://docs.getsmileapi.com/reference/create-beta-maw3.md): ## Create a **Maw** object. This endpoint supports different templates depending on region and use case. Required parameters: `consent`, `templateId`, plus additional fields depending on the selected template. ### Supported Templates | Template ID | Region | Required Parameters | |-----------------|------------------|-----------------------------------------------------------------------------| | `tpl-maw004001` | Mexico (MX) | `mobileNumber`, `countryCode`, `fullName`, `idType=NATIONAL_ID`, `idNumber` | | `tpl-maw004002` | Africa countries | `gaid` | | `tpl-maw004003` | Philippines (PH) | `mobileNumber`, `countryCode`, `fullName`, `idType=NATIONAL_ID`, `idNumber` | ### Sandbox Test Values | Template ID | Parameters | Expected Response | |-----------------|---------------------------------------------------------------------------------------------------------|------------------------| | `tpl-maw004001` | `mobileNumber = 529559991234`, `countryCode = MX`, `fullName = George`, `idNumber = ZAZD801124MBSYQN13` | `resultCode = SUCCESS` | | `tpl-maw004002` | `gaid = '00000000-0000-0000-0000-000000000000'` | `resultCode = SUCCESS` | | `tpl-maw004003` | `mobileNumber = 639559991234`, `countryCode = PH`, `fullName = George`, `idNumber = 4561234567` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system will return: `resultCode = NO_DATA`, and no items will be included in the response. - [Borrower Screening (Signal2)](https://docs.getsmileapi.com/reference/borrower-screening.md) - [Create Signal2](https://docs.getsmileapi.com/reference/create-beta-signal2.md): ## Create a **Signal2** object. This endpoint requires the following mandatory parameters: `consent`, `phone`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region | Required Parameters | |-----------------|-----------------------------------------------------------------------------------------|-------------------------------------------------| | `tpl-sgn002001` | IN (India), MX (Mexico), PH (Philippines), ID (Indonesia), CO (Colombia), TH (Thailand) | `consent`, `templateId`, `countryCode`, `phone` | ### Field Guidelines - `phone` must include the country code without leading '+' (e.g., `639559991234`) - MD5 encryption is supported using the format: `MD5(countryCode + phone)`, e.g., `MD5(639559991234)` ### Sandbox Test Values | Parameter | Value | Expected Response | |---------------|-----------------|------------------------| | `templateId` | `tpl-sgn002001` | | | `countryCode` | e.g., `PH` | | | `phone` | `639559991234` | `resultCode = SUCCESS` | For all other valid `phone` and `countryCode` combinations, the response will return: `resultCode = NO_DATA`, and no items will be included. You may also contact **Smile** to request additional specialized `templateId`s for other regions or business cases. - [Credit Lifecycle (Signal1)](https://docs.getsmileapi.com/reference/credit-lifecycle.md) - [Data Dictionary - Credit Lifecycle](https://docs.getsmileapi.com/reference/credit-lifecycle-data-dictionary.md) - [Create Signal](https://docs.getsmileapi.com/reference/create-beta-signal.md): ## Create a **Signal** object. This endpoint requires the following mandatory parameters: `consent`, `phone`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region | Required Parameters | |-----------------------------------------------------------|--------------|-------------------------------------------------| | `tpl-sgn003001` | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-f250f305c3bf0aa690cca93ef0f0fb03` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-f6b74d81a4807f4c01e6a920920775ad` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-7a01659636c119ca4566308effd05d06` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-e5ba74fe8089fe44eeeafb68991b1e70` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | ### Field Guidelines - `phone` must include the country code (e.g., `+639559991234` or `639559991234`) - MD5 encryption is supported using the format: `MD5(countryCode + phone)`, e.g., `MD5(+639559991234)` ### Sandbox Test Values | Parameter | Value | Expected Response | |---------------|-----------------|------------------------| | `templateId` | `tpl-sgn003001` | | | `countryCode` | `PH` | | | `phone` | `639559991234` | `resultCode = SUCCESS` | For all other valid `phone` and `countryCode` combinations, the response will return: `resultCode = NO_DATA`, and no items will be included. You may also contact **Smile** to request additional specialized `templateId`s for other regions or business cases. - [List Signals](https://docs.getsmileapi.com/reference/list-beta-signals.md): List all Signals. - [View Signal](https://docs.getsmileapi.com/reference/get-beta-signal.md): View Signal by unique ID. - [Signals(Alpha)](https://docs.getsmileapi.com/reference/signals-alpha.md) - [Create Signal](https://docs.getsmileapi.com/reference/create-alpha-signal.md) - [List Signals](https://docs.getsmileapi.com/reference/list-alpha-signals.md): List all Signals. - [View Signal](https://docs.getsmileapi.com/reference/get-alpha-signal.md): View Signal by unique ID. - [Multiple Application Warning (MAW2)](https://docs.getsmileapi.com/reference/multiple-application-warning.md) - [Data Dictionary - Multiple Applications Warning (MAW)](https://docs.getsmileapi.com/reference/multiple-applications-warning-maw.md): Data Dictionary for Multiple Applications Warning (MAW) - [Create Maw2](https://docs.getsmileapi.com/reference/create-beta-maw2.md): ## Create a Maw2 object. This endpoint requires **four mandatory parameters**: `consent`, `mobileNumber`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |--------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------| | `tpl-maw002001` | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | | `mawTpl-bfc93eb72d24860bf62429a1dd06708d` (deprecated) | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-----------------|------------------------| | templateId | `tpl-maw002001` | | | countryCode | `PH` | | | mobileNumber | `639559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. - [List Maws](https://docs.getsmileapi.com/reference/list-beta-maws.md): List all Maws. - [View Maw](https://docs.getsmileapi.com/reference/get-beta-maw.md): View Maw by unique ID. - [Create Maw](https://docs.getsmileapi.com/reference/create-alpha-maw.md): ## Create a Maw2 object. This endpoint requires **four mandatory parameters**: `consent`, `mobileNumber`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |--------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------| | `tpl-maw002001` | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | | `mawTpl-bfc93eb72d24860bf62429a1dd06708d` (deprecated) | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-----------------|------------------------| | templateId | `tpl-maw002001` | | | countryCode | `PH` | | | mobileNumber | `639559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. - [List Maws](https://docs.getsmileapi.com/reference/list-alpha-maws.md): List all Maws. - [View Maw](https://docs.getsmileapi.com/reference/get-alpha-maw.md): View Maw by unique ID. - [Footprints](https://docs.getsmileapi.com/reference/footprints.md) - [Data Dictionary - Footprints](https://docs.getsmileapi.com/reference/footprints-data-dictionary.md) - [Create Footprint](https://docs.getsmileapi.com/reference/create-alpha-footprint.md): ## Create a **Footprint** object. This endpoint requires the following mandatory parameters: - `consent` - `templateId` Additional required fields depend on the selected `templateId`. ### Supported Templates | Template ID | Input Type | Required Parameters | |-------------------------|------------------------|-------------------------------------------------------------| | `tpl-email-footprint` | Email address only | `consent`, `templateId`, `emailAddress`, `countryCode` | | `tpl-mobile-footprint` | Mobile number only | `consent`, `templateId`, `mobileNumber`, `countryCode` | | `tpl-score-footprint` | Email + mobile number | `consent`, `templateId`, `emailAddress`, `mobileNumber`, `countryCode` | | `tpl-ftp005001` (deprecated) | Email address only | `consent`, `templateId`, `emailAddress`, `countryCode` | | `tpl-ftp005002` (deprecated) | Mobile number only | `consent`, `templateId`, `mobileNumber`, `countryCode` | ### Field Rules - For `tpl-ftp005001`, `emailAddress` **must** be provided and `mobileNumber` should be omitted or `null`. - For `tpl-ftp005002`, `mobileNumber` **must** be provided and `emailAddress` should be omitted or `null`. - For `tpl-score-footprint`, `emailAddress` **and** `mobileNumber` **must** both be provided. - For all templates, `countryCode` is required and must be a valid ISO country code. ### Sandbox Test Values | Template ID | Test Input | Expected Response | |-------------------------|---------------------------------------------------------------------------------------------|------------------------| | `tpl-email-footprint` | `emailAddress = gpalomero1234@smileapi.io`, `countryCode = PH` | `resultCode = SUCCESS` | | `tpl-mobile-footprint` | `mobileNumber = 639559991234`, `countryCode = PH` | `resultCode = SUCCESS` | | `tpl-score-footprint` | `emailAddress = gpalomero1234@smileapi.io`, `mobileNumber = 639559991234`, `countryCode = PH` | `resultCode = SUCCESS` | For all other valid input combinations, if no mock data is matched, the response will return: `resultCode = NO_DATA`, and no items will be included. - [List Footprints](https://docs.getsmileapi.com/reference/list-alpha-footprints.md): List all Footprints. - [View Footprint](https://docs.getsmileapi.com/reference/get-alpha-footprint.md): View Footprint by unique ID. - [Social Security (Signal3)](https://docs.getsmileapi.com/reference/social-security-signals.md) - [Data Dictionary - Thailand Social Security Signals](https://docs.getsmileapi.com/reference/social-security-signal-th-data-dictionary.md): Thailand Social Security Signal Data Dictionary - [Data Dictionary - Mexico Social Security Signals](https://docs.getsmileapi.com/reference/social-security-signal-mx-data-dictionary.md): Mexico Social Security Signal Data Dictionary - [Create Signal3](https://docs.getsmileapi.com/reference/create-beta-signal3.md): ## Create a Signal3 object. This endpoint supports different templates depending on region and use case. Required parameters: `consent`, `templateId`, plus additional fields depending on the selected template. ### Supported Templates | Template ID | Region(s) | Required Parameters | |-----------------------------------|---------------|--------------------------------------------------| | `tpl-sgn003002` | MX (Mexico) | `phone`, `fullName`, `curp` | | `tpl-social-securities-signal-th` | TH (Thailand) | `fullName`, `mobileNumber`, `idType`, `idNumber` | ### Sandbox Test Values | Template ID | Parameters | Expected Response | |-----------------------------------|--------------------------------------------------------------------------------------------------|------------------------| | `tpl-sgn003002` | `phone = 529559991234`, `fullName = John Doe`, `curp = DOEJ800101HDFXXX01` | `resultCode = SUCCESS` | | `tpl-social-securities-signal-th` | `mobileNumber = 669178912345`, `fullName = John Doe`, `idType = PID`, `idNumber = 1234567890123` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. ### Remarks In production mode, if the API request is successful, a Signal3 object will be created with the status of `PROCESSING`. When the Status becomes `COMPLETED` or `ERROR`. - [Create IncomeEstimator](https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md): ## Create an **IncomeEstimator** object. This endpoint requires `consent`, `templateId`, `emailAddress`, and `countryCode`. ### Supported template | Template ID | Country | Required parameters | | --- | --- | --- | | `tpl-incomeestimator-001` | PH | `consent`, `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 | Parameter | Value | Expected Response | |----------------|-----------------------------|------------------------| | `countryCode` | `PH` | | | `emailAddress` | `gpalomero1234@smileapi.io` | `resultCode = SUCCESS` | - [List IncomeEstimators](https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md): List all IncomeEstimator objects. - [View IncomeEstimator](https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md): View an IncomeEstimator object by unique ID. - [Verifications](https://docs.getsmileapi.com/reference/verification.md) - [List Verifications](https://docs.getsmileapi.com/reference/list-verifications.md): List verificatins. - [Request Verification](https://docs.getsmileapi.com/reference/create-verification.md): sumbit required parameters to request verification. - [Get Verification](https://docs.getsmileapi.com/reference/get-verification.md): Get verification by ID. - [Getting Started](https://docs.getsmileapi.com/reference/getting-started-snap.md) - [List File Types](https://docs.getsmileapi.com/reference/list-file-types.md): Get the available file types for uploads. - [Archives](https://docs.getsmileapi.com/reference/archives.md) - [List Archives](https://docs.getsmileapi.com/reference/list-archives.md): List the user's archives. - [Create Archive](https://docs.getsmileapi.com/reference/create-archive.md): Create an archive. - [View Archive](https://docs.getsmileapi.com/reference/get-archive.md): View a user's archive by ID. - [Classify Archive](https://docs.getsmileapi.com/reference/create-and-classify-archive.md): Classify an archive. - [Revoke Archive](https://docs.getsmileapi.com/reference/delete-archive.md): Delete a user's particular archive information including the related data. - [Getting Started](https://docs.getsmileapi.com/reference/getting-started-flip.md) - [Forms](https://docs.getsmileapi.com/reference/forms.md) - [List Forms](https://docs.getsmileapi.com/reference/list-alpha-forms.md): List the user's forms data. - [View Form](https://docs.getsmileapi.com/reference/get-alpha-form.md): View a user's form by ID. - [Records](https://docs.getsmileapi.com/reference/records.md) - [Social Security (Alpha)](https://docs.getsmileapi.com/reference/social-security-records-alpha.md) - [Create Social Security](https://docs.getsmileapi.com/reference/create-social-security.md): ## Create a Social Security object. This endpoint requires **mandatory parameters**: `consent`, `mobileNumber`, `fullName`, `curp`, `emailAddress`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |-----------------|-------------|----------------------------------------------------| | `tpl-sss003001` | MX (Mexico) | `mobileNumber`, `fullName`, `curp`, `emailAddress` | ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-------------------------|------------------------| | templateId | `tpl-sss003001` | | | emailAddress | Any valid email address | | | curp | Any valid curp | | | fullName | Any string | | | mobileNumber | `529559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. ### Remarks In production mode, if the API request is successful, a SocialSecurity object will be created with the status of `PROCESSING`. When the Status becomes `COMPLETED` or `ERROR`, it will be notified through the [webhook](https://docs.getsmileapi.com/reference/webhooks#records-completed). Generally, the API will return the result in about 1 minute. - [List Social Securities](https://docs.getsmileapi.com/reference/list-social-securities.md): List all social security records for users - [View Social Security](https://docs.getsmileapi.com/reference/get-social-security.md): View a social security record by ID - [Social Securities (Beta)](https://docs.getsmileapi.com/reference/social-securities-records-beta.md) - [Create Social Security](https://docs.getsmileapi.com/reference/create-beta-social-security.md): ## Create a Social Security object. This endpoint requires **mandatory parameters**: `consent`, `mobileNumber`, `fullName`, `curp`, `emailAddress`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |-----------------|-------------|----------------------------------------------------| | `tpl-sss003002` | MX (Mexico) | `mobileNumber`, `fullName`, `curp`, `emailAddress`| ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-------------------------|------------------------| | templateId | `tpl-sss003002` | | | emailAddress | Any valid email address | | | curp | Any valid curp | | | fullName | Any string | | | mobileNumber | `529559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. ### Remarks In production mode, if the API request is successful, a SocialSecurity object will be created with the status of `PROCESSING`. When the Status becomes `COMPLETED` or `ERROR`. - [List Social Securities](https://docs.getsmileapi.com/reference/list-beta-social-securities.md): List all social security records for users - [View Social Security](https://docs.getsmileapi.com/reference/get-beta-social-security.md): View a social security record by ID ## Recipes - [Quick Start In Android Webview](https://docs.getsmileapi.com/recipes/quick-start-in-android-webview.md) - [Quick Start Wink Widget](https://docs.getsmileapi.com/recipes/quick-start-wink-widget.md)