FETCH MOBILE NUMBER TO OWNER NAME IN REAL TIME
Introduction
Mobile number validation is essential due to an increasing number of cases linked to misuse of mobile numbers by impostors while availing various services. This API helps to mitigate this problem by verifying a mobile number in real time and returning the associated user's name.
In order to ensure continued compliance with the Digital Personal Data Protection Act, 2023 (DPDP Act), we are implementing DPDP V3 (Consent-Driven Processing). Under this framework, clients are required to obtain explicit, informed, and verifiable consent from the data principal prior to accessing, processing, viewing, or storing any personal data through the platform. This regulatory transition may require modifications to existing configurations and workflows. Clients are advised to review and update their implementations to ensure ongoing compliance with applicable data protection obligations. Further information regarding this transition can be enquired here. Learn more about this change here.
Consider using Phone Validation API if you require other information in addition to the name, such as the name of the cell carrier's telecom business and the area code where the mobile number is registered.
API Details
Request
Type | URL |
|---|---|
POST | https://api.attestr.com/api/ |
Request Body Parameters
Type | Name | Description | Optional (default) | Min Version | Max Version |
|---|---|---|---|---|---|
String | number | Input 10 digit mobile number to be verified. | Required | v1 |
Request Header Parameters
Type | Name | Value / Description | Optional | Min Version | Max Version |
|---|---|---|---|---|---|
String | Content-Type | application/json | Required | v1 | |
String | Authorization | Basic | Required | v1 |
If you do not have the authentication token, please refer to Register App to generate one.
Sample Request Payload
Response
HTTP status code 200
Please note that the valid key decides the availability of rest of the keys in the response. If provided contact number does not exist, all keys except valid and message are omitted. If true, remaining keys will have appropriate data.
Key | Description | Type | Min Version | Max Version |
|---|---|---|---|---|
valid | True | false depending on if provided contact number exists and is valid | Boolean | v1 | |
name | Name of the registered mobile number user | String | v1 | |
message | Error message if provided number is invalid | String | v1 |
Sample Response
Sample response for valid contact number
Sample response for invalid contact number
Error Response
Parameter | Type | Description |
|---|---|---|
code | Number | Unique error codes for different errors. Always available. |
message | String | Error message describing the error. Always Available. |
details | String | Detail error message. Available only for certain types of errors. |
Error Codes
HTTP Status | Error Code | Error Message |
|---|---|---|
400 | 4001 | Malformed data or missing required parameter values |
400 | 4005 | Operation could not be performed due to low credits balance |
401 | 4016 | Invalid client authorization |
403 | 4031 | Unauthorized access |
403 | 4035 | Requested service is not provisioned for your account |
403 | 4039 | Client's IP address is not whitelisted |
403 | 4035 | Requested service is not provisioned for your account |
429 | 4291 | Maximum account rate limit exceeded |
429 | 4292 | Maximum API rate limit exceeded |
429 | 4293 | Maximum account daily limit exceeded |
429 | 4294 | Maximum API daily limit exceeded |
500 | 5001 | Request could not be processed |