Smile Providers API
The Providers API from Smile — 2 operation(s) for providers.
The Providers API from Smile — 2 operation(s) for providers.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.curl "https://apis.io/api/v1/apis/getsmileapi:getsmileapi-providers-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
openapi: 3.2.0
info:
title: Smile Providers API
version: 1.14.0
description: The Smile API provides employment and income data from a single API.
contact:
name: Smile Technology Pte Ltd
url: https://www.getsmileapi.com
email: info@getsmileapi.com
termsOfService: https://www.getsmileapi.com/terms-and-conditions
servers:
- url: https://sandbox.smileapi.io/v1
description: Sandbox
- url: https://open.smileapi.io/v1
description: Production
security:
- basicAuth: []
tags:
- name: Providers
paths:
/providers:
parameters: []
get:
summary: List Providers
tags:
- Providers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderListResponse'
examples:
Example:
value:
code: OK
message: Success
requestId: 5b79399a-6852-4234-bb0e-ad472648282d
data:
nextCursor: '1259723474'
items:
- id: upwork
name: Upwork
longName: Upwork Global Inc.
logoUrl: https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png
type: GIG
typeLabel: Gig Platform
subType: SERVICES
subTypeLabel: Professional Services
active: true
enabled: true
mfa: true
accountConnection: true
supported:
- IDENTITIES
- id: freelancer
name: Freelancer
longName: Freelancer Technology Pty Limited
logoUrl: https://cdn.smileapi.io/image/provider-logo/v20210813064500/freelancer.png
type: GIG
typeLabel: Gig Platform
subType: SERVICES
subTypeLabel: Professional Services
active: true
enabled: true
mfa: true
accountConnection: true
supported:
- IDENTITIES
- id: grab
name: Grab
longName: Grab Holdings Inc
logoUrl: https://cdn.smileapi.io/image/provider-logo/v20210813064500/freelancer.png
type: GIG
typeLabel: Gig Platform
subType: TRANSPORTATION
subTypeLabel: Transport and Delivery
active: true
enabled: true
mfa: true
accountConnection: true
supported:
- IDENTITIES
'400':
$ref: '#/components/responses/Standard-Errors'
operationId: list-providers
description: Get a list of employment data providers from the Smile Network.
parameters:
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/size'
- schema:
type: string
in: query
name: type
description: Filter results to certain type of providers.
- schema:
type: string
in: query
name: subType
description: Filter results to certain subset of a certain subtype of providers
- schema:
type: boolean
in: query
name: active
description: Filter results to active or inactive providers.
- schema:
type: boolean
in: query
name: enabled
description: Filter results to enabled or disabled providers.
- schema:
type: boolean
in: query
name: accountConnection
description: Filter results to providers with real-time account connections.
- schema:
type: string
in: query
name: name
description: Filter results by provider name
- schema:
type: array
items:
type: string
in: query
name: ids
description: Filter results by provider ids, each id will be matched exactly, please following this format 'ids=id1,id2,id3'.
- schema:
type: array
maxItems: 10
items:
type: string
in: query
name: topIds
description: Show these providers on the top of the list, please following this format 'ids=id1,id2,id3'.
/providers/{id}:
parameters:
- $ref: '#/components/parameters/id'
get:
summary: Get Provider
tags:
- Providers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderGetResponse'
examples:
Example:
value:
code: OK
message: Success
requestId: 5b79399a-6852-4234-bb0e-ad472648282d
data:
id: upwork
name: Upwork
longName: Upwork Global Inc.
logoUrl: https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png
type: GIG
typeLabel: Gig Platform
subType: SERVICES
subTypeLabel: Professional Services
active: true
enabled: true
mfa: true
accountConnection: true
supported:
- IDENTITIES
- TRANSACTIONS
operationId: get-provider
description: Get a data provider from the Smile Network.
parameters: []
components:
parameters:
id:
name: id
in: path
schema:
type: string
minLength: 1
maxLength: 200
description: ID of the specific object in the collection.
required: true
cursor:
name: cursor
in: query
required: false
schema:
type: string
description: Uses the filter values of the previous page to determine the next set of items.
size:
name: size
in: query
schema:
type: integer
example: 50
minimum: 1
maximum: 150
default: 10
description: The number of objects you want returned in a collection.
schemas:
ObjectNextCursor:
title: ObjectNextCursor
type: string
example: '1259723474'
description: The next cursor value that can be used in the following query.
x-internal: false
ProviderGetResponse:
title: Provider Get Response
properties:
code:
$ref: '#/components/schemas/ObjectMetadataRefCode'
message:
$ref: '#/components/schemas/ObjectMetadataRefMessage'
requestId:
$ref: '#/components/schemas/ObjectMetadataRefRequestID'
data:
$ref: '#/components/schemas/Provider'
x-examples: {}
description: ''
ProviderListResponse:
type: object
properties:
code:
$ref: '#/components/schemas/ObjectMetadataRefCode'
message:
$ref: '#/components/schemas/ObjectMetadataRefMessage'
requestId:
$ref: '#/components/schemas/ObjectMetadataRefRequestID'
data:
type: object
properties:
nextCursor:
$ref: '#/components/schemas/ObjectNextCursor'
items:
type: array
items:
$ref: '#/components/schemas/Provider'
x-examples: {}
title: Provider List Response
description: ''
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
example: OK
x-internal: false
ObjectMetadataRefMessage:
type: string
title: ObjectMetadataRefMessage
description: Message response to the request
example: Success
x-internal: false
RefDatapoint:
type: string
title: Datapoint
enum:
- IDENTITIES
- TRANSACTIONS
- RATINGS
- EMPLOYMENTS
- DOCUMENTS
- INCOMES
- CONTRIBUTIONS
- EINCOMES
- LIABILITIES
- LINK
- INSIGHTS
description: Supported data points for this employment data provider
example: IDENTITIES
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
example: 5b79399a-6852-4234-bb0e-ad472648282d
Provider:
title: Provider
type: object
description: An employment data provider. A provider holds employment and income information of the user.
x-tags:
- Providers
x-examples:
Example:
id: upwork
name: Upwork
longName: Upwork Global Inc.
logoUrl: https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png
type: GIG
typeLabel: Gig Platform
subType: SERVICES
subTypeLabel: Professional Services
active: true
enabled: true
mfa: true
accountConnection: true
supported:
- IDENTITIES
- TRANSACTIONS
properties:
id:
type: string
description: Unique ID of the data provider
example: upwork
name:
type: string
description: Name of the data provider
example: Upwork
longName:
type: string
description: Full name or legal name of the data provider
logoUrl:
type: string
description: URL to the data provider's logo
example: https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png
type:
type: string
enum:
- GIG
- GOVERNMENT
- SYSTEM
- EMPLOYER
- CREDENTIAL
description: Type of employment data provider
example: GIG
typeLabel:
type: string
description: Type label of employment data provider, like "Gig Platform"
example: Gig Platform
enum:
- Gig Platform
- Govt Service
- System
- Employer
- Credential
subType:
type: string
description: Subset of Type of employment data provider
enum:
- SERVICES
- TRANSPORTATION
- SHARING
- TRADING
- INSURANCE
- HRIS
- PAYROLL
- WALLET
- IDENTIFICATION
- ISIC-A
- ISIC-B
- ISIC-C
- ISIC-D
- ISIC-E
- ISIC-F
- ISIC-G
- ISIC-H
- ISIC-I
- ISIC-J
- ISIC-K
- ISIC-L
- ISIC-M
- ISIC-N
- ISIC-O
- ISIC-P
- ISIC-Q
- ISIC-R
- ISIC-S
- ISIC-T
- ISIC-U
subTypeLabel:
type: string
description: Subtype label of employment data provider, like "Services"
example: Professional Services
enum:
- Professional Services
- Transport and Delivery
- Asset Sharing
- Online Selling
- Social Insurance
- Payroll System
- Tamper-proof document issuance & verification systems
- Human Resource Information System
- Identification
- Agriculture, forestry and fishing
- Mining and quarrying
- Manufacturing
- Electricity, gas, steam and air conditioning supply
- Water supply; sewerage, waste management and remediation activities
- Construction
- Wholesale and retail trade; repair of motor vehicles and motorcycles
- Transportation and storage
- Accommodation and food service activities
- Information and communication
- Financial and insurance activities
- Real estate activities
- Professional, scientific and technical activities
- Administrative and support service activities
- Public administration and defense; compulsory social security
- Education
- Human health and social work activities
- Arts, entertainment and recreation
- Other service activities
- Activities of households as employers; undifferentiated goods; and services-producing activities of households for own use
- Activities of extraterritorial organization and bodies
active:
type: boolean
description: Indicates whether data provider integration is working
enabled:
type: boolean
description: Indicates whether data provider is enabled or access is allowed for the client
mfa:
type: boolean
description: Whether data provider requires multi-factor authentication.
accountConnection:
type: boolean
description: Whether a real-time account connection is available for this data provider
default: true
supported:
type: array
description: Supported data points for this employment data provider
items:
$ref: '#/components/schemas/RefDatapoint'
monitorSupported:
type: boolean
description: Whether support CDS for this data provider
default: false
required:
- id
- name
- longName
- logoUrl
- type
- typeLabel
- subType
- subTypeLabel
- active
- enabled
- mfa
- accountConnection
- supported
- monitorSupported
responses:
Standard-Errors:
description: Standard error response
content:
application/json:
schema:
type: object
properties:
code:
$ref: '#/components/schemas/ObjectMetadataRefCode'
message:
$ref: '#/components/schemas/ObjectMetadataRefMessage'
requestId:
$ref: '#/components/schemas/ObjectMetadataRefRequestID'
data:
type: object
securitySchemes:
basicAuth:
type: http
scheme: basic
x-provenance:
method: searched
source: https://docs.getsmileapi.com/reference
harvested: '2026-10-20'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.getsmileapi.com/reference/create-alpha-blacklist.md
- https://docs.getsmileapi.com/reference/create-alpha-footprint.md
- https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md
- https://docs.getsmileapi.com/reference/create-alpha-maw.md
- https://docs.getsmileapi.com/reference/create-alpha-signal.md
- https://docs.getsmileapi.com/reference/create-and-classify-archive.md
- https://docs.getsmileapi.com/reference/create-archive.md
- https://docs.getsmileapi.com/reference/create-beta-maw2.md
- https://docs.getsmileapi.com/reference/create-beta-maw3.md
- https://docs.getsmileapi.com/reference/create-beta-signal.md
- https://docs.getsmileapi.com/reference/create-beta-signal2.md
- https://docs.getsmileapi.com/reference/create-beta-signal3.md
- https://docs.getsmileapi.com/reference/create-beta-social-security.md
- https://docs.getsmileapi.com/reference/create-consent-template.md
- https://docs.getsmileapi.com/reference/create-invite-template.md
- https://docs.getsmileapi.com/reference/create-invite.md
- https://docs.getsmileapi.com/reference/create-token-1.md
- https://docs.getsmileapi.com/reference/create-user-1.md
- https://docs.getsmileapi.com/reference/create-verification.md
- https://docs.getsmileapi.com/reference/create-webhook.md
- https://docs.getsmileapi.com/reference/delete-account.md
- https://docs.getsmileapi.com/reference/delete-archive.md
- https://docs.getsmileapi.com/reference/delete-consent-template.md
- https://docs.getsmileapi.com/reference/delete-invite-template.md
- https://docs.getsmileapi.com/reference/delete-webhook.md
- https://docs.getsmileapi.com/reference/disable-account-monitor.md
- https://docs.getsmileapi.com/reference/generate-account-export.md
- https://docs.getsmileapi.com/reference/get-account-1.md
- https://docs.getsmileapi.com/reference/get-account-payload.md
- https://docs.getsmileapi.com/reference/get-alpha-blacklist.md
- https://docs.getsmileapi.com/reference/get-alpha-footprint.md
- https://docs.getsmileapi.com/reference/get-alpha-form.md
- https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md
- https://docs.getsmileapi.com/reference/get-alpha-maw.md
- https://docs.getsmileapi.com/reference/get-alpha-signal.md
- https://docs.getsmileapi.com/reference/get-archive.md
- https://docs.getsmileapi.com/reference/get-beta-maw.md
- https://docs.getsmileapi.com/reference/get-beta-signal.md
- https://docs.getsmileapi.com/reference/get-beta-social-security.md
- https://docs.getsmileapi.com/reference/get-contribution.md
- https://docs.getsmileapi.com/reference/get-document-1.md
- https://docs.getsmileapi.com/reference/get-eincomes.md
- https://docs.getsmileapi.com/reference/get-employment-1.md
- https://docs.getsmileapi.com/reference/get-feature-insight.md
- https://docs.getsmileapi.com/reference/get-identity-1.md
- https://docs.getsmileapi.com/reference/get-income-1.md
- https://docs.getsmileapi.com/reference/get-invite-template.md
- https://docs.getsmileapi.com/reference/get-invite.md
- https://docs.getsmileapi.com/reference/get-liabilities.md
- https://docs.getsmileapi.com/reference/get-link.md
- https://docs.getsmileapi.com/reference/get-provider-1.md
- https://docs.getsmileapi.com/reference/get-rating-1.md
- https://docs.getsmileapi.com/reference/get-task.md
- https://docs.getsmileapi.com/reference/get-transaction-1.md
- https://docs.getsmileapi.com/reference/get-user-1.md
- https://docs.getsmileapi.com/reference/get-user-session-payload.md
- https://docs.getsmileapi.com/reference/get-verification.md
- https://docs.getsmileapi.com/reference/get-webhook.md
- https://docs.getsmileapi.com/reference/list-accounts-1.md
- https://docs.getsmileapi.com/reference/list-alpha-blacklists.md
- https://docs.getsmileapi.com/reference/list-alpha-footprints.md
- https://docs.getsmileapi.com/reference/list-alpha-forms.md
- https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md
- https://docs.getsmileapi.com/reference/list-alpha-maws.md
- https://docs.getsmileapi.com/reference/list-alpha-signals.md
- https://docs.getsmileapi.com/reference/list-archives.md
- https://docs.getsmileapi.com/reference/list-beta-maws.md
- https://docs.getsmileapi.com/reference/list-beta-signals.md
- https://docs.getsmileapi.com/reference/list-beta-social-securities.md
- https://docs.getsmileapi.com/reference/list-consent-templates.md
- https://docs.getsmileapi.com/reference/list-contributions.md
- https://docs.getsmileapi.com/reference/list-documents-1.md
- https://docs.getsmileapi.com/reference/list-eincomes.md
- https://docs.getsmileapi.com/reference/list-employments-1.md
- https://docs.getsmileapi.com/reference/list-file-types.md
- https://docs.getsmileapi.com/reference/list-identities-1.md
- https://docs.getsmileapi.com/reference/list-incomes-1.md
- https://docs.getsmileapi.com/reference/list-insights.md
- https://docs.getsmileapi.com/reference/list-invite-log.md
- https://docs.getsmileapi.com/reference/list-invite-templates.md
- https://docs.getsmileapi.com/reference/list-invites.md
- https://docs.getsmileapi.com/reference/list-liabilities.md
- https://docs.getsmileapi.com/reference/list-links.md
- https://docs.getsmileapi.com/reference/list-providers.md
- https://docs.getsmileapi.com/reference/list-ratings-1.md
- https://docs.getsmileapi.com/reference/list-tasks.md
- https://docs.getsmileapi.com/reference/list-transactions-1.md
- https://docs.getsmileapi.com/reference/list-users-1.md
- https://docs.getsmileapi.com/reference/list-verifications.md
- https://docs.getsmileapi.com/reference/list-webhooks.md
- https://docs.getsmileapi.com/reference/reset-user-session.md
- https://docs.getsmileapi.com/reference/update-invite-template.md
merge:
pages: 92
deduped: 1153
conflicts_kept_first: 0