Response parameters and values

Reference for response fields, release codes, validation codes and number-status codes returned by num-iD services.

Phone number information data services num-id.com

This document contains proprietary and confidential information belonging to num-iD. Unless specifically authorized, no portion of this document may be copied, saved, or shared in any format, whether physical, electronic, or mechanical, including but not limited to photocopying, recording, or storing in a retrieval system, without prior written consent from num-iD.

No part of this document should be interpreted as an offer to provide goods or services unless explicitly mentioned. All transactions are governed by contract.

1. List of response fields

The following table details the response fields available in the num-iD phone-numbers information data services. Please refer to the ENUM and HTTP interface specifications to determine which fields are applicable for each query service.

Field	Key / Type	Description
Telephone number	`tl` / `tn` STRING	Original number provided (E.164). `tl` is used in ENUM responses, `tn` in HTTP responses. Example: `tn: "351300000000"`.
Operator Code	`od` STRING	Identifies the Service Provider associated with the queried TN. See the num-iD customer portal for a mapping of `od` to operator names and associated data. Example: `od: "11111111"`.
Operator of Record	`or` STRING	The Operator Code (`od`) of the operator who owns the number range that the `tn` belongs to. Provided from the national number portability database. Example: `or: "11111"`.
Operator Country	`oc` STRING	ISO 3166-1 alpha-2 country code. Example: `oc: "PT"`.
Operator Name	`on` STRING	Operator (name) associated with `od` or `or`. Example: `on: "NOS Comunicaçoes"`.
Number Type	`nt` STRING	Fixed, Mobile or Service number. Example: `nt: "fixed"`.
Mobile Country Code	`mcc` STRING (INT)	Mobile Country Code. Example: `mcc: "111"`.
Mobile Network Code	`mnc` STRING (INT)	Mobile Network Code. Example: `mnc: "111"`.
Portability Dip Indicator	`pdi` BOOL	true: the number has been checked through a number-portability lookup. false: either the number hasn't been queried for portability, or the lookup couldn't be completed (data will be provided from NRI). In ENUM responses, `pdi` is omitted if the lookup is unsuccessful.
Portability Indicator	`pi` BOOL	true: number is ported. For ENUM, `pi` is not present where a `tn` is not ported.
Release Code	`rc` STRING (INT)	See section 2 for the full list of values.
Validation of Number	`vn` STRING (INT)	See section 3 for the full list of values.
Status of Number	`sn` STRING (INT)	See section 4 for the full list of values.
Porting Count	`pc` INTEGER	Number of times a number has been ported in the previously specified period. Example: `pc: "1"`.
Last Ported	`lp` DATE	The date a number was last ported. Format: `dd/mm/aaaa`.
Previous Operator Code	`poc` STRING	Previous Operator Code related to the queried number. Example: `poc: "88260671"`.

2. Release Codes `rc`

Reference of values returned in the rc field. The last two columns indicate availability per product.

Code	Name	Definition	Identify	Verify
1-00	Successful	Successful query.	Yes	Yes
1-01	Invalid Format	Invalid or missing number.	Yes	Yes
1-02	Invalid Service	Query type requested is incorrect or not authorised.	Yes	Yes
1-03	Not Authorised	Customer is not authorised for the service or destination attempted.	Yes	Yes
1-04	Country Code Invalid	The number's country code is not valid or not supported.	Yes	Yes
1-05	Wrong Number Length or Format	The number is the wrong length or contains invalid characters.	Yes	Yes
1-06	Number Not Found	The number cannot be found.	Yes	Yes
1-07	Service Error	Failure of the service.	Yes	Yes
1-08	Customer Not Authorised	The customer is not authorised for this service.	Yes	Yes
1-09	Rate Limit Reached	QPS rate limit has been reached for this customer or destination.	Yes	Yes
1-10	Remote Timeout	The query to the remote destination timed out.	Yes	Yes
2-01	Subscriber Error (Temporary)	Remote query returned a subscriber-related error — this may be temporary.	No	Yes
2-02	Unknown Subscriber	Remote query returned 'Unknown Subscriber'.	No	Yes
2-03	Telephone Service not provisioned	Remote query returned 'Telephone Service not Provisioned'.	No	Yes
2-04	Absent Subscriber	Remote query returned 'Absent Subscriber'.	No	Yes
2-05	Subscriber Busy	Remote query returned 'Subscriber Busy'.	No	Yes
2-06	Subscriber Blocked	Remote query returned 'Subscriber Blocked'.	No	Yes
2-07	Roaming Not Allowed	Remote query returned 'Roaming Not Allowed'.	No	Yes
2-08	Phone Switched Off	Remote query returned 'Phone Switched Off'.	No	Yes
2-09	Destination Network Error	Remote query failed due to an error related to the destination network — this may be temporary.	No	Yes
2-10	Facility Not Supported	Remote query returned 'Facility Not Supported'.	No	Yes
2-11	Destination Network Busy	Remote query returned a 'Destination Network Busy' error.	No	Yes
2-12	No Network Response	Remote query did not get a response from the destination network — this may be temporary.	No	Yes
2-13	Destination Error	Remote query failed due to a destination error — this may be temporary.	No	Yes
2-14	Destination Network Unavailable	Remote query failed due to the destination network being unavailable — this may be temporary.	No	Yes
2-15	Service Not Supported	Query to a service which is not available, or not available to the customer or destination.	Yes	Yes
2-16	Internal System Error	Temporary internal system error.	Yes	Yes

3. Validation of Number `vn`

Reference of values returned in the vn field.

Value	Validation	Definition
00	The number is valid.	Valid check.
01	The number length is too short.	Longer number may be expected.
02	The number length is too long.	Shorter number may be expected.
03	The number format is incorrect.	Contains invalid characters or does not have a valid country prefix.
04	The number is not part of an allocated range.	Number range does not belong to any active operator in the country.
05	The number type is not valid for the service.	Number type may not be valid.

4. Status of Number `sn`

Reference of values returned in the sn field. Only returned by the HLR (Verify) service.

Value	Status	Definition
00	HLR returned a successful status.	The number is valid.
01	HLR returned Unknown Subscriber.	Non-existing subscriber.
02	HLR returned Absent Subscriber.	Absent subscriber.
03	HLR returned 'other' status.	The query returned an HLR response code which was not unknown or absent — this may be temporary.
04	HLR query failed.	The remote query timed out or otherwise failed to return a live status — this may be temporary.

Response parameters and values

1. List of response fields

2. Release Codes rc

3. Validation of Number vn

4. Status of Number sn

2. Release Codes `rc`

3. Validation of Number `vn`

4. Status of Number `sn`