Company
Product
Social
© 2024 NAAM. All Rights Reserved.
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.
All API requests must be authenticated using an API key passed as a custom HTTP request header.
Keep your API key secure; do not expose it in client-side code or public repositories.
Naam exposes a single search endpoint that accepts mobile number lookups. All requests must be sent over HTTPS.
Send a GET request with the mobile number you want to look up.
| Parameter | Type | Required | Description |
|---|---|---|---|
| mobile | string | Yes | The mobile number you want to look up |
curl --location 'https://app.naam.ai/api/v1/prospect/mobile?query=1234567890' \
--header 'x-access-token: your-api-token' \On success, the API returns HTTP 200 OK with a JSON body containing caller identity data. The code field is 200 for a successful lookup.
{
"message": "success",
"result": {
"mobile": "1234567890",
"name": "John Doe"
}
}| Field | Type | Description |
|---|---|---|
| success | boolean | true when the request is completed without errors. |
| result.mobile | string | Queried mobile number |
| result.name.fullName | string | Caller's full name |
When a request cannot be fulfilled, the API returns a JSON error body with a code that identifies the specific failure. Use these codes to implement robust error handling in your integration.
| Code | Description |
|---|---|
| 400 | Invalid Enrichment Id |
| 401 | Quantity exceeds bulk limit |
| 402 | Daily limit exhausted |
| 402 | Credits exhausted |
| 402 | Bulk functionality is disabled |
| 406 | Not Acceptable |
| 713 | Performance Threshold Exceeded |
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.