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-maws-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 Maws (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: Maws (Alpha)
paths:
  /alpha/maws:
    post:
      summary: Create Maw
      operationId: create-alpha-maw
      description: '## Create a Maw2 object.

        This endpoint requires **four mandatory parameters**:

        `consent`, `mobileNumber`, `countryCode`, and `templateId`.


        ### Supported Template


        | Template ID | Region(s) | Required Parameters |

        |--------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------|

        | `tpl-maw002001` | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` |

        | `mawTpl-bfc93eb72d24860bf62429a1dd06708d` (deprecated) | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` |


        ### Sandbox Test Values


        | Parameter | Value | Expected Response |

        |--------------|-----------------|------------------------|

        | templateId | `tpl-maw002001` | |

        | countryCode | `PH` | |

        | mobileNumber | `639559991234` | `resultCode = SUCCESS` |


        For **all other valid input combinations**, if no mock data match is found, the system returns

        `resultCode = NO_DATA` and the response contains no items.'
      tags:
      - Maws (Alpha)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlphaMawPostResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b72199a-6852-4234-bb0e-ad472648282d
                    data:
                      id: maw-e35d521ef8f147c4aa01b7c1af85aaf7
                      createdAt: '2021-04-14T09:30:24Z'
                      status: COMPLETED
                      resultCode: SUCCESS
                      resultMessage: Success!
                      requestMeta:
                        mobileNumber: '6381789801234'
                        countryCode: PH
                        templateId: tpl-maw002001
                        consent:
                          type: Terms And Conditions
                          version: 1
                          consentedWith: I agree to the terms and conditions.
                          consentedAt: '2021-04-14T09:30:24Z'
                          consentTemplateId: null
                      items:
                      - date: '2021-04-14'
                        level: '2'
                        source: seat
                        duration: '10'
                        platformId: 5b79399a68524234bb0ead472648282d
                      - date: '2021-03-14'
                        level: '3'
                        source: sms
                        duration: null
                        platformId: 5b79399a68524234bb0ead472648282d
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlphaMawPostRequest'
            examples:
              Example:
                value:
                  consent:
                    type: Terms And Conditions
                    version: 1
                    consentedWith: I agree to the terms and conditions.
                    consentedAt: '2021-04-14T09:30:24Z'
                    consentTemplateId: null
                  templateId: tpl-maw002001
                  mobileNumber: '6381789801234'
                  countryCode: PH
    get:
      summary: List Maws
      operationId: list-alpha-maws
      tags:
      - Maws (Alpha)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlphaMawListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: null
                      items:
                      - id: maw-e35d521ef8f147c4aa01b7c1af85aaf7
                        createdAt: '2021-04-14T09:30:24Z'
                        status: COMPLETED
                        resultCode: ''
                        resultMessage: ''
                        requestMeta:
                          mobileNumber: '6381789801234'
                          countryCode: PH
                          templateId: mawTpl-xxxxxxxxxxxxxxx
                          consent:
                            type: Terms And Conditions
                            version: 1
                            consentedWith: I agree to the terms and conditions.
                            consentedAt: '2021-04-14T09:30:24Z'
                            consentTemplateId: null
                        items:
                        - date: '2021-04-14'
                          level: '2'
                          source: seat
                          duration: '10'
                          platformId: 5b79399a68524234bb0ead472648282d
                        - date: '2021-03-14'
                          level: '3'
                          source: sms
                          duration: null
                          platformId: 5b79399a68524234bb0ead472648282d
      description: List all Maws.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
      - name: mawId
        in: query
        required: false
        schema:
          type: string
        description: Filter maws by a specific Maw ID.
      - name: mobileNumber
        in: query
        required: false
        schema:
          type: string
        description: Filter maws by a specific mobile number.
      - schema:
          type: string
          format: date
        in: query
        name: startDate
        description: Filter maws by the start date of the request range (YYYY-MM-DD).
      - schema:
          type: string
          format: date
        in: query
        name: endDate
        description: Filter maws by the end date of the request range (YYYY-MM-DD).
  /alpha/maws/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: View Maw
      description: View Maw by unique ID.
      operationId: get-alpha-maw
      tags:
      - Maws (Alpha)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlphaMawGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b72199a-6852-4234-bb0e-ad472648282d
                    data:
                      id: maw-e35d521ef8f147c4aa01b7c1af85aaf7
                      createdAt: '2021-04-14T09:30:24Z'
                      status: COMPLETED
                      resultCode: ''
                      resultMessage: ''
                      requestMeta:
                        mobileNumber: '6381789801234'
                        countryCode: PH
                        templateId: mawTpl-xxxxxxxxxxxxxxx
                        consent:
                          type: Terms And Conditions
                          version: 1
                          consentedWith: I agree to the terms and conditions.
                          consentedAt: '2021-04-14T09:30:24Z'
                          consentTemplateId: null
                      items:
                      - date: '2021-04-14'
                        level: '2'
                        source: seat
                        duration: '10'
                        platformId: 5b79399a68524234bb0ead472648282d
                      - date: '2021-03-14'
                        level: '3'
                        source: sms
                        duration: null
                        platformId: 5b79399a68524234bb0ead472648282d
components:
  schemas:
    AlphaMawListResponse:
      title: Alpha Maw 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/AlphaMaw'
    AlphaMaw:
      type: object
      required:
      - id
      - createdAt
      - status
      - requestMeta
      properties:
        id:
          type: string
          description: The unique ID for the Alpha Maw.
        createdAt:
          $ref: '#/components/schemas/RefDateTime'
        status:
          type: string
          description: The current status of the Maw.
          enum:
          - PROCESSING
          - ERROR
          - COMPLETED
        resultCode:
          type: string
          description: The final result of the Maw.
          enum:
          - SUCCESS
          - NO_DATA
          - SYSTEM_ERROR
          - SERVICE_UNAVAILABLE
        resultMessage:
          type: string
          description: A detailed description of the final result of the Maw.
        requestMeta:
          $ref: '#/components/schemas/AlphaMawPostRequest'
        items:
          type: array
          items:
            $ref: '#/components/schemas/AlphaMawItem'
    RefDate:
      type: string
      format: date
      description: The date, yyyy-MM-dd
      example: '2000-01-21'
    AlphaMawPostResponse:
      title: Alpha Maw Post Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/AlphaMaw'
    AlphaMawItem:
      type: object
      required:
      - platformId
      - source
      - date
      properties:
        date:
          $ref: '#/components/schemas/RefDate'
        level:
          type: string
          description: The level of the item. 1 - whitelist 2 - secondary whitelist, 3 - normal, 4 - greylist, 5 - blacklist
        platformId:
          type: string
          description: Unique ID for the platform.
        duration:
          type: string
          description: The duration of the item. It will have value if source is seat.
        source:
          type: string
          description: 'The source of the item. Possible values are: seat, voice, sms.'
        platformTags:
          type: array
          default: []
          items:
            type: string
            description: 'A tag associated with the item. Possible values are: finance, other, etc.'
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    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.
    AlphaMawPostRequest:
      type: object
      required:
      - consent
      - templateId
      - mobileNumber
      - countryCode
      properties:
        mobileNumber:
          type: string
          description: Subject's mobile number. Must start with country code i.e. 639559991234, and no leading zeros
          example: '639559991234'
        countryCode:
          $ref: '#/components/schemas/RefCountry'
        templateId:
          type: string
          description: Generated internally by Smile. You can request the specific templateId from Smile.
          example: tpl-maw002001
        consent:
          $ref: '#/components/schemas/Consent'
    RefCountry:
      type:
      - string
      - 'null'
      title: Country ISO Codes
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BQ
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - KH
      - CM
      - CA
      - CV
      - KY
      - CF
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CD
      - CK
      - CR
      - CI
      - HR
      - CU
      - CW
      - CY
      - CZ
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - VA
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - KP
      - KR
      - XK
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MK
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - AN
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - MP
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RS
      - RE
      - RO
      - RU
      - RW
      - BL
      - SH
      - KN
      - LC
      - MF
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - CS
      - SC
      - SL
      - SG
      - SX
      - SK
      - SI
      - SB
      - SO
      - ZA
      - GS
      - SS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SZ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - XT
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - US
      - UM
      - UY
      - UZ
      - VU
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      - null
      description: 2 character alpha ISO-3166 codes
      example: PH
    AlphaMawGetResponse:
      title: Alpha Maw Get Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/AlphaMaw'
  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.
  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