HTTP Request The caller information lookup service will perform HTTP GET request to given Endpoint URL when it comes to requesting caller information. If an API key is specified the request will be decorated with the X-API-Key header containing given API Key
Request example
GET https://external-service.com/lookup?number=[phone-number] HTTP/1.1
X-API-Key: [api-key]HTTP Response
The 3rd party should always send a response to the requester even if an error occurs.
Status codes
In a case where API key is supplied but it is incorrect, the 3rd party should respond with HTTP code 401 (Unauthorized).
If the request was successful, the 3rd party should send a response containing status code 200 (OK).
The 3rd party in general should follow status codes defined in HTTP/1.1 standard.
Response payload
The response of the request should contain payload in JSON format. Hence, Content-Type: application/json; charset=utf-8
It is expected that the payload from 3rd party will contain basic caller information such as:
- phone: Phone number of the caller (in E164 format).
- firstName: First name of the caller.
- lastName: Last name of the caller.
These additional JSON properties are parsed, but are optional:
- middleName: Middle name of the caller.
- companyName: Company name the caller is employed.
- address: Address of the caller or company.
- postalCode: Postal code of the caller or company.
- city: City of the caller or company.
- Country: Country of the caller or company
Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content:
{
"phone": "+4512345678",
"firstName": "Jonas",
"lastName": "Nielsen",
"middleName": "Christian",
"companyName": "Zylinc",
"address": "Roskildevej 99",
"postalCode": "1234",
"city": "Kobenhavn",
"country": "Danmark"
}