SMsmileapi
Signals (Alpha)

Create Signal

Changed on
post/alpha/signals

Request

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

Request body

phonestring required

Subject's mobile number. Must start with country code i.e. +639559991234, and no leading zeros

Example request

{
  "phone": "+639559991234",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

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": {
    "createdAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "phone": "+639559991234",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    },
    "result": {
      "events_application_reception_day30": 1,
      "events_application_reception_day30_institution_count": 9,
      "events_application_approval_day30": 3,
      "events_loan_disbursement_day30": 9,
      "events_repayment_reminder_day30": 9,
      "events_repayment_reminder_day30_institution_count": 9,
      "events_successful_repayment_day30": 9,
      "events_successful_repayment_day30_institution_count": 9,
      "events_overdue_day30": 9,
      "events_overdue_day30_institution_count": 9,
      "events_overdue_day30_amount": 9,
      "events_debt_day30_amount": 9,
      "events_overdue_day30_days": 9,
      "events_marketing_day90_institution_count": 9,
      "events_application_reception_day90": 9,
      "events_loan_disbursement_day90": 9,
      "events_loan_disbursement_day90_institution_count": 9,
      "events_overdue_day90": 9,
      "events_overdue_day90_amount": 9,
      "events_debt_day90_amount": 1,
      "events_overdue_day90_days": 4,
      "events_marketing_day180_institution_count": 9,
      "events_application_reception_day180": 9,
      "events_loan_disbursement_day180": 9,
      "events_loan_disbursement_day180_institution_count": 9,
      "events_overdue_day180": 9,
      "events_overdue_day180_amount": 9,
      "events_loan_disbursement_days_since_last": 9,
      "events_successful_repayment_days_since_last": 4,
      "events_overdue_days_since_last": 1
    }
  }
}

Changes

  • v1a68faef4b017Revision changes
    • breaking

      added to the / request property allOf list

    • breaking

      the / request property type changed from string to no type, and format from date-time to no format

    • 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

  • v1b1df692df5aeRevision changes
    • info

      api tag Signals (Alpha) added

    • info

      api tag Signals(Alpha) removed