SIM Swap Verification

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.
v1.0
FEATURED BUNDLE
Carrier KYC Verification

FEATURES

Check for Suspicious Activity

Prevent Fraud

Verify SIM Swap Info

Specifications

Available
endpoints

GET mobile/subscribers/{phoneNumber}/verify-simswap

Description

Verify if sim-swap has been perfomed since the specified date with the relevant mobile network operator as identified by the 'phoneNumber' value provided.

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