--- title: "Create Signal" method: POST path: "/alpha/signals" tags: ["Signals (Alpha)"] --- # Create Signal `POST /alpha/signals` ## Request body - SignalPostRequest - `phone` string, required — Subject's mobile number. Must start with country code i.e. +639559991234, and no leading zeros - `consent` Consent, required - `type` string — The consent flag key, the consent content should be sent to Smile previously - `version` string — The version of this consent - `consentedAt` string, date-time, required — Date and time - `consentedWith` string, required — The short sentences display on the consent page. - `consentTemplateId` string — The related consent template id, you can get it from Smile Developer Portal or /consentTemplates endpoint. ## Response `200` OK - SignalPostResponse - `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 - `message` string — Message response to the request - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs. - `data` Signal - `id` string, required — Unique ID for the Signal Request - `createdAt` string, date-time, required — Date and time - `status` 'PROCESSING' | 'ERROR' | 'COMPLETED', required — Current status of the Signal Request - `resultCode` 'SUCCESS' | 'NO_DATA' | 'SYSTEM_ERROR' | 'SERVICE_UNAVAILABLE' — Final result of the Signal Request - `resultMessage` string — Longer description of the final result of the Signal Request - `requestMeta` object, required - `phone` string — Subject's mobile number provided in the request - `consent` Consent - `type` string — The consent flag key, the consent content should be sent to Smile previously - `version` string — The version of this consent - `consentedAt` string, date-time, required — Date and time - `consentedWith` string, required — The short sentences display on the consent page. - `consentTemplateId` string — The related consent template id, you can get it from Smile Developer Portal or /consentTemplates endpoint. - `result` ObjectSignalRefResult - `events_marketing_day30_institution_count` integer — Number of institutions with marketing promotion events in the last 30 days - `events_application_reception_day30` integer — Number of application reception events in the last 30 days - `events_application_reception_day30_institution_count` integer — Number of institutions with application reception events in the last 30 days - `events_application_approval_day30` integer — Number of application approval events in the last 30 days - `events_loan_disbursement_day30` integer — Number of loan disbursement events in the last 30 days - `events_loan_disbursement_day30_institution_count` integer — Number of institutions with loan disbursement events in the last 30 days - `events_repayment_reminder_day30` integer — Number of repayment reminder events in the last 30 days - `events_repayment_reminder_day30_institution_count` integer — Number of institutions with repayment reminder events in the last 30 days - `events_successful_repayment_day30` integer — Number of successful repayment events in the last 30 days - `events_successful_repayment_day30_institution_count` integer — Number of institutions with successful repayment events in the last 30 days - `events_overdue_day30` integer — Number of overdue events in the last 30 days - `events_overdue_day30_institution_count` integer — Number of institutions with overdue events in the last 30 days - `events_overdue_day30_amount` integer — Amount of overdue events in the last 30 days - `events_debt_day30_amount` integer — Amount of debt events in the last 30 days - `events_overdue_day30_days` integer — Number of days of overdue events in the last 30 days - `events_marketing_day90_institution_count` integer — Number of institutions with marketing promotion events in the last 90 days - `events_application_reception_day90` integer — Number of application reception events in the last 90 days - `events_loan_disbursement_day90` integer — Number of loan disbursement events in the last 90 days - `events_loan_disbursement_day90_institution_count` integer — Number of institutions with loan disbursement events in the last 90 days - `events_overdue_day90` integer — Number of overdue events in the last 90 days - `events_overdue_day90_institution_count` integer — Number of institutions with overdue events in the last 90 days - `events_overdue_day90_amount` integer — Amount of overdue events in the last 90 days - `events_debt_day90_amount` integer — Amount of debt events in the last 90 days - `events_overdue_day90_days` integer — Number of days of overdue events in the last 90 days - `events_marketing_day180_institution_count` integer — Number of institutions with marketing promotion events in the last 180 days - `events_application_reception_day180` integer — Number of application reception events in the last 180 days - `events_loan_disbursement_day180` integer — Number of loan disbursement events in the last 180 days - `events_loan_disbursement_day180_institution_count` integer — Number of institutions with loan disbursement events in the last 180 days - `events_overdue_day180` integer — Number of overdue events in the last 180 days - `events_overdue_day180_institution_count` integer — Number of institutions with overdue events in the last 180 days - `events_overdue_day180_amount` integer — Amount of overdue events in the last 180 days - `events_overdue_day180_days` integer — Number of days of overdue events in the last 180 days - `events_loan_disbursement_days_since_last` integer — Number of days since the last loan disbursement event - `events_successful_repayment_days_since_last` integer — Number of days since the last successful repayment event - `events_overdue_days_since_last` integer — Number of days since the last overdue event ## Changes - **2024-11-11** (v1) `b1df692df5ae` — 2 info - api tag `Signals (Alpha)` added - api tag `Signals(Alpha)` removed - **2024-10-23** (v1) `b5d1c4e69089` — 3 info - api operation id `create-signal` removed and replaced with `create-alpha-signal` - api tag `Signals(Alpha)` added - api tag `Signals` removed - **2024-08-05** (v1) `5cff755a0d41` — 1 info - added the optional property `data/requestMeta/consent` to the response with the `200` status - **2024-06-27** (v1) `4f4b86b82632` — 77 warning - removed the optional property `data/result/events_application_approval_day180` from the response with the `200` status - removed the optional property `data/result/events_application_approval_day180_institution_count` from the response with the `200` status - removed the optional property `data/result/events_application_approval_day30_institution_count` from the response with the `200` status - removed the optional property `data/result/events_application_approval_day90` from the response with the `200` status - …73 more - **2024-06-03** (v1) `af24d6c5d9ee` — 2 info - added the optional property `data/resultCode` to the response with the `200` status - added the optional property `data/resultMessage` to the response with the `200` status [Change history](https://skmtc.dev/smileapi/apis/smile-api/changes/alpha/signals/post.md) --- [API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/a4930eb49f4d/schema)