Getting Started
Docs
- Client Portal Setup
Client Portal Setup
There is one prerequisite before a client can create projects and services. SMS providers need to be configured properly so that services can be consumed via API.
SMS Providers
NTH provider will be primarily used for the configured country numbers. If the number is outside of the country numbers list, Twilio provider will be used as a fallback.
Projects
Companies can have any number of projects configured. When creating a project it only requires a name. By clicking on a specific project, it will open a Project Details page.
Projects Services
On the Project Details page, you will be able to manage Services which can then be consumed via API. Projects can have any number of services.
Configuring a service is quite comprehensive and it has the following options:
- Service name
- Code Length - Determines how many characters will be used for 2 Factor Authentication.
- Code Type - Determines what type of character sets will be used when generating 2FA codes. Supported types: digits, letters, mixed.
- Letter Case - Determines the case of the letters (if used) in the 2FA code generation. Supports: upper, lower, mixed.
- Time To Live In Minutes - Determines how long the code will be valid for authentication. If expired a new code has to be generated and sent.
- Max Attempts - Determines what is the maximum number of attempts that can be made when trying to verify a specific 2FA code. If exceeded, a new code has to be generated and sent.
- Max Attempts Per Minute - Determines maximum number of attempts that can be attempted in a single minute. Once exceeded, the process will be blocked for a Cool Down Minutes duration.
- PSD2 dynamic linking and Strong Customer Authentication (On/Off)
- Encrypt SMS (On/Off) - When encrypted the contents of the SMS will be sent in an encrypted form. The device where the SMS will be sent will use the Axios application to decrypt the contents.
- Custom scheme (used when Encrypt SMS is On) - Enables an option for defining a custom scheme for encryption.
- Android application hash string (On/Off) - When enabled it allows a custom Hash to be appended to the contents (Android only).
- Message templates - Provides an option to define multiple templates for different languages.
API Keys
Once a service is created a unique API key can be generated which is required for the service to be consumed via API. Once generated the API key will be displayed only once for security reasons. If lost, a new key must be generated.