Getting started with Number Lookup API

Step 1

Declare intended use case

Step 2

Get your credentials

Step 3

Select a language

This guide shows how to get started using the Number Lookup API.

Before you can start looking up numbers, you need to complete some basic configuration steps:

Account required!

Using the Number Lookup API requires signing up for a free account on the Sinch Customer Dashboard. If you haven't already done so, sign up now!

1. Declare intended use case

Go to Access Requirements in the Number Lookup menu and click SUBMIT USE CASES for Line Type access to select your use cases. This is required before using the Number Lookup API to ensure compliance with legal and regulatory requirements and align with the rights of use for the services.

Important!

If you do not declare your intended use cases, you will receive an error: 403 error: Line type use cases not specified.

2. Get credentials

Get your Client ID and Client Secret. The client ID and client secret will serve as your username name and password for this API. These access keys are also found in the Customer Dashboard. Go to Settings, then Access keys.

Important:

The client ID will be readily visible. The secret ID, however, will only be visible upon new key creation. Create a new key and then save your secret ID in a safe place.

3. Select a language

You're ready to get started looking up numbers with Number Lookup API. These guides will walk you through setting up a simple application in the following languages:

REST API guides

You can access the Number Lookup API directly through HTTP requests. Select your preferred language and learn how to set up a simple application: