# Smile API Documentation

> One Trusted Source for Employment Data in Asia! The Smile API provides employment and income data from a single API.

## Integration: Onboarding
- [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)

## Integration: Use Case
- eKYC
  - [Implementation & Go-Live](https://docs.getsmileapi.com/docs/customer-verification-implementation.md)
- Increase Credit Limit
  - [Implementation & Go-live](https://docs.getsmileapi.com/docs/credit-decisioning-implementation.md)

## Integration: Others
- [Test Upload Guidelines](https://docs.getsmileapi.com/docs/test-upload-guidelines.md)
- [Product FAQs](https://docs.getsmileapi.com/docs/faqs.md)

## Integration: Developer Resources
- [Guideline for Blacklist](https://docs.getsmileapi.com/docs/guideline-for-blacklist.md)

## Integration: Test Evaluation Guidelines
- [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: API Guide
- [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)

## API Reference: Smile Network Resources
- [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.
- Tasks
  - [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.

## API Reference: Wink - Account Linking
- [Getting Started](https://docs.getsmileapi.com/reference/getting-started-wink.md)
- Resources
  - [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.
- User Data
  - [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,…
    - [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.

## API Reference: Signals - Risk Screening
- [Getting Started](https://docs.getsmileapi.com/reference/getting-started-signals.md)
- [Product Previews](https://docs.getsmileapi.com/reference/product-previews.md)
  - [Smile Shield](https://docs.getsmileapi.com/reference/smile-shield.md): Data Dictionary for Smile Shield
  - [Lending Pulse](https://docs.getsmileapi.com/reference/maw-features.md)
  - [Income Estimator](https://docs.getsmileapi.com/reference/income-estimator.md)
  - [Smile Cards](https://docs.getsmileapi.com/reference/smile-cards.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…
  - [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…
- [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…
- [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…
  - [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…
  - [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.
  - MAW (Alpha)
    - [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…
    - [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`.  ###…
  - [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…
- [Income Estimators](https://docs.getsmileapi.com/reference/income-estimators-alpha.md)
  - [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 | |…
  - [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): ## Request a Verification object.  This endpoint requires `consent` and the identity information to verify. Place `idType`, `idSubType`, and `idNumber` in `additionalData.ids`. The Sandbox field…
  - [Get Verification](https://docs.getsmileapi.com/reference/get-verification.md): Get verification by ID.

## API Reference: Snap - Document Processing
- [Getting Started](https://docs.getsmileapi.com/reference/getting-started-snap.md)
- File Types
  - [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.

## API Reference: Flip - Form Processing
- [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 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  |…
    - [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)