- Add your API key to the querystring with key=your_api_key
- Add your API key to the request headers with x-api-key=your_api_key
- Login the user with our one-time-password feature that retrieves a JWT token
Querystring authentication
This is the simplest way to authenticate typically used to simply share code between internal developers to try things out or to simply HACK togheter something cool but it will expose your API key directly in the URL. So use with caution. Add a querystring parameter with the name key=your_api_key and that’s all. Example: Search for a company by name adding the API key to the urlcURL
Request header authentication
This is the most used way of authenticating especially if you are building internal integrations. In the request header add the key x-api-key=your_api_key and that’s all.cURL
Login user and retrieve JWT token
This way of authenticating is typically used only when there are external applications where you need to access the API with the users credentials. This feature is only granted by approved applications. The process is summarized in the flow chart below and step-by-step instructions. 1. First Step - send a one-time password Issue a HTTP POST to login-otp with the user e164PhoneNumber or emailAddresses.cURL
Response
cURL
Response
- Fourth Step - how to reuse the JWT token
cURL