Getsmileapi Smile API

Name: Smile API
Brand: Smile API
Availability: InStock

✓ Official Vendor SpecData EnrichmentContact Enrichmentbasic30 EndpointsREST

For Agents

Verify income, retrieve employment and identity records, and read transactions and liabilities through user-permissioned account linking under HTTP basic auth.

Use for: I need to create a Smile user and request a linking session, Retrieve the latest income for user usr_123, Get the employment record for a linked account, List all transactions for account acc_456

Not supported: Does not handle KYC document checks, credit-bureau lookups, or payment disbursement - use for user-permissioned employment and income data retrieval only.

This is the trimmed, developer-docs-aligned cut of the Smile API surface, focused on the core employment and income verification primitives an integrator typically needs. It exposes 30 endpoints covering users, providers, accounts, employments, identities, incomes, transactions, documents, contributions, liabilities, and webhooks. It is the right starting point for fintech, lending, and HR-tech teams that want a leaner integration surface than the full v1.14 spec while still receiving normalised, user-permissioned payroll data.

Jentic One on Github View OpenAPI Document

Install Jentic One Beta

Connect the Smile API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Smile API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgetsmileapi%2Fgetsmileapi-getsmileapi-main" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgetsmileapi%2Fgetsmileapi-getsmileapi-main" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Smile API.

Create users and drive the Smile Link account-linking flow via session payloads

Fetch normalised employment and identity records on a linked account

Retrieve income, transactions, contributions, and liabilities on a per-user basis

List and inspect supported data providers for filter UIs

Trigger an account export and disable monitoring when a user closes their account

GET STARTED

Start building with Smile API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Smile API for, with concrete tasks.

★ Lender income verification

Digital lenders ask the applicant to link their payroll provider through Smile Link, then pull income and employment records to underwrite the loan. This trimmed surface gives the underwriting service exactly the endpoints it needs without the full webhooks-and-consent administrative footprint.

Create user, request session payload, then once linked fetch the last 6 months of incomes for risk scoring

Liability snapshot for credit decisioning

Credit teams pull a borrower's liabilities - contributions, recurring deductions, and outstanding obligations - alongside income to compute affordability. The /liabilities and /contributions endpoints expose this in normalised form across providers, removing the need to parse provider-specific schemas.

List liabilities and contributions for user usr_123 and compute monthly committed outflows

Document retrieval for compliance

Onboarding flows need source documents like payslips for KYC and audit trails. The /documents endpoint returns paged document records linked to a user, and the per-document GET retrieves metadata and download references for downstream archival.

List documents for user usr_123, filter to payslips from the last 3 months, and stage them in compliance storage

AI agent for end-user data download

An AI agent connected through Jentic accepts a user's request to export their data, calls the export endpoint on each linked account, and returns the resulting URLs. Jentic injects the basic-auth credential so the agent never holds the raw secret.

For user usr_123, list accounts and call POST /accounts/{id}/export on each, returning the download URLs

Key Endpoints

30 endpoints — this is the trimmed, developer-docs-aligned cut of the smile api surface, focused on the core employment and income verification primitives an integrator typically needs.

METHOD

PATH

DESCRIPTION

POST

/users

Create a Smile user

GET

/users/{id}/payload

Get session payload for Smile Link

GET

/providers

List supported data providers

GET

/incomes

List income records

GET

/employments

List employment records

GET

/transactions

List transaction records

POST

/accounts/{id}/export

Trigger account data export

POST

/users

Create a Smile user

GET

/users/{id}/payload

Get session payload for Smile Link

GET

/providers

List supported data providers

GET

/incomes

List income records

GET

/employments

List employment records

GET

/transactions

List transaction records

POST

/accounts/{id}/export

Trigger account data export

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Smile API by hand means encoding your client id and secret into a basic-auth header, pointing at the open smileapi.io host, and managing user-permissioned income and employment linking yourself. Through Jentic you install once, import the Smile API from the API Directory, store the client id and secret once, and your agent calls it.

Permission scoping

Smile puts the user and account id in the URL path (/users/{id}/payload, /accounts/{id}/export), so a rule can pin your agent to one user's linked records: it can read that payload and its income, employment, and transaction data and nothing else. You choose the operations it may call, so account exports are not included unless you add them.

Credential isolation

Your Smile client id and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'verify a user's income' or 'list employment records', and Jentic returns the matching Smile operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Smile API through Jentic.

What authentication does the Smile API use?

Smile uses HTTP basic authentication with your client id as the username and client secret as the password. Through Jentic the credentials are vaulted and the basic-auth header is constructed per request so the raw secret never enters the prompt.

Can I fetch a user's transactions through the API?

Yes. GET /transactions returns paged transaction records for a user across their linked accounts, and GET /transactions/{id} retrieves a single record. The same listing pattern applies to /incomes, /employments, /identities, /documents, /contributions, and /liabilities.

What are the rate limits for the Smile API?

The OpenAPI spec does not encode explicit rate limits. Practical guidance is to subscribe to webhooks for change-driven flows rather than polling /accounts or /incomes in tight loops, and to back off exponentially on any 429 response.

How do I trigger an account data export through Jentic?

Search Jentic for 'export smile account', load the POST /accounts/{id}/export schema, and execute with the account id. Jentic injects the basic-auth header automatically and returns the export URL.

What is the difference between this surface and the v1.14 surface at sandbox.smileapi.io?

This 30-endpoint surface is the developer-docs-aligned cut focused on retrieval and core lifecycle. The 103-endpoint v1.14 surface adds consent-template management, invites, tasks, and admin-tier endpoints - useful when you operate the platform end-to-end rather than only consuming verification data.

Is the Smile API free?

Smile offers a sandbox environment for development; production access is metered and requires a commercial agreement. Check getsmileapi.com for current tiers and reach the team via the contact details listed in the API documentation.

Can I limit what my agent is allowed to do with the Smile API?

Yes. Because you run Jentic One yourself, your own rules decide which Smile operations and credentials the agent may use, and Smile puts the user and account id in the URL path (/users/{id}/payload, /accounts/{id}/export) so a rule can pin the agent to a single user's linked records. Scoped that way, the agent can read that user's payload, income, employment, and transaction data and nothing else. You also choose the operations it may call, so account exports via POST /accounts/{id}/export stay off the list unless you add them.

Getsmileapi Smile API

Connect the Smile API to your agent

Capabilities

Start building with Smile API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs