# HLR Lookup

```json
{
  "name": "HLR Lookup",
  "slug": "hlr_lookup",
  "url": "https://composio.dev/toolkits/hlr_lookup",
  "markdown_url": "https://composio.dev/toolkits/hlr_lookup.md",
  "logo_url": "https://logos.composio.dev/api/hlr_lookup",
  "categories": [
    "developer tools & devops"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-10-29T05:32:38.629Z"
}
```

![HLR Lookup logo](https://logos.composio.dev/api/hlr_lookup)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with HLR Lookup MCP or direct API to validate phone numbers, check carrier details, verify portability, and process bulk lookups through natural language.

## Summary

HLR Lookup is a phone-number intelligence service for validation, network checks, and portability data.
It helps businesses verify numbers, reduce failed messages, and process lookups at scale.

## Categories

- developer tools & devops

## Toolkit Details

- Tools: 14

## Images

- Logo: https://logos.composio.dev/api/hlr_lookup

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for HLR Lookup.
  - Setup:
    - Configure Api Key credentials for HLR Lookup.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Validate customer numbers before sending messages
- Check carrier and portability for leads
- Process yesterday's phone list in bulk

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `HLR_LOOKUP_CHECK_PHONE_STATUS` | Check Phone Status | Run full HLR lookups for 1-80 phone numbers. This processes sensitive phone data and spends credits; optional status features can increase the cost. |
| `HLR_LOOKUP_CREATE_BATCH` | Create Batch | Create an empty persistent HLR_V2 batch. Creation has no documented charge and handles no phone data; later uploads persist sensitive phone data, and processing can spend credits. |
| `HLR_LOOKUP_DELETE_BATCH` | Delete Batch | Permanently delete one HLR batch and its results. This action is irreversible: never invoke it without explicit authorization, and download all needed results before deletion. It does not select a batch automatically. |
| `HLR_LOOKUP_DOWNLOAD_BATCH_RESULTS` | Download Batch Results | Download a completed batch's full, unpaginated CSV or JSON result export, including source phone values and sensitive HLR intelligence, as a file reference. Select the required format explicitly. |
| `HLR_LOOKUP_GET_BALANCE` | Get Credit Balance | Return the connected HLR Lookup account's remaining credit balance. This zero-credit read is the approved authentication check and does not process a phone number. |
| `HLR_LOOKUP_GET_BATCH` | Get Batch | Return metadata and current progress for one HLR batch. Use it to follow an asynchronous batch until status is COMPLETE. |
| `HLR_LOOKUP_LIST_BATCHES` | List Batches | List the connected account's HLR batches with their metadata and progress. The response reports provider offset and limit values, but the API documents no pagination inputs. |
| `HLR_LOOKUP_MNP_LOOKUP` | Run MNP Lookup | Look up network and mobile-number-portability data for 1-80 phone numbers. This processes sensitive phone data and spends credits; requesting the optional ported date is the only MNP feature that can add a surcharge. |
| `HLR_LOOKUP_PAUSE_BATCH` | Pause Batch | Pause processing one HLR batch. This action returns when the command is accepted and does not poll for a status change. |
| `HLR_LOOKUP_SCHEDULE_BATCH` | Schedule Batch | Schedule processing of one uploaded HLR batch at a UTC time. Scheduled processing of sensitive phone data can irreversibly spend credits, so never invoke this action automatically. This action does not poll for processing or completion. |
| `HLR_LOOKUP_START_OR_RESUME_BATCH` | Start or Resume Batch | Start or resume processing one uploaded HLR batch. Processing sensitive phone data can irreversibly spend credits, so never invoke this action automatically. This action returns when the command is accepted and does not poll for completion. |
| `HLR_LOOKUP_UPLOAD_BATCH_CSV` | Upload Batch CSV | Upload a CSV file of sensitive phone data into an empty HLR batch. The provider permits one source upload; repeating it on a populated batch is documented to fail. |
| `HLR_LOOKUP_UPLOAD_BATCH_JSON` | Upload Batch Phone Numbers | Upload 1-100,000 sensitive phone numbers into an empty HLR batch as a compact JSON array. The UTF-8 body must not exceed 2 MiB, and a populated batch cannot be uploaded again. |
| `HLR_LOOKUP_VALIDATE_NUMBER` | Validate Phone Numbers | Validate formatting and original-network information for 1-80 phone numbers without a live HLR lookup. It costs zero credits but still processes sensitive phone data. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK, the OpenAI provider, and the OpenAI SDK
```python
pip install composio composio_openai openai
```

```typescript
npm install @composio/core @composio/openai openai
```

#### Path 1, Step 2: Create a Composio session

Initialize Composio with the OpenAI Responses provider and create a session scoped to HLR Lookup
```python
import json
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
client = OpenAI()

session = composio.create(user_id="your-user-id", toolkits=["hlr_lookup"])
tools = session.tools()
```

```typescript
import OpenAI from "openai";
import { Composio } from "@composio/core";
import { OpenAIResponsesProvider } from "@composio/openai";

const composio = new Composio({ provider: new OpenAIResponsesProvider() });
const client = new OpenAI();

const session = await composio.create("your-user-id", { toolkits: ["hlr_lookup"] });
const tools = await session.tools();
```

#### Path 1, Step 3: Run HLR Lookup tools with your agent

Send a request, execute the HLR Lookup tool calls through the session, and print the final answer
```python
response = client.responses.create(
    model="gpt-5.6-sol",
    tools=tools,
    input=[{"role": "user", "content": "Validate the phone number +14155552671 and return its carrier and portability details."}],
)

while True:
    tool_calls = [o for o in response.output if o.type == "function_call"]
    if not tool_calls:
        break
    results = composio.provider.handle_tool_calls(response=response, session=session)
    response = client.responses.create(
        model="gpt-5.6-sol",
        tools=tools,
        previous_response_id=response.id,
        input=[
            {"type": "function_call_output", "call_id": call.call_id, "output": json.dumps(results[i])}
            for i, call in enumerate(tool_calls)
        ],
    )

print(response.output_text)
```

```typescript
let response = await client.responses.create({
  model: "gpt-5.6-sol",
  tools,
  input: [{ role: "user", content: "Validate the phone number +14155552671 and return its carrier and portability details." }],
});

while (response.output.some((o) => o.type === "function_call")) {
  const outputs = await composio.provider.handleToolCalls(session, response.output);
  response = await client.responses.create({
    model: "gpt-5.6-sol",
    tools,
    previous_response_id: response.id,
    input: outputs,
  });
}

console.log(response.output_text);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and your agent framework
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/mcp @ai-sdk/openai
```

#### Path 2, Step 2: Create a session with MCP enabled

Create a session scoped to HLR Lookup and read its MCP URL and headers
```python
from composio import Composio

composio = Composio()
session = composio.create(user_id="your-user-id", toolkits=["hlr_lookup"], mcp=True)
```

```typescript
import { Composio } from "@composio/core";

const composio = new Composio();
const { mcp } = await composio.create("your-user-id", {
  toolkits: ["hlr_lookup"],
  mcp: true,
});
```

#### Path 2, Step 3: Connect your agent to the MCP server

Pass the session's MCP URL and headers to your agent and run a HLR Lookup request
```python
import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock

options = ClaudeAgentOptions(
    mcp_servers={
        "composio": {
            "type": "http",
            "url": session.mcp.url,
            "headers": session.mcp.headers,
        }
    },
    system_prompt="You are a helpful assistant with access to HLR Lookup tools.",
    tools=[],
    allowed_tools=["mcp__composio__*"],
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query("Validate the phone number +14155552671 and return its carrier and portability details.")
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { createMCPClient } from "@ai-sdk/mcp";
import { openai } from "@ai-sdk/openai";
import { generateText, stepCountIs } from "ai";

const client = await createMCPClient({
  transport: { type: "http", url: mcp.url, headers: mcp.headers },
});

const { text } = await generateText({
  model: openai("gpt-5.6-sol"),
  tools: await client.tools(),
  prompt: "Validate the phone number +14155552671 and return its carrier and portability details.",
  stopWhen: stepCountIs(10),
});

console.log(text);
await client.close();
```

## Why Use Composio?

### 1. AI Native HLR Lookup Integration

- Supports both HLR Lookup MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable phone-number validation and network lookups
- Rich coverage for number checks, account balances, portability data, and bulk HLR processing

### 2. Managed Auth

- Securely store and use your HLR Lookup API key without hard-coding credentials
- Central place to manage, scope, and revoke HLR Lookup access
- Per user and per environment credentials for safer deployments

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access HLR Lookup
- Scoped, least privilege access to HLR Lookup resources
- Full audit trail of agent actions to support review and compliance

## Use HLR Lookup with any AI Agent Framework

Choose a framework you want to connect HLR Lookup with:

- [ChatGPT](https://composio.dev/toolkits/hlr_lookup/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/hlr_lookup/framework/claude-cowork)
- [Hermes](https://composio.dev/toolkits/hlr_lookup/framework/hermes-agent)
- [Atomic Agent](https://composio.dev/toolkits/hlr_lookup/framework/atomic-agent)

## Related Toolkits

- [Supabase](https://composio.dev/toolkits/supabase) - Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure.
- [Codeinterpreter](https://composio.dev/toolkits/codeinterpreter) - Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms.
- [GitHub](https://composio.dev/toolkits/github) - GitHub is a code hosting platform for version control and collaborative software development. It streamlines project management, code review, and team workflows in one place.
- [1password](https://composio.dev/toolkits/_1password) - 1Password is a password manager and digital vault for storing logins, secrets, notes, and secure documents. It helps individuals and teams protect credentials, share access safely, and reduce password risk.
- [Ably](https://composio.dev/toolkits/ably) - Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.
- [Abuselpdb](https://composio.dev/toolkits/abuselpdb) - Abuselpdb is a central database for reporting and checking IPs linked to malicious online activity. Use it to quickly identify and report suspicious or abusive IP addresses.
- [Alchemy](https://composio.dev/toolkits/alchemy) - Alchemy is a blockchain development platform offering APIs and tools for Ethereum apps. It simplifies building and scaling Web3 projects with robust infrastructure.
- [Algolia](https://composio.dev/toolkits/algolia) - Algolia is a hosted search API that powers lightning-fast, relevant search experiences for web and mobile apps. It helps developers deliver instant, typo-tolerant, and scalable search without complex infrastructure.
- [Anakin](https://composio.dev/toolkits/anakin_io) - Anakin is a web automation platform offering scraping, crawling, search, and browser automation. Use it to extract structured data, automate site tasks, and monitor web changes reliably.
- [Anchor browser](https://composio.dev/toolkits/anchor_browser) - Anchor browser is a developer platform for AI-powered web automation. It transforms complex browser actions into easy API endpoints for streamlined web interaction.
- [Apiflash](https://composio.dev/toolkits/apiflash) - Apiflash is a website screenshot API for programmatically capturing web pages. It delivers high-quality screenshots on demand for automation, monitoring, or reporting.
- [Apiverve](https://composio.dev/toolkits/apiverve) - Apiverve delivers a suite of powerful APIs that simplify integration for developers. It's designed for reliability and scalability so you can build faster, smarter applications without the integration headache.
- [Appcircle](https://composio.dev/toolkits/appcircle) - Appcircle is an enterprise-grade mobile CI/CD platform for building, testing, and publishing mobile apps. It streamlines mobile DevOps so teams ship faster and with more confidence.
- [Appdrag](https://composio.dev/toolkits/appdrag) - Appdrag is a cloud platform for building websites, APIs, and databases with drag-and-drop tools and code editing. It accelerates development and iteration by combining hosting, database management, and low-code features in one place.
- [Appveyor](https://composio.dev/toolkits/appveyor) - AppVeyor is a cloud-based continuous integration service for building, testing, and deploying applications. It helps developers automate and streamline their software delivery pipelines.
- [Authyo](https://composio.dev/toolkits/authyo) - Authyo is a REST API service for passwordless authentication, OTP verification, session management, and transactional notifications. Use it to add secure login flows and user verification without building auth infrastructure from scratch.
- [AWS Marketplace MCP](https://composio.dev/toolkits/aws_marketplace_mcp) - AWS Marketplace MCP provides MCP access to AWS Marketplace's cloud software, data, and services catalog. Use it to discover, compare, and evaluate 30K+ AWS Marketplace listings faster.
- [Azure Monitor Activity Log](https://composio.dev/toolkits/azure_monitor_activity_log) - Azure Monitor Activity Log is Azure's service that records management and control-plane events for a subscription. Use it to audit changes, troubleshoot issues, and track resource operations across your Azure resources.
- [Backendless](https://composio.dev/toolkits/backendless) - Backendless is a backend-as-a-service platform for mobile and web apps, offering database, file storage, user authentication, and APIs. It helps developers ship scalable applications faster without managing server infrastructure.
- [Baserow](https://composio.dev/toolkits/baserow) - Baserow is an open-source no-code database platform for building collaborative data apps. It makes it easy for teams to organize data and automate workflows without writing code.

## Frequently Asked Questions

### Do I need my own developer credentials to use HLR Lookup with Composio?

Yes, HLR Lookup requires you to configure your own API key. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)