Overview
Smile Identity gives you an array of tools to access your KYC activities within the Smile Identity Portal, ranging from the dashboard, developer tools and job list to name a few. In addition, we also provide a view to enable our partners to ascertain the availability (uptime and downtime) of all the ID authorities in the countries we operate in.
There are three ways to access ID authority downtime information:
Using the ID API status page in Smile Identity Portal.
Connecting to our ID Status API.
By setting up automated slack bot notifications.
Using the ID API status page in Smile Identity Portal
To access the ID authority availability, you must have previously registered for an account with Smile Identity and be logged in to your account.
Once logged in:
Navigate to the ID API Status page where the list of all ID authorities grouped per country will be displayed. We have 3 statuses Online, Interruption and Offline.
Online - Available: This implies the ID authority is up and running.
Interruption - Service Interruption: This implies that the ID authority, while online, is experiencing latency and heavy traffic which could lead to some job requests not being processed.
Offline - Service Outage: This implies the ID authority is experiencing downtime
Smile provides a 12 hour snapshot of ID authorities availability. To view this, click on your ID authority of choice. A color grid line (green, yellow, red) depicting the timeline of availability of the ID authority over the previous 12 hours. You can hover over the color grid to see the time in the day in which a particular status event occurred.
Connecting to our ID Status API.
At times, you may receive a status code of 1015, which depicts Offline - Service Outage and would want to programmatically check when the service is back online.
This is especially useful if:
You would like to build an internal notification system in-app to notify your customers and internal stakeholders.
You want to queue up a list of failed requests and build a retry mechanism whenever your system is back online.
Smile provides an API to enable you to codify these service interruptions in a way that suits your business needs.
Using the endpoint below:
POST https://[env].smileidentity.com/api/v2/partner/id_status
Where [env] is either "portal" or "prod"
You can find more information on our documentation page.
Prerequisites
To access the ID authority availability, you must have previously registered for an account and conversant with Signing your API request
By setting up automated Slackbot notifications.
Smile provides an automated Slackbot to provide real-time alerts to our partners when there are service interruptions and outages, as well as notify when these interruptions have been rectified.
To access the ID authority availability via the slackbot, have your slack admin install the Smile Identity app from the Slack app directory.
Step 1 - In your portal visit https://portal.smileidentity.com/partner/id_status
Step 2 - Sign into your slack workspace
Step 3 - Select the channel you would like to install the chatbot. Once done, the Smile ID app will be installed in your smile channel
Step 4 - Connect the app to your smile portal - After the app is added to your workspace, your browser initiates a login authorization request. Once logged in, your account will be connected to the Smile Identity Slackbot.
Alternatively, enter /smileidcommand within the channel installed, a prompt asking you to connect your Smile ID account appears. Click Connect Account, and complete the login steps.
Step 5 - Subscribe to receive alerts - To minimize spam, subscribe to specific ID authorities to receive notifications on their availability status. Simply enter the /smileid command within the installed channel, and select ID types you want to be notified on. You can select multiple ID types per country.
On completion you will receive a prompt verifying successful subscription and a list of ID types subscribed to.
Note: To unsubscribe, follow steps highlighted in Step 5