Sign in
Signals

Create Signal

post/alpha/signals

Request body

phonestring required

Must start with country code i.e. +639178912345, and no leading zeros

Example request

{
  "phone": "+639178902345",
  "consent": {
    "consentedAt": "2021-04-14T09:30:24Z"
  }
}

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": "+639178912345"
    },
    "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