Chenosis
PRODUCT BY
Chenosis
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.

Click here to view our fair use policy.

Specifications

POST oauth/client/accesstoken
https://api.chenosis.io/oauth/client/accesstoken?grant_type=client_credentials

Overview

The OAuth2 request.

Header parameters

Content-Type application/x-www-form-urlencoded

Query parameters

grant_type string

Body parameters

client_id string required
The client id fromt your app.
client_secret string required
The client secret fromt your app.
200OK
refresh_token_expires_in string

When the token will expire

api_product_list string

The products associated

api_product_list_json json

The products associated

organization_name string

The organisation that is beign called against

developer.email string

The developer email

token_type string

The type of authorization

issued_at string

When the token was issued

client_id string

The Client ID from the app

access_token string

The Client Secret from the app

application_name string

The application ID

scope string

What scope has been applied

expires_in string

When the token will expire

refresh_count string

How many refreshes available

status string

The status of the request

{
    "refresh_token_expires_in": "0",
    "api_product_list": "[product_verify_experience]",
    "api_product_list_json": [
        "product_verify_experience"
    ],
    "organization_name": "prod",
    "developer.email": "[email protected]",
    "token_type": "BearerToken",
    "issued_at": "1617003906435",
    "client_id": "HJFGT565435GGh87qi6n88zstxiL26BG",
    "access_token": "wwNJdSTHF54RD476HMI8plZuwLp3",
    "application_name": "7879798543g-98jh-6yg5-7876-876hg5df4sd2",
    "scope": "USER-VERIFICATION",
    "expires_in": "3599",
    "refresh_count": "0",
    "status": "approved"
}
POST verify/v1/identity/verification
api.chenosis.io/verify/v1/identity/verification

Overview

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

Body 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. - sms, call, email
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) - af, ar, ca, cs, da, de, el, en, en-GB, es, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nb, nl, pl, pt, pr-BR, ro, ru, sv, th, tl, tr, vi, zh, zh-CN, zh-HK
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 verify/v1/identity/verification/{verificationId}
api.chenosis.io/verify/v1/identity/verification/{verificationId}

Overview

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

URL variable parameters

verificationId string
Unique identifier for the verification
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 verify/v1/identity/verification/{verificationId}
api.chenosis.io/verify/v1/identity/verification/{verificationId}

Overview

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

Body parameters

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

URL variable parameters

verificationId string
Unique identifier for the verification
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"
}
GET verify/v1/identity/sms/rate
api.chenosis.io/verify/v1/identity/sms/rate

Overview

This interface is used to get the fees for SMS verifications

Auth type

oauth2 authorisation required
Please checkout the documentation to review how to access the endpoint via oAuth 2.
200OK
statusCode string

HTTP error code extension

statusMessage string

Message.

data
supportedCountries
name string

Name of supported country

code string

Dialing country code of the supported country

fee string

Cost of creating a verification in USD

transactionId string

transaction ID for tracing.

{
    "statusCode": "string",
    "statusMessage": "string",
    "data": {
        "supportedCountries": {
            "name": "string",
            "code": "string",
            "fee": "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"
}

Pricing

60 Day Trial

This API product contains all the capabilities that you need to easily add SMS or Voice based two factor authentication...

$ 0 .00 PER
CALL
SUBSCRIBE

Other cyber security & cryptography products

Generate Mnemonic Password

Generate mnemonic hashes which reversibly convert...

Icon for the partner

Chenosis Key

This API product contains all the capabilities tha...

Generate Strong Password

Use this API to securely generate high information...