Add your Key ID and Secret to send test requests.

HLR API Reference

Every HLR endpoint, grouped by the role a key needs to call it. Requests go through the gateway and must be signed — see Authentication.

Lookups

Submit a lookuppost

Queues one number or a batch for lookup and returns a job to poll. The job is charged per number as results arrive.

Check a jobget

Returns a job's status, per-outcome counts and price. Poll this after submitting.

List a job's resultsget

Returns the per-number results of a job, paginated. Use exports for large completed jobs.

List past jobsget

Returns your lookup jobs, newest first, filterable by category, status and date range.

Cancel a jobpost

Stops a queued or running job. Numbers not yet processed are not charged. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Exports

Get an exportget

Returns the export's availability and, once ready, a time-limited download link.

Build an exportpost

Starts building a downloadable file of a completed job's results. Repeating this returns the existing build. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Pricing

Get your pricingget

Returns the prices that apply to you, so you can estimate a job before submitting it.

List product pricesget

Returns every lookup product available to you with its price.

Withdraw a refund request POST

Withdraws a refund request that is still pending. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Submit a lookup POST

Queues one number or a batch for lookup and returns a job to poll. The job is charged per number as results arrive.