Chenosis Key (Nigeria)

This API product contains all the capabilities that you need to easily add SMS or Voice based two factor authentication using a one-time password to your existing application login or workflow.

Overview

Use this API to authenticate your users in Nigeria using SMS or Voice based two factor authentication. This API uses carrier-approved templated messages to eliminate carrier message filtering and delivery blocking. Easily send messages globally using Chenosis' language translation and global regulations compliance.

Fight fraud before it starts. Validate users with SMS or Voice at any step of your user‘s journey.

Getting started

The Chenosis two factor authentication API seamlessly checks that a user is the owner of the phone number they provide in two simple steps:

  1. Get an access token by sending your client ID and secret to /oauth/client
  2. Add this as a Bearer token to your Authorization header
  3. Call Create Verification (POST) with the users's phone number for Chenosis to send them  4-10 digit verification code via SMS or Voice.
  4. Call Verify Verification for Chenosis to check that the user’s input matches the verification code. If they match, Chenosis registers the phone number as approved.

Specifications

Available
endpoints

POST v1/identity/verification

Description

This interface is used to send a verification to the end-user by specifying the communication details of the end-ser.

Auth type

oauth2 Authorisation required
Please checkout the documentation to review how to access the endpoint via oAuth 2.

Header parameters

Content-Type application/json

FormData parameters

to string required
Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.
channel string
This field is used to set/indicate the channel used to send the verification code to the end-user. The value 'sms' means the verification is sent to the user using an SMS message. The value 'call' means the verification is sent to the user via a phone call made to the end-ser. The value 'email' means the verification is sent to the user using an email message.
locale string
This field is used to set/indicate the the language/locale used when sending the verification code to the end-user. Default is English (en)
201Created
statusCode string

HTTP error code extension

statusMessage string

Message.

data
to string

Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.

channel string

sms,call,email

verificationId string

Unique identifier for the verification, this value will be used to query the status of the verification.

status string

approved,pending,expired,cancelled

transactionId string

transaction ID for tracing.

{
    "statusCode": "string",
    "statusMessage": "string",
    "data": {
        "to": "string",
        "channel": "string",
        "verificationId": "string",
        "status": "string"
    },
    "transactionId": "string"
}
401Unauthorized
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
404Not Found
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
407Proxy Authentication Required
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
500Internal Server Error
timestamp string

Timestamp

status string

HTTP error code extension

error string

Support Message

message string

Support Message

path string

Path accessed

{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
GET v1/identity/verification/{verificationId}

Description

This interface is used to get the verification status of a verification that was previosly sent using the 'verificationId' to identify it.Please note that if the verification is 'approved', it will not be possible to get the status of the verification.

Auth type

oauth2 Authorisation required
Please checkout the documentation to review how to access the endpoint via oAuth 2.

Header parameters

Content-Type application/json
200OK
statusCode string

HTTP error code extension

statusMessage string

Message.

data
to string

Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.

channel string

sms,call,email

verificationId string

Unique identifier for the verification, this value will be used to query the status of the verification.

status string

approved,pending,expired,cancelled

transactionId string

transaction ID for tracing.

{
    "statusCode": "string",
    "statusMessage": "string",
    "data": {
        "to": "string",
        "channel": "string",
        "verificationId": "string",
        "status": "string"
    },
    "transactionId": "string"
}
401Unauthorized
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
404Not Found
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
407Proxy Authentication Required
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
500Internal Server Error
timestamp string

Timestamp

status string

HTTP error code extension

error string

Support Message

message string

Support Message

path string

Path accessed

{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
PATCH v1/identity/verification/{verificationId}

Description

This interface is used to verify a verification that was previosly sent. The 'code' is sent in order to verify that the correct user received the code. Please note that if the verification is 'approved', it will not be possible to get the status of the verification. The response in this request will be the only time the 'status' will be returned as 'approved' if the code is correct.

Auth type

oauth2 Authorisation required
Please checkout the documentation to review how to access the endpoint via oAuth 2.

Header parameters

Content-Type application/json

FormData parameters

code string required
This is the verification code that was sent to the end-user.
200OK
statusCode string

HTTP error code extension

statusMessage string

Message.

data
to string

Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.

channel string

sms,call,email

verificationId string

Unique identifier for the verification, this value will be used to query the status of the verification.

status string

approved,pending,expired,cancelled

transactionId string

transaction ID for tracing.

{
    "statusCode": "string",
    "statusMessage": "string",
    "data": {
        "to": "string",
        "channel": "string",
        "verificationId": "string",
        "status": "string"
    },
    "transactionId": "string"
}
401Unauthorized
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
404Not Found
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
407Proxy Authentication Required
statusCode string

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": "string",
    "statusMessage": "string",
    "SupportMessage": "string"
}
500Internal Server Error
timestamp string

Timestamp

status string

HTTP error code extension

error string

Support Message

message string

Support Message

path string

Path accessed

{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}

CHENOSIS KEY (NIGERIA)

PRICING

READY TO START BUILDING YOUR APP?

Get started by creating an account and adding funds to your wallet.

GET STARTED