---
title: "Create HLR lookup"
method: POST
path: "/api/v2/hlr"
tags: ["HLR Lookups"]
---

# Create HLR lookup

`POST /api/v2/hlr`

## Request

- Base URL: `https://app.didlogic.com`
- URL: `https://app.didlogic.com/api/v2/hlr`
- Auth: HTTP bearer

Submits phone numbers for an HLR (Home Location Register) lookup
(maximum 1500 numbers per request).

Numbers must be supplied in **E.164 format** (e.g. `+14155552671`); a leading `+`
is added automatically when omitted.

A single number resolves synchronously; larger batches are processed asynchronously — poll
hlr_history for results. Lookups are performed
independently of call setup and do not affect PDD. Results are not cached: each request
re-queries the provider.

`hlr_request.task_id` feeds hlr_history (`task_ids`).

## Request body

- object
  - `numbers` string[]: Array of phone numbers in E.164 format (e.g. +14155552671)

## Response `201`

returns the created HLR lookup task

- object
  - `hlr_request` object, required: Created HLR lookup task details
    - `status` 'pending' | 'completed' | 'failed', required: Task status
    - `processed_at` unknown, required
    - `created_at` string, required: Task creation timestamp
    - `task_id` integer, required: Task identifier
    - `total_numbers` integer, required: Total numbers in the request

## Other responses

- `401`: returns unauthorized
- `403`: returns forbidden
- `422`: returns unprocessable entity for validation errors

---

[API](https://skmtc.dev/didlogic/apis/get-started.md) · [All operations](https://skmtc.dev/didlogic/apis/get-started/llms.txt) · [OpenAPI document](https://skmtc.dev/didlogic/apis/get-started/revisions/dc972d592b34?raw)