This page will help you get started with Sherlock API.
This starter kit is designed to get you up and running with Sherlock APIs optimized for developing integrations with all demand side partners. Sherlock provide a comprehensive list of Network Authentication APIs.
Below a list of our APIs and the business cases they address.
General Usability Notes:
- identifier: This is a unique identifier defined by the API user. GUIDs are recommended
- carrierName: Is a string representing the Carrier the mobile device should be registered for network access. In production the string must be non-case sensitive match, however, during testing this value is arbitrary.
- customerName: Is a string representing the business entity requesting the data from the carrier. In production the string must be non-case sensitive match, however, during testing this value is arbitrary.
- msisdn : Is a string representing the mobile number in E164 format.
Core Network Authentication
| End Point | Description |
|---|---|
| Silent Authentication | Retrieve the IP address of the device by providing the msisdn and unique ID |
| Zero Trust Silent Authentication | Verify a match between msisdn and IP address in one request |
| Number Verify | Verifies if the number is connected to the carrier network |
| SIM Swap | Check if the SIM was swapped based on the past 24 hours |
| SIM Swap - Age Range | Check if the SIM was swapped in the last x hours, based on the provided hours |
| Device Location | Return the longitude and latitude |
| GeoFence | Check the proximity of the device within a specific longitude and latitude |
Number and Customer Verification
| End Point | Description |
|---|---|
| Number Verification Verify Number | Verify the msisdn is valid mobile user on the specified Carrier |
| Number Verification Verify Name | Receive a score representing the confidence a subscribers first and last name matches the Carrier's record. |