SMsmileapi
File Types

List File Types

Changed on

Get the available file types for uploads.

get/fileTypes

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/fileTypes
  • Auth
    HTTP basic

Query parameters

cursorstring

Uses the filter values of the previous page to determine the next set of items.

sizeinteger
Example:50

The number of objects you want returned in a collection.

typestring

Filter results to certain type of file types.

activeboolean

Filter results to active or inactive file types.

enabledboolean

Filter results to enabled or disabled file types.

ocrboolean

Filter results to file types that support OCR.

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/SOCIAL_SECURITY.png",
        "type": "PAYSLIP",
        "typeLabel": "SOCIAL SECURITY Records"
      }
    ]
  }
}

Changes

  • v13bcbeecafbabRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • v1a1f9b403ab62Revision changes
    • info

      removed the BANK_STATEMENT enum value from the /// response property for the response status

    • info

      removed the CLEARANCE_BARANGAY enum value from the /// response property for the response status

    • info

      removed the CLEARANCE_NBI enum value from the /// response property for the response status

    • info

      removed the CLEARANCE_POLICE enum value from the /// response property for the response status

    • info

      removed the COMPANY_ID enum value from the /// response property for the response status

    • info

      removed the GOVERNMENT_ID enum value from the /// response property for the response status

    • info

      removed the OTHERS enum value from the /// response property for the response status

    • info

      removed the PAYSLIP enum value from the /// response property for the response status

    • info

      removed the SOCIAL_SECURITY enum value from the /// response property for the response status

    • info

      removed the TAX_DOCUMENT enum value from the /// response property for the response status

    • info

      removed the UTILITY_BILLS enum value from the /// response property for the response status