Mobile Customer Information

RATE THIS PAGE
Easily retrieve detailed up to date information about a phone number.

Overview

This API provides comprehensive information about the phone number.

In addition to determining the country of origin of the phone number provided, you can also retrieve the mobile network operator, check if the phone number is active on the network, and in countries with mobile number portability, you can use this API to determine of the number has been ported from another network. It also allows to know if roaming is enabled on the number, get the last date a SIM swap was performed and determine if call divert has been activated.

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/subscriber/{phoneNumber}/information
api.host.com/mobile/subscriber/{phoneNumber}/information

Overview

Send network related information of subscriber as identified by phoneNumber.

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

phoneNumber string
ID of the subscriber is the MSISDN of the subscriber represented as International ITU-T E.164.

Request


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

Responses

200OK
statusCode string

HTTP error code extension

statusMessage string

Message.

phoneNumber string

phoneNumber provided in the input

data
country string

Country of origin of the phoneNumber provided.

mobileNetwork string

Mobile Network Operator of the phoneNumber provided

subscriberIsActive string

TRUE,FALSE,NONE

simIsPorted string

TRUE,FALSE,NONE

roamingIsEnabled string

TRUE,FALSE,NONE

callDivertIsEnabled string

TRUE,FALSE,NONE

lastSimSwapDate string

The date when the last sim swap performed on the SIM of the phoneNumber provided represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format. If the date cannot be determined, the value will be an empty string

transactionId string

transaction ID for tracing.

{
    "statusCode": "string",
    "statusMessage": "string",
    "phoneNumber": "string",
    "data": {
        "country": "string",
        "mobileNetwork": "string",
        "subscriberIsActive": "string",
        "simIsPorted": "string",
        "roamingIsEnabled": "string",
        "callDivertIsEnabled": "string",
        "lastSimSwapDate": "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

Easily retrieve detailed up to date information about a phone number.

$ 0 .00 PER
CALL
SUBSCRIBE

Other customer information products

Icon for the partner

Call Forward Status

A simple and easy way to know if calls to...

View

Icon for the partner

Home Location

A simple API that allows you to know which country...

View

Icon for the partner

SIM Swap Date

One simple API to determine the most recent sim sw...

View

Related recipes

VIEW ALL
DATABASE
Chenosis Key

View Tutorial

Related tutorials

VIEW ALL
onboarding
Configure Nginx as a reverse proxy for your Express API

View Tutorial
support
How to create an APP and start using APIs!

View Tutorial