USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers....

60
DATA SERVICES Line Information Database (LIDB) USER GUIDE

Transcript of USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers....

Page 1: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

DATA SERVICES

Line Information Database (LIDB)

USER GUIDE

Page 2: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

2 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Table of Contents

Table of Contents .......................................................................................................................... 2

Summary of Revisions ................................................................................................................... 5

Chapter 1: LIDB Overview ............................................................................................................ 6

Customer Support ...................................................................................................................... 6

Scheduled System Maintenance ................................................................................................ 6

Documentation ........................................................................................................................... 7

For More Information .................................................................................................................. 7

Chapter 2: Data Provisioning ......................................................................................................... 8

Using the Web Application ......................................................................................................... 8

Using Secure Shell with SFTP ................................................................................................... 9

Record Format ........................................................................................................................... 9

Initial Data Load ......................................................................................................................... 9

Data Fall-Out / Errors ................................................................................................................. 9

Virtual Service Provider Program ............................................................................................. 10

Virtual Service Provider Reseller Program ............................................................................... 10

Chapter 3: Reports ..................................................................................................................... 11

Monthly Change Report ........................................................................................................... 11

Transaction Error Report .......................................................................................................... 14

Data Audit ................................................................................................................................ 16

Chapter 4: Routing and Access ................................................................................................... 20

CNAM Data Access with IP Connectivity .................................................................................. 20

Chapter 5: Industry and Operator Conversions ............................................................................. 22

Changing Point Codes for CNAM - Access Customers ............................................................. 22

Ownership Changes - SPID Migrations .................................................................................... 22

Chapter 6: Policies and Procedures ............................................................................................ 23

CNAM Data Provisioning Policies ............................................................................................. 23

Auto-Delete Process for Ported or Pooled Numbers ................................................................. 23

CNAM Delivery in Wireless ...................................................................................................... 23

CNAM Delivery for Identity Verification ..................................................................................... 23

Blocking CNAM Delivery .......................................................................................................... 24

Special Requests ..................................................................................................................... 24

Chapter 7: IP-CNAM Specification .............................................................................................. 25

SIP Subscribe/Notify ................................................................................................................ 25

SIP Invite/Response ................................................................................................................. 30

CNAM Query for ENUM ........................................................................................................... 35

Chapter 8: Data File Format ....................................................................................................... 40

Page 3: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

3 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Data File Requirements ............................................................................................................ 40

Protecting Private or Sensitive Numbers .................................................................................. 40

Preventing Truncated Files with AS/400 or FTP Transfer ......................................................... 41

Multiple Record Updates .......................................................................................................... 41

Identifying Errors ...................................................................................................................... 41

200-Byte Record Format Details .............................................................................................. 42

Chapter 9: Error Messages ......................................................................................................... 58

Page 4: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

4 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

The information in this document belongs to Neustar. It may not be used, reproduced or disclosed without

the written approval of Neustar.

DISCLAIMER AND LIMITATION OF LIABILITY

Neustar has made efforts to check the accuracy and completeness of the information in this document.

However, Neustar makes no warranties of any kind (whether express, implied or statutory) with respect to

the information contained herein. Neustar assumes no liability to any party for any loss or damage (whether

direct or indirect) caused by any errors, omissions, or statements of any kind contained in this document.

Further, Neustar assumes no liability arising from the application or use of the product or service described

herein and specifically disclaims any representation that the products or services described herein do not

infringe upon any existing or future intellectual property rights. Nothing herein grants the reader any license to

make, use, or sell equipment or products constructed in accordance with this document. Finally, all rights and

privileges related to any intellectual property right described herein are vested in the patent, trademark, or

service mark owner, and no other person may exercise such rights without express permission, authority, or

license secured from the patent, trademark, or service mark owner. Neustar reserves the right to make

changes to any information herein without further notice.

Trademarks

The Neustar logo and other trademarks, service marks, and designs are registered or unregistered

trademarks of Neustar, Inc. and its subsidiaries in the United States and in foreign countries. All other

trademarks are property of their respective owners.

This document may describe features and/or functionality that are not present in your software or your service

agreement. Contact your account representative to learn more about what is available with this Neustar product. If you

need help using this product, contact customer support.

Page 5: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

5 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Summary of Revisions

The following changes were made to this document since the last version

Date Revisions

March 2016 Revised and rebranded guide.

Page 6: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

6 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 1: LIDB Overview Neustar provides reliable, secure, and accessible database and storage services for landline,

wireless, and broadband operators. Our database services help operators offer enhanced

services without building additional infrastructure or increasing administrative workload.

The Neustar independent database is the largest in the U.S. with unsurpassed nationwide

coverage.

Calling Name Services (CNAM) - Delivery, Storage and Transport services ensure that

caller name information is consistently and accurately presented to subscribers.

Line Information Database (LIDB) enables carriers to store and manage their

subscriber line information in a secure database other carriers can access to

determine how to handle collect, international, and other calls.

Customer Support Customer Support is available at the following times and can be reached via e-mail or

telephone:

Monday - Friday; 5:00 a.m. to 8:00 p.m. Pacific Time.

E-mail: [email protected]

Telephone: 1-844-638-7778

When contacting Customer Support for troubleshooting, it is helpful to have the following

information available:

Table 1-1 Troubleshooting Information

Service Information Required

CNAM Storage Provide both the originating and terminating numbers.

Indicate the incorrect CNAM information being displayed

and provide the corrected CNAM information.

CNAM Delivery via SS7 Provide your company's originating point code, the

terminating point code, translation type, and the

sub-system number along with your request.

CNAM Delivery via IP Provide your company's IP address information along

with your request.

Scheduled System Maintenance Scheduled maintenance windows are reserved for the following times:

First and third Saturday of each month; 10:00 p.m. to 6:00 a.m. Pacific Time.

Details of any maintenance will be posted to the application login page in advance if the

maintenance window is needed.

Page 7: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

7 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Documentation Updates to the User Guide are posted to the Product Documentation section in

NeustarConnect. Contact Customer Support to request access to this resource.

You must have Adobe Acrobat Reader installed on your computer to view and print

documentation. For more information and to download the Acrobat Reader, go to the Adobe

Web site www.adobe.com).

For More Information If you need more information or have questions about any part of Neustar Database Services,

contact Customer Support.

Page 8: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

8 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 2: Data Provisioning Neustar offers the following options for operators to manage and maintain subscriber data,

including:

Web Application - The Neustar Web application allows you to view and update line

number information, transfer data files, and view reports.

Secure Shell with SFTP - The Secure Shell (SSH) protocol establishes secure access

to a remote computer. Once access is gained, Secure FTP (SFTP) allows the transfer

of ASCII files between remote sites.

Using the Web Application The Database Services application allows you to manage your line number information. The

application provides:

System access 24 hours a day, seven days a week

Encryption and firewalls to protect the security of your data

Real-time line information and updates

Ability to transfer data files and perform range updates

Look up the owner of a phone number

Account administration to manage user names and passwords

View OCN and Virtual Service Provider (VSP) company associations

Configure company defaults for common values (i.e. default all LIDB indicators to

block)

Profanity filtering using pattern, boundary and exact word matching

Optional automatic resubmission when TN ownership cannot be validated

You can access the LIDB application from this link: http://callerid.neustar.biz

A Getting Started user guide is available for the application, and is available from Customer

Support.

User Accounts

User accounts contain settings for the user’s role (company user, read-only user, company

administrator) and for certain features in the application.

After initial access is established, users must change their own passwords. The application

also provides an option for company administrators to manage password resets.

Changing Your Password

Passwords must be changed every 90 days to protect your data against unauthorized access.

The application notifies you when you need to change your password by showing a warning

Page 9: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

9 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

icon next to your user name when you log in.

Inactive Accounts

For security reasons, if an account has not been used for more than six months (180 days), it

is automatically changed to inactive status. An administrator must unlock the user account to

regain access.

Using Secure Shell with SFTP Neustar provides a setup form to configure your connection and account. You must have the

SFTP client software. Request and submit the SFTP Setup Form to Service Deployment or

Customer Care. Once the form is received, and all information is accurate, it will take

approximately 10 business days to complete the setup.

To use SFTP, you must provide a current connecting public IP address. If your public IP

address has not been provided to Neustar, or has changed and your company did not notify

Neustar of the change, your connection attempt times out. If you receive a time-out message,

contact Customer Support. Be prepared to provide your most current public IP address.

Failure to notify Neustar of changes to your public IP can result in loss of transmission for up to

a week.

Record Format The data files you submit to Neustar must conform to the 200-byte record format specified in

this guide. For more information, see Appendix B, “Data File Format.”

Initial Data Load The Service Deployment team assists you with determining the date to send your initial file.

This date may be impacted by the number of lines, timing of notifications to your end-users, and

whether you are migrating from another LIDB or CNAM provider.

Following the initial load, Neustar sends you a data audit for your review and acceptance. (You

provide the contact information for the audit recipient.)

Data Fall-Out / Errors The Neustar validation system checks for the proper format of your file and that your company

is authorized to update the CNAM information associated to the 10-digit telephone number.

Your company is responsible for rectifying any transaction errors. Transaction error training is

provided by the Service Deployment Team following the processing of your test file. For more

information on errors, see “Example Transaction Errors”

Page 10: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

10 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Virtual Service Provider Program For resellers with a direct relationship to the owning telco The Virtual Service Provider (VSP) program enables resellers to obtain a Letter of Authorization (LOA) from the owning carrier and update CNAM Data directly with Neustar. The industry owner of the telephone numbers (the registered CLEC) should be a CNAM Storage customer with Neustar to ensure proper Calling Name delivery.

Service Initiation for VSP To initiate the service, complete and return the Calling Name Storage setup form and the Letter of Authorization (LOA). The Neustar standard LOA is available from the Service Deployment team or Customer Service. Other industry owners such as Level 3 and/or Bandwidth may supply the reseller with a mutually agreed upon LOA for use with this service. Neustar assigns each VSP a pseudo OCN (Operating Company Number) for use when provisioning CNAM Data. The deployment team will assist with setup and testing efforts.

Updates by the Industry Owner – The industry owner still "owns" the telephone number. If

the industry owner submits an update for a line number in your inventory, it will be processed and added to the database. Although the industry owner cannot see the record in the CNAM inventory using the Database Services application, the database validates the owner and accepts the update.

Virtual Service Provider Reseller Program For resellers without a direct relationship to the owning telco The Virtual Service Provider (VSP) Reseller program enables resellers to publish CNAM Data so as long as the owning carrier or enterprise has not already published CNAM Data with Neustar. The industry owner of the telephone numbers (the registered CLEC) should be a CNAM Storage customer with Neustar to ensure proper delivery.

Service Initiation for VSP Reseller To initiate the service, complete and return the Calling Name Storage setup form. The Neustar setup forms are available from the Service Deployment team or Customer Service. Neustar assigns each VSP Reseller a pseudo OCN (Operating Company Number) for use when provisioning CNAM Data. The deployment team will assist with setup and testing efforts.

Updates by the Industry Owner or a VSP - The industry owner still "owns" the telephone

number. If the industry owner or a VSP (with a LOA) submits an update for a line number in your inventory, it will be processed and added to the database. Although the industry owner cannot see the record in the CNAM inventory using the Database Services application, the database validates the owner and accepts the update.

Page 11: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

11 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 3: Reports Neustar provides the following standard reports to assist you in managing your subscriber

data: Monthly Change Report, Transaction Error Report, and an Audit Report. Additional

reports may be available and subject to a monthly fee.

You can access most reports using the Line Information Database application. Using the Web

application, you can view reports for LIDB and CNAM. Reports can also be posted to an SFTP

connection if requested; contact Customer Support for more information.

From the LIDB main screen, click Reports.

Monthly Change Report The Monthly Change report (MCR) lists changes to your data during a given month. It includes

data associated with each line number and the type of update (insert, change, or delete). Each

Monthly Change Report is retained for two months from posting. You can use this report to

compare the updates listed on the report against your records.

A sample report is shown in Figure 3-1, “LIDB Monthly Change Summary Report” and Figure

3-2, “Monthly Change Report Detail.”

The first page of the report is the summary, which lists the total number of inserts, changes, and deletions. Subsequent pages list details for each line number.

Figure 3-1 LIDB Monthly Change Summary Report

Page 12: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

12 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Figure 3-2 Monthly Change Report Detail

The following table describes the columns on the Monthly Change Report.

Note If discrepancies appear in the type of update performed (“trans type,” “PIN action,” or

“CNAM transaction” columns), the LIDB made normal operating adjustments to perform the

update. For more information, see Table 3-2.

Table 3-1 Monthly Change Report Description

Column Description

Billing number The subscriber’s line or special billing number (SBN).

Trans type The type of transaction submitted:

C: Change

I: Insert

D: Delete

RAO Billing Revenue Accounting Office

Class Class of service. Most common codes are:

R: Residence

B: Business

P: Public coin phone

S: Semi-public coin

N: Public non-coin

Refer to “Service Equipment Indicators/ Class of Service Codes” on

page 70 for a complete list of valid codes.

Third-number The type of third-number billing allowed on the line number:

C: Third-number billed calls allowed

B: Third-number billed calls denied

Not active for Wireless subscribers (WCNAM).

Page 13: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

13 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Column Description

Collect The type of collect call billing allowed on the line number:

A: Collect calls allowed

B: Collect calls denied

Not active for Wireless subscribers (WCNAM).

CNAM Trans The action you have submitted for a calling name:

I: Insert

C: Change

D: Delete

Pres. Ind Indicates whether the calling name will be displayed:

A: Allow

R: Restrict

Calling Name The subscriber’s name, for Calling Name Delivery service. Limited to 15

characters, including punctuation.

PIN number Valid range is from 2000 to 9999.

Not active for wireless subscribers (WCNAM).

PIN type The type of billing allowed on the PIN:

U: Unrestricted

D: Domestic

C: Domestic Conditional

R: Restricted

Not active for Wireless subscribers (WCNAM).

PIN act The action you have submitted on the PIN:

I: Insert

C: Change

D: Delete

Not active for wireless subscribers (WCNAM).

Sub Acct Number associated with the PIN type:

01: Unrestricted, Domestic, or Domestic Conditional PIN

02: Restricted PIN

Not active for wireless subscribers (WCNAM).

Service denial Shows whether the PIN is in service:

N: In service

P: Suspended (due to fraud, nonpayment, and so on)

T: System has automatically deactivated the PIN because the

maximum threshold for the assigned Usage Category was exceeded

(for Neustar use only)

Not active for wireless subscribers (WCNAM).

Page 14: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

14 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Column Description

Usage Cat Shows the PIN monitoring and auto deactivation level. This code is

based on how often the subscriber uses his or her PIN:

055: Ultra-low Usage (rarely uses PIN)

001: Low Usage (infrequently uses PIN)

002: High usage (frequently uses PIN)

Not active for wireless subscribers (WCNAM).

Priority Indicates the priority level of the update performed on the record:

H: High priority (called in or entered by online access)

N: Normal priority (file transfer, magnetic tape, fax, or mail)

Entry date The date the update posted to the Neustar database.

Interpreting MCR Update Differences

If you notice a difference between an update you sent and how it appears on your report,

review the following table for explanations of common processing changes that are part of

normal processing.

Table 3-2 MCR Conversion Explanations

Update You Sent Report Shows Reason

Trans type I (insert) Trans type C (change) A record already existed in the LIDB for

the billing number. The system made the

update you requested, but needed to

process it as a “change” rather than an

“insert.”

Trans type C

(change)

Trans type I (insert) The record did not exist in the LIDB, so

the system inserted it. Therefore, the

update was reported as an “insert”

rather than a “change.”

PIN action S to

suspend PIN

PIN action C; Serv.

denial indicator P

The LIDB shows PIN service in the

service denial indicator field. The

system processed the update to change

the PIN to “suspended.”

If you see a discrepancy in an area not covered in the previous, contact Customer Support for

assistance.

Transaction Error Report Neustar has a validation system to ensure proper format of your file and your company’s

authorized to update the CNAM information associated to the 10-digit telephone number.

The Transaction Errors report lists information rejected by the database following the validation

process. The report is available online for 60 days from posting.

The report header identifies the update type, company identifier, company name, and the date

and time that the file was processed in UTC.

Page 15: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

15 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

The next section of the report is a summary that lists the following:

• Number of transactions sent

• Number of errors

• Error percentage

Each error is separated by a dashed line.

Table 3-3 LIDB Transaction Error Report Format

Line Position Length

(in bytes)

Field

1 1 10 Line number (Billing No.)

1 11 1 Record type

1 12 1 Record subtype

1 19 1 Action code

1 25 4 OCN

1 32 1 PIN key

1 40 1 PIN Type

1 49 25 Not applicable

1 79 22 Not applicable

1 105 1 Not applicable

1 112 6 Effective date

2 4 1 Special indicator

2 12 4 PIN #

2 19 1 PIN indicator - ACTING

2 27 3 NA

2 40 1 NA

2 49 25 NA

2 76 25 NA

2 104 3 Class

2 114 1 LSCNB indicator

2 120 1 BNS code

Page 16: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

16 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Line Position Length

(in bytes)

Field

2 127 3 Usage category

3 1 45 Error Message

3 49 25 NA

3 76 2 NA

3 79 10 NA

3 93 40 Input file

Transaction Errors Report Sample

The following figure shows the Transactions Errors report.

Figure 3-3 Transaction Error Report - Combined (OLNS)

Data Audit The audit report provides a complete listing of your subscriber records stored in the database. Contact Customer Support to request this report. To work with Audit information, review your data and then update the information by using your usual data management method. See “Audit Report Format” for assistance in locating the key fields described below. Tip To print audit information so it is easier to read, set your paper orientation to “landscape.”

Page 17: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

17 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Audit Report Format

The following table describes the Audit Report format. The “Length” shows the number of bytes

each field uses. The “Position” identifies the location of each field in a row (with each byte

equaling one position).

Table 3-4 Audit Report Fields

Field Name

Length

(Bytes)

Position

Description

Billing

number

10 1–10 The subscriber’s line or special billing number

(SBN).

NOT IN USE 6 11–16

Collect

Accept

1 17 Indicates whether collect call billing is allowed or

denied on the line number.

A = Collect calls allowed

B = Collect calls denied

NOT IN USE 35 18–52

Class of

Service

1 53 Codes are:

R = Residence

B = Business

P = Public coin

S = Semi-public coin

N = Public non-coin

NOT IN USE 20 54–73

Third #

Accept

1 74 Indicates whether third-number billing is allowed

or denied on the line number.

CBill-to-third calls allowed

BBill-to-third calls denied

NOT IN USE 4 75–78

PIN Type 1 79 The type of calls allowed on the PIN.

U = Unrestricted

D = Domestic

C = Domestic Conditional

R = Restricted

PIN Status 1 80 Indicates whether the PIN is in service.

N = PIN in service

P = PIN suspended (due to nonpayment, potential

fraud, and so on)

T = System has automatically deactivated the PIN.

PIN usage exceeds the maximum threshold for the

assigned usage category.

Page 18: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

18 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Field Name

Length

(Bytes)

Position

Description

PIN 4 81–84 The four-digit security number associated with a

billing number. Valid PINs range from 2000 to

9999.

NOT IN USE 4 85–88

Usage

Category

3 89–91 This field shows the PIN monitoring and auto

deactivation level based on how often the

subscriber uses the PIN.

055 = Ultra-low Usage (rarely uses PIN)

001 = Low Usage (infrequently uses PIN)

002 = High Usage (frequently uses PIN)

NOT IN USE 1 92

Presentation

Indicator

1 93 Indicates whether the calling name appears in the

database (does not affect the switch).

A = Allow

R = Restrict

Calling Name 15 94–108 The subscriber’s name, for Calling Name Delivery

service. Limited to 15 characters, including spaces

and punctuation.

Table 3-5 LIDB Audit Report Fields

Field Name

Length

(Bytes)

Position

Description

Billing

number

10 1–10 The subscriber’s line or special billing number

(SBN).

NOT IN USE 42 11–52

Class of

Service

1 53 Valid codes include

R = Residence

B = Business

P = Public coin

S = Semi-public coin

N = Public non-coin

NOT IN USE 39 54-92

Presentation

Indicator

1 93 Indicates whether the calling name appears in

the database (does not affect the switch).

A = Allow

R = Restrict

Page 19: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

19 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Calling Name 15 94–108 The subscriber’s name, for Calling Name

Delivery service. Limited to 15 characters,

including spaces and punctuation.

Note The reports you receive may contain data in some of the fields

listed as “not in use.” This data is not used for CNAM processing.

Page 20: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

20 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 4: Routing and Access The terminating operator is responsible for obtaining and displaying Calling Name information to

its subscribers. Industry standards are published for querying the LIDBs. The two industry

routing guides associated with CNAM are:

The Calling Name Access Routing Guide (CNARG) published by Telcordia is used for

6-digit routing with non-ported numbers and identifies which LIDB has CNAM data

associated with a given carrier's native number blocks. For CNAM Storage; Neustar

obtains rights to your company's Operating Company Number (OCN) within Telcordia

and claims your NPA-NXXs in the CNARG. This, in turn, notifies the industry to route

CNAM queries to Neustar for your company's CNAM information.

Note CNARG updates must have an effective date of the 15th or later of the following month.

For example, a change made in March that will be reflected in April's CNARG should have an

effective date of April 15 or beyond.

The CNAM Subscription Version (SV) maintained within the Number Portability

Administration Center (NPAC) provides 7-10 digit routing information and identifies

which LIDB has CNAM data associated with a given carrier's ported number or pooled

block. For CNAM Storage; when you port numbers your company must update the

CNAM Subscription Version (SV) with the Neustar routing information. These

updates can be administered via a Service Order Administration (SOA) or a Low Tech

Interface (LTI).

When you obtain a pooled block it is the operator's responsibility to work directly with

the Pooling Administrator to ensure the CNAM SV is correctly populated. For more

information about pooling and porting numbers, see the NPAC Web site

http://www.npac.com.

The correct values for Neustar customers are:

+ Destination Point Code (DPC): 238-013-000

+ Subsystem Number (SSN): 000

(This does not impact how switches are programmed.)

Note A pooled or ported number must be activated in the NPAC prior to adding it to the Neustar

database or it is rejected.

CNAM Data Access with IP Connectivity The IP-CNAM Data Access service employs the Neustar Calling Name Gateway, which

facilitates native IP access to calling name databases using the services of the Session Initiation

Protocol (SIP) or ENUM to launch a query.

Queries to CNAM data using SIP or ENUM are described in Appendix A, “IP-CNAM Specification.”

Page 21: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

21 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Connectivity and Pricing

The IP CNAM service requires a Virtual Private Network (VPN) connection. VPNs must be

secure site-to-site connections. Connectivity pricing is outlined in Table 4-1.

Table 4-1 VPN Connectivity Pricing

Type of Charge Costs

Monthly Recurring Charges $400.00

Non-recurring Charges $1000.00

Service Initiation

To initiate the IP CNAM service, complete and return the VPN Connectivity Form. The VPN

Connectivity Form is updated frequently; contact your Customer Service for the most recent

form.

You must also submit the domain name or URL in the FROM field of the SUBSCRIBE

message. This information is required for IP CNAM to work.

For more information on IP CNAM service, see “SIP Subscribe/Notify”

Change Management

If your domain name or URL changes, call Customer Support or e-mail the Customer Support

group at [email protected].

Failover Management

Failover is not an automatic function using IP connectivity. Operators with two connections

(dual connectivity) are responsible for failover of their system. If one site becomes unavailable,

the customer must redirect traffic to the other site.

Page 22: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

22 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 5: Industry and Operator Conversions This chapter describes changes you may need to make to your CNAM-related data based on

industry or operator changes.

Changing Point Codes for CNAM - Access Customers If your company’s point codes change or you add or remove switches, you must notify Neustar

by submitting the Calling Name Delivery Setup form, available from Customer Support.

Ownership Changes - SPID Migrations SPID (Service Provider ID) migrations are required when carriers merge with or acquire

another company or obtain new markets. The new service provider initiates a SPID migration by

notifying the NPAC. The NPAC updates the SPID associated with codes, LRNs, and pooled

block records.

If the carrier is a Neustar Database Services customer, the Neustar database must also be

updated. Neustar facilitates this process with service providers.

For more information on SPID migrations in general, refer to the NPAC Web site at:

http://www.npac.com.

Service Provider Responsibilities

Neustar requires your cooperation to update data as a result of SPID migrations. Service

providers must communicate with Neustar personnel to discuss the details.

Neustar Responsibilities

Neustar receives notifications from the NPAC for all SPID migrations and reviews them to

determine if a Neustar Database Services customer is involved. If so, a notification is sent to

the customer. Neustar contacts the customer to arrange a conference call to discuss the details

of the data changes. Neustar has also established a back-end process with the NPAC to

ensure proper population of CNAM and LIDB subscription versions.

After the update, Neustar provides a LIDB audit report at no charge.

Page 23: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

23 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 6: Policies and Procedures This chapter describes policies and procedures regarding the CNAM service.

CNAM Data Provisioning Policies The basic rule for CNAM data provisioning is that the calling name should uniquely identify the

calling party. In addition, the following policies apply to calling name data:

Should not be all numeric.

Cannot be all special characters such as ….,,,,////$$$$%%%%####()@!.

Should be more than one alpha character long and spell something of value.

Should not be anything generic such as “unknown,” “unavailable,” “anonymous,”

“wireless call,” “cell phone,” “restricted,” “private,” etc.

Should not be any meaningless phrases such as “whos callin u,” “why so serious,”

etc.

Should not be generic jargon such as “The Dude,” “Trouble,” “The best wife,” “The

Man,” “TBone,” “Princess,” “Big Sexy,” etc.

Should not refer to religious titles such as “God,” “Devil,” “Satan,” etc.

Should not refer to fictional characters such as “bugs bunny,” “Smurf,” “Mickey Mouse,”

etc.

Should not refer to famous people such as “Paris Hilton,” “Bill Clinton,” “Barack

Obama,” “Brittany Spears,” “Justin Timberlake,” etc.

Should not contain profanity.

Auto-Delete Process for Ported or Pooled Numbers When a number is ported or pooled and a change of ownership occurs, the Neustar validation

system will recognize the change and delete the line number.

Other changes, such as disconnecting a line number, result in a record without an associated

SPID, and the Neustar system does not recognize it as a disconnect and does not delete the

line number.

CNAM Delivery in Wireless When Calling Name data is delivered with a Short Message Service (SMS) and/or a Multimedia

Message Service (MMS) to parties who subscribe to a Caller ID with Name service, the CNAM

data will be queried and available for delivery during continuous interaction. After 24 hours of

SMS interactions between the sender/receiver, the data must be queried again.

CNAM Delivery for Identity Verification CNAM Data may be used for the purposes of verifying identity and preventing fraud. Name

information will not be disclosed; instead a match/mismatch or an identity score will be

provided to validate subscriber information and identity.

Page 24: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

24 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Blocking CNAM Delivery Federal and/or state regulations require that local exchange telephone companies make

available to their subscribers the ability to block the delivery of their telephone number and/or

name information to the terminating telephone when the subscriber originates a telephone call.

The blocking can either be on a call-by-call basis or on an every call basis. A subscriber who

has blocked delivery may also unblock calls on a call-by-call basis or an every call basis. In

accordance with such regulations, Neustar CNAM customers must abide by the

blocking/unblocking information received during call setup, and must not attempt to obtain a

caller’s name information by originating a query when the subscriber has attempted to block

such information, and must not block information that a subscriber has attempted to unblock.

Special Requests You can request additional services from Neustar for managing your data which are billed at

$200 per hour, based on the time and cost of the effort.

Page 25: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

25 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 7: IP-CNAM Specification Queries to CNAM data using SIP must follow the extensible SIP Subscribe/Notify framework as defined

in the standard IETF RFC 3265 or the SIP Invite/Response message, as described in this chapter.

SIP Subscribe/Notify CNAM Subscribers in the network can subscribe to CNAM Notifiers’ name services on a per-

call basis.. The CNAM Notifiers, acting on behalf of the name databases, send a notification

when those calling name subscriptions are resolved into the name availability indicator, calling

name, if present, and permanent privacy status associated with the calling directory number.

If the name is not to be delivered to the called end-user equipment because of a “private”

privacy status associated with the name, a “From” header display-name parameter with a value

of “private” is sent to the called end-user equipment.

If the name availability indicator reveals that the name is not available for delivery, a “Calling-

Name” header display-name parameter with a value of “unavailable” is sent to the called end-

user equipment.

Otherwise, a “Calling-Name” header display-name parameter containing the derived calling

name is sent to the called end-user equipment.

The following graphic shows a typical flow of messages:

Figure A-1 IP CNAM Message Flow

Page 26: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

26 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Note In accordance with SIP privacy mechanisms, the CNAM Subscriber does not subscribe

to calling name service for those calls in which the “Privacy” header indicates a “private” status

[4].

Node Behavior

This section describes how the CNAM subscriber and CNAM Notifier functions.

CNAM Subscriber Behavior

To achieve carrier-grade availability and optimal transaction rates, the CNAM Notifier is

optimized to support stateless fetch transactions. When the subscribe request is transmitted by

a CNAM Subscriber to a CNAM Notifier, this requirement translates to the “Expires” header

having a value of zero (0) or, alternatively, a subscribe request with no “Expires” header

present, which implies the default value of zero (0) as defined by the “calling-name-info” event

package [2]. This use of subscribe polling reduces the complexity of the calling name event,

limiting the duration of the subscription to a single calling name fetch and avoiding the necessity

to support state related procedures such as unsubscribing and refreshing subscriptions.

The Request URI of a subscribe request contains enough information to route the request to the

appropriate CNAM Notifier, as listed in the request routing procedures outlined in SIP [2]. For

example, a SIP URI populated with the fully qualified domain name (FQDN) of the Neustar

Calling Name Gateway: sip:callerid.Neustar.biz.

CNAM Subscribers must populate exactly one “Event” header in the Subscriber request,

indicating they are subscribing to the calling-name event (“Event: calling-name”).1 optionally,

the CNAM Subscriber may also include within the

“Event” header an “id” parameter, which contains an opaque token that identifies the specific

calling name subscription within a SIP peer-to-peer dialog (e.g. “Event: calling-name; id=2”). The

CNAM Notifier includes this token, if present, in the corresponding Notify request

1. A request to register the “calling-name” event token with the IANA is

pending.

CNAM Notifier Behavior

The CNAM Notifier confirms the Subscribe request with a final response. A “200 OK” response

indicates that the calling name subscription has been accepted and that the CNAM Subscriber

is authorized to subscribe to the requested calling name information.

Non-200 class final responses indicate that no subscription has been created, and no

subsequent NOTIFY response is sent. For example, if the responsible IP-resident or SS7-

resident name database is out-of-service because of temporary overload conditions,

transmission availability, or maintenance activities, the CNAM Notifier returns a “503 Service

Unavailable” final response, containing a “Retry-After” header, which the CNAM Subscriber

makes use of to throttle subsequent traffic to the affected CNAM Notifier.

Once accepted with a “200 OK” response, under no circumstance should a calling name

subscription extend for any longer than the time necessary for automated processing, such as

Page 27: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

27 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

the time required to query or timeout waiting for a response from an SS7-resident calling name

database.

Upon completion, regardless of the outcome, the CNAM Notifier sends a Notify request

containing a “Subscription-State” header with a value of terminated (“Subscription-State:

terminated”).

The CNAM Notifier will populate the “Event” header within the Notify request to indicate a

response to the calling name subscription (“Event: calling-name”).

Additionally, if the “Event” header “id” parameter was received in the corresponding Subscribe

request, the CNAM Notifier will echo that value back to the CNAM Subscriber (e.g., “Event:

calling-name; id=2”).

If the subscription request fails due to a processing error (errors experienced querying SS7-

resident name database), the CNAM Notifier immediately informs the CNAM Subscriber by

returning a Notify request, which includes the “calling-name-info” event package body indicating

an “out-of-service” availability. Otherwise the CNAM Notifier will construct and send a Notify

request that includes the calling name information (name availability, display-name if available,

and permanent privacy status).

Event Package

Event Package Name

“calling-name” is the token designated as the event identifier for the calling-name-info event

package.

Event Packet Parameters

This event package does not define any new “Event” header parameters.

SUBSCRIBE Body

This mandatory section of the calling-name-info event package defines the event body

expected in Subscriber requests. The Subscribe body contains the calling-name-request

portion of the calling-name-info event package, indicating the address-of-record of callee and

optionally the called party. The calling-name-request syntax is as follows:

calling-name-request = callee CRLF

[ called CRLF ]

callee =“Calling-Party” HCOLON addr-spec

called =“Called-Party” HCOLON addr-spec

addr-spec =SIP URI / SIPS URI / TEL URI

Example:

Calling-Party: sip: 9726840623@cnam-subscriber;user=phone

NOTIFY Body

This mandatory section of the calling-name-info event package defines the event body

expected in Notify requests. The Notify body contains the calling-name-response portion of the

calling-name-info event, indicating the availability of the display-name, display-name if present,

and the permanent privacy status. The syntax of the calling-name-response is as follows:

Page 28: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

28 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

calling-name-response =calling-name-status CRLF

[calling-name CRLF]

[presentation-indicator CRLF]

calling-name-status =“Calling-Name-Status” HCOLON calling-name-

availability

calling-name-availability =“Available” / “Unavailable” /

“out-of-service”

calling-name =“Calling-Name” HCOLON name-addr

name-addr =[ display-name ] LAQUOT addr-spec RAQUOT

display-name =* (token LWS) / quoted-string

addr-spec =SIP URI / SIPS URI / TEL URI

presentation-indicator =“Presentation-Indicator” HCOLON “allowed /

“restricted”

/ “toggled” / “no indication”

Examples:

Calling-Name-Status: available

Calling-Name: “Joe Smith” <sip:

[email protected];user=phone>

Presentation-Indicator: allowed

Message Flow Samples

In the following example, the 200 OK final response messages are omitted for brevity.

Figure A-2 IP CNAM Final Response Message Flow

A1: SUBSCRIBE Message

SUBSCRIBE sip:cnam-notifier.com SIP/2.0

Via: SIP/2.0/UDP cnam-subscriber.com;branch=z9hG4bKnashds8

To: <sip:cnam-notifier.com>

From: <sip:cnam-subscriber.com>;tag=1234

Call-ID: a84b4c76e66710

CSeq: 314159 SUBSCRIBE

Max-Forwards: 10

Contact: <sip:cnam-subscriber.com>

Page 29: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

29 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Expires: 0

Event: calling-name; id=2

Content-Type: application/calling-name-info

Content-Length: 54

Calling-Party:sip:[email protected];user=phone

A2: NOTIFY Message

NOTIFY sip:cnam-subcriber.com SIP/2.0

Via: SIP/2.0/UDP cnam-notifier.com;branch=a1hB4bGnashds4

Max-Forwards: 10

Contact: <sip:cnam-notifier.com>To: <sip:cnam-

subscriber.com>;tag=1234

From: <sip:cnam-notifier.com>;tag=5678

Call-ID: a84b4c76e66710

Cseq: 951413 NOTIFY

Content-Type: application/calling-name-info

Subscription-State: terminated

Event: calling-name; id=2

Content-Length:130

Calling-Name-Status:Available

Calling-Name: “Joe Smith”

<sip:[email protected];user=phone>

Presentation-Indicator: allowed

Security

The SIP Subscribe/Notify model is a classic setup for an amplifier denial-of-service attacks or,

worse yet, phishing attacks on calling name databases.

To prevent such attacks, SIP implementations typically require authentication; however, even

with authentication, man-in-the-middle attacks may be used to hijack 29xisting subscriptions. For

this reason, Neustar offers secure Internet protocol connectivity, such as IPSec and TLS, as IP

connectivity options between the Neustar Calling Name Gateway and the concerned network

nodes in the customer’s network.

Limitations and Restrictions

The following limitations should be noted:

Residence Architecture versus Business Group Architecture – Telcordia calling name

technical requirements defines two different architectures used to support calling name

service [1]. This section addresses only the “residence” architecture and does not

address the “business group” architecture, which is better served by the local business

group name database, for example, the callers’ IP Centrex application.

Responding to database overload – The calling name subscription mechanism

described in this document does not attempt to map the Automatic Code Gapping (ACG)

procedures related to SCP overload, specified in the Telcordia GR-1188-CORE [1].

Page 30: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

30 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

In the event the CNAM Notifier detects the serving SCP is experiencing overload

conditions (the return of the “ACG Indicators”), the CNAM Notifier responds to CNAM

Subscriber requests with a calling-name-info event package (Notify body) containing a

calling-name-status value of “out-of-service.”

References

[1] “CLASS Feature: Calling Name Delivery,” Generic Requirements 1188, Telcordia

Technologies, December 2000.

[2] “Session Initiation Protocol (SIP),” Request for Comments 3261, June 2002.

[3] “Session Initiation Protocol (SIP) – Specific Event Notification,” Request for Comments

3265, Internet Engineering Task Force, June 2002.

[4] “A Privacy Mechanism for the Session Initiation Protocol (SIP),” Request for Comments

3323, Internet Engineering Task Force, November 2002.

SIP Invite/Response Neustar provides SIP INVITE 380 access to CNAM database. This enables VoIP service

providers to access the PSTN in order to retrieve Calling Name information.

Neustar looks local database or converts the IP CNAM information, maps it to the equivalent

GR-1188 CNAM query, and sends it through the SS7 network to the appropriate CNAM

database. Neustar sends a SIP 380 lookup response back with requested Calling Name

information.

The following sections list the functional requirements and provides sample messages.

Connection Requirements

Connection

1. The communication with Neustar for SIP Invite/380 Response is via UDP

2. The UDP connection to Neustar is restricted by IP address or domain name

3. Neustar will return SIP 404 (not found) message for any attempts from an IP address

or domain name that is restricted or not defined.

4. Neustar can accept multiple IP addresses/domain names

5. Neustar will send 380 Response by UDP to the IP address from which SIP Invite was sent

6. The client port number that Neustar sends the 380 Response is determined by the

following rules:

If rport attribute is in the VIA header in INVITE message, use that value as a remote port

If rport attribute is not in the VIA header in INVITE message, and port number is defined in the

addr-spec attribute, use that port value as a remote port

Other than above, use 5060 as a remote port

Page 31: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

31 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Invite Message Requirements

SIP INVITE Message

1. Neustar includes at least the following fields, which follows SIP RFC 2234 definition for

basic rules:

Invite header

Via header

From header

To header

Call-ID header

Cseq header

Contact header

Max-Forwards header

Content-length header

3. The FROM header must include:

An 11-digit E.164 formatted number with a plus (‘+’) sign and ‘1’ country code prefix with the

remaining 10 digits conforming to the North American Number Plan

OR

An 11-digit E.164 formatted number with ‘1’ country code prefix with the remaining 10 digits

conforming to the North American Number Plan

OR

A 10-digit number conforming to the North American Number Plan

Response Message Requirements

SIP Response Message

1. If “Invite Message Requirements” on page 43 are met, a 380 Response containing a

P-Asserted-Identity header with the display name is returned

2. If “Invite Message Requirements” on page 43 are not met, a “400 – Bad Request”

message is returned

Page 32: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

32 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

3. The 380 Response will include the following headers:

380 Response header

Via header

Max-Forwards header

Contact header

To header

From header

Call-ID headerCseq header

P-Asserted-Identity header

Content-Length header

4. The 380 Response header has the following format:

SIP/2.0 380 cnam lookup

5. The Via header is the same as the Via header in INVITE message

6. The Max-Forwards header will contain value 10.

7 A contact header containing SIP application IP/User Name

8. The From header is the same as the From header in INVITE message

9. The To header will contain:

The To header from INVITE message

The global unique tag created by (S)IP-CNAM Gateway Application

10. The Call-ID header will be the same as the Call-ID header in INVITE message

11. The CSeq header will be the same as CSeq header in INVITE message

12. The Content-Length header must be 0

13. The P-Asserted-Identity follows the BNF definition in “P-Asserted-Identity BNF” on

page 45.

14. The P-Asserted-Identity will contain:

Display-name

The number from the From header in INVITE message

15. If the calling name (either the customer name or city/state) is available , the calling

name will be used as a display-name in P-Asserted-Identity header

Page 33: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

33 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

16. If no name available as per access config, then “Unavailable” will be used as a

display-name in P-Asserted-Identity

17.

18. If the query times out for external database, the “Unavailable” will be

used as a display-name in P-Asserted-Identity

19. When (S) IP-CNAM gets the name from the SS7 network, if the presentation is set

as “restricted”, a configurable string “PRIVATE” is used as a display-name in P-

Asserted-Identity in 380 Response

Acknowledgment Message Requirements

ACK Message

1

.

Neustar accepts the ACK messages outlined below but does not take any action.

ACK header

Via header

From header

To header

Call-ID header

CSeq header

Max-Forwards header

Content-Length header

Sample: SIP Invite/Response 380

The following sections illustrate sample messages using the IP CNAM specification.

P-Asserted-Identity BNF

PAssertedID = "P-Asserted-Identity" HCOLON PAssertedID-value*(COMMA

PAssertedID-value)

PAssertedID-value = name-addr/addr-spec

name-addr = [display-name]LAQUO addr-spec RAQUOT

addr-spec = SIP-URI/SIPS-URI/absoluteURI

display-name = *(token LWS)/quoted-string

token = 1*(alphanum/"-"/"."/"!"/"%"/"*"/"_"/"+"/"`"/"'"/"~"

alphanum = ALPHA/DIGIT

LWS = [*WSP CRLF]*WSP

SWS = [LWS]

quoted-string =SWS DQUOTE*(qdtext/quoted-pair) DQUOTE

qdtext = LWS/%x21/%x23-5B/%x5D-7E/UTF8-NONASCII

LAQUOT = SWS"<"

Page 34: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

34 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

RAQUOT = ">"SWS

quoted-pair = "\"(%x00-09/%x0B-0C/%x0E-7F)

Sample Invite

INVITE: sip:[email protected]:5060; SIP/2.0 Via:

SIP/2.0/UDP 192.168.199.250:5060;branch=z9hG4bk50603232286714-

3073754899

From:<sip:[email protected]>;tag=NeustarI1234567890

To: [email protected]:5061

Call-ID: [email protected]

CSeq: 1 INVITE

Contact: <sip:192.168.199.250:5060;transport=udp>

Max-Forwards: 70

Content-Length: 0

Sample 380 Response with Name

SIP/2.0 380 cnam lookup

Via: SIP/2.0/UDP

192.168.199.250:5060;branch=z9hG4bk50603232286714-3073754899

Max-Forwards: 10

Contact: "CNAM"<sip:[email protected]:5060>;transport=udp

To: <[email protected]:5061>;tag=b985fe44

From:<sip:[email protected]>;tag=NeustarI1234567890

Call-ID: [email protected]

CSeq: 1 INVITE

P-Asserted-Identity: "John Smith"

<sip:[email protected]>

Content-Length: 0

Sample 380 Response without Name

SIP/2.0 380 cnam lookup

Via: SIP/2.0/UDP

192.168.199.250:5060;branch=z9hG4bk50603232286714-3073754899

From:<sip:[email protected]>;tag=NeustarI1234567890

To: [email protected]:5061;tag=shooter

Call-ID: [email protected]

CSeq: 1 INVITE

P-Asserted-Identity: "Unavailable"

<sip:[email protected]>

Content-Length: 0

Sample 380 Response NPA-NXX is invalid

SIP/2.0 380 cnam lookup

Via: SIP/2.0/UDP

192.168.199.250:5060;branch=z9hG4bk50603232286714-3073754899

From:<sip:[email protected]>;tag=NeustarI1234567890

To: [email protected]:5061;tag=shooter

Call-ID: [email protected]

CSeq: 1 INVITE

P-Asserted-Identity: "Unavailable"

Page 35: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

35 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

<sip:[email protected]>

Content-Length: 0

Sample 380 Response with Timeout

SIP/2.0 380 cnam lookup

Via: SIP/2.0/UDP

192.168.199.250:5060;branch=z9hG4bk50603232286714-3073754899

From:<sip:[email protected]>;tag=NeustarI1234567890

To: [email protected]:5061;tag=shooter

Call-ID: [email protected]

CSeq: 1 INVITE

P-Asserted-Identity: "Unavailable"

<sip:[email protected]>

Content-Length: 0

Sample final ACK

ACK sip:192.168.199.250:5060;transport=udp;trans-type=5 SIP/2.0

Via: SIP/2.0/UDP 192.168.199.250:5060;branch=

z9hG4bk50603232286714-3073754899

From: <sip:[email protected]>;tag=VPSF506071629314

To:

<sip:204.8.249.18:5060;transport=udp;trans-

type=55>;tag=Neustar019D19. 2811

Call-ID: [email protected]

CSeq: 1 ACK

Max-Forwards: 69

Content-Length: 0

CNAM Query for ENUM Refer to the following ENUM Working Group document for more information:

IANA Registration for an Enumservice Calling Name Delivery (CNAM) Information and IANA Registration for URI type 'pstndata' at:

http://tools.ietf.org/html/draft-ietf-enum-cnam-08

ENUM CNAM Query

ENUM client sends the following ENUM Query to (S) IP-CNAM.

Table A-1 ENUM Client Query

Element Octets Value Note

ID

2 A 2-octet ID for ENUM Query

assigned by ENUM client

Page 36: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

36 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

QR|Opcode|AA|TC

|RD|RA|Z|RCODE

2

0x00 0x00

QR: 1-bit

OPCODE: 4-bit

Authoritative Answer AA: 1-bit

TrunCation (TC): 1-bit

Recursion Desired (RD): 1-bit

Recursion Available (RA): 1-bit

Z: 3-bit

Response Code (RCODE): 4-bit

QDCOUNT 2 0x00 0x01 16-bit integer

ANCOUNT 2 0x00 0x00 16-bit integer

NSCOUNT 2 0x00 0x00 16-bit integer

ARCOUNT 2 0x00 0x00 16-bit integer

QNAME

variable ENAM CNAM query. The 0x00 is end

of QNAME

QTYPE

2

0x00 0x23 The value of QTYPE = 35 (NAPTR:

ENUM Naming Authority Pointer)

QCLASS

2

0x00 0x01 The value of QCLASS = 1(IN:

Internet)

The following shows the ENUM Query sample with calling number

13604936000.

0x00 0x01 ID = 1

0x00 0x00 Q/R = 0 (Query), OPCODE = 0, AA = 0, TC = 0, RD = 1, RA = 0

Z = 0, RCODE = 0

0x00 0x01 QDCOUNT = 1

0x00 0x00 ANCOUNT = 0

0x00 0x00 NSCOUNT = 0

0x00 0x00 ARCOUNT = 0

01 30 01 30 01 30 01 36 01 33 01 39 01 34 01 30 01 36 01 33 01 31

QNAME:

0.0.0.6.3.9.4.0.6.3.1.subaccount.callerid.neustar.biz

0x00 The end of QNAME

0x00 0x23 QTYPE = 35 (NAPTR)

0x00 0x01 QCLASS = 1 (Internet)

Note:

1. Here subaccount is optional.

2. Application will support “cnam.tnsi.com” as Top Level Domain for some time in parallel along with new TLD “callerid.neutsar.biz” for

3. The use of “arpa.e164” as TLD is highly discouraged, however it would be supported for backward compatibility.

Page 37: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

37 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

ENUM CNAM Response

(S)IP-CNAM sends the following format of ENUM Response to ENUM client.

Table A-2 ENUM Response to Client

Element Octets Value Note

ID 2 A 2-octet ID from ENUM Query ID

QR|Opcode|AA|TC|

RD|RA|Z|RCODE

2 QR: 1-bit, value = 1

OPCODE: 4-bit, value = 0

Authoritative Answer (AA): 1-bit, value = 1

TrunCation (TC): 1-bit, value = 0

Recursion Desired (RD): 1-bit, value = 0

Recursion Available (RA): 1-bit, value = 0

Z: 3-bit, value = 0

Response Code (RCODE): 4-bit:

0: no error

1: format error if (S) IP-CNAM detects

the ENUM query wrong format

2: server failure if (S) IP-CNAM detects

the SS7 associations down

3: name error if ENUM query timeout

4: not implemented

5:refused if the client IP address in

ENUM query is not in the (S)IP-CNAM

configuration

QDCOUNT 2 0x00

0x01

16-bit integer, value = 1

Table A-2 ENUM Response to Client

Element Octets Value Note

ANCOUNT 2 0x00

0x01

16-bit integer, value = 1

NSCOUNT 2 0x00

0x00

16-bit integer, value = 0

ARCOUNT 2 0x00

0x00

16-bit integer, value = 0

Page 38: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

38 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Element Octets Value Note

QNAME variable From ENUM Query QNAME

QTYPE 2 0x00

0x23

From ENUM Query QTYPE

QCLASS 2 0x00

0x01

From ENUM Query QCLASS

NAME variable ENAM CNAM query. The 0x00 is end of

QNAME

TYPE 2 0x00

0x23

The value of QTYPE = 35 (NAPTR: ENUM

Naming Authority Pointer)

CLASS 2 0x00

0x01

The value of QCLASS = 1(IN: Internet)

TTL 4 0x00

0x00

0x00

0x01

4-octet TTL, value = 1

RDLENGTH 2 2-octet RDATA length

ORDER 2 0x00

0x0A

2-octet order, value = 10

PREFERENCE 2 0x00

0x64

2-octet preference, value = 100

FLAGS 2 0x01

0x75

Length = 1, ASCII = u

SERVICES 18 11 45 32

55 2b 70

73 74 6e

64 61 74

61 3a 63

6e 61 6d

The service value = 'E2U+pstndata:cnam'.

The length = 17

REGEXP variable The REGEXP length and REGEXP

REPLACEMENT 1 0x00 1-octet replacement. The value = 0x00

The following shows the ENUM Response sample with calling number 13604936000 and

calling name: "TEST NeustarI”

0x00 0x01 ENUM Response ID (from ENUM Query ID)

0x84 0x00 Q/R = 1 (Response), OPCODE = 0, AA = 1, TC = 0, RD = 0, RA = 0

Z = 0, RD = 0 (No Error)

0x00 0x01 QDCOUNT = 1

Page 39: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

39 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

0x00 0x01 ANCOUNT = 1 (RCODE = 0 No Error)

0x00 0x00 NSCOUNT = 0

0x00 0x00 ARCOUNT = 0

01 30 01 30 01 30 01 36 01 33 01 39 01 34 01 30 01 36 01 33 01 31

QNAME: 0.0.0.6.3.9.4.0.6.3.1.subaccount.callerid.neustar.biz

0x00 The end of QNAME

0x00 0x23 QTYPE = 35 (NAPTR)

0x00 0x01 QCLASS = 1 (Internet)

01 30 01 30 01 30 01 36 01 33 01 39 01 34 01 30 01 36 01 33 01 31

Answer NAME:

0.0.0.6.3.9.4.0.6.3.1.subaccount.callerid.neustar.biz

0x00 The end of NAME

0x00 0x23 Answer TYPE = 35 (NAPTR)

0x00 0x01 Answer CLASS = 1 (Internet)

0x00 0x00 0x00 0x01 TTL = 1

0x00 0x67 Answer Data LENGTH = 104

0x00 0x0A ORDER = 10

0x00 0x64 PREFENRENCE = 11

0x01 0x75 FLAG: length = 1, ASCII = u

11 45 32 55 2b 70 73 74 6e 64 61 74 61 3a 63 6e 61 6d

SERVICE = "E2U+pstndata:cnam"(The length = 17 4f)

REGEXP Length = 79

REGEXP

21 5e 2e 2a 24 21 70 73 74 6e 64 61 74 61 3a 63 6e 61 6d

2f 2b 31 36 30 34 39 33 36 30 30 30 3b 3b

63 68 61 72 73 65 74 3d 75 73 2d 61 73 63 69 69 2c

54 45 53 54 25 32 30 56 52 53 4e 25 32 30 25 32 30 25 32 30 25 32 30 25 32 30

25 32 30 21

!^.*$!pstndata:cnam/+13604936000;; charset=us-

ascii,TEST%20NeustarI%20%20%20%20%20%20!

0x00 REPLACEMENT

ENUM Source URI in ENUM Query:

ENUM Source URI Parameter can be sent in ENUM query with pstndata uri containing TN and

Name for Extended data response and score value. ( As part of DNS Additional records in Query

for EDNS0 version). If subscribed to this service with extended name, SCP returns extended

name for TN along with score value to compare regular name with extended name.

Page 40: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

40 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 8: Data File Format This section describes the file format for customers to use to submit data to Neustar. The

format is known as the “200-byte Record Format.”

Data File Requirements Follow these requirements when creating data files to send to Neustar:

Data files must be in text format, with the .txt extension. Do not send files in any other

formats.

File names must be unique, with a maximum of 15 characters. If two or more files with

the same name are sent in the same production run, the last file received will overwrite

the previous data. You may find it helpful to include the date in the file name. You do not

have to use your company name or “Neustar” in the file name.

The file name must not contain any of the following list of special characters:

~ ! @ # $ % ^ * ( ) + = { } \ ; ” ’ , < > ? /

Do not use these characters as the first character of a file name:

- (dash), . (period), ~ (tilde)

Do not send empty files. In your scripting, ensure that non-worked holidays do not

generate and send empty files. When specifying the path name for the file that you

want to send, be particularly careful to enter the correct name. If you enter an incorrect

name, an empty file will be sent. Processing is delayed when Neustar receives a batch

of records containing an empty file.

To ensure fast and efficient processing, Neustar limits files to less than 20,000 records

per file. Files larger than 20,000 records, or multiple files totaling over 20,000 records,

may delay processing. Contact Customer Support in advance to schedule uploads of

more than 20,000 records per production run.

If you use a spreadsheet application to prepare your data files, be sure to check the

OTCs (column 1) to make sure they did not inadvertently get changed. In some

situations, copying cell data can cause a column of numbers to be incremented (1111,

1112, 1113). For more information, contact Neustar Customer Support.

Protecting Private or Sensitive Numbers To ensure the highest level of protection for your subscribers and to prevent private or sensitive

customer names (for example, crisis clinics, women/children’s shelters, law enforcement, DEA,

FBI) from appearing on calling name displays, do not submit line records for these customers.

Although you can configure the privacy indicator in the record format, the calling name delivery

is ultimately the responsibility of the originating switch. Neustar cannot guarantee that all

switches will honor the privacy indicator. For more information, see “Blocking CNAM Delivery”

In addition, Neustar does not compensate for queries of CNAM records denoting the privacy

indicator in position 19 of the 200-byte record format.

Page 41: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

41 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Preventing Truncated Files with AS/400 or FTP Transfer Using an AS/400 system or sending files by FTP may cause your files to truncate (a portion of

the 200-byte record is cut off). Entering an asterisk (*) in position 200 may prevent truncation.

The “Transaction Errors Report” shows an error for a file that contains an asterisk (*) in position

200. While the asterisk is not a standard part of the 200-byte format, the record is still processed

and does not need to be corrected.

Multiple Record Updates If you update a line number multiple times in a data file, the system processes each update in

order, and the last update will be the final one.

Identifying Errors Use the Transaction Errors report, available after each file is processed, to see if your file

produced any errors. You can use the information provided on the report and in this guide to

resolve any errors you encounter. For more information, see “Transaction Errors Report Sample”

Page 42: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

200-Byte Record Format Details Files may include optional record delimiters for a line feed (for 201 bytes per record) or a carriage return/line feed pair (for 202 bytes per record).

The following tables describe the 200-byte record format and the optional Verification Data tags. The Notes column contains any special

requirements or instructions for that field.

Table B-1 200-Byte Record Format

Position Field Name Format

(length)

Description Notes

1-6 Filler Numeric (6) Not used; populate with spaces. An incorrect OTC causes these errors on the

Transaction Error report:

No OTC in transaction

OTC not in LEC Master File

Transaction OTC does not match group file

7-9 NPA Numeric (3) Required. NPA (area code)

10-12 NXX Numeric (3) Required. NXX (exchange)

13-16 Line Numeric (4) Required. Line number

17 Record type Alpha- Required. You can combine record types in a file. Any records

numeric (1) 3 = Identifies the record without Verification containing verification data must have a “4” in this

Data tags. position or the entire file is rejected.

4 = Identifies the record with the presence of

Verification Data tags.

For the Verification Tag format, see Table B-2 on page 65.

18-19 Record sub-type Alpha- Required. Populate with “00” (zeros) If incorrect, causes “Bad Record Type or Subtype” error

numeric (2) in Transaction Error report.

20 Filler Alpha (1) Populate with a space

21 Action code Alpha (1) Required. If the TN has been ported, make sure it has been

I = Insert new line number record activated with the NPAC before submitting an Insert.

C = Change record The point code should be: 238.013.000

D = Delete record For LIDB: Do not submit a delete for a TN that your

company no longer owns

22-24 Class of service Alpha (3) Required for LIDB only. If LIDB only: must populate

See “Service Equipment Indicators/ Class of Service Codes” on page 70

If CNAM: space through

If this field is populated with spaces, it will default to “Res”.

Page 43: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

25 BNS Alpha (1) Billed Number Screening It is recommended that you populate this field. If it is not

A = Block both third and collect

B = Block third-number only

C = Block collect only

D = Allows both third and collect calls. This is

the default.

If this field is populated with a space, it

defaults to “D.”

specified, the default is to allow third party and collect

calling.

Note: Positions 26-45, 65-115, 167-173, and 185-189 are for OLNS only. If your company does not participate in OLNS, populate these fields with spaces.

In this table, OLNS fields are indicated with a shaded background.

26 LSCNB indicator Alpha (1) Optional OLNS field. Defaults to “No”

LIDB-Specific Called Number Blocking LSCNB is a fraud control feature associated with calls

Restrictions being billed to the line number.

Y - Yes Space through if you are not an OLNS customer.

N - No

27 Originating

collect-billing

indicator

Alpha (1) Optional OLNS field.

A = Allowed

B = Not allowed (block)

D = Allow domestic calls only

Space through if you are not an OLNS customer.

28 Originating

third-number billing

Alpha (1) Optional OLNS field.

A = Allowed

B = Not allowed (block)

D = Allow domestic calls only

Space through if you are not an OLNS customer.

29 Originating local,

non-toll call indicator

Alpha (1) Optional OLNS field.

A = Allowed

B = Not allowed (block)

Space through if you are not an OLNS customer.

30 Originating credit

card indicator

Alpha (1) Optional OLNS field.

A = Allowed

B = Not allowed (block)

D = Allow domestic calls only

Space through if you are not an OLNS customer.

Appendix B

Data F

ile Form

at

Page 44: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

31 Originating free DA

indicator

Alpha (1) Optional OLNS field.

Originating Free Directory Assistance (DA)

Indicator

Values are:

A = Allowed

B = Not allowed (block)

Space through if you are not an OLNS customer.

32 Originating special

BNS indicator

Alpha (1) Optional OLNS field.

Originating Special Billed Number Screening

Indicator

A = Allowed

B = Not allowed (block)

Space through if you are not an OLNS customer.

33 Originating sent paid

indicator

Alpha (1) Optional OLNS field.

A = Allowed

B = Not allowed (block)

D = Allow domestic calls only

R = Allow intraLATA calls only due to

non-payment

C = Allow intraLATA calls only at customer

request

Space through if you are not an OLNS customer.

34 Originating DACC

indicator

Alpha (1) Optional OLNS field.

Originating Directory Assistance Call

Completion Indicator

A = Allowed

B = Not allowed (block)

R = Allowed with billing restrictions

L = Allow local (non-toll) calls only

Space through if you are not an OLNS customer.

35 Originating IC

indicator

Alpha (1) Optional OLNS field.

Originating Interexchange Carrier Indicator

I = Originating IC indicator

N = Originating IC denied

Space through if you are not an OLNS customer.

Appendix B

Data F

ile Form

at

Page 45: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

36-39 Originating IC Numeric (4) Optional OLNS field.

Originating Interexchange Carrier

0000-9999

Space through if you are not an OLNS customer.

40 Originating INC

indicator

Alpha (1) Optional OLNS field.

Originating International Carrier Indicator

I = Originating INC indicated

N = Originating INC not indicated

D = Originating INC denied

Space through if you are not an OLNS customer.

41-44 Originating INC Numeric (4) Optional OLNS field.

Originating International Carrier 0000-9999

Space through if you are not an OLNS customer.

45 Treatment Indicator Alpha (1) Optional OLNS field.

See Table B-3, “Treatment Indicators for OLNS,” on page 73.

Space through if you are not an OLNS customer.

46 Calling name action

type

Alpha (1) I = Insert new calling name

C = Change calling name

D = Delete calling name

or populate with a space

If C or I is used, then positions 47-62 must be

populated.

If CNAM: populate

If LIDB only: populate with spaces

If you send a record as an “I” (insert) and the record

already exists, the system process the record as a “C”

(change).

If you send a record as a “C” and the record did not

previously exist, the system inserts the record as sent.

47 Calling name privacy

indicator

Alpha (1) A = Allow name to be displayed

R = Block name from display

or populate with a space

If populated with spaces and position 48-62 is populated with a valid name, then the default will set to allow.

If CNAM: populate

If LIDB only: populate with spaces

Do not submit line records for highly sensitive numbers. Neustar cannot guarantee that all switches will honor the privacy indicator. For more information,

see“Protecting Private or Sensitive Numbers” on page 54.

Appendix B

Data F

ile Form

at

Page 46: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

48-62 Calling name string Alpha (15) Subscriber name, or populate with spaces.

Required if position 46 is C or I.

The first character must not be an asterisk (*).

Do not populate with the phone number or the

record will be rejected

63-64 Foreign language Numeric (2) See “Foreign Language Identifiers” on page 72 or populate with spaces

If CNAM: populate with calling name information.

If LIDB only: populate with spaces

Use alpha only (except commas) in the calling name

string. Do not populate with the phone number or the

record will be rejected

Note: To provide an extended Caller ID name, see the

Extended Name tags in Table B-2 on page 65.

If double quotes are sent in the string (from an

automated system, for example), the Neustar system

changes them to single quotes.

If a backslash (\) is used in the string, it will be

automatically replaced by a space character in the

Neustar system.

For more information on calling name requirements,

see “CNAM Data Provisioning Policies” on page 33.

65 Restrict Indicator

(PIN key)

Numeric (1) Optional OLNS field.

This entry must match pos. 71, Card Type.

0 = No PIN

1 = Unrestricted, domestic, or domestic

conditional

2 = Restricted

The PIN Key must correspond to the Card Type in

position 71.

Space through if you are not an OLNS customer.

66-69 PIN string Numeric (4) Optional OLNS field.

Personal Identification Number

First digit cannot be 0 or 1

Space through if you are not an OLNS customer.

Appendix B

Data F

ile Form

at

Page 47: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

70 PIN action Alpha (1) Optional OLNS field. Space through if you are not an OLNS customer.

I = Insert new PIN

D = Delete PIN

C = Change PIN

S = Suspend service to PIN

R = Restore service to PIN

71 Card type Alpha (1) Optional OLNS field. Space through if you are not an OLNS customer.

U = Unrestricted

D = Domestic

C = Domestic conditional

R = Restricted

72 Usage Category Numeric (3) Optional OLNS field. Space through if you are not an OLNS customer.

055 = ultra-low usage

001 = normal usage

002 = high usage

If populated with spaces, the default is 001.

75 Customer Text Op

Code

Alpha (1) Optional OLNS field.

I = Insert

C = Change

D = Delete

Space through if you are not an OLNS customer.

76-115 Customer Text Alphanumeric

(40)

Optional OLNS field.

Used to notify the operator of specific

customer information, for example, that this is

a line for the hearing impaired.

Space through if you are not an OLNS customer.

116 Filler 51 Populate with spaces.

Appendix B

Data F

ile Form

at

Page 48: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

167 Addl. Originating CC

Indicator

Alpha (1) Optional OLNS field.

Additional Originating Calling Card Indicator

A = Allowed

B = Not Allowed (block)

R = Restrict

Space through if you are not an OLNS customer.

168 Addl. Originating

Third Num Bill

Indicator

Alpha (1) Optional OLNS field.

Additional Originating Third Number Indicator

A = Allowed

B = Not Allowed (block)

V = Allow with operator verification

W = Allow with operator or automatic

verification

Space through if you are not an OLNS customer.

169 Originating Bill Svc

Spare Indicator

Alpha (1) Optional OLNS field.

Originating Billing Services/Spare Indicator

A = Allowed

B = Not Allowed (block)

Space through if you are not an OLNS customer.

170 Addl. Originating

Special BNS

Indicator

Alpha (1) Optional OLNS field.

Additional Originating Special Billed Number

Screening Indicator

A = Allowed

B = Not Allowed (block)

Space through if you are not an OLNS customer.

171 Addl. Origination

Sent Paid ind

Alpha (1) Optional OLNS field.

Additional Originating Sent-Paid Indicator

A= Allowed

B = Not Allowed (block)

Space through if you are not an OLNS customer.

172 Addl. Originating Bill

Svc Indicator Spare

Numeric (2) Optional OLNS field.

Additional Originating Billing Service/Spare

Indicator

00- 99

Space through if you are not an OLNS customer.

Appendix B

Data F

ile Form

at

Page 49: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Position Field Name Format

(length)

Description Notes

174-177 OCN Alpha-

numeric (4)

Required. Valid Operating Company Number

(assigned by the NECA)

If incorrect, causes “No OCN in transaction” error.

If you need to change an existing OCN or add a

state-specific OCN, contact Neustar.

178-181 BSP Alpha-

numeric (4)

Valid Billing Service Provider (NP). Not in

use. Populate with spaces

182-184 RAO Alpha-

numeric (3)

Recommended. Valid billing Revenue

Accounting Office number

The Telcordia-assigned billing Revenue Accounting

Office. If unknown, populate with spaces, and Neustar

will populate the field with the Telcordia-assigned RAO,

per industry standards. If populated with alphanumeric

data, Neustar populates the BSP (Billing Service

Provider) field (visible on the LIDB audit) and the

default RAO applies, per industry guidelines

185 IL Presub Carrier

Indicator

Alpha (1) Optional OLNS field. Space through if you are not an OLNS customer.

Intra-LATA Pre-Subscription Indicator

N = Not indicated

I = Indicated

D = Denied

E = Not indicated - ILP does not exist

T = Not indicated - IntraLATA toll calls not

allowed

186 IL Presub

Carrier Code

Numeric (4) Optional OLNS field.

Intra-LATA Pre-Subscription Number

0000-9999

190-195 Filler Alpha-

numeric

(11)

Not used; populate with spaces.

196-200 Filler Alpha (5) Populate with spaces.

Page 50: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Table B-2 Verification Data Tags. All elements are Optional.

Tag format: <tag>=<value>~~<tag>=<value> Example: lastname=Smith~~firstname=John

Extended Name ename Alpha. Extended name for Caller ID. 60 ename=JOHN D. SMITH

Extended Name

Presentation Indicator

enind Numeric.Possible values are:

0=Presentation allowed (public)

1=Presentation restricted (private or anonymous)

2=(reserved-don’t use)

3=No indication

1 enind=0

Last Name lastname Alphanumeric. Last name of billed customer.

Note: The lastname and firstname tags are combined for a

maximum length of 29. If the length exceeds 29, the firstname is

truncated (shortened). Do not use a comma (,) in either field or

the record will be rejected.

Variable;

lastname and

firstname

combined is

limited to 29

characters

lastname=SMITH

First Name firstname Alphanumeric. First name of billed customer. See Note above. firstname=JOHN

or

firstname=JOHN D.

or

firstname=JOHN DAY

Business Name busname Alphanumeric. Business name, if applicable. 30 busname=AAA CLEANERS

Street Address straddress Alphanumeric. House number and street name. 30 straddress=123 MAIN ST

Address address2 Alphanumeric. Apt.#, Suite, etc. 30 address2=Apt. 3A

Address3 (Reserved) Reserved field Reserved

for future use.

City city Alphanumeric. City of billed customer 28 city=SEATTLE

State state Alphanumeric. State of billed customer. Use standard 2-letter

state abbreviation.

2 state=WA

ZIP zip Numeric. Must be either a 5-digit or 9-digit ZIP code. 9 zip=985034501

Data Element Tag Name Type and Description Max.

Appendix B

Data F

ile Form

at

Page 51: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Table B-2 Verification Data Tags. All elements are Optional.

Tag format: <tag>=<value>~~<tag>=<value> Example: lastname=Smith~~firstname=John

Carrier Type type Numeric. Possible values are: 3 type=6

(Company Type) 1=LEC

2=Independent

3=Unbundler

4=Reseller

5=UNE-P

6=Wireless

7=VoIP

8=MVNO

9=Cable

10=Power

11=Satellite

Line Technology Type linetype Numeric. Possible values are:

1=PSTN

2=Wireless

3=Landline VoIP

4=Wireless VoIP

5=Hybrid

6=Other

3 linetype=2

Service Start Date servicedate Mmddyyyy 8 servicedate=10012009

Third Party Bill Block billblock Alphanumeric. Possible values are:

1=900/976 calls not allowed from this line

2=900/976 calls allowed from this line

3 billblock=1

Data Element Tag Name Type and Description Max.

Appendix B

Data F

ile Form

at

Page 52: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

Table B-2 Verification Data Tags. All elements are Optional.

Tag format: <tag>=<value>~~<tag>=<value> Example: lastname=Smith~~firstname=John

Calling Plan callingplan Numeric. Possible values are:

1=Individual

2=Family Plan (primary line)

3=Family Plan (other line)

4=Business

Note: On a family plan the primary line is most often the primary

account holder. Secondary lines or "other lines" are simply the

other phone lines on the family share plan.

3 callingplan=1

Subscription Type subscriptiontype Numeric. Possible values are:

1=Contract (postpaid)

2=Non-Contract (prepaid)

3=Lifeline

4=Free

Note: An example of a “free” subscription would be an Internet

telephony service that provides its users free calling services.

3 subscriptiontype=1

Device Serial Number deviceserialno Alphanumeric. Globally unique number identifying mobile

phone.

Note: This is the International Mobile Equipment Identity (IMEI),

Mobile Equipment Identifier (MEID) or Electronic Serial Number

(ESN).

20 deviceserialno=353104006338

894

Device OEM deviceoem Alphanumeric. The Original Equipment Manufacturer (OEM) of

the device.

20 deviceoem=MOTOROLA INC.

Device Model devicemodel Alphanumeric. The model number of the device. 20 devicemodel=E550

Data Element Tag Name Type and Description Max.

Appendix B

Data F

ile Form

at

Page 53: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

53 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Verification Data Elements

Verification Data consists of additional customer data you can store for number verification

queries. To submit Verification Data, the record must contain a “4” in position 17 (Record Type)

of the 200-byte format. The data file is rejected if verification data is present for a record type of

“3”.

Formatting Verification Data Tags

Verification Data tags are added to the end of the 200-byte record format.

The tags can appear in any order and all of them are optional. If you do not use a

particular tag, just omit it.

Tags must be formatted as follows:

<tag>=<value>~~<tag>=<value> For example:

lastname=Smith~~firstname=John

Use two tildes (~~ ) to separate tags. (The tilde character is typically to the left of the

number 1 key on the keyboard.)

Do not add a leading space in the value of a tag.

You can use spaces within the value of a tag as long as it is not the first character. For

example, the spaces in the street address shown in the following example are

acceptable:

straddress=777 Maple Ave SE~~city=Lacey~~state=WA

The following example would NOT be acceptable because of the leading

space (the space after the equal sign) in each value:

straddress= 777 Maple Ave SE~~city= Lacey~~state= WA

The following example shows a complete 200-byte record followed by Verification Data tags. Note

that position 17 contains a “4,” indicating that the record includes Verification Data tags.

2110213604936000400 IRESA IASMITH, JOHN DAY 7654

321 lastname=SMITH~~firstname=JOHN DAY~~straddress=777 Maple Ave

SE~~city=LACEY~~state=WA~~zip=98503~~type=1~~billblock=1~~linetype=2

Removing Verification Data Tags

If you want to remove the value for a previously submitted Verification Data tag, you must submit

a record with the same tag and the word “DELETE” as the value.

For example, the following record would remove the firstname, lastname, straddress, city, state,

and zip from the record for 360-493-6000:

36049360004 [ ...rest of 200-byte format]

lastname=DELETE~~firstname=DELETE~~straddress=DELETE~~city=DELETE~~state=DELE

TE~~zip=DELETE

Page 54: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

54 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

To remove a single Verification Data tag, the record would look like this:

36049360004 [ ...rest of 200-byte format] straddress=DELETE

Service Equipment Indicators/ Class of Service Codes

The following table lists the valid service equipment/class of service codes for positions 22-24 of

the 200-byte record format:

Service

Equipment

Class of Service

Indicator

(Online Access

Pages)

Code

(200-byte Record

Format)

Telcordia Technologies Description

[Blank] Blank is valid

SBN Special billing number

01 (bus./res.

defined in another

field

BUS BUS Plain old telephone service (POTS)

line-business

RES Plain old telephone service (POTS)

line-residential

02 PBC LEC public-standard interface-postpay

overtime

03 PLR POTS line-residential-message rate 1

04 PRM POTS line-residential-message rate 2

05 SPC LEC semi-public

06 PBF POTS line-business-flat rate

07 PBM POTS line-business-message rate 1

08 PBN Coinless (non-IPP)

09 YIP Coinless (IPP)

10 PTC LEC prepaid telecommunications card station

11 PLB POTS line-business-message rate 2

12 LPS LEC public-standard interface-prepay

overtime

13 DAI LEC public-alternate interface

14 ICS IC public-standard interface

15 ICA IC public-alternate interface

16 PRF POTS line-residential-flat rate

17 VQN Voice quote-without tax

18 VQT Voice quote-with tax

19 ISI IPP-standard interface

Page 55: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

55 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Service

Equipment

Class of Service

Indicator

(Online Access

Pages)

Code

(200-byte Record

Format)

Telcordia Technologies Description

20 IAI IPP-alternate interface

21 HOS Hospital

22 PSN Prison (non-IPP)

23 AQN Auto quote-without tax

24 AQT Auto quote-with tax

25 DML Dormitory line

26 CXL Centrex line

27 PBX PBX line

28 PIP Prison (IPP)

29 WAT WATS line

30 CEL Cellular

31 PGR Pager

32 PCS Personal Communication Service (PCS)

33 FGA Feature Group A

34 MOB Mobile

35 SBB LEC public special billing-postpay overtime

36 SBA LEC public special billing-prepay overtime

37 INI Public-incompatible network interface

38 CLO Cellular-rate 1

39 CLT Cellular-rate 2

40 ONE POTS line-business-single line

41 MUL POTS line-business-multi-line

42 PPY Public-postpay

Page 56: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

56 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Foreign Language Identifiers

The following table lists the valid foreign language identifiers for positions 63-64 of the 200-byte

record format:

Value Language Value Language

00 English 21 Navaho

01 Spanish 22 Hungarian

02 French 23 Hebrew

03 German 24 Dutch

04 Italian 25 Mon-Khmer (Cambodian)

05 Mandarin 26 Gujarathi

06 Tagalog 27 Ukrainian

07 Polish 28 Czech

08 Korean 29 Pennsylvania Dutch

09 Vietnamese 30 Miao (Hmong)

10 Portuguese 31 Norwegian

11 Japanese 32 Slovak

12 Greek 33 Swedish

13 Arabic 34 Serbo-Croatian

14 Hindi (Urdu) 35 Kru

15 Russian 36 Rumanian

16 Yiddish 37 Lithuanian

17 Thai (Laotian) 38 Finnish

18 Persian 39 Panjabi

19 French Creole 40 Formosan

20 Armenian 41 Croatian

Page 57: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

57 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Treatment Indicators

The following table lists the valid treatment indicators for position 45 of the 200-byte record

format:

Table B-3 Treatment Indicators for OLNS

Value Description

A Automated treatment-provide alerting tone only

B Automated treatment-provide alerting tone and prompting announcement 1

C Automated treatment-provide alerting tone and prompting announcement 2

D Automated treatment-provide alerting tone and prompting announcement 3

E Operator treatment-operator handling (station limitations)

F Special treatment-operator handling (at customer request)

G Special treatment-handicapped

H Special treatment-deaf

I Operator treatment-high fraud

J Automated treatment-provide alerting tone only-no operator access

K Automated treatment-provide alerting tone and prompting announcement 4-no operator access

L Automated treatment-provide alerting tone and prompting announcement 5-no operator access

M Automated treatment-provide alerting tone and prompting announcement 6-no operator access

N Automated treatment-provide alerting tone and prompting announcement 7

O Automated treatment-provide alerting tone and prompting announcement 8

P Automated treatment-provide alerting tone and prompting announcement 9

Q Automated treatment-provide alerting tone and prompting announcement 10-no operator access

R Automated treatment-provide alerting tone and prompting announcement 11-no operator access

S Automated treatment-provide alerting tone and prompting announcement 12-no operator access

T Automated treatment-special handling 1

U Automated treatment-special handling 2

V Automated treatment-special handling 3

W Automated treatment-special handling 4

X Automated treatment-special handling 5-no operator access

Y Automated treatment-provide alerting tone and prompting announcement 13

Z Automated treatment-provide alerting tone and prompting announcement 14-no operator access

Page 58: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

58 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Chapter 9: Error Messages The following table describes the error messages that can appear on reports and in the Web

application.

Table C-1 Error Messages

Type Error Code Error Message

Top – Level Codes

02_

Insert successful

03_ Insert successful, processed as update

04_ Update successful

05_ Update successful, processed as insert

06_ Delete Successful

07_ Transaction successful, no change necessary

10_ Sorry, An unexpected error has occurred

11_ Invalid Request Format

14_ Company is inactive

21_ Company does not have rights to this line number

22_ Company does not have rights to this line number

23_ Company does not have rights to this line number

28_ Industry record not found for this TN/NPA-NXX, will resubmit for processing

29_ Industry record not found for this TN/NPA-NXX

30_ Missing or invalid TN

31_ Missing or invalid OCN

32_ Invalid or missing Transaction Code

33_ One or more packages must be designated for insert and update actions

40_ Custom Data not accepted at this time

41_ Tag Name is invalid

CNAM Field Codes CB_ Invalid CNAM, Presentation Indicator is invalid

CC_ Invalid CNAM, Caller name is missing

CE_ Invalid CNAM, Invalid characters in Caller Name string

CF_ Invalid CNAM, Caller Name must contain at least one alpha value

CG_ Invalid CNAM, Caller Name failed profanity screening

CH_ Invalid CNAM, Extended Caller First Name exceeds length

CI_ Invalid CNAM, Invalid characters in Extended Caller First Name string

CJ_ Invalid CNAM, Extended Caller First Name must contain at least one alpha value

CK_ Invalid CNAM, Extended Caller First Name failed profanity screening

CL_ Invalid CNAM, Extended Caller Last Name exceeds length

CM_ Invalid CNAM, Invalid characters in Extended Caller Last name string

CN_ Invalid CNAM, Extended Caller Last Name must contain at least one alpha value

CO_ Invalid CNAM, Extended Caller Last Name failed profanity screening

CP_ Invalid CNAM, Extended Caller Business Name exceeds length

CQ_ Invalid CNAM, Invalid characters in Extended Caller Business Name string

Page 59: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

59 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Table C-1 Error Messages

CR_ Invalid CNAM, Extended Caller Business Name failed profanity screening

CS_ Invalid CNAM, Extended Caller Business Name cannot be the same as the phone number

CT_ Invalid CNAM, CNAM Action Code is invalid

CU_ Invalid CNAM, Action code and CNAM action does not match

CV_ Invalid CNAM, ename Tag Value is missing

CW_ Invalid CNAM, enind Tag Value is missing

CX_ Invalid CNAM, efirstname Tag Value is missing

CY_ Invalid CNAM, elastname Tag Value is missing

CZ_ Invalid CNAM, ebusname Tag Value is missing

C1_ Invalid CNAM, Extended Presentation Indicator is invalid

LIDB Codes

LIDB Codes LA_ Invalid LIDB, BNS is invalid

LB_ Invalid LIDB, Class of Service indicator is invalid

LC_ Invalid LIDB, Revenue Accounting Office string does not meet length requirements

LD_ Invalid LIDB, invalid characters in Revenue Accounting Office string

LE_ Invalid LIDB, Revenue Accounting Office string is invalid

LF_ Invalid LIDB, PIN1 action is invalid

LG_ Invalid LIDB, PIN1 does not meet length requirements

LH_ Invalid LIDB, PIN1 is invalid

LI_ Invalid LIDB, first position value in PIN1 is invalid

LJ_ Invalid LIDB, PIN1 Action of C or I requires PIN String

LK_ Invalid LIDB, PIN1 Type is invalid

LL_ Invalid LIDB, PIN1 Service Denial is invalid

LM_ Invalid LIDB, PIN1 Usage Category is invalid

LT_ Invalid LIDB, PIN1 Key is invalid

LU_ Invalid LIDB, PIN1 Key must correspond to Card Type

LV_ Invalid LIDB, PIN1 Usage Category requires PIN Type

LW_ Invalid LIDB, PIN1 Type is required

LX_ Invalid LIDB, PIN1 and PIN2 values cannot be the same

LY_ Invalid LIDB, PIN1 value is missing

LZ_ Invalid LIDB, PIN2 value is missing

OLNS Codes

OLNS Codes OA_ Invalid OLNS, Customer Text Operation code is invalid

OB_ Invalid OLNS, Customer Text exceeds length

OD_ Invalid OLNS, Originating Collect Billing indicator is invalid

OE_ Invalid OLNS, Originating 3rd Number Billing indicator is invalid

OF_ Invalid OLNS, Originating Non-Toll Call indicator is invalid

OG_ Invalid OLNS, Originating Credt Card indicator is invalid

Page 60: USER GUIDE · 2019-02-08 · CNAM Storage Provide both the originating and terminating numbers. Indicate the incorrect CNAM information being displayed and provide the corrected CNAM

60 ⁄⁄ LIDB USER GUIDE

© 2016 Neustar, Inc. All rights reserved.

Table C-1 Error Messages

OH_ Invalid OLNS, Originating Free Directory Assistance indicator is invalid

OI_ Invalid OLNS, Originating Special Billed Number Screening indicator is invalid

OJ_ Invalid OLNS, Originating Sent Paid indicator is invalid

OK_ Invalid OLNS, Originating Billing Services/Spare indicator is invalid

OL_ Invalid OLNS, Originating Directory Assistance Call Completion indicator is invalid

OM_ Invalid OLNS, Originating Interexchange Carrier indicator is invalid

ON_ Invalid OLNS, Originating Interexchange Carrier is invalid

OO_ Invalid OLNS, Originating International Carrier indicator is invalid

OP_ Invalid OLNS, Originating International Carrier is invalid

OQ_ Invalid OLNS, Foreign Language ID is invalid

OR_ Invalid OLNS, Treatment indicator is invalid

OS_ Invalid OLNS, Additional Originating Credit Card indicator is invalid

OT_ Invalid OLNS, Additional Originating 3rd Number indicator is invalid

OU_ Invalid OLNS, Additional Originating Special Billed Number Screening indicator is invalid

OV_ Invalid OLNS, Additional Originating Sent Paid indicator is invalid

OW_ Invalid OLNS, Additional Originating Billing Services/Spare indicator is invalid

OX_ Invalid OLNS, Xensblk is invalid

OY_ Invalid OLNS, Intra-LATA Pre-Subscription indicator is invalid

OZ_ Invalid OLNS, Intra-LATA Pre-Subscription Code is invalid