Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Notification Services for Hosted Web
greenID offers two (2) notification services specifically introduced for this capability. They are:
Info |
---|
Hosted Web customers can use the existing notification service to be notified of a change to verification status. Please refer to Notification of Verification for more information. |
SMS Notification Service
What is the SMS Notification Service?
This notification service has been specifically introduced for customers using the SMS Invite service for Hosted Web. This is a push notification service and will notify customers (on a configured URL) - when the status of an SMS reaches a final state in greenID. This allows customers to take necessary steps in their workflow - for example, sending the SMS again if the SMS failed to be delivered to the individual attempting verification.
How does it work?
Once a phone number has been successfully submitted to greenID for sending an SMS, greenID will send an API response to the customer which will contain a 'submitted' status (among other output fields). This service enables customers to receive a notification to a specific URL once we are informed by our SMS provider of the final delivery status of the SMS i.e. Delivered, Undelivered or Failed. Below is the explanation of the SMS statuses:
Status | Explanation |
Delivered | SMS Service Provider has received confirmation of message delivery from the upstream carrier, and, where available, the destination handset. |
Undelivered | SMS Service Provider received a delivery receipt indicating that the message was not delivered. This can happen for several reasons including carrier content filtering and the availability of the destination handset. |
Failed | The message could not be sent. |
When a notification is sent to the customer's URL, it will contain:
verificationID
SMS Status
The SMS notification will be an HTTP POST to the configured URL. The POST HTTP request will contain form data with the following fields:
Verification ID - as the field “verificationId”
SMS Status - as the field “smsStatus”
SMS ID - as the field “smsMessageId”
How can this be setup?
The notification URL is set as a property for a client organisation and can only be configured or changed by GBG staff. Please contact your account representative for more information.
Cancel Notification Service
This notification service has been specifically introduced for customers using greenID Hosted so they are able to be notified when users cancel out of their Hosted journey. Unlike other implementation, Hosted does not hand off to a customer's calling application for actions like a user exiting the process. This notification service allows customer manage their workflow in the scenario that the user exits the journey from Hosted.
How does it work?
Once the user is registered in greenID via the Hosted web service or Hosted site and hit the 'Cancel' button on any of the Hosted pages, a notification is sent to a customer configured URL. The notification will contain a verification ID. It must be noted that if the user opts out of the Hosted journey prior to registration, greenID will not send a notification because an associated verification ID will not be available at the time.
How can this be setup?
The notification URL is set as a property for a client organisation and can only be configured or changed by GBG staff. Customers can configure the notification URL for this to be the same as their other notification URLs, if required.
Please contact your account representative for more information.
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|