SMsmileapi
Social Securities (Beta)

List Social Securities

Changed on

List all social security records for users

get/beta/socialSecurities

Request

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

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

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

socialSecurityIdstring

Filter social securities by social security id

startDatestring date

Filter social securities by report date, start of date range (YYYY-MM-DD)

endDatestring date

Filter social securities by report date, end of date range (YYYY-MM-DD)

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": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "createdAt": "2021-04-14T09:30:24Z",
        "result": {
          "currency": "PHP"
        },
        "requestMeta": {
          "emailAddress": "john.doe@example.com",
          "fullName": "John Doe",
          "mobileNumber": "529559991234",
          "curp": "DOEJ800101HDFXXX01",
          "templateId": "tpl-sss003002",
          "consent": {
            "type": "Terms and Conditions",
            "version": "1.0.0",
            "consentedAt": "2021-04-14T09:30:24Z",
            "consentedWith": "I agree to the terms and conditions"
          }
        }
      }
    ]
  }
}

Changes

  • v1a68faef4b017Revision changes
    • breaking

      the ///// response's property type changed from string to no type, and format from date-time to no format for status

    • info

      added to the ///// response property allOf list for the response status

  • v13bcbeecafbabRevision changes
    • breaking

      the response property //// became optional for 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

    • info

      removed the non-success response with the status

    • info

      added the optional property //// to the response with the status