Add your Key ID and Secret to send test requests.
List results
Returns the per-number results of a lookup, paginated. Use an export for large completed lookups.
Authorization
KeyId ApiSecret x-key-id<token>
Your API key id.
In: header
x-api-secret<token>
Your API key secret.
In: header
Path Parameters
lookupId*string
Length
1 <= lengthQuery Parameters
page?integer
Default
1Range
1 <= value <= 10000pageSize?integer
Default
50Range
1 <= value <= 200status?string
Value in
"accepted" | "rejected" | "failed" | "invalid"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/hlr/lookups/string/results?page=1&pageSize=50&status=accepted" \ -H "x-key-id: YOUR_KEY_ID" \ -H "x-api-secret: YOUR_API_SECRET"{
"data": [
{
"lookupId": "00000000-0000-4000-8000-000000000001:0",
"number": "21650000001",
"status": "accepted",
"price": {
"amount": 1.0025,
"currency": "EUR"
},
"processedAt": "2026-09-15T22:27:33.323Z",
"result": {
"connectivityStatus": "UNDETERMINED",
"mccmnc": "60501",
"mcc": "605",
"mnc": "01",
"imsi": null,
"msc": null,
"originalNetwork": "Orange",
"originalCountryName": "Tunisia",
"originalCountryCode": "TN",
"originalCountryPrefix": "216",
"currentNetwork": "Orange",
"ported": false,
"portedNetworkName": null,
"portedCountryName": null,
"portedCountryCode": null,
"portedCountryPrefix": null,
"presentInNetwork": true,
"reachable": false,
"roaming": false,
"roamingNetworkName": null,
"roamingCountryName": null,
"roamingCountryCode": null,
"roamingCountryPrefix": null,
"countryCode": "TN",
"countryName": "Tunisia"
}
}
],
"meta": {
"page": 1,
"pageSize": 2,
"hasNext": false
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request is not valid. See `fields` for what to correct.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "AUTHENTICATION_REQUIRED",
"message": "This endpoint requires an API key.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "No such resource.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource is not in a state that allows this operation.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the interval in `Retry-After`.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Something went wrong on our side.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_RESPONSE_INVALID",
"message": "The upstream service returned an unexpected response.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is temporarily unavailable. Try again shortly.",
"requestId": "9f1c7b2e-…"
}
}Get a lookup GET
Returns a lookup's status, per-outcome counts and price. Poll this after submitting.
Cancel a lookup POST
Stops a lookup that is still queued or running; numbers not yet processed are not charged. Only a non-terminal lookup can be cancelled — once it is terminal (`completed`, `partially_completed`, `cancelled` or `failed`), the call returns 409 CONFLICT and nothing changes.