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-signals-alpha-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 Signals (Alpha) 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: Signals (Alpha)
paths:
  /alpha/signals:
    post:
      summary: Create Signal
      operationId: create-alpha-signal
      tags:
      - Signals (Alpha)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalPostResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b72199a-6852-4234-bb0e-ad472648282d
                    data:
                      id: signal-e35d521ef8f147c4aa01b7c1af85aaf7
                      createdAt: '2021-04-14T09:30:24Z'
                      status: COMPLETED
                      resultCode: ''
                      resultMessage: ''
                      requestMeta:
                        phone: '+639178902345'
                        consent:
                          type: Terms And Conditions
                          version: 1
                          consentedWith: I agree to the terms and conditions.
                          consentedAt: '2021-04-14T09:30:24Z'
                          consentTemplateId: ct-5b79399a68524234bb0ead472648282d
                      result:
                        events_arbitrary_day30: 0
                        events_preloan_day30: 0
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignalPostRequest'
    get:
      summary: List Signals
      tags:
      - Signals (Alpha)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: null
                      items:
                      - signal:
                          id: signal-e35d521ef8f147c4aa01b7c1af85aaf7
                          createdAt: '2021-04-14T09:30:24Z'
                          status: COMPLETED
                          resultCode: ''
                          resultMessage: ''
                          requestMeta:
                            phone: '+639178902345'
                            consent:
                              type: Terms And Conditions
                              version: 1
                              consentedWith: I agree to the terms and conditions.
                              consentedAt: '2021-04-14T09:30:24Z'
                              consentTemplateId: ct-5b79399a68524234bb0ead472648282d
                          result:
                            events_arbitrary_day30: 0
                            events_preloan_day30: 0
      operationId: list-alpha-signals
      description: List all Signals.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
      - name: signalId
        in: query
        required: false
        schema:
          type: string
        description: Filter Signal Requests by a specific Signal Request ID.
      - name: phone
        in: query
        required: false
        schema:
          type: string
        description: Filter Signal Requests by a specific mobile phone.
      - schema:
          type: string
          format: date
        in: query
        name: startDate
        description: Filter Signal Requests by request date, start of date range (YYYY-MM-DD)
      - schema:
          type: string
          format: date
        in: query
        name: endDate
        description: Filter Signal Requests by request date, end of date range (YYYY-MM-DD)
  /alpha/signals/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: View Signal
      description: View Signal by unique ID.
      operationId: get-alpha-signal
      tags:
      - Signals (Alpha)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b72199a-6852-4234-bb0e-ad472648282d
                    data:
                      id: signal-e35d521ef8f147c4aa01b7c1af85aaf7
                      createdAt: '2021-04-14T09:30:24Z'
                      status: COMPLETED
                      resultCode: ''
                      resultMessage: ''
                      requestMeta:
                        phone: '+639178902345'
                        consent:
                          type: Terms And Conditions
                          version: 1
                          consentedWith: I agree to the terms and conditions.
                          consentedAt: '2021-04-14T09:30:24Z'
                          consentTemplateId: ct-5b79399a68524234bb0ead472648282d
                      result:
                        events_arbitrary_day30: 0
                        events_preloan_day30: 0
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:
    SignalListResponse:
      title: Signal list Response
      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/Signal'
    Signal:
      type: object
      required:
      - id
      - createdAt
      - status
      - requestMeta
      properties:
        id:
          type: string
          description: Unique ID for the Signal Request
        createdAt:
          $ref: '#/components/schemas/RefDateTime'
        status:
          type: string
          description: Current status of the Signal Request
          enum:
          - PROCESSING
          - ERROR
          - COMPLETED
        resultCode:
          type: string
          description: Final result of the Signal Request
          enum:
          - SUCCESS
          - NO_DATA
          - SYSTEM_ERROR
          - SERVICE_UNAVAILABLE
        resultMessage:
          type: string
          description: Longer description of the final result of the Signal Request
        requestMeta:
          type: object
          properties:
            phone:
              type: string
              description: Subject's mobile number provided in the request
              example: '+639559991234'
            consent:
              $ref: '#/components/schemas/Consent'
        result:
          $ref: '#/components/schemas/ObjectSignalRefResult'
    SignalGetResponse:
      title: Signal Get Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Signal'
    ObjectSignalRefResult:
      type: object
      title: Object-Signal-Ref-result
      properties:
        events_marketing_day30_institution_count:
          type: integer
          example: 0
          description: Number of institutions with marketing promotion events in the last 30 days
        events_application_reception_day30:
          type: integer
          example: 1
          description: Number of application reception events in the last 30 days
        events_application_reception_day30_institution_count:
          type: integer
          example: 9
          description: Number of institutions with application reception events in the last 30 days
        events_application_approval_day30:
          type: integer
          example: 3
          description: Number of application approval events in the last 30 days
        events_loan_disbursement_day30:
          type: integer
          example: 9
          description: Number of loan disbursement events in the last 30 days
        events_loan_disbursement_day30_institution_count:
          type: integer
          example: 0
          description: Number of institutions with loan disbursement events in the last 30 days
        events_repayment_reminder_day30:
          type: integer
          example: 9
          description: Number of repayment reminder events in the last 30 days
        events_repayment_reminder_day30_institution_count:
          type: integer
          example: 9
          description: Number of institutions with repayment reminder events in the last 30 days
        events_successful_repayment_day30:
          type: integer
          example: 9
          description: Number of successful repayment events in the last 30 days
        events_successful_repayment_day30_institution_count:
          type: integer
          example: 9
          description: Number of institutions with successful repayment events in the last 30 days
        events_overdue_day30:
          type: integer
          example: 9
          description: Number of overdue events in the last 30 days
        events_overdue_day30_institution_count:
          type: integer
          example: 9
          description: Number of institutions with overdue events in the last 30 days
        events_overdue_day30_amount:
          type: integer
          example: 9
          description: Amount of overdue events in the last 30 days
        events_debt_day30_amount:
          type: integer
          example: 9
          description: Amount of debt events in the last 30 days
        events_overdue_day30_days:
          type: integer
          example: 9
          description: Number of days of overdue events in the last 30 days
        events_marketing_day90_institution_count:
          type: integer
          example: 9
          description: Number of institutions with marketing promotion events in the last 90 days
        events_application_reception_day90:
          type: integer
          example: 9
          description: Number of application reception events in the last 90 days
        events_loan_disbursement_day90:
          type: integer
          example: 9
          description: Number of loan disbursement events in the last 90 days
        events_loan_disbursement_day90_institution_count:
          type: integer
          example: 9
          description: Number of institutions with loan disbursement events in the last 90 days
        events_overdue_day90:
          type: integer
          example: 9
          description: Number of overdue events in the last 90 days
        events_overdue_day90_institution_count:
          type: integer
          example: 0
          description: Number of institutions with overdue events in the last 90 days
        events_overdue_day90_amount:
          type: integer
          example: 9
          description: Amount of overdue events in the last 90 days
        events_debt_day90_amount:
          type: integer
          example: 1
          description: Amount of debt events in the last 90 days
        events_overdue_day90_days:
          type: integer
          example: 4
          description: Number of days of overdue events in the last 90 days
        events_marketing_day180_institution_count:
          type: integer
          example: 9
          description: Number of institutions with marketing promotion events in the last 180 days
        events_application_reception_day180:
          type: integer
          example: 9
          description: Number of application reception events in the last 180 days
        events_loan_disbursement_day180:
          type: integer
          example: 9
          description: Number of loan disbursement events in the last 180 days
        events_loan_disbursement_day180_institution_count:
          type: integer
          example: 9
          description: Number of institutions with loan disbursement events in the last 180 days
        events_overdue_day180:
          type: integer
          example: 9
          description: Number of overdue events in the last 180 days
        events_overdue_day180_institution_count:
          type: integer
          example: null
          description: Number of institutions with overdue events in the last 180 days
        events_overdue_day180_amount:
          type: integer
          example: 9
          description: Amount of overdue events in the last 180 days
        events_overdue_day180_days:
          type: integer
          example: 0
          description: Number of days of overdue events in the last 180 days
        events_loan_disbursement_days_since_last:
          type: integer
          example: 9
          description: Number of days since the last loan disbursement event
        events_successful_repayment_days_since_last:
          type: integer
          example: 4
          description: Number of days since the last successful repayment event
        events_overdue_days_since_last:
          type: integer
          example: 1
          description: Number of days since the last overdue event
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    SignalPostResponse:
      title: Signal Post Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Signal'
    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
    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
    ObjectMetadataRefMessage:
      type: string
      title: ObjectMetadataRefMessage
      description: Message response to the request
      example: Success
      x-internal: false
    Consent:
      type: object
      required:
      - consentedAt
      - consentedWith
      properties:
        type:
          type: string
          description: The internal name of your consent document (e.g. "Terms and Conditions" or "Privacy Policy"); your own reference label
          example: Terms and Conditions
        version:
          type: string
          description: Your internal version identifier for this consent document (e.g. "1.0.0")
          example: 1.0.0
        consentedAt:
          allOf:
          - $ref: '#/components/schemas/RefDateTime'
          description: The date and time the subject accepted your consent document, typically when they tapped "I agree" in your app. Not the time of this API call. Use ISO 8601 format, e.g. "2024-04-14T09:30:24Z"
        consentedWith:
          type: string
          description: The exact text of the button or checkbox the user clicked to give consent, e.g. "I agree to the Terms and Conditions"
          example: I agree to the terms and conditions
        consentTemplateId:
          type: string
          description: ID of a stored Consent Template. Retrieve from the Developer Portal or GET /consentTemplates. Overrides any inline fields above when provided.
    SignalPostRequest:
      type: object
      required:
      - consent
      - phone
      properties:
        phone:
          type: string
          description: Subject's mobile number. Must start with country code i.e. +639559991234, and no leading zeros
          example: '+639559991234'
        consent:
          $ref: '#/components/schemas/Consent'
  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