API Documentation
Seamlessly integrate Naam's AI-powered caller identity data into your applications.
1. Authentication
Authenticate your requests by including the following header with your API Key.
x-access-token:
your-api-token
2. Endpoint
Our primary search endpoint allows you to query any mobile number.
POST https://api.naam.ai/api/v1/search/mobile
3. Request Payload
Send a POST request with a JSON body as follows:
{
"mobile": "9876******"
}
4. Success Response
{
"success": true,
"code": "2001",
"data": {
"mobile": "9876******",
"name": { "first": "John", "last": "Doe" },
"user_type": ["public"],
"msg": "Successful!"
}
}
5. Error Codes
| Code | Description |
|---|---|
| 4010 | Unauthorized: Invalid or missing token |
| 4032 | Forbidden: Token expired or revoked |
| 4001 | Bad Request: Invalid mobile number format |
| 5000 | Internal Server Error |
Need help? Contact our support team at [email protected]
