A simple API to let you know if a SIM swap has been performed on a number.

Overview

Do you want to know if your customers' phone has been possibly compromised? Use this API to check if a SIM swap has been performed on a phone number.

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.
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-simswap
api.host.com/mobile/subscribers/{phoneNumber}/verify-simswap

Overview

Verify if sim-swap has been perfomed since the specified date 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

dateLimit string required
This is the limit used to verify if a sim-swap has been performed since this date. Represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format.

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.
200OK
statusCode integer

HTTP error code extension

statusMessage string

Corresponding message.

phoneNumber string

phoneNumber provided in the input

data
dateLimit string

The date limit that was used to verify with the mobile network operator

wasSimSwapPerformed string

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

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "phoneNumber": "string",
    "data": {
        "dateLimit": "string",
        "wasSimSwapPerformed": "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

A simple API to let you know if a SIM swap has been performed on a number.

$ 0 .00 PER
CALL
SUBSCRIBE

Other identity and verification products

Government ID Verification

Use this API to verify your customer’s and user’s...

View