Skip to main content
HLR Lookup logo
  • Category: phone & sms
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: HLR_LOOKUP
  • Version: 20261101_00

Tools

Slug: HLR_LOOKUP_CHECK_PHONE_STATUSRun full HLR lookups for 1-80 phone numbers. This processes sensitive phone data and spends credits; optional status features can increase the cost.

Input Parameters

array
required
One to 80 phone-number lookup requests. Each item defaults to private caching and disables optional billable features.
string
Optional caller account reference sent only in the provider’s AccountID header. This is not an authentication credential.
string
Optional caller reference sent only in the provider’s ReferenceID header for request reconciliation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_CREATE_BATCHCreate 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.

Input Parameters

string
required
Descriptive source filename for the new batch.
object
Processing options for the future HLR batch. Private caching and non-billable feature defaults are applied when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_DELETE_BATCHPermanently 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.

Input Parameters

string
required
ID of the batch to permanently delete. Confirm explicit authorization, the intended account, and that all needed results were downloaded first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_DOWNLOAD_BATCH_RESULTSDownload a completed batch’s CSV or JSON result export as a file reference, selecting the format explicitly. The export may contain sensitive phone data and HLR intelligence; JSON results are sanitized before delivery.

Input Parameters

string ("CSV" | "JSON")
required
Required result export format. CSV and JSON use different provider routes.
string
required
ID of a batch whose status is COMPLETE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_GET_BALANCEReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_GET_BATCHReturn metadata and current progress for one HLR batch. Use it to follow an asynchronous batch until status is COMPLETE.

Input Parameters

string
required
ID of a batch owned by the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_LIST_BATCHESList 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_MNP_LOOKUPLook 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.

Input Parameters

array
required
One to 80 portability lookup requests. Each item defaults to private caching and disables the optional billable ported-date feature.
string
Optional caller account reference sent only in the provider’s AccountID header. This is not an authentication credential.
string
Optional caller reference sent only in the provider’s ReferenceID header for request reconciliation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_PAUSE_BATCHRequest a pause in processing one HLR batch and return the provider’s success flag. The action does not poll for a status change.

Input Parameters

string
required
ID of the uploaded HLR batch to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_SCHEDULE_BATCHSchedule 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.

Input Parameters

string
required
ID of the uploaded HLR batch to update.
string
required
ISO 8601 UTC time at which batch processing should start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_START_OR_RESUME_BATCHRequest to start or resume processing one uploaded HLR batch and return the provider’s success flag without polling for completion. Processing sensitive phone data can irreversibly spend credits, so never invoke this action automatically.

Input Parameters

string
required
ID of the uploaded HLR batch to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_UPLOAD_BATCH_CSVUpload 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.

Input Parameters

integer
Zero-based CSV column containing phone numbers. Defaults to the first column; the provider does not document a maximum.
string
required
ID of an empty HLR_V2 batch owned by the connected account.
object
required
CSV file whose raw bytes contain the phone-number source data. No official row or file-size limit is documented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_UPLOAD_BATCH_JSONUpload 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.

Input Parameters

string
required
ID of an empty HLR_V2 batch owned by the connected account.
array
required
Phone numbers to upload. The provider accepts 1-100,000 values, and their compact UTF-8 JSON array must not exceed 2 MiB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HLR_LOOKUP_VALIDATE_NUMBERValidate 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.

Input Parameters

array
required
One to 80 numbers to validate, with optional input and output formatting.
string
Optional caller account reference sent only in the provider’s AccountID header. This is not an authentication credential.
string
Optional caller reference sent only in the provider’s ReferenceID header for request reconciliation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not