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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/getsmileapi:getsmileapi-incomes-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Smile Incomes 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: Incomes
paths:
  /incomes:
    get:
      summary: List Incomes
      tags:
      - Incomes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomeListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: '1259723474'
                      items:
                      - id: inc-17bbf36498de4d68a0d4f86c7b62f69f
                        workItem: null
                        employer: ABC Corporation
                        startDate: '2021-06-16'
                        endDate: '2021-06-30'
                        paymentMethod: Bank
                        currency: PHP
                        frequency: Monthly
                        baseAmount: 8500
                        grossAmount: 10000
                        netAmount: 7820.25
                        metadata:
                          createdAt: '2021-06-30T09:30:24Z'
                          sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                          sourceType: UPLOAD
                          userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                          providerId: abccorp
                      - id: inc-18adf56798de4d68a9f3g34c7b62f32e
                        workItem: null
                        employer: ABC Corporation
                        startDate: '2021-06-01'
                        endDate: '2021-06-15'
                        paymentMethod: Bank
                        currency: PHP
                        frequency: Monthly
                        baseAmount: 8500
                        grossAmount: 10000
                        netAmount: 7820.25
                        metadata:
                          createdAt: '2021-06-14T09:30:24Z'
                          sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                          sourceType: UPLOAD
                          userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                          providerId: abccorp
      operationId: list-incomes
      description: List the user's incomes from employment data sources.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/accountId'
      - schema:
          type: string
          format: date
        in: query
        name: startDate
        description: Filter by income date, start of date range (YYYY-MM-DD)
      - schema:
          type: string
          format: date
        in: query
        name: endDate
        description: Filter by income date, end of date range (YYYY-MM-DD)
      - $ref: '#/components/parameters/sourceId'
  /incomes/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: View Income
      tags:
      - Incomes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomeGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: inc-17bbf36498de4d68a0d4f86c7b62f69f
                      workItem: null
                      employer: ABC Corporation
                      startDate: '2021-06-01'
                      endDate: '2021-06-15'
                      paymentMethod: Cash
                      currency: PHP
                      frequency: Monthly
                      baseAmount: 8500
                      grossAmount: 10000
                      netAmount: 7820.25
                      metadata:
                        createdAt: '2021-06-14T09:30:24Z'
                        sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                        sourceType: UPLOAD
                        userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                        providerId: abccorp
      operationId: get-income
      description: View the user's income by ID.
      parameters: []
components:
  schemas:
    IncomeListData:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/ObjectNextCursor'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Income'
    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
      example: PHP
    RefObjectID:
      type: string
      title: Object ID
      description: Unique ID of this object
      example: 17bbf36498de4d68a0d4f86c7b62f69f
    ObjectMetadataRefMessage:
      type: string
      title: ObjectMetadataRefMessage
      description: Message response to the request
      example: Success
      x-internal: false
    IncomeGetResponse:
      title: Income Get Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Income'
    IncomeListResponse:
      title: Income List Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/IncomeListData'
    ObjectReferenceMetadata:
      title: Reference Metadata
      type: object
      description: Metadata related to account-specific data
      properties:
        itemCreatedAt:
          $ref: '#/components/schemas/RefDateTime'
        createdAt:
          $ref: '#/components/schemas/RefDateTime'
        accountId:
          type: string
          deprecated: true
          description: The accountId of this object
        sourceId:
          type: string
          description: The ACCOUNT or ARCHIVE ID associated with this object
        sourceType:
          $ref: '#/components/schemas/RefSourceType'
        userId:
          type: string
          description: The user ID associated with this object
        providerId:
          type: string
          description: The provider ID associated with this object
      required:
      - createdAt
      - itemCreatedAt
      - sourceId
      - sourceType
      - userId
      - providerId
    RefEmployer:
      type:
      - string
      - 'null'
      title: Employer
      description: Employer name
      example: ABC Corporation
    RefSourceType:
      type:
      - string
      - 'null'
      title: Ref-Source-Type
      example: Account
      enum:
      - ACCOUNT
      - UPLOAD
      - ARCHIVE
      - SOCIAL_SECURITY
      description: Source Type
    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
    RefDateTime:
      type: string
      title: Date and Time string
      format: date-time
      example: '2021-04-14T09:30:24Z'
      description: Date and time
    Income:
      title: Income
      type: object
      description: The stored income information of the user from an employment data provider.
      x-examples:
        Example:
          id: inc-17bbf36498de4d68a0d4f86c7b62f69f
          workItem: null
          employer: ABC Corporation
          startDate: '2021-06-01'
          endDate: '2021-06-15'
          currency: PHP
          frequency: Monthly
          baseAmount: 8500
          grossAmount: 10000
          netAmount: 7820.25
          metadata:
            createdAt: '2021-06-14T09:30:24Z'
            sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
            sourceType: UPLOAD
            userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
            providerId: user-provided
      x-internal: false
      x-tags:
      - Incomes
      allOf:
      - $ref: '#/components/schemas/IncomePayload'
      - properties:
          metadata:
            $ref: '#/components/schemas/ObjectReferenceMetadata'
      required:
      - id
      - startDate
      - currency
      - metadata
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    RefPayPeriod:
      type:
      - string
      - 'null'
      title: Pay Period
      description: Pay period
      enum:
      - Hourly
      - Daily
      - Weekly
      - Semimonthly
      - Monthly
      - Bimonthly
      - Quarterly
      - Annually
      - Variable
      - Unspecified
      - null
      example: Annually
    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
    IncomePayload:
      type: object
      required:
      - id
      - startDate
      - currency
      properties:
        id:
          $ref: '#/components/schemas/RefObjectID'
        workItem:
          type:
          - string
          - 'null'
          description: Work performed (specially in the case of contract or freelance jobs)
        employer:
          $ref: '#/components/schemas/RefEmployer'
        startDate:
          type: string
          description: Start date
          format: date
          example: '2021-06-01'
        endDate:
          type:
          - string
          - 'null'
          example: '2021-06-15'
          format: date
          description: End date
        currency:
          $ref: '#/components/schemas/RefCurrency'
        frequency:
          $ref: '#/components/schemas/RefPayPeriod'
        baseAmount:
          type:
          - number
          - 'null'
          description: Base amount
        grossAmount:
          type:
          - number
          - 'null'
          description: Gross amount
        netAmount:
          type:
          - number
          - 'null'
          description: Net amount
  parameters:
    sourceId:
      name: sourceId
      in: query
      required: false
      schema:
        type: string
      description: Filter to those associated with a particular source ID. If we query the link account data, the sourceId is the accountId, If we query the archive data, then the sourceId is the archiveId
    id:
      name: id
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 200
      description: ID of the specific object in the collection.
      required: true
    userId:
      name: userId
      in: query
      required: false
      schema:
        type: string
      description: Filter to those associated with a particular user ID.
    accountId:
      name: accountId
      in: query
      required: false
      schema:
        type: string
      description: Filter to those associated with a particular account ID.
      deprecated: 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.
  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