Government ID Verification

RATE THIS PAGE

Use this API to verify your customer’s and user’s identity using their ID number, passport number, drivers license numbers and more.

Overview

Do you have customer KYC information and want to verify the information provided to you? This API allows you to supply the government ID (ID Number, International Passport Number, Drivers' License Number, etc) together with the customers mobile number and we will let you know if there's a match.

Specifications

Postman collection Swagger

POST client-credentials/accesstoken

https://staging.api.chenosis.io/client-credentials/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.

Request


curl --location --request POST 'https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials'
    --header 'Authorization: token // https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials'
    --header 'Content-Type: application/x-www-form-urlencoded'
    --data-raw '{
        "client_id": "xxxxxxxxxxxxxxx",
        "client_secret": "xxxxxxxxxxxxxxx",
    }'

Responses

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"
}

GET mobile/subscribers/{phoneNumber}/verify-id-number

api.host.com/mobile/subscribers/{phoneNumber}/verify-id-number

Overview

Verify if the national identity number provided matches subscriber data with the relevant mobile network operator as identified by the 'phoneNumber' value provided.

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

Query parameters

nationalIdNumber string required

This is the ID number to be verified with mobile network operator

URL variable parameters

phoneNumber string

Used to identify the subscriber with relevant mobile operator. This is the MSISDN of the subscriber represented as International ITU-T E.164.

Request


curl --location --request GET 'https://api.host.com/mobile/subscribers/{phoneNumber}/verify-id-number?nationalIdNumber=string'
    --header 'Authorization: token // https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials'
    --header 'Content-Type: application/json'

Responses

200OK

statusCode integer

HTTP error code extension

statusMessage string

Corresponding message.

phoneNumber string

phoneNumber provided in the input

data

nationalIdNumber string

NationalIdNumber value that was passed to be matched with phoneNumber data.

nationalIdNumberMatch string

Y,N-NA,N-AV,N-AD

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "phoneNumber": "string",
    "data": {
        "nationalIdNumber": "string",
        "nationalIdNumberMatch": "string"
    },
    "transactionId": "string"
}

400Bad Request

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

401Unauthorized

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

403Forbidden

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

404Not Found

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

405Method Not Allowed

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

406Not Acceptable

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

500Internal Server Error

statusCode integer

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": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

Pricing

100 Free Daily

Use this API to verify your customer’s and user’s identity using their ID number, passport number, drivers license numbers and...

^$ 0 ^.00 PER
CALL

Other identity and verification products

A simple API to let you know if a SIM...

View

VIEW ALL

Product

Government ID Verification

Overview

Specifications

Overview

Header parameters

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

Query parameters

grant_type string

Body parameters

client_id string required

client_secret string required

Request

Responses

200OK

refresh_token_expires_in string

api_product_list string

api_product_list_json json

organization_name string

developer.email string

token_type string

issued_at string

client_id string

access_token string

application_name string

scope string

expires_in string

refresh_count string

status string

Overview

Auth type

oauth2 authorisation required

Header parameters

Content-Type application/json

Query parameters

nationalIdNumber string required

URL variable parameters

phoneNumber string

Request

Responses

200OK

statusCode integer

statusMessage string

phoneNumber string

data

nationalIdNumber string

nationalIdNumberMatch string

transactionId string

400Bad Request

statusCode integer

statusMessage string

SupportMessage string

401Unauthorized

statusCode integer

statusMessage string

SupportMessage string

403Forbidden

statusCode integer

statusMessage string

SupportMessage string

404Not Found

statusCode integer

statusMessage string

SupportMessage string

405Method Not Allowed

statusCode integer

statusMessage string

SupportMessage string

406Not Acceptable

statusCode integer

statusMessage string

SupportMessage string

500Internal Server Error

statusCode integer

statusMessage string

SupportMessage string

Pricing

100 Free Daily

Other identity and verification products

SIM Swap Verification