SMsmileapi
Validations (Alpha)

List Validations

Changed on

List previously submitted validations.

get/alpha/validations

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/alpha/validations
  • 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.

userIdstring

Filter to those associated with a particular user ID.

startDatestring date
Example:2021-04-01

Filter by creation date, start of date range (YYYY-MM-DD)

endDatestring date
Example:2021-04-21

Filter by creation date, end of date range (YYYY-MM-DD)

typestring

Filter by validation type (e.g. BankAccount).

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": "maw-00d49fe7b5834ba79474cb1373998ff3",
        "createdAt": "2021-04-14T09:30:24Z",
        "result": {
          "matchScore": 100
        },
        "requestMeta": {
          "name": "George",
          "idType": "NATIONAL_ID",
          "idNumber": "1234567890",
          "countryCode": "PH",
          "bic": "DEUTDEFF",
          "iban": "AT610904300234573201",
          "accountNumber": "0123456789",
          "templateId": "tpl-vld006001",
          "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

  • v10e1328ab4423Revision changes
    • info

      endpoint added