API Restful - Description - Phone - Response

Support DQE
Support DQE
  • Updated

This page describes the response returned by the Restful Phone /phone/lookup endpoint.

Related Phone documentation:

Restful Phone response

Success response

The JSON response contains validation and formatting details for the provided phone number.

Key Description Type
IdError

Error code returned by the API.

2: valid syntax; 1: valid and attributed; 0: invalid or non-existing number.

 INTEGER
Error Error message associated with the validation result. STRING
Formatted Formatted phone number according to the selected format. STRING
International Phone number in international format. STRING
National Phone number in national format. STRING
E164 Phone number in E.164 format. STRING
Country ISO 3-letter country code. STRING
CountryCode International dialing code. STRING
NationalNumber National significant number. STRING
Type Phone number type: mobile, landline, VOIP, etc. STRING
Operator Telecom operator when available. STRING
IsValid Indicates whether the phone number is valid. BOOLEAN
IsMobile Indicates whether the number is a mobile number. BOOLEAN
Status Status returned by the optional status verification. STRING

Example:

{
  "IdError": 0,
  "Error": "",
  "Formatted": "+33 6 11 22 33 44",
  "International": "+33611223344",
  "National": "06 11 22 33 44",
  "E164": "+33611223344",
  "Country": "FRA",
  "CountryCode": "33",
  "NationalNumber": "611223344",
  "Type": "Mobile",
  "Operator": "Orange",
  "IsValid": true,
  "IsMobile": true,
  "Status": "ACTIVE"
}

Error response

Error type Response type
Missing or invalid authentication 401 Unauthorized
Missing phone parameter 400 Bad Request
Invalid phone number Validation error response

Related to

Was this article helpful?

0 out of 0 found this helpful