<<

CIRA Registrar Documentation

.CA Registry Guide for Registrars

Version: 4.06 Release: June 3, 2011 2 .CA Registry Guide for Registrars: Version 4.06 DISCLAIMER AND COPYRIGHT NOTICE Everything in this document is protected by copyright. You may make a copy of any material in this document, but only if you use it for personal, educational or non-commercial purposes. If you use it for any of these purposes, you must acknowledge the source and include this disclaimer and copyright notice on each copy. CIRA shall have the right, at its sole and absolute discretion, to modify, add, or remove any part or parts of this document without any notice whatsoever to you. Any changes to this document shall be effective immediately unless otherwise stated by CIRA. You agree that any use or copying of this document by you constitutes your fully informed acceptance of these terms. The document was last modified on May 31, 2011.

This document provides technical details for system functions that CIRA provides to Registrars. It also provides, for the Registrar's convenience, summaries of certain CIRA policies, rules, and procedures. CIRA does not guarantee nor represent that the summaries of CIRA policy, rules and procedures contained in this document are reflective of the actual policies, rules, and procedures. Registrars are urged to consult the authoritative version of the relevant CIRA policies, rules and procedures before proceeding with any process. CIRA does not accept any liability for a Registrar's reliance on the summaries contained herein. The authoritative version of all CIRA policies, rules and procedures are available at http://www.cira.ca/registrars- documents.

Copyright © 2011 Canadian Internet Registry Authority (CIRA) 350 Sparks Street, Suite 306, Ottawa, Ontario K1R 7S8, Canada www.cira.ca Printed in Canada

.CA Registry Guide for Registrars: Version 4.06 3 4 .CA Registry Guide for Registrars: Version 4.06 Preface About the .CA Registry Guide for Registrars ...... 9 Audience ...... 9 Document Conventions...... 9 Notes, and cautions...... 9 Text conventions...... 10 Related documents...... 10 References ...... 10 Getting help...... 10 Send us your comments ...... 11

Chapter 1 Getting Started ...... 13 CIRA ...... 13 Becoming a Registrar...... 13 Canadian Presence Requirements ...... 13 Accessing CIRA System Interfaces ...... 14 Interfaces for Registrars ...... 14 Interfaces for Registrants...... 14 Interfaces for Everyone...... 15

Chapter 2 .CA Registry Concepts ...... 17 Understanding Registry Objects ...... 17 Contacts...... 17 Domain Names...... 18 Hosts...... 19 Sponsorship ...... 20 Status values...... 20 Service Messages...... 20 Life Cycle ...... 20 Life Cycle Stages...... 21 Life Cycle Diagrams...... 27

Chapter 3 Overview of Business Processes ...... 31 Creating a New Registration ...... 31 Registrant Requirements...... 31 Registrar Requirements...... 31 Registrar Deposit Account Balance ...... 33 Creating Registrant contacts...... 34 Presenting CPR Categories ...... 34 Understanding CPR Categories for Registrants ...... 35 Valid Canadian Presence Requirement values...... 35 Registrant WHOIS Privacy...... 36 WHOIS Privacy Settings...... 36 Understanding the CIRA Registrant Agreement ...... 36 Registrar displaying the Agreement on their ...... 37 Using CIRA's Registrant Agreement Page...... 38 Updating the agreement to a new version...... 38 Providing Reseller IDs...... 38 Providing Registrant IP Addresses ...... 38 Creating a Domain Name...... 38

.CA Registry Guide for Registrars: Version 4.06 5 Requesting a Specialized Domain Name...... 39 Creating a Host ...... 39 Updating a domain name...... 39 Renewing Registrations ...... 40 Deleting Registrations ...... 40 Transferring Registrations...... 40 Transferring a Domain Name ...... 40 Notification Emails...... 41 Optional Email Co-branding...... 42 TBR...... 42

Chapter 4 EPP Interface Overview ...... 45 Accessing the Registry EPP Service ...... 45 EPP Client and Server Configuration...... 45 Establishing an EPP connection ...... 46 CIRA Greeting ...... 46 Hello request...... 46 Greeting response ...... 47 EPP Encoding ...... 47 XML...... 47 Special Characters ...... 48 EPP Date and Time Representation...... 48 Request / Response Overview...... 48 Login ...... 49 Logout ...... 52 Service Messages...... 54 Poll...... 54 EPP Service Messages ...... 56 Poll Acknowledgement ...... 61

Chapter 5 .CA Manager Interface ...... 65 Accessing .CA Manager...... 65 Reports ...... 65 Financial Summary...... 66

Chapter 6 Contacts ...... 67 Contact Object ...... 67 Status Values...... 69 Contact Info...... 70 Contact Check...... 75 Contact Create ...... 79 Get Agreement...... 90 Contact Delete ...... 91 Contact Update ...... 94

Chapter 7 Hosts ...... 107 Host Object ...... 107 Host Info...... 108 Host Check...... 113

6 .CA Registry Guide for Registrars: Version 4.06 Host Create ...... 116 Entering name server data ...... 121 Host Update ...... 122 Host Delete ...... 130

Chapter 8 Domains ...... 135 Domain Object ...... 135 About Valid Domain name formats...... 135 Domain Info...... 138 Domain Check...... 144 Domain Create ...... 148 Domain Delete ...... 159 Domain Renew ...... 164 Domain Update ...... 169 Domain Transfer ...... 180

Appendix A Appendix A ...... 191 Valid Formats and Data Values ...... 191 Understanding legal types for Registrants ...... 191 Corporation (Canada or Canadian province or territory) ...... 191 Canadian citizen ...... 191 Permanent resident of Canada...... 192 Government or government entity in Canada...... 193 Canadian educational institution...... 193 Canadian unincorporated association ...... 194 Canadian hospital...... 195 Partnership registered in Canada...... 195 Trade-mark registered in Canada by non-Canadian owner...... 196 Canadian trade union ...... 196 Canadian political party ...... 197 Canadian library, archive or museum...... 197 Trust established in Canada...... 198 Aboriginal Peoples (individuals) indigenous to Canada...... 198 Aboriginal Peoples (groups) indigenous to Canada ...... 199 Indian Band recognized by the Indian Act of Canada...... 199 Legal representative of a Canadian citizen or permanent resident ...... 200 Official marks registered in Canada...... 201 Her Majesty the Queen...... 201 About valid and invalid Contact names ...... 201 Authorization Information ...... 204 Domain Names ...... 204 Email Addresses ...... 205 IP Addresses...... 205 Postal Codes...... 205 Telephone and Fax Numbers...... 205 Country Codes ...... 206 Province Codes...... 213 State, Territories and Region Codes of the United States ...... 214

Appendix B Appendix B ...... 217

.CA Registry Guide for Registrars: Version 4.06 7 Scope ...... 217 Revised CPR Categories ...... 217 Presenting CPR Categories to Registrants ...... 222 Changes to the Contact Create Request ...... 222

Appendix C Appendix C ...... 231 About Reports ...... 231 Activity Summary ...... 231 Pending Contacts ...... 232 Financial Transactions...... 232 Financial Summary...... 233 Reconciliation Reports ...... 233 Registrars ...... 233 Contacts...... 233 Addresses...... 234 Contact Statuses ...... 235 Domains...... 235 Domain Statuses ...... 237 Domain Contacts ...... 237 Hosts...... 238 Host Statuses ...... 238 Domain Hosts ...... 238

8 .CA Registry Guide for Registrars: Version 4.06 Preface

About the .CA Registry Guide for Registrars This document describes: • The structure of the .CA Registry, including its various object types, such as Registrars, users, contacts, domain names, hosts • Operations that can be performed on each type of object, including Registry policies that require or prohibit certain field values and relationships between objects • The Extensible Provisioning Protocol (EPP) interface protocol that can be used by an authorized Registrar’s computer system to access and manipulate Registry objects • The To be released (TBR) domain names process • The Registrar web browser, .CA Manager, interface that authorized people can use to access and manipulate Registry objects Audience This document is intended for CIRA Certified Registrars. The purpose of this document is to give Registrars the information and specifications required to effectively communicate with the CIRA Registry. You can access a copy of this document at this web address: https://services.cira.ca/DotCaManager Document Conventions The following conventions are used in this document.

Notes, and cautions Notes and cautions are used to alert you to important information or risks.

Notes Notes use the following convention:

Note This text contains important and helpful information.

Cautions Cautions use the following convention:

Caution This text contains important information that may help prevent unexpected results or data loss.

.CA Registry Guide for Registrars: Version 4.06 9 Preface Getting help

Text conventions Function and parameter names are enclosed in single quotes, ‘lang’. Elements are enclosed in angular brackets, . A title name located within a cross reference is enclosed in double quotes, “.CA Registry Guide for Registrars”. Cross references and hypertext links are in blue font, http://www.cira.ca.

Related documents To view other technical documentation access the following links: https://services.cira.ca/DotCaManager http://www.cira.ca/registrars-technical-documents/?lang=en

Release Note for Updates to the Technical Specifications Documents the publication history and changes (if any), to the Technical Specifications for Registrars between quarterly release dates.

Working with the .CA Manager Documents how to work with new functions developed for CIRA’s .CA Manager.

References The following documents were referenced in the creation of this document: Hollenbeck, S. Extensible Provisioning Protocol (EPP). RFC 4930. , Inc., Dulles, Virginia, May 2007. Hollenbeck, S. Extensible Provisioning Protocol (EPP) Domain Name Mapping. RFC 4931. Versing, Inc., Dulles, Virginia, May 2007. Hollenbeck, S. Extensible Provisioning Protocol (EPP) Host Mapping. RFC 4932. VeriSign, Inc., Dulles, Virginia, May 2007. Hollenbeck, S. Extensible Provisioning Protocol (EPP) Contact Mapping. RFC 4933. VeriSign, Inc., Dulles, Virginia, May 2007.

Getting help You can email your questions to the Registration Services Department at: [email protected] CIRA’s normal business hours are from 8:30 am to 4:30 pm, Monday through Friday. The emergency technical support telephone number is (613) 237-0324. CIRA provides emergency technical support to CIRA system users outside normal CIRA business hours. Emergencies are problems or issues that impact a system or process and cannot be postponed for resolution until the next CIRA business day.

10 .CA Registry Guide for Registrars: Version 4.06 Preface Send us your comments

Note CIRA may charge a fee for calls made to this service for issues that are of a non- emergency status.

Send us your comments We welcome any comments that you have about our documentation. Send your comments to us at: [email protected]

.CA Registry Guide for Registrars: Version 4.06 11 Preface Send us your comments

12 .CA Registry Guide for Registrars: Version 4.06 Chapter 1

Getting Started

CIRA The Canadian Internet Registration Authority (CIRA) is the not-for-profit corporation that manages the .CA domain space on behalf of all Canadians. CIRA activities include: • Managing the .CA domain name space • Operating DNS services for .CA domain names • Developing and implementing domain name policy • Facilitating .CA dispute resolution • Accrediting and licensing Registrars • Running a WHOIS service for .CA domain names • Representing CIRA as a member of the Internet Corporation for Assigned Names and Numbers (ICANN) and other international organizations. A fifteen-member Board of Directors consisting of elected and appointed members oversee CIRA's operations. Board members are elected annually by CIRA Members through an online process. Membership in CIRA is free, and open to anyone who holds a .CA domain name. Becoming a Registrar Information about becoming a Registrar is available on the CIRA website. Canadian Presence Requirements The .CA domain name space has been developed as a key public resource for the social and economic development of all Canadians. Therefore, individuals or organizations that wish to register a .CA domain name must meet CIRA's Canadian Presence Requirements (CPR). Each Registrant must indicate to CIRA how they qualify for a .CA domain name by indicating which CPR category they belong to. In addition, CIRA requires that every Registrant agree to the CIRA Registrant Agreement to ensure that there is a legally binding relationship between the two parties. For more information you can refer to the CIRA POLICIES, RULES AND PROCEDURES Canadian Presence Requirements for Registrants located at: http://www.cira.ca/registrant-documents

.CA Registry Guide for Registrars: Version 4.06 13 Getting Started Chapter 1 Accessing CIRA System Interfaces

Accessing CIRA System Interfaces

Interfaces for Registrars

Introduction to Extensible Provisioning Protocol (EPP) Interface Registrars are encouraged to communicate their registry management requests to CIRA through automated computer-to-computer communication. CIRA's new Registry management system utilizes the Extensible Provisioning Protocol (EPP) for this communication, and has extended EPP to meet Canadian registry requirements. EPP is an XML-based client-server protocol, where the Registrar interacts with the CIRA EPP server through a set of XML commands. These commands identify the Registrar, manipulate contact, host, and domain name information, and request delivery of Registry service messages to the Registrar. For additional information about the EPP interface for Registrars and the functionality that it provides, see “EPP Interface Overview” on page 45

Introduction to .CA Manager Interface CIRA provides a web interface, ".CA Manager", used for managing Registrar-specific information (such as co-branding logos for CIRA-generated email notifications to Registrants), requesting reports, and monitoring the Registrar's account balance to ensure their account has sufficient funds. .CA Manager can also be used to manually submit registry management requests. Certain seldom- used registry management requests, such as registering a municipal domain name, can only be submitted using .CA Manager. You can obtain access credentials for .CA Manager by contacting CIRA Registration Services at [email protected].

Note It is possible to lock out a user login for one hour after five failed login attempts. This is a security feature.

Introduction to the TBR ("To Be Released" Domain Names) Interface A "To Be Released" domain name (TBR) is a previously registered domain name that was deleted and is available for re-registration during a special registration session known as a TBR session. The TBR process allows Registrars to compete for TBR domain names. The new EPP system does not make significant changes to the existing TBR system. See also http://www.cira.ca/tbr-2010

Interfaces for Registrants

CIRA Registrant Agreement CIRA requires that every .CA domain name Registrant agree to the CIRA Registrant Agreement. CIRA strongly encourages Registrars to present the CIRA Registrant agreement to Registrants on behalf of CIRA because this simplifies the registration process and hence lowers Registrar's support costs.

14 .CA Registry Guide for Registrars: Version 4.06 Chapter 1 Getting Started Accessing CIRA System Interfaces

Alternately, the Registrar can direct the Registrant to a specific page on the CIRA website to agree to the CIRA Registrant Agreement.

Caution CIRA does not send an email to direct a Registrant to come to the CIRA site to agree to the Registrant agreement

For more information about the option of directing a Registrant to the CIRA Agreement Landing Page to agree to the CIRA Registrant Agreement, see “Understanding the CIRA Registrant Agreement” on page 36.

Registrant membership Membership in CIRA is free and open to anyone who holds a .CA domain name. CIRA Members are part of a group of .CA domain name holders who influence CIRA. Members are entitled to: • Attend and vote at CIRA's annual general meetings • Nominate candidates for CIRA's Board of Directors • Vote in the Board of Directors elections • Participate in consultations and surveys • Bring forward issues or concerns to CIRA Members and Directors CIRA encourages Registrars to forward Registrants to the CIRA Member website at https://member.cira.ca/en/index.html.

Interfaces for Everyone

WHOIS CIRA publishes domain name registration information to the public on the CIRA WHOIS system available at: http://whois.cira.ca/public and through direct computer communications using port 43. WHOIS records show: • domain name status • who is responsible for the domain name (Registrant and Administrative Contact) • other key information, such as the Technical Contact, host names, and Registrar information. For Registrants classified as "individuals", WHOIS may or may not display information about individual Registrants and their Administrative and Technical Contacts. Registrars must provide "individual" Registrants an interface whereby the Registrant indicates whether their contact information should be shown or hidden in WHOIS. Contact information of corporate Registrants is displayed by default and can be protected only in special circumstances; only CIRA can apply privacy protection to a non-individual Registrant.

.CA Registry Guide for Registrars: Version 4.06 15 Getting Started Chapter 1 Accessing CIRA System Interfaces

For information about CIRA's privacy policies, see CIRA Policies, Rules and Procedures, CIRA Privacy Policy at: http://www.cira.ca/assets/Documents/Legal/Registrants/privacy.pdf

Message Delivery to Private Registrants When Registrant information is not disclosed to the public through WHOIS, CIRA offers a mechanism whereby an interested party can send a message to the Registrant via the CIRA website at https://registrants.cira.ca/message/delivery/en Persons can request disclosure of Registrant information under certain limited and specified circumstances. See CIRA's policy "Request for Disclosure of Registrant Information - Rules and Procedures" at: http://www.cira.ca/assets/Documents/Legal/Dispute/disclosureregistrant.pdf Law enforcement and National Security agencies can request disclosure of Registrant information in a manner consistent with the principles set out in the Personal Information Protection and Electronic documents Act. See CIRA's policy "Request for Disclosure of Registrant Information for Law Enforcement and National Security Agencies - Rules and Procedures" at: http://www.cira.ca/assets/Documents/Legal/Dispute/disclosurelaw.pdf

16 .CA Registry Guide for Registrars: Version 4.06 Chapter 2

.CA Registry Concepts This chapter summarizes .CA Registry concepts and introduces some of the basic terminology. Understanding Registry Objects Registry objects are entities in the .CA Registry that represent equivalent objects in the Domain Name System (DNS). The Registry defines three main objects types: •contacts •domains •hosts

Contacts Registrants, administrative contacts, and technical contacts are all represented as contact objects in the Registry. Each contact must be identified by an ID that is unique in the entire registry and is created by the Registrar. In the case of individual Registrants, it is common for one contact to perform all three roles for a domain name.

Registrant The Registrant is the entity that has the authority to use and manage the domain name. The .CA Registry classifies each Registrant as either an individual Registrant, or a non-individual Registrant. Because CIRA manages the .CA domain name space as a resource for Canadians, CIRA requires that every .CA domain name Registrant complies with CIRA's Canadian Presence Requirements and agree to the CIRA Registrant Agreement. Canadian Presence Requirements are set out in the General Registration Rules and the Registrant Agreement between CIRA and registrants. Read more about the Canadian presence requirements in “Overview of Business Processes” on page 31. There are also the Administrative Contact and the Technical Contact. A domain name must have one Registrant contact, one Administrative contact and optionally may have up to three technical contacts.

Administrative Contact An Administrative Contact is either the Registrant or someone authorized to act on behalf of the Registrant. Both the Administrative Contact, and the Registrant are notified of important changes to a domain name registration. Typically, in the case of a company, the company is the Registrant, a trusted employee or third party is the Administrative Contact.

Technical Contact A technical contact is an individual identified as a contact for technical information-related administration of a registered domain name.

.CA Registry Guide for Registrars: Version 4.06 17 .CA Registry Concepts Chapter 2 Understanding Registry Objects

You can perform the following requests for contact objects; check availability, view information, create, update, and delete. See “Contacts” on page 67, for information about contacts and contact functionality.

Domain Names A domain name comprises sequence of "segments" separated by periods. A domain name segment is a string of letters and numbers, as short as two characters and no longer than 63 characters. A hyphen cannot be used to start a domain name or end a domain name, but is acceptable within a domain name. Domain names which match the name of an existing top-level domain, such as com.ca or ca.ca, are restricted and therefore not available for registration. Domain names that begin with the four characters "xn--" are not available for registration. In addition, accented characters or other symbols are not accepted within domain names at this time. See“Domains” on page 135 for information about domain objects and domain functionality. You can perform the following requests for domain objects; check availability, view information, create, update, renew, transfer, and delete.

Second level domain names In the Domain Name System hierarchy, a second-level domain is a domain name that is directly below a top-level domain (TLD). The top-level domain for Canada is .ca. The second-level domain name includes the top-level domain name. For example, in: cira.ca, the segment “cira” is second level and the segment “ca” is the top level. The following is an example of a domain name at the second level: – “abc.ca” (2nd level, which comprises “name – dot – extension”)

Third level domain names Typically a third-level domain name consists of a string of supported characters, separated by dots. The third level .CA domain name uses the following format: – “abc.on.ca” or “abc.bc.ca” or “abc.qc.ca” (3rd level, which comprises “name – dot – province – dot – extension”)

Note Although third-level domain names can no longer be created, existing 3rd and 4th level domain names can be transferred and renewed. CIRA continues to support existing 3rd and 4th level domain names as well as 2nd and 4th level municipal domain names. Third-level domain names that are deleted and not subsequently renewed will not be available as TBR domain names.

Fourth level domain names Typically, a fourth-level domain name consists of a string of supported characters, separated by dots. The fourth level .CA domain name uses the following format: – “abc.ottawa.on.ca” or “abc.montreal.qc.ca” (4th level, which comprises “name – dot – city – dot – province – dot – extension”)

18 .CA Registry Guide for Registrars: Version 4.06 Chapter 2 .CA Registry Concepts Understanding Registry Objects

Note Although fourth-level domain names (except 4th-level municipal) can no longer be created, existing 4th level domain names can be transferred and renewed. CIRA continues to support existing 4th level domain names as well as 2nd and 4th level municipal domain names.

Second and fourth level municipal domain names The second-level domain name includes the top-level domain name. For example, in: cira.ca, the segment “cira” is the second level and the segment “ca” is the top level. The following example of a domain name at the second level: – “vancouver.ca” (2nd level, which comprises “name – dot – extension”) The domain name of the fourth level is characterized by a string of supported characters, separated by dots. The fourth level .CA domain name, uses the following format: – “ville. gatineau. qc. ca” (4th level, which comprises “municipal identifier– dot – city – dot – province – dot – extension”)

Note These domain names are reserved for the exclusive use of the municipalities

Provincial domain names Provincial .CA domain names represent all the Canadian provinces and territories. The following is an example of a provincial domain name: –ontario.ca

Note These domain names are reserved for the exclusive use of the provinces and territories

Restricted domain names There is a small set of domain names that you cannot register through the regular registration process. These domain names are called restricted domain names. A query to the CIRA WHOIS system for a restricted domain name will show the name as being restricted.

Hosts A host (also known as a name server) is a computer that uses DNS to resolve domain names into IP addresses. The Registry maintains and publishes information about which hosts contain IP address information for registered domain names. Entering name server data for a domain name is not mandatory. CIRA supports both IPv4 and IPv6 address types for hosts. An IPv4 address is a unique 32-bit identifier that consists of a set of four numbers, in the range of 0 to 255, separated by periods. For example, 64.230.164.58 An IPv6 address is a unique 128-bit identifier. IPv6 notation consists of eight groups of four hexadecimal digits, separated by colons. For example, 2001:db8:0000:0000:0000:0000:0000:5b0f CIRA supports entering IPV6 IP addresses in standard shorthand notations such as: • removing the leading zeros in a group

.CA Registry Guide for Registrars: Version 4.06 19 .CA Registry Concepts Chapter 2 Sponsorship

• replacing one or more consecutive groups that consist entirely of zero values with two colons (::). This can only be done once in an address. For more information about hosts refer to “Hosts” on page 107 Sponsorship Each Registry object has a Registrar "sponsor", initially the Registrar who requested that the object be created in the Registry. Domain name sponsorship is changed by the domain transfer process. Only the sponsoring Registrar (or CIRA) can usually see full information about an object or modify it. However, Registrars can see full information for all hosts regardless of sponsorship. CIRA is committed to protecting the rights and privacy of registrants of .CA domain names, Registrars who are not the sponsor of a contact or domain name can only see information that is available through WHOIS.

Status values Each Registry object has an associated set of possible status values. Setting a status value causes the Registry to prohibit associated operations on the object (such as update, transfer, or delete). A “hold” status prevents DNS from resolving a domain name. Some status values may be set or reset by a Registrar; these are known as "client status flags". Other status values may only be set by the Registry; these are known as "server status values". These may be set automatically according to CIRA policies for domain life cycle management, or explicitly by CIRA Registration Services. Service Messages The Registry uses service messages to inform Registrars about important changes or events. These messages are queued for delivery using either EPP or .CA Manager. Registrars are required to retrieve their service messages at least once per week. See “EPP Service Messages” on page 56 about poll queues. Domain Name Life Cycle The domain life cycle are the states that a domain name passes through from the beginning of the life cycle (available state) to the end of the life cycle (available state). The CIRA Registry implements a domain life cycle similar to the gTLD life cycle. The domain name life cycle can be varied and starts when the domain name is registered. When you renew, the number of years that you add plus the time left in the registration period cannot exceed 10 years Extensions to the gTLD life cycle are the Pending Create and To Be Released life cycle stages. The Pending Create stage is used when a Registrant has not yet accepted the CIRA Registrant agreement. The “To Be Released stage” is used to continue the current TBR system. Auto-Renew Grace and Redemption Grace are standard gTLD life cycle stages.

Grace Periods Grace periods are restrictions that prevent certain actions. Many important grace periods occur within a certain amount of time following the registration of a domain name, or following a transaction that could change who the holder of the domain name is. In many cases, grace periods

20 .CA Registry Guide for Registrars: Version 4.06 Chapter 2 .CA Registry Concepts Domain Name Life Cycle

are used in order to allow CIRA to correct any errors or fraudulent activities around high risk transactions. Grace periods also exist to allow a certain flexibility within the Registry and to allow actions to be reversed after a short time. Grace periods are used in the following situations: – registering a new domain name – waiting for a new Registrant to sign the CIRA Agreement – transferring a domain name – deletion of a domain name

Life Cycle Stages

Available Domain names are available for registration and the Registrant meets the CIRA registration criteria. Domain names in this life cycle stage are not in the zone file and do not have a Registrar sponsor. Table 1: Available Life Cycle Stage

Event Registry Actions Domain Create If Registrant contact has not accepted Registrant Agreement: request • Set life cycle stage to Pending Create • Set serverHold status flag • Set serverUpdateProhibited Change Registrant and serverTransferProhibited status flags for 60 days Otherwise: • Set life cycle stage to Add Grace • Set serverUpdateProhibited Change Registrant and serverTransferProhibited status flags for 60 days Request to register Set life cycle stage to Pending Create municipal domain Set pendingCreate status flag Set serverUpdateProhibited Change Registrant and serverTransferProhibited status flags for 60 days

Pending Create The Pending Create stage is used when a domain name is created for a Registrant that has not yet accepted the CIRA Registrant agreement. When this occurs the contact is also in the Pending Create state; if this condition persists for 7 days the domain name moves to the Pending Delete stage. The domain name would not enter the Pending Create state if the Registrar had presented the CIRA Registrant Agreement directly to the Registrant during the registration process.

.CA Registry Guide for Registrars: Version 4.06 21 .CA Registry Concepts Chapter 2 Domain Name Life Cycle

The Pending Create stage is also used when a Registrar requests a municipal domain name. In this case, the domain name remains in the Pending Create state until CIRA approves or denies the request. A Registrar can delete a domain name that is in the Pending Create state. If the registration is deleted the registration fee is refunded to the Registrar. DNS does not resolve domain names in the Pending Create stage. Table 2: Pending Create Life Cycle Stage

Event Registry Actions Registrant accepts Set life cycle stage to Add Grace agreement on CIRA Reset serverHold status flag Registrant Agreement web page CIRA RSU accepts Set life cycle stage to Add Grace registration request Reset serverHold status flag (CPR and municipal domain criteria) CIRA RSU rejects Set life cycle stage to Pending Delete registration request Set serverHold, serverDeleteProhibited, serverUpdateProhibited, (CPR or municipal serverTransferProhibited, and serverRenewProhibited status flags domain criteria) Reset status flag 7 days after stage Set life cycle stage to Pending Delete began and the Set serverHold, serverDeleteProhibited, serverRenewProhibited, Registrant has still not serverTransferProhibited, and serverUpdateProhibited status flags agreed to the CIRA Registrant agreement, Add message to poll queue the domain name is deleted by CIRA

Add Grace Period When the Registrant contact has agreed to CIRA Registrant Agreement, a newly created domain name enters the Add Grace Period stage. A Registrar can delete a domain name during the Add Grace Period. When a Registrar deletes a domain name that is still in the Add Grace period, the Registrar may receive a refund of the registration fee. The maximum daily allowance is 5% of the total number of domain names that have been registered by the Registrar within the last 30 days. A domain name that is deleted during the Add Grace Period directly enters the Pending Delete stage without entering the To Be Released stage. DNS resolves domain names in the Add Grace Period stage, usually within 1 hour. If the Add Grace Period stage persists for 5 days, the domain name enters the Registered stage. For 60 days after the domain name entered the Add Grace Period, the domain name cannot be transferred to another Registrar, nor can the Registrant contact ID be updated.

22 .CA Registry Guide for Registrars: Version 4.06 Chapter 2 .CA Registry Concepts Domain Name Life Cycle

Table 3: Add Grace Life Cycle Stage

Event Registry Actions Domain Delete Set life cycle stage to Pending Delete request Set serverHold, serverUpdateProhibited, serverTransferProhibited, serverRenewProhibited, and pendingDelete status flags Domain Renew Update registration period request Reduces the Registrar financial balance 5 days after stage Set life cycle stage to Registered began Set serverDeleteProhibited status flag Set serverTransferProhibited status flag for next 55 days Set serverUpdateRegistrantProhibited status flag

Registered A domain name is registered and active when the Registrant has agreed to the CIRA Registrant agreement. A domain name can be renewed and remain in the registered state indefinitely. A Registrar cannot delete a domain name in the Registered stage. Of course, DNS resolves domain names in the Registered stage. If the Registrar's account has sufficient funds when a domain name registration expires, the registry automatically renews the registration for one year, moves the domain name to the Auto Renew Grace Period, and charges the Registrar's account accordingly. However, if the Registrar's account does not have sufficient funds when a domain name registration expires, the domain name moves immediately to the Redemption Grace Period.

Table 4: Registered Life Cycle Stage

Event Registry Actions Domain Transfer at If serverTransferProhibited status flag is not set, least 60 days after – Transfer domain life cycle stage began Set serverTransferProhibited status flag for 60 days Set serverUpdateProhibited Change Registrant flag for 60 days 14 days after domain If the domain Registrant contact is a Registrar’s special TBR Registrant: was registered in – Set life cycle stage to To Be Released TBR session Otherwise: – Set serverUpdateProhibited Change Registrant status flag Note that the Registrar must transfer the successfully TBR registered name to a valid contact within 14 days

.CA Registry Guide for Registrars: Version 4.06 23 .CA Registry Concepts Chapter 2 Domain Name Life Cycle

60 days after Domain Remove serverUpdateProhibited Change Registrant and Create serverTransferProhibited status flags Domain Update to If (at least 60 days after registration) change Registrant OR (if TBR registered domain and within 14 days): (Note: a new – Update domain Registrant contact Registrant is a Set serverUpdateProhibited Change Registrant flag for 60 days different individual than the original Set serverTransferProhibited status flag for 60 days Registrant) Domain Update to If (at least 60 days after registration) change Registrant OR (if TBR registered domain and within 14 days): (Registrant is same – Update domain Registrant contact individual) Note that the Registrant must meet the system requirements and qualify as the same individual. This means that the CPR category and name do not change. 60 days after Reset serverUpdateProhibited Change Registrant flag successful Domain Update to change Registrant If Registrar Deposit Account has sufficient funds: expires – Set life cycle stage to Auto-Renew Grace Period – Perform auto-renewal for 1 year – Reset serverDeleteProhibited status flag – Otherwise domain name is moved to Redemption Grace Period If Registrar Deposit Account has insufficient funds: – Set life cycle stage to Redemption Grace Period – Set severHold, serverUpdateProhibited(All), serverDeleteProhibited

Auto-Renew Grace Period A Registrar can delete a domain name in the auto-renew grace period stage and thereby obtain a refund of the renewal fee; the domain name then enters the Redemption Grace Period. Alternatively, in the auto-renew grace period a Registrar could get the attention of a Registrant that has not paid for their domain name renewal by setting the domain name "clientHold" status. DNS resolves domain names in the auto-renew grace stage unless clientHold status is set. If a Registrar to Registrar domain name transfer occurs during auto-renew grace period, the domain name enters the Registered stage.

24 .CA Registry Guide for Registrars: Version 4.06 Chapter 2 .CA Registry Concepts Domain Name Life Cycle

Note If within 45 days of an auto-renew by the CIRA Registry system, a Registrant chooses to transfer the domain name to a new Registrar, the fee that was charged to the “losing” Registrar is refunded. The payment responsibility is given to the gaining Registrar. The gaining Registrar is charged a 1 year renewal fee upon the successful transfer

If the auto-renew grace period stage persists for 45 days, the domain name enters the Registered stage. In cases where a full year is not added because of the maximum number of years limit (10 years), the gaining Registrar is still charged the transfer fee.

Table 5: Auto Renew Grace Life Cycle Stage

Event Registry Actions Domain Delete Set life cycle stage to Redemption Grace request Set serverHold, serverUpdateProhibited “all” and serverDeleteProhibited status flags If the domain name is still in the Auto Renew Grace period, the registration fee is refunded to the Registrar 45 days after stage Set life cycle stage to Registered began Set serverDeleteProhibited status flag, Unset clientHold if present

Redemption Grace Period In the Redemption Grace Period, the sponsoring Registrar can still renew the domain name. DNS does not resolve domain names in the Redemption Grace Period stage because the Registry has set the serverHold status. If the Redemption Grace Period stage persists for 30 days, the domain name enters the To Be Released stage (unless it is an existing 3rd or 4th level domain name or a municipal domain name). Table 6: Redemption Grace Life Cycle Stage

Event Registry Actions Domain Renew Set life cycle stage to Registered, note that no additional fee, beyond the request renewal fee, is charged Set serverDeleteProhibited 30 days after stage Set life cycle stage to To Be Released began Set serverDeleteProhibited, serverRenewProhibited, serverTransferProhibited, serverUpdateProhibited Change Registrant, and serverUpdateProhibited status flags set to all

.CA Registry Guide for Registrars: Version 4.06 25 .CA Registry Concepts Chapter 2 Domain Name Life Cycle

To Be Released CIRA uses the To Be Released stage to integrate the registry with CIRA's current TBR system. DNS does not resolve domain names in the To Be Released stage. These domain names have serverHold status set and all server status values set to "prohibited". A domain name must be in the To Be Released stage (and be published in the CIRA TBR list) for at least 60 hours, after which it is listed in the next TBR session; these sessions occur every Wednesday at 14:00 Eastern time. Domain names in a TBR session are eligible for re-registration on a first-come, first-served basis. If a Registrar successfully gains a TBR domain name, CIRA sets the domain name's Registrant contact to a Registrar-specific "generic TBR Registrant". If the gaining Registrar does not update the domain name within 14 days to reassign the TBR domain name to "real" Registrant and Administrative contacts, the Registrar loses the domain name and restarts its TBR processing. Domain names that are not registered during a TBR session enter the Pending Delete stage.

Table 7: To Be Released Life Cycle Stage

Event Registry Actions Domain was Set life cycle stage to Registered registered in TBR Set serverDeleteProhibited status flags session Set serverTransferProhibited status flag for 60 days After 14 days set serverUpdateProhibited Change Registrant status flag (See also Table 4: “Registered Life Cycle Stage” on page 23) Disable serverHold status flag Domain was not Set life cycle stage to Pending Delete registered in TBR Set serverDeleteProhibited, serverRenewProhibited, session serverTransferProhibited, serverUpdateProhibited Change Registrant, and serverUpdateProhibited status flags

Pending Delete Pending Delete domain names are in a one day period where the domain name is prepared for release to the “available” state. While the domain name is in the Pending Delete state, the domain name is not in the zone file. No Registrar request or action can affect a domain name in the Pending Delete life cycle stage.

Table 8: Pending Delete Life Cycle Stage

Event Registry Actions 1 day after stage began Set domain registration status to Available Reset all status flags (serverHold is implied for an available domain) and delete domain contacts and domain details if applicable

26 .CA Registry Guide for Registrars: Version 4.06 Chapter 2 .CA Registry Concepts Domain Name Life Cycle

Life Cycle Diagrams The following sub-topics contact a variety of domain name life cycle diagrams that in some cases illustrate certain grace periods.

Domain name life cycle Figure 1: The Life cycle provides a graphical example of the general CIRA domain life cycle.

Figure 1: Life cycle

Re-assign Registrant Grace Period The Re-assign Registrant figure below illustrates the 60-day period that does not allow the re- assignment of a Registrant and the period after which the re-assignment is permitted. At any time during the registered stage when a Registrar to Registrar transfer occurs, the 60-day period following this transfer does not permit a Registrant re-assignment. See the Domain Update section of this document for more information about re-assigning a Registrant.

Figure 2: Re-assign Registrant

.CA Registry Guide for Registrars: Version 4.06 27 .CA Registry Concepts Chapter 2 Domain Name Life Cycle

Re-assign Registrant for TBR domain name Grace Period When a Registrar purchases a domain name during a TBR session, the Registrar is also the Registrant. The Registrar can then re-assign the domain name to the actual Registrant within the initial 14-day period.The Registrant cannot be re-assigned again for a 60 day period.

Figure 3: Re-assign Registrant (TBR) displays the stage in the life cycle where a reassignment of the domain name obtained during a TBR session, from a generic Registrant to a Registrant can occur.

Note The re-assignment from a TBR Registrant to a Registrant must be done within the first 14 days

Figure 3: Re-assign Registrant (TBR)

Transfer Grace Period When a domain name is first created, a Domain Transfer is not permitted until the domain name is 60 days old. See the “Domain Transfer” on page 180 for more information about a Registrar to Registrar transfer. Figure 4: Registrar to Registrar Transfer, where in the life cycle a Registrar can transfer a domain name.

28 .CA Registry Guide for Registrars: Version 4.06 Chapter 2 .CA Registry Concepts Domain Name Life Cycle

Figure 4: Registrar to Registrar Transfer

Deletion Grace Period Only the sponsoring Registrar or the Registry can delete a domain name. Registrars can delete domain names that are in the Add Grace and Auto-renew periods of the life cycle. In the Add-Grace period, the maximum daily allowance is 5% of the total number of domain names that have been registered by the Registrar in the last 30 days. See the “Domain Delete” on page 159 for information about deleting a domain name. Figure 5: Deletions displays the two periods where a Registrar can delete a domain name.

Figure 5: Deletions

.CA Registry Guide for Registrars: Version 4.06 29 .CA Registry Concepts Chapter 2 Domain Name Life Cycle

30 .CA Registry Guide for Registrars: Version 4.06 Chapter 3

Overview of Business Processes This chapter summarizes business tasks and activities related to registry object management. Creating a New Registration When creating a contact that is to be used in the role of a Registrant, Registrars offer a choice of Canadian Presence Requirements to the Registrant. Registrars are also required to supply a Registrant contact identifier to CIRA and in some cases, to their customer. Registering municipal domain names cannot be performed using the EPP process because CIRA must monitor the process and approve the municipal domain name. .CA Manager allows you to register municipal domain names as well as perform information-gathering functions, such as report generation.

Registrant Requirements Some Registrant information, as well as Administrative Contact details are required for a Registrant to register a domain name. Among other things, Registrants confirm that they meet the Canadian Presence Requirements by agreeing to the CIRA Registrant Agreement that is presented to them during the registration process.

Note Because CIRA manages the .CA domain name space as a resource for Canadians, CIRA requires every Registrant to indicate how they meet Canadian Presence Requirements (CPR)

Registrar Requirements As a Registrar you must meet the CIRA Accreditation certification requirements and you cannot default in your obligations under the Registrar Agreement. The purpose of completing the CIRA accreditation program is to demonstrate that you are able to provide the required Registrar services and are knowledgeable about the Registration Rules and the domain name system in general. As a Registrar you must: • complete the CIRA Accreditation program • have sufficient funds in your Registrar Deposit Account to cover the certification fee (plus applicable taxes); the fee will be automatically debited from your account • provide your current Certificate of Corporate Status and any additional corporate documents that CIRA may require CIRA processes applications in the order they are received. You will be notified by email when you are scheduled to complete the examination for accreditation. If you meet the CIRA Accreditation program obligations, re-accreditation takes effect on the anniversary date and the Registrar Agreement continues in full force and effect.

.CA Registry Guide for Registrars: Version 4.06 31 Overview of Business Processes Chapter 3 Creating a New Registration

Note Failure to be accredited will result in the termination of the Registrar Agreement and loss of access to the .CA Registry

About the Tests The CIRA accreditation tests ensure that CIRA Registrars are familiar with the requirements for the CIRA Registry. In order to receive technical accreditation from CIRA, you must do the following: 1 Complete the EPP Accreditation Test. This test is mandatory for Registrars that want to use EPP to contact to CIRA. You can access the test questions via the .CA Manager 2 Complete the .CA Registrar Policy Accreditation. This is a multiple choice test that tests your understanding of the CIRA Registry rules. This test is mandatory for all CIRA Registrars.

The process The CIRA EPP (Extensible Provisioning Protocol) Registry is used by CIRA certified Registrars to communicate with the CIRA EPP registry, therefore you must first complete the testing of your client systems.

Note All Registrars operating within the old registry system have completed the accreditation process on or before September 15, 2010. Registrars did not complete both elements of the accreditation process prior to September 15, 2010 are not eligible to function within CIRA’s new registry system

The CIRA Technical Support staff will also provide you with the following: • accreditation server information • accreditation password (RSU will confirm your username and password) • Instructions on where to obtain the .CA Registry Guide for Registrars • Other documentation that will provide you with additional information • Documentation that will explain the technical EPP test that you will be expected to perform during the accreditation process

Technical Accreditation CIRA RSU will provide you with a set of questions and use cases. You must demonstrate the correct execution of a variety of registry operations. For example you may be required to perform the following tasks: • EPP command • Create a domain name with a host • Get information for a domain name without using WHOIS

Note Applicant Registrars must complete all aspects of the Technical accreditation test without errors

32 .CA Registry Guide for Registrars: Version 4.06 Chapter 3 Overview of Business Processes Registrar Deposit Account Balance

Upon a successful completion of the technical accreditation testing, CIRA will provide to you, your results. CIRA will also provide feedback for those Registrars that failed to successfully complete the tests. You will not be limited in the number of attempts that you wish to make to complete the accreditation process. Upon successfully completing all aspects of the EPP Technical questions you will then be required to complete the Policy Accreditation process.

Accreditation Testing CIRA highly recommends that you reference the following documents prior to and during your Policy Accreditation Test; • Canadian Presence Requirements for Registrants • Registrant Agreement • General Registration Rules • Registrar Agreement • To Be Released Domain Names Policies, Rules and Procedures • Registration of Municipal Domain Names Policies, Rules and Procedures

Note If you experience any technical difficulty or require support in any capacity during the Technical or Policy Accreditation process, please be sure to email [email protected]. CIRA’s Technical Support team will be able to assist you

Registrar Deposit Account Balance As a Registrar it is your responsibility to ensure that your account is sufficiently funded to meet your business needs. A domain name registration, explicit renewal, or transfer request will be rejected if the Registrar deposit account has insufficient funds. If domain name auto-renewal causes a Registrar's account balance to decrease to the level where insufficient funds are available to process an auto-renewal, the registry does not auto-renew the domain name. Instead: • The domain name immediately moves to the Redemption Grace Period instead of the Auto Renew Grace Period. DNS does not resolve domain names in the Redemption Grace Period. The Registrar has 30 days to renew ("restore") the domain name to avoid its subsequent transition to the To Be Released stage. (Alternatively, the Registrant could transfer the domain name to another Registrar within this 30-day period; a transfer requires a renewal of at least one year with associated renewal fee paid by the gaining Registrar.) • CIRA queues an EPP service message for the Registrar indicating the auto-renewal failure and specifying the domain name. • CIRA sends an email notification to the Registrant and Administrative Contact for the domain name indicating this registry action and specifying the domain name. As a convenience feature for Registrars, each Registrar may set a “low balance threshold” using .CA Manager. If a transaction causes a Registrar’s account balance to transition from “above the low balance threshold” to “equal to or below the low balance threshold”, CIRA will queue a single

.CA Registry Guide for Registrars: Version 4.06 33 Overview of Business Processes Chapter 3 Creating Registrant contacts

EPP service message and send an email notification to the Registrar indicating this transition. No further alerts or emails will be sent until the Registrar account balance increases above the low balance threshold (which will reset the alert mechanism to again watch for “below low balance threshold”).

Note CIRA will use reasonable commerical efforts to send Registrars a notification by email if a transaction causes the Registrar account balance to translition below the low balance threshold

Creating Registrant contacts The Registrant is the individual or non-individual that has the authority to use and manage the domain name. A Registrant contact is created in order to assign it to a domain name. To create a contact, provide the following: • Contact ID (Registrar-generated and unique) • complete name is mandatory • CPR category information is mandatory if you intend to use the contact as a Registrant for a domain name • postal address, including the city, state, or province, postal code and country is optional • complete email address is optional, but highly desirable • phone numbers are optional CIRA requires the complete information in order to enforce Canadian Presence Requirements. For more information on CPR (Canadian Presence Requirements), see “Presenting CPR Categories” on page 34. The .CA Registry allows for two types of Registrant and classifies a contact as either “individual” or “non-individual”. A domain name must also have one administrative contact (which must be an individual) and optionally up to three technical contacts (which must also be individuals).

Note As Registrant for a domain name you must indicate CPR (Canadian Presence Requirements) category information and agree to the CIRA Registrant Agreement

CIRA strongly encourages Registrars to offer the Canadian Presence Requirements (CPR) categories to the Registrant in a specific manner. Initially the Registrant should see a choice list containing only these alternatives. Presenting CPR Categories Registrars are strongly encouraged to display the following Canadian Presence Requirements (CPR) categories to Registrants: • Canadian citizen • Corporation •Other Only if a Registrant selects “Other”, other CPR categories are offered to Registrants.

34 .CA Registry Guide for Registrars: Version 4.06 Chapter 3 Overview of Business Processes Understanding CPR Categories for Registrants

Canadian Presence Requirements (CPR) categories are criteria that classify Registrants into a legal type (i.e., as a non-individual or an individual). The table “valid CPR Categories” on page 35 identifies which CPR categories are classified as individual and non-individual Registrants. Understanding CPR Categories for Registrants A 'CPR category' (formerly known as a 'Legal type') is a category that the Registrant must fall into in order to meet the Canadian Presence Requirements or CPR. The Canadian Presence Requirements (CPR) are set out in the General Registration Rules and the Registrant Agreement between CIRA and Registrants. For an expanded and more detailed explanation of legal types for Registrants, see Appendix A and “Understanding legal types for Registrants” on page 191.

Valid Canadian Presence Requirement values The following abbreviations are valid values for the current Canadian Presence Requirements:

Table 9: valid CPR Categories Valid values Description Classification CCO Corporation (Canada or Canadian province or Non-individual territory) CCT Canadian citizen Individual RES Permanent Resident of Canada Individual GOV Government or government entity in Canada Non-individual EDU Canadian Educational institution Non-individual ASS Canadian Unincorporated Association Non-individual HOP Canadian Hospital Non-individual PRT Partnership Registered in Canada Non-individual TDM Trade-mark registered in Canada (by a non- Non-individual Canadian owner) TRD Canadian Trade union Non-individual PLT Canadian Political party Non-individual LAM Canadian Library, Archive or Museum Non-individual TRS Trust established in Canada Non-individual ABO Aboriginal Peoples (individuals or groups) Individual indigenous to Canada INB Indian Band recognized by the Indian Act of Non-individual Canada LGR Legal Representative of a Canadian Citizen or Individual Permanent Resident OMK Official mark registered in Canada Non-individual MAJ Her Majesty the Queen Non-individual

.CA Registry Guide for Registrars: Version 4.06 35 Overview of Business Processes Chapter 3 Registrant WHOIS Privacy

Registrant WHOIS Privacy Because CIRA is committed to protecting the rights and privacy of Registrants of .CA domain names, Registrars must provide functionality to allow an Individual Registrant to change their CIRA WHOIS privacy protection settings from public to private through a Contact Update request. Registrants with the following Canadian Presence Requirement (CPR) categories are considered to be individuals: • Canadian citizens • permanent residents • legal representatives • aboriginal peoples All other CPR categories are considered to be non-individual Registrants. A non-individual is not permitted to change their WHOIS privacy settings via their Registrar.

Note In extraordinary circumstances, CIRA may grant WHOIS privacy protection to non- individual Registrants

CIRA will verify that a Registrar is compliant with the CIRA Privacy Policy.You can read more about CIRA's Privacy Policy at: http://www.cira.ca/assets/Documents/Legal/Registrants/privacy.pdf

WHOIS Privacy Settings Registrars must provide a way for Registrants who are classified as individuals to change their WHOIS privacy settings via their Registrar. Registrants who are classified as non individuals must apply directly to CIRA. CIRA may grant WHOIS privacy protection to non-individual Registrants, but only in exceptional circumstances. Registrars can direct non-individual Registrants to [email protected]. Understanding the CIRA Registrant Agreement CIRA requires that every domain name have an associated Registrant contact which includes CPR category information and indicates that the Registrant has agreed to the CIRA Registrant Agreement. When a new Registrant Contact is created, the Registrant is required to agree to the CIRA Registrant Agreement. As a Registrar you have two alternative ways to accomplish this: 1 Display the CIRA Registrant Agreement to each Registrant as a component of your registration process before you create the contact in the Registry. Include the information from the Registrant in your contact create request. See "Displaying the CIRA Registrant Agreement" below. CIRA recommends this approach because it reduces the chances of error and delay in the registration process and hence reduces Registrar support costs. 2 Create the contact in the Registry during the registration process. After creating the contact, provide the Registrant contact ID to the Registrant, and direct the Registrant to the CIRA Registrant Agreement page on the CIRA website. Both approaches have some common characteristics.

36 .CA Registry Guide for Registrars: Version 4.06 Chapter 3 Overview of Business Processes Registrar displaying the Agreement on their website

The first section provides an introduction about the agreement, the second section provides the agreement, and the third section contains further text about the agreement. The Registrant is required to scroll through the CIRA agreement and read it thoroughly. Below the agreement text there is a text field into which the Registrant inputs their Registrant contact identifier that they received from the Registrar, followed by a "captcha" text field. Registrars are required to display the following confirmation details to Registrants, on their website: The complete Registrant agreement must be scrollable and printable. • The "I agree" button with the complete statement as quoted: – "You have read, understood and agree to the terms and conditions of the Registrant Agreement, and that CIRA may, from time to time and at its discretion, amend any or all of the terms and conditions of the Registrant Agreement, as CIRA deems appropriate, by posting a notice of the changes on the CIRA website and by sending a notice of any material changes to Registrant." – "You meet all the requirements of the Registrant Agreement to be a Registrant, to apply for the registration of a Domain Name Registration, and to hold and maintain a Domain Name Registration, including without limitation CIRA's Canadian Presence Requirements for Registrants, at: www.cira.ca/assets/Documents/Legal/Registrants/CPR.pdf." – "CIRA will collect, use and disclose your personal information, as set out in CIRA's Privacy Policy, at: http://www.cira.ca/privacy/policy.html." • The text "Enter the Contact ID provided to you by your Registrar" and the text field for the "Registrar-Provided Contact ID" • Registrants must also be given the option to not agree. Therefore Registrars must show the following text with the Registrant agreement, "If you do not agree, the process will end here and you will not be able to register a .CA domain name."

Note Until a Registrant has agreed to the CIRA Agreement, related domain names are in a pending create stage of the life cycle, and will not resolve until the process is completed.

Registrar displaying the Agreement on their website If the Registrar chooses to display the CIRA Registrant Agreement to the Registrant, the format and behaviour of the web page must conform exactly to CIRA standards.

Note CIRA requires that every certified Registrar provide, on an ongoing basis, a way for CIRA Registration Services to access a reasonable facsimile of the Registrar's CIRA Registrant Agreement page to verify the compliance of this page to CIRA's guidelines

CIRA may change the Registrant Agreement from time to time. CIRA provides a 30-day notice of changes to the CIRA Registrant Agreement to both Registrants and Registrars. When a new agreement comes into effect, CIRA systems accepts both the current and new version of the agreement, for a given time period, on that particular day. This time period will be announced via a Registrar Advisory. At the end of the time period, CIRA will no longer accept the older version of the agreement.

.CA Registry Guide for Registrars: Version 4.06 37 Overview of Business Processes Chapter 3 Using CIRA's Registrant Agreement Page

A Registrar may programmatically request the current version of the Agreement from CIRA to display during their registration process. Registrars may store the current version of the agreement on their systems. During the creation of a contact that will be used in the role of a Registrant for a domain name, Registrars must submit the version number of the agreement that they display to the Registrant and an "I agree" parameter which will be set to Y if the Registrant clicks the "I Agree" button and "N" if the Registrant declines the agreement. Registrars are not allowed to edit any of the text. Using CIRA's Registrant Agreement Page If a contact has CPR data but does not indicate agreement with the CIRA Registrant Agreement, the registry sets the contact to "Pending Create" status. If any domain names are created that use this contact as a Registrant, the domain name status is also "Pending Create" and the DNS will not resolve the domain name. If within the 7 days, the Registrant does not accept the Agreement, CIRA assumes that the Registrant chooses not to accept the agreement. In this case, any associated domain names which have "pending create" status are deleted. The Registry will delete any contact that does not have a Registrant, Administrative Contact, or Technical Contact relationship with any domain name for a 60 day period. For testing purpose you may use the following temporary URL https://services.test.cira.ca/agree

Updating the agreement to a new version CIRA provides a 30-day notice of changes to the CIRA Registrant Agreement to both Registrants and Registrars.This means that in all likelihood, changes to the Registrant agreement would occur during a quarterly release. When a new agreement comes into effect, CIRA systems accepts both the current and new version of the agreement, for a given time period, on that particular day. This time period will be announced via a Registrar Advisory. At the end of the time period, CIRA will no longer accept the older version of the agreement. Providing Reseller IDs CIRA encourages Registrars who have resellers to provide CIRA with reseller id associated with each contact. The .CA Registry does not validate re-seller information and does not disclose it. CIRA will use this information solely for data analysis purposes. This will benefit Registrars by lowering support costs. Providing Registrant IP Addresses CIRA encourages Registrars to provide their client’s computer IP address during contact creation. This IP address makes it possible for CIRA to determine the geographic location of the Registrant’s computer. This data may lower Registrars’ support costs by reducing the likelihood having Registrants go through the “Registrant Identification Verification” (RIV) process. Creating a Domain Name Registrars can use the domain create command to create an available domain name in the Registry and create relationships between the domain name and previously created contacts and hosts. Follow these steps to request a domain name registration:

38 .CA Registry Guide for Registrars: Version 4.06 Chapter 3 Overview of Business Processes Requesting a Specialized Domain Name

1 Using the Domain Check request, check to see if the domain name is available 2 Create an associated contact if one does not exist. Ensure that the contact you want to use as the Registrant has a value for the CPR category 3 Verify that the contact you are using as a Registrant has agreed to the CIRA Registrant Agreement 4 Create the domain name in the registry and include the relationships to the contacts and to the hosts outside of the domain name being created 5 If there are related hosts that are inside the domain name being created: a Create associated hosts b Update the domain object to add relationships to these hosts Requesting a Specialized Domain Name Certain domain names (such as provincial) are reserved by CIRA; Registrars cannot obtain registrations for these domain names. The new system supports multi-level domain names only under certain circumstances. A municipal domain name can be either at the 2nd or 4th level: • “halifax.ca” (2nd level, which comprises “municipal name – dot – extension”) • no 3rd level municipal domain name is permitted • “city.halifax.ns.ca” (4th level, which comprises “municipal identifier – dot – municipal name – dot – province – dot – extension”) A municipal domain name can only be requested using .CA Manager. A request for any other 3rd or 4th level domain name registration will be rejected by the .CA Registry system. However, existing 3rd and 4th level domain names may be renewed. For more information see “Domain Create” on page 148. Creating a Host CIRA requires the Registrar to create host records if they want the domain name to resolve on the Internet. The registry uses a host create request to create new hosts. Hosts are used as name servers in the Domain Name System (DNS). When the Registrar creates hosts for a domain name, rules are followed to ensure that the domain name can resolve. Two or more distinct name servers must be defined for each protocol in use. If one host is unavailable the other host will still resolve. Registrars can use IPv4 and IPv6 addresses concurrently, however, they are not interchangeable or compatible. This means that if you want to use both protocols, you must provide data for two unique name servers that are accessible by IPv4 and two unique name servers that are accessible by IPv6.

Updating a domain name See “Domain Update” on page 169.

.CA Registry Guide for Registrars: Version 4.06 39 Overview of Business Processes Chapter 3 Renewing Registrations

Renewing Registrations When a domain name’s period of registration nears completion, the Registrant will need to pay their Registrar to renew their domain name and keep their domain name registered. CIRA automatically renews the domain name for one year, but a Registrar can delete it during the auto renew grace period if the Registrant does not pay for the automatic renewal within 45 days. If the Registrar deletes it, the domain name enters a 30-day redemption grace period, during which the domain name can still be renewed. If it is not renewed during the redemption grace period, in most cases, it will subsequently go to the next phase in the domain name life-cycle during which it is added to the “To Be Released” (TBR) list for an upcoming TBR session. Once it is on the TBR list, the domain name can no longer be renewed. Registrars can renew a domain name up to and not exceeding a 10-year period. See “Domain Renew ” on page 164 for information about renewing domain names. Deleting Registrations Registrars cannot delete a domain name unless they are the sponsoring Registrar and the domain name is in the Add Grace Period, Auto-Renew, Redemption, or Pending Create stage of the domain name life cycle. See the “Domain Name Life Cycle” on page 20 for information about domain name life cycle stages. When a domain name registration is deleted while it is in the Add Grace Period or Pending Create stage of the domain life cycle, the domain name is set to Pending Delete for 1 day. All charges are refunded. If a domain name is deleted while it is in the Auto-Renew stage, the domain name is set to Redemption Grace Period and the most recent charge is refunded. See “Domain Delete” on page 159 for information about the Domain Delete request. Transferring Registrations Transferring a domain name means transferring the sponsorship of a domain name from the present sponsoring Registrar to the requesting Registrar. When this occurs, the sponsorship of any subordinate host is also transferred; these hosts are listed in the Domain Transfer response.

Transferring a Domain Name To initiate a transfer request, the Registrant first requests a domain name authorization code ("authInfo") from the losing Registrar, who must provide it within 5 days of a request and remove any registry domain name transfer prohibition (reset "clientTransferProhibited"). The losing Registrar cannot cancel the request, and there is no pending period. The Registrant then submits a transfer request to the gaining Registrar that includes the domain name, the associated domain authInfo, and identifiers of contacts for the domain name Registrant and Administrative Contacts. A successful Registrar to Registrar transfer request is processed immediately; the domain name registration is extended by a year (or more) only if the domain name registration is not already at the .CA 10 year maximum. A minimum 1-year renewal fee is charged even if the domain name registration is already at the 10-year maximum.

40 .CA Registry Guide for Registrars: Version 4.06 Chapter 3 Overview of Business Processes Notification Emails

CIRA's privacy policies prohibit access to or transfer of contact data between Registrars; the .CA registry does not support authorization information for contacts. In a domain name transfer request, the specified contacts must already be sponsored by the gaining Registrar. After a successful transfer, the registry will prohibit another transfer from occurring for a period of 60 days from the current transfer date. The registry also prohibits any domain name update that re- assigns the contact of the Registrant for the domain name for 60 days from the current transfer date. This is to prevent unauthorized transfers of domain names. A Registrar is never allowed to execute a contact update to change the name of the contact that is used in the role of the Registrant for any domain name, regardless of grace period or stage of life. Only CIRA is allowed to change the name of a Registrant using a contact update.

Note If a transfer of a domain name is done during Auto Renew Grace Period the domain name will be placed in the registered stage of life with the Server Delete Prohibited status set.If a transfer of a domain name is done during Redemption Grace Period the domain name will again be placed in the registered stage of life with the Delete prohibited status applied

Transfer of a domain name is prohibited when: • the clientTransferProhibited or serverTransferProhibited status flags are set • for the first 60 days subsequent to the activation of the domain name. This is the point when the Registrant Agreement has been signed, therefore the life cycle stage has been set to “Add Grace” period stage • the domain name has just been transferred, after a successful transfer, the registry prohibits any subsequent transfers or domain name updates that change the contact in the role of the Registrant, from taking place for a 60 day period • the domain name has just been updated such that the contact id of the contact in the role of the Registrant has changed. After a successful update of this kind, the registry prohibits transfers, or subsequent Registrant contact re-assignments for 60 days • the requesting Registrar does not have sufficient funds See “Domain Transfer” on page 180 for information about the Domain Transfer request. Notification Emails CIRA sends the following emails to Registrants and Administrative Contacts.

Request Trigger Recipients Domain Create Domain name transitions to Add Grace Registrant, Administrative Contact Period stage (Registrant has agreed to CIRA Registrant Agreement) Contact Update Any change to related active domain name Registrant, current and new Registrant email, Administrative Contact Administrative Contact name, or Administrative Contact email

.CA Registry Guide for Registrars: Version 4.06 41 Overview of Business Processes Chapter 3 Notification Emails

Request Trigger Recipients Domain Name Any change to Registrant email, Registrant, current and new Update Administrative Contact name, or Administrative Contact Administrative Contact email Domain Name Any change to Registrant email, Losing Registrant and Transfer Administrative Contact name, or Administrative Contact Administrative Contact email Domain Name Domain name transitions to either TBR or Registrant, Administrative Contact Delete Pending Delete stage

In addition, CIRA sends a membership offer to new holders of a new .CA domain name. The invitation email is sent to the Registrant and the Administrative Contact upon domain name activation.

Caution The .CA Registry does not send emails to Registrants asking them to go to the CIRA website. If a Registrar does not display the Registrant Agreement to the Registrant in the CIRA-prescribed manner during the registration process, the Registrar must provide the appropriate instructions to the Registrant including URL of the Registrant Agreement page on the CIRA website and the Registrant’s contact ID. In addition to providing this information to the Registrant through the Registrar’s web interface, the Registrar must send an email notification to the Registrant containing this information.

Optional Email Co-branding With the exception of the CIRA membership solicitation email, the .CA registry supports optional Registrar co-branding of Registry-generated email notifications. A Registrar may use.CA Manager to specify any of the following co-branding elements: • Registrar brand image • Registrar name • Registrar URL • Registrar customer service telephone number • Registrar customer service email address

TBR A "To Be Released" domain name (TBR) is a previously registered domain name that was deleted and is available for re-registration during the .CA TBR session. The current TBR interface remains intact as do the policies and procedures.

42 .CA Registry Guide for Registrars: Version 4.06 Chapter 3 Overview of Business Processes Notification Emails

TBR Interface The format of the REGIS_TBR_DOM request will not change. A Registrar must provide values for all mandatory parameters as is done currently. The exception is the rgpc_rant parameter. As explained below, we do not use this value but it is mandatory.You must provide a value of zero.

TBR Participation To participate in TBR you must make the following preparations using the .CA Manager interface. Refer to the .CA Manager for more details on how to prepare for TBR. For more information see “Instructions for Sending a Valid .CA TBR Request”available at http:// www.cira.ca/tbr-2010

Note These actions are only required once, not once per TBR session.

• Enter the IP address you will use to connect to the TBR server. You will need to use the Registrar Profile section of the .CA Manager (Dashboard) page. • Create a contact to be used as the initial registrant of a domain name registered in TBR • Enter that contact ID in the registrar profile as the TBR generic registrant ID For each domain name registered in TBR, the new Registry takes the following action and imposes the following requirements on the Registrar. • The gaining Registrar is the sponsor of the domain name • The period of registration is one year and the Registrar account is debited accordingly • The domain name becomes registered. Service message 3044 (Domain [--domain name--] has been successfully registered through the TBR) is sent • Associates the domain name with the Registrar’s TBR Registrant • Assigns the new authInfo. The new authInfo is a series of alphanumeric characters 10 characters long

Note Registrars can access the domain name authInfo by performing a domain info request. Only the authInfo associated with the domain name is required when transferring a domain name from the TBR Registrant to the Registrant.

• There is NO add grace period and NO refund • The Registrant and Administrative Contact of the domain name are set to the default TBR Registrant • A Registrar must, within 14 days, update the domain name to re-assign the Registrant and Administrative Contacts to a legitimate third-party Registrant and an Administrative Contact • There are no hosts assigned; the Registrar must update the domain name with any appropriate host assignments Following the above, CIRA will treat the domain name as a normal registered domain name.

.CA Registry Guide for Registrars: Version 4.06 43 Overview of Business Processes Chapter 3 Notification Emails

If a Registrar fails to assign a legitimate Registrant and Administrative contact to a domain name registered in TBR within the 14 day grace period, the domain name will be put into the next TBR release. There will be NO refund.

Note If a Registrar "wins" a domain name in the TBR session but does not have sufficient funds in its account to cover the registration cost, the domain name will be put into the next TBR release.

44 .CA Registry Guide for Registrars: Version 4.06 Chapter 4

EPP Interface Overview EPP (Extensible Provisioning Protocol) is an industry standard computer communications protocol used by Internet systems. EPP provides a robust, flexible protocol to allocate objects within Registries over the internet. The EPP client - server protocol defines object management operations maps protocol operations to specific domain names, contacts, and hosts. CIRA has implemented the EPP formally specified in RFCs 4930, 4931,4932, and 4933. Security services beyond those defined in EPP are provided by the Transport Layer Security (TLS) Protocol [RFC 2246]. Accessing the Registry EPP Service CIRA provides an EPP safe test environment, which allows the Registrars to test their systems without affecting the production database. CIRA’s EPP servers will only accept Registrar EPP connections from Registrar-specific CIRA- configured IP addresses.

Note The safe test environment mimics production and as such, CIRA recommends that Registrars keep their test information unique and generic

EPP Client and Server Configuration EPP client must connect to CIRA’s EPP servers using Secure Socket Layer (SSL). CIRA uses SSL to provide mutual authentication between CIRA EPP servers and Registrar EPP clients using public keys, and to provide encrypted connections for all data exchange. SSL certificates are digital identification documents issued by a trusted source known as a Certificate Authority (CA).

EPP Client Configuration The .CA Manager file download capability offers CIRA self-signed SSL certificates available in two formats: • .der - often used by Java clients • .pem – often used by OpenSSL clients Download and extract the certificate appropriate for your client software, and install it in your EPP client computer’s certificate store. Ensure that your EPP client is SSL enabled.

Information Required by CIRA for EPP Server Configuration To configure CIRA EPP servers to interact with the EPP client, we require the following:

.CA Registry Guide for Registrars: Version 4.06 45 EPP Interface Overview Chapter 4 Establishing an EPP connection

1 A client SSL certificate that you obtain from an approved certificate authority. (During the initial system integration phase CIRA will alternatively accept a self-signed certificate.) Send this certificate to CIRA (in either DER or PEM format); CIRA will upload it to our EPP server’s key stores. 2 The IP address of your EPP client. This is required by CIRA to enable EPP client access through the EPP server firewall. Registrars should send both their client SSL certificate and their EPP client IP address to [email protected]. Please ensure that the certificate file name identifies the organization in some useful way. Establishing an EPP connection To establish a connection to the Registry EPP server, the Registrar sends an EPP request to the Registry. The Registry responds to the Registrar’s initial with a response. The response contains information that the Registrar may require to communicate with the Registry server.

CIRA Greeting The CIRA EPP is sent by the CIRA EPP server in response to the Registrar’s . The greeting is used by CIRA to let the Registrar know what the EPP server provides to the Registrar. The CIRA EPP server also sends the current date and time in UTC, the protocol version supported by the server, the language for the text response and one or more elements which identify what the CIRA EPP server manages. The Registrar can then establish a session with the EPP server after a greeting has been issued by the server. For more information on the protocol between the CIRA Registry and the Registrar refer to RFC 4930. It is expected that the CIRA EPP and will conform to CIRA’s policies as well as to RFC 4930. For example, the EPP server states CIRA’s data collection policy in the element of the . CIRA requires that all contact information for non individuals be publicly available (due to CIRA’s WHOIS policy). All contact information for individuals will only be available at the request of the individual.

Note EPP defines the Hello / Greeting protocol that allows a Registrar to query the Registry for information such as EPP protocol version, supported languages, and data collection policies.

Hello request A Registrar may send an EPP request to the Registry at any time between a successful Login and Logout. Example request:

46 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview EPP Encoding

Greeting response The server returns a response after receiving the request and establishing a successful connection. It specifies the services that the CIRA EPP server provides, sent in response to a element and also on connection to the server. The following XML code is an example of a CIRA EPP response format. CIRA EPP server version: 3.0.4 2010-01-25T20:22:46.0Z 3.0 en fr urn:ietf:params:xml:ns:epp-1.0 urn:ietf:params:xml:ns:domain-1.0 urn:ietf:params:xml:ns:host-1.0 urn:ietf:params:xml:ns:contact-1.0 urn:ietf:params:xml:ns:cira-1.0 urn:ietf:params:xml:ns:poll-1.0

EPP Encoding XML EPP uses Extensible Mark-up Language (XML), to map to objects using XML namespaces, and in addition to this, the CIRA EPP interface also uses CIRA defined extensions. (Namespaces in XML make it possible to give elements and attributes unique names.) See http://www.w3.org/TR/xml/ for information about SGML and HTML.

.CA Registry Guide for Registrars: Version 4.06 47 EPP Interface Overview Chapter 4 Request / Response Overview

Special Characters Some special characters have special meaning as markup delimiters in XML. An XML entity reference is a group of characters used as a substitute for a single specific character. Entity references always begin with an ampersand (&) and end with a semicolon (;). For example, to represent a left angle bracket (<) within XML data, substitute the entity reference "<". Registrars can also substitute a numeric or hexadecimal reference. Predefined XML entity references are specified in the following table. Table 10: Predefined XML Entity References

Character Description Entity Numeric Hexadecimal Reference Reference Reference & ampersand & & & < less than < < < > greater than > > > " double quote " " " ' single quote ' ' '

EPP Date and Time Representation Date and time values must be represented in Universal Coordinated Time (UTC) using the Gregorian calendar. Because EPP does not support truncated date-time forms or lower case "T" and "Z" characters, the extended date-time form using upper case "T" and "Z" characters defined in http://www.w3.org/TR/xmlschema-2/#isoformats must be used to represent date-time values. Request / Response Overview All EPP XML requests and responses comprise an element with EPP-specific sub-elements. The response to a request usually contains this information: 1 Result code includes one or more response code numbers , each having a corresponding human-readable message . For example, a successful execution of a request can return the result code "1000" with the associated message “Command completed successfully”. 2 An EPP error usually indicates that some required data is missing. When an operation fails, an error response is provided. Where possible CIRA includes an error code and a more comprehensible error message using the following format:

XXXX Reason goes here

3 Data - displays information that is returned within a element as a response to the request. Not all responses return a element. For example, some responses do not return a element.

48 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Login

4 Transaction IDs - displays the Registrar Transaction ID and the Registry Transaction ID contained in the element Registrars can also find common EPP response codes on the Internet by accessing the Results Codes section of the Extensible Provisioning Protocol document number RFC 4930. Login The EPP request establishes an ongoing session that preserves client identity and authorization information during the entire session.

Note The number of failed login attempts is limited to five unsuccessful attempts, after which the connection to the server is closed.

A lack of activity during the session results in the Registry ending the session and closing the connection. The time-length of inactivity is: • 5 minutes (300 seconds) – EPP session

Request The Login Request Fields table lists the XML fields used to initiate a Login request. The corresponding EPP element is displayed below the field name.

Table 11: Login Request Fields Name Type Usage Description Valid Values Client ID Varchar2 (30) Mandatory The Registrar’s The client ID client must exist on the identification Registry server, used to access prior to login CIRA’s XML interface Password Varchar2 (16) Mandatory The Registrar’s Character values password used to are: a – z, A – Z, access CIRA’s 0 – 9 XML interface Passwords are case sensitive The password must exist on the Registry server, prior to login Preferred Varchar2 (2) Optional The Registrar’s You can choose – Language language of "fr" for French or preference "en" for English

.CA Registry Guide for Registrars: Version 4.06 49 EPP Interface Overview Chapter 4 Login

Table 11: Login Request Fields Name Type Usage Description Valid Values Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the login request

Response The Login Response Fields table lists the XML fields that may occur in the response to a Login request. The corresponding EPP element is displayed below the field name.

Table 12: Login Response Fields

Field Name / EPP Elements Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human- readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response / error codes The Login Response and Error Codes table lists the Login response and error codes. Table 13: Login Response / Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully

50 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Login

General response / error codes The request failed due to a syntax error or 2000 – Unknown command Registry policy violation 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2102 – Unimplemented option 2400 – Command failed 2502 – Session limit exceeded, server closing connection 5006 – You are already logged in Field-specific response / error codes The Client ID field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2200 – Authorization error 2306 – Parameter value policy error The Password field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2200 – Authorization error 2306 – Parameter value policy error 5003 – Invalid language parameter - see documentation for CIRA-supported languages 5004 – Password is not within valid parameters: – password must be from 6 - 16 characters – supported character values are: a - z, A - Z, 0 - 9

EPP Interface The following XML code is an example of a client login request. MyRegistrar myregistrar3 1.0

.CA Registry Guide for Registrars: Version 4.06 51 EPP Interface Overview Chapter 4 Logout

en ABC-12345

The following XML code is an example of a successful CIRA server response: Command completed successfully ABC-12345 CIRA-000001-0000001

Logout The EPP request terminates a current session. When a session does not terminate with a logout request, the connection remains open for 5 minutes (300 seconds) after which the Registry server terminates the session and closes the connection.

Request The Logout Request table lists the XML fields used to initiate a Logout request. The corresponding EPP element is displayed below the field name.

Table 14: Logout Request Name Type Usage Description Valid Values Logout Varchar2 Required Initiates the logout request Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when initiating the logout request

Response The Logout Response Fields table lists the XML fields that may occur in response to a Logout request. The corresponding EPP element is displayed below the field name.

52 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Logout

Table 15: Logout Response Fields

Field Name / EPP Elements Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 1500 is "Command completed successfully; ending session" Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response / error codes The Logout Response and Error Codes table lists the Logout response and error codes. Table 16: Logout Response / Error Codes

Cause Response / Error Code The request was successful 1500 – Command completed successfully; ending session General response / error codes The request failed due to a syntax error or 2000 – Unknown command Registry policy violation 2001 – Command syntax error 2002 – Command use error 2400 – Command failed 5007 – You are not currently logged in

EPP Interface The following XML code is an example of a client logout request. ABC-12345

.CA Registry Guide for Registrars: Version 4.06 53 EPP Interface Overview Chapter 4 Service Messages

Service Messages The CIRA EPP server uses service messages for communication. Messages arrive when specific changes occur and are generated whenever a certain change takes place. Service messages are placed in the queue until a poll command retrieves them. As a Registrar you must retrieve your queued messages from the service messages. The Registry sends service messages to Registrars about operations performed by the Registry. The service messages can contain account balance notifications. Each service message is transferred to the appropriate Registrar by a message protocol: • The Registrar sends a Poll request to determine whether there are any pending service messages. The Registry response contains either the first service message in the queue for the Registrar or an indication that there are no queued service messages for the Registrar. • If the queue contained a service message, the Registrar sends a Poll Acknowledge request to delete the service message from the Registry’s message queue. The Registry response indicates the number of remaining service messages in the queue.

Poll Registrars use the command to receive messages, as well as keep the connection “alive”. A successful Poll request determines whether any pending service messages are queued for that Registrar. Messages are retrieved on a “first in – first out” basis. The response contains the count of service messages in the Registrar’s message queue and the first service message if the queue is not empty. Polling can also help keep the session alive during periods of no activity. When there is no activity on the connection for 5 minutes, CIRA terminates the connection. Message queues can consume Registry resources when service messages are not retrieved regularly. CIRA will remove any messages that have been left in the poll queue longer than 30 days.

Request Service messages are retrieved with the EPP command. ABC-12353

The Poll Request Fields table lists the fields used in the Poll request. The EPP element is displayed below the field name.

54 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Service Messages

Table 17: Poll Request Fields Name Type Usage Description Valid Values Poll message CLOB Mandatory The XML "req" or "ack" retrieval statement that defines the action as a poll request Transaction ID Varchar2 (64) Optional A transaction identifier generated by the Registrar when initiating the poll request

Response The .CA Registry responds to every action with a response. The Poll request response may be with a success message and a request for an acknowledgement. The corresponding EPP element is displayed below the field name. The Poll Response Fields table lists the fields in a Poll response.

Table 18: Poll Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 1000 is "Command completed successfully" Message Count The message count and the Registry message ID as well as the date of the message. It also has an associated human-readable CIRA Service Messages Usually CIRA includes a more specific Service message which contains one or more tags. Note that the contents of the depends upon the message(s) type being returned Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID

.CA Registry Guide for Registrars: Version 4.06 55 EPP Interface Overview Chapter 4 Service Messages

Registry Transaction ID A transaction identifier generated by the Registry when processing the request.

Response / error codes Response codes are returned with the response to a Poll request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The Poll Response Codes table lists the Poll response and error codes. Table 19: Poll Response Codes

Cause Response Code The request was successful 1300 - Command completed successfully; no messages 1301 - Command completed successfully; ack to dequeue Cause Error Codes The request failed due to a 2000 – Unknown command syntax error or Registry 2001 – Command syntax error policy violation. 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2400 – Command failed EPP Service Messages The following service messages are delivered to Registrars via the poll queue:

Table 20: EPP Service Messages Msg Service Message What Triggers the Poll Message Object Information ID 3027 Domain [--domain name--] has been Successful Domain:Transfer to transferred to another Registrar losing Registrar 3028 Registrant [--registrant ID--] has accepted Successful Agreement Landing Page the CIRA Registrant Agreement Agreement (Registrant agrees to the agreement) 3029 Registrant [--registrant ID--] has not Registrant fails to agree to the CIRA accepted the CIRA Registrant Agreement agreement on the CIRA Landing within the required time period. CIRA will page (the pending contact and delete the pending contact and associated domain name are deleted by CIRA) domain name information.

56 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Service Messages

Table 20: EPP Service Messages Msg Service Message What Triggers the Poll Message Object Information ID 3030 Registrant [--registrant ID--] has declined Registrant clicks the "I do not agree" the CIRA Registrant Agreement. CIRA button on the ALP will delete the pending contact and associated domain name information. 3031 The Registrar account balance has Message is sent when their account decreased to [--amount--]. balance decreases to a Registrar- specified value 3032 Domain [--domain--] was not Message is sent to the sponsoring automatically renewed by the Registry Registrar when they have because the Registrar account balance has insufficient funds to auto renew insufficient funds. The domain is now in the Redemption Grace Period and has been removed from DNS. If the domain is not explicitly renewed or transferred within [--RGP length--] days, the domain will be deleted. 3033 Domain [--domain name--] was not Message is sent to the sponsoring automatically renewed by the Registry Registrar when they are suspended because automatic renewal is prohibited for the Registrar. The domain is now in the Redemption Grace Period and has been removed from DNS. If the domain is not explicitly renewed or transferred within [--RGP length--] days, the domain will be deleted. 3034 Registrant [--registrant ID--] has not Message is sent to the sponsoring accepted the CIRA Registrant Agreement. Registrar 48 hours prior to CIRA If the Registrant does not accept the deleting the Registrant contact and agreement by [--deadline--] CIRA will associated domain name information delete the Registrant contact and associated domain information 3035 Contact [--contact ID--] status has been Manual status update using CIRA changed by CIRA from [--complete list of Admin former status flags--] to [--complete list of new status flags--]. 3036 Domain [--domain name--] status has Manual status update using CIRA been changed by CIRA from [--complete Admin list of former status flags--] to [--complete list of new status flags--].

.CA Registry Guide for Registrars: Version 4.06 57 EPP Interface Overview Chapter 4 Service Messages

Table 20: EPP Service Messages Msg Service Message What Triggers the Poll Message Object Information ID 3037 Host [--host name--] status has been Manual status update using CIRA changed by CIRA from [--complete list of Admin former status flags--] to [--complete list of new status flags--]. 3038 The EPP client at [--IP address--] More than a configuration-defined exceeded the maximum allowed request number of requests were received in rate. the allowed time interval. 3039 Contact [--contact ID--] has been deleted. Housekeeping 3040 Domain [--domain name--] has been Housekeeping deleted. 3041 Host [--host name--] has been deleted Housekeeping 3042 Domain [--domain name--] has reverted to Housekeeping the 'To Be Released (TBR)' list because the Registrant of the domain was not changed. 3043 Domain [--domain name--] was not Housekeeping automatically renewed by the Registry because renewal is prohibited for the domain. The domain is now in the Redemption Grace Period and has been removed from DNS. If the domain is not explicitly renewed or transferred within [-- RGP length--] days, the domain will be deleted. 3044 Domain [--domain name--] has been Message is sent to the successful successfully registered through the TBR Registrar upon registration and entry process. into the Registry 3045 The TBR registration of Domain [-- Message is sent to the successful domain name--] has been rejected due to Registrar when a domain name has insufficient funds. The Domain has been been acquired in the TBR session but returned to the TBR list. the Registrar does not have sufficient funds in their account to cover the registration cost, the domain name will be put into the next TBR release.There will be NO refund.

58 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Service Messages

Table 20: EPP Service Messages Msg Service Message What Triggers the Poll Message Object Information ID 3046 The TBR registration of Domain [-- Message is sent to the successful domain name--] has been rejected due to a Registrar when a domain name has missing or invalid TBR Registrant ID. The been acquired in the TBR session but Domain has been returned to the TBR list. the Registrant ID is invalid or is missing 3047 The request to create the domain name [-- Message is sent to the sponsoring domain name--] has been received and Registrar when they have submitted will be processed shortly. a special domain name request 3048 Your request to create the domain [-- Message is sent to the sponsoring domain name--] has been approved and Registrar when the domain name has subsequently created by CIRA. been approved by CIRA 3049 Your request to create the domain [-- Message is sent to the sponsoring domain name--] has been declined by Registrar when the domain name has CIRA. been declined by CIRA 3050 Lost delegation [--host name--] Message is sent to Registrars that have domain names associated with hosts subordinate to a deleted domain name 3051 Recovered delegation [--host name--] Message is sent to Registrars that have domain names associated hosts subordinate to a domain name renewed from redemption grace 3052 Contact [--Contact ID--] has been Message is sent to Registrars when successfully updated by CIRA the contact has been edited by CIRA 3053 As part of the CIRA Canadian Dispute Message is sent to the ‘losing’ Resolution Process, you are no longer the Registrar sponsor of [--domain name--]. Contact RSU if you require additional information. 3054 As part of the CIRA Canadian Dispute Message is sent to the ‘gaining’ Resolution Process, you are now the Registrar sponsor of [--domain name--]. Contact [-- contact ID--] has been updated by CIRA from [--contact ID--] to [--contact ID--] for reason [--reason for update--]. You have not been debited and no expiry dates have changed. 3055 You have successfully submitted your Message is sent to the Registrar Registrar recertification form. Please send when the Recertification form has a copy of your certificate of Compliance/ been sent to CIRA via the .CA certificate of Status to Manager [[email protected]].

.CA Registry Guide for Registrars: Version 4.06 59 EPP Interface Overview Chapter 4 Service Messages

Table 20: EPP Service Messages Msg Service Message What Triggers the Poll Message Object Information ID 3056 CIRA has processed your Registrar Message is sent to the Registrar recertification. when CIRA has successfully processed the Registrar’s recertification 3057 Your Registrar re-certification is now due Message is sent to the Registrar 60 days and 30 days prior to the recertification due date 3059 Contact ID [--contact ID--] has been Message is sent to the sponsoring successfully updated by CIRA from [--old Registrar when CIRA Admin name--] to [--new name--]. explicitly modifies the Registrant name 3060 Contact ID [--contact ID--] has been Message is sent to the sponsoring successfully updated by CIRA. The CPR Registrar when CIRA Admin Category has been changed by CIRA from modifies the CPR Category [--old CPR Category--] to [--new CPR Category--]. 3061 Registrant ID for domain name [--domain Message is sent to the sponsoring name--] has been successfully changed by Registrar when CIRA Admin CIRA from [--old contact ID--] to [--new modifies the Registrant ID for a contact ID--] specific domain name 3062 Contact ID [--old contact ID--] has been Message is sent to the sponsoring successfully updated by CIRA to [--new Registrar when CIRA Admin contact ID--]. modifies the existing Contact ID to a new Contact ID 3063 Admin contact ID for domain name [-- Message is sent to the sponsoring domain name--] has been successfully Registrar when CIRA Admin changed by CIRA from [--old contact ID-- modifies the Admin contact ID for a ] to [--new contact ID--] specific domain name 3064 Domain name [--domain name--]has been Message is sent to the losing transferred to another Registrar. As the Registrar when a domain name is losing Registrar, you will receive a credit transferred during the auto renew for the auto-renew charge. grace period.

The following example is an EPP response to a Poll request when the message contains additional information content but does not contain a reference to a specific Registry object: Command completed successfully; ack to dequeue

60 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Service Messages

2010-01-20T16:58:17.0Z Domain example.ca has been transferred to another Registrar 3027 example.ca CIRA-000323-0000000002

The following example is an EPP response to a Poll request when the message queue is empty. Command completed successfully; no messages ABC-12353 cira-000002-0000000003

Poll Acknowledgement For each Registry Poll response message that contains a message, the Registrar must send a Poll Acknowledgement request that confirms that the message was received and causes the Registry to remove the message from the queue. De-queuing the message makes subsequent messages available for retrieval.

Request The Poll Acknowledgement Request Fields table lists the fields used in a Poll Acknowledgement request. The corresponding EPP element is displayed below the field name.

Table 21: Poll Acknowledgement Request Fields

Field Name / Description EPP Element Message ID The mandatory ID of the message being acknowledged

.CA Registry Guide for Registrars: Version 4.06 61 EPP Interface Overview Chapter 4 Service Messages

Field Name / Description EPP Element Transaction ID If the request contains an optional Registrar Transaction ID, this value will be included in the response.

Response The Poll Acknowledgement response contains the ID of the message that has been acknowledged and the number of messages remaining in the queue. The corresponding EPP element is displayed below the field name. The Poll Acknowledgement Response Fields table lists the fields in a Poll Acknowledgement response. The corresponding EPP element is displayed below the field name. Table 22: Poll Acknowledgement Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Message Count The message count and the Registry message id. Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID). Registry Transaction ID A transaction identifier generated by the Registry when processing the request.

Response / error codes Response codes are returned with the response to a Poll Acknowledgement request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages The Poll Acknowledgment Request Fields table lists the Poll Acknowledgement response and error codes.

Poll Acknowledgement Request Codes

Cause Response Code The request was successful 1300 - Command completed successfully, no messages 1301 - Command completed successfully; ack to dequeue Cause Error Codes

62 .CA Registry Guide for Registrars: Version 4.06 Chapter 4 EPP Interface Overview Service Messages

The request failed due to a syntax error 2000 – Unknown command or Registry policy violation. 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection

EPP Interface The following example is an EPP Poll Acknowledgement request.

ABC-12346

The following example is an EPP response to a Poll Acknowledgement request when the message queue is empty.

Command completed successfully; no messages ABC-12346 cira-000002-0000000003

.CA Registry Guide for Registrars: Version 4.06 63 EPP Interface Overview Chapter 4 Service Messages

64 .CA Registry Guide for Registrars: Version 4.06 Chapter 5

.CA Manager Interface This chapter describes the Registrar’s self management Web Interface known as .CA Manager. The Registrar interface is a web interface that provides access to the Registrar's account information. The Registry implements the Registrar Web Interface as a way for Registrars to access specific features that are available only through .CA Manager. CIRA is working to bring you .CA Manager. The current version, for testing purposes only, contains a download page, some preliminary reports and displays the current Registrar account balance. New features will be added in subsequent releases. Using .CA Manager web interface, Registrars will be able to: • view and manage Registrar information • create, delete, or update domain names, contacts, and hosts • request reports Accessing .CA Manager Registrars will be required to register with CIRA to access .CA Manager. After registration with CIRA, Registrars can use their user name and password to gain access to CIRA’s .CA Manager Web Interface. To access .CA Manager application, login at: https://services.cira.ca/DotCaManager/ When Registrars login to .CA Manager, they must ensure that the user account and password have the proper case or the login will fail.

Note A lack of activity results in .CA Manager ending the session and closing the connection. The time-length of inactivity for .CA Manager is 30 minutes

Reports Reporting via the .CA Manager provides Registrars with a method for reconciling their accounts and comparing their records for accuracy against CIRA registry records. This helps Registrars ensure that there are no inconsistencies. The Reports section of the .CA Manager has two main features: • The Activity Summary reports on all your interactions with the CIRA Registry over a requested monthly reporting period • The Transactions are reports based on all financial interactions over a specified period

.CA Registry Guide for Registrars: Version 4.06 65 .CA Manager Interface Chapter 5 Accessing .CA Manager

Financial Summary You can download Financial Summary Reports from the previous month. The reports are available in a PDF format. The Financial Summary Report for the previous month is available on the 4th of each subsequent month. For example, the Registrar Financial Summary for the month of January 2011 will be available on the 4th of February 2011. To download the Registrar Financial Summary Reports do the following: 1 Go to http://reports.cira.ca/financial_summary 2 Login using your login credentials for your primary Registrar Profile 3 Obtain the desired report Financial Summary Reports for October 2010, November 2010, and December 2010 are also available

66 .CA Registry Guide for Registrars: Version 4.06 Chapter 6

Contacts This chapter describes the creation and management of contacts within the Registry. A domain name must have a relationship to one or more contacts. There are three types of relationships between a domain name and related contacts: • Registrant • Administrative Contact • Technical Contact A contact can only be used as a Registrant if the validation rules are satisfied as described in the “Domain Create” on page 148 and “Domain Update” on page 169 of this document. •The “Contact Check” on page 75 queries whether a subsequent Contact Create request would succeed •The “Contact Info” on page 70 is used to retrieve information associated with an existing contact object The Registry supports these transform requests to modify contact information: •The “Contact Create” on page 79 is used to create a contact object •The “Contact Delete” on page 91 is used to delete a contact object •The “Contact Update” on page 94 request is used to modify the attributes of a contact object Transform requests are typically processed and completed in real time. The Registry may defer completing a requested action if offline review is required. In such situations, the response contains a 1001 response code to indicate that the request has been received and processed, but the requested action is pending. The Registry manages the status of the object that is the subject of the request to reflect the initiation and completion of the requested action. Contact Object Each contact has these properties: Table 23: Contact Objects

Field Name Description Contact ID The Registrar-supplied contact identifier Address Type The contact postal address type The only Registry-supported type is "loc", indicating that the address is in a localized form Name The name of the individual or organization See “About valid and invalid Contact names” on page 201 for more information on valid and invalid contact names

.CA Registry Guide for Registrars: Version 4.06 67 Contacts Chapter 6 Contact Object

Field Name Description Organization The name of the organization with which the contact is affiliated Street The street address comprising from one to three fields City The address city name State or Province The address province

See “Canadian Provinces” on page 213”, for valid Canadian provincial codes Postal Code The address postal code Country Code The address country code See “Country Codes” on page 206, for a list of country codes Phone The contact’s telephone number Fax The contact’s fax number Email The contact’s email address Authorization The contact’s authorization information Information Preferred Language The contact’s preferred language for communication • "en" for English • "fr" for French CPR Category The Registrant CPR category. Contacts used in Administrative Contact or Technical relationships do not require CPR Category See the “Valid Canadian Presence Requirement values” on page 35 Individual An indicator denoting whether the CPR category is defined as individual Y or N WHOIS Privacy An indicator denoting whether the information of the Registrant is partially displayed (PRIVATE) or displayed in full (FULL) Contacts used solely for Administrative Contact or Technical Roles do not require WHOIS Privacy and this field must be empty

68 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Object

Field Name Description Agreement Fields The values associated with the CIRA Registrant Agreement. Providing data in the Agreement fields, along with CPR Category data allows for creation of a contact that can be immediately used in the role of the Registrant for a domain name. In this case, the Registrar presents the Registrant Agreement to the Registrant on the Registrar’s website during the Registration process in a manner prescribed by CIRA. See “Using CIRA's Registrant Agreement Page” on page 38 for more information. If CPR Category data is submitted but Agreement Fields data is not submitted, CIRA assumes that the Registrar prefers to use the alternate method in which the Registrar directs the Registrant to visit a CIRA website to agree to the Registrant Agreement within 7 days. In either case, the contact used as the Registrant is required to accept the agreement • Agreement Version The version of CIRA’s Registrant Agreement that was displayed to the Registrant on the Registrar’s website and agreed to by the contact • Contact Signed Agreement An indication whether the contact has agreed to CIRA’s Registrant Agreement ("Y" or "N") Contacts used solely for Administrative Contact or Technical Roles do not require Agreement Fields Original Registrant The IP address associated with the request from the Registrant to IP address the Registrar to create the contact, in either IPv4 or IPv6 format Registrar Reseller The ID of the Registrar Reseller associated with the contact create ID request

Status Values A contact object always has at least one associated status value. Each status value is accompanied by text that describes the rationale for the status applied to the object. The sponsoring Registrar can explicitly add or remove status values prefixed with "client" using a Contact Update request, but must not alter other status values. The Registry may change any status value.

Table 24: Contact Status Values

.CA Registry Guide for Registrars: Version 4.06 69 Contacts Chapter 6 Contact Info

Status Description clientDeleteProhibited The Registry will reject requests to delete the object serverDeleteProhibited clientUpdateProhibited The Registry will reject requests to update the object (other than to remove this status) serverUpdateProhibited pendingCreate A transform request has been processed for the object, but the action has not been completed by the Registry. The pendingCreate status occurs when a contact has CPR Category data, but does not have Agreement Fields data pendingDelete Pending Delete domain names are in a one day period where the domain name is prepared for release to the "available" state.

Contact Info A successful Contact Info request retrieves information associated with an existing contact. Only the sponsoring Registrar can receive a successful response to the contact EPP request.

Request The Contact Info Table lists the XML fields that may be used in a Contact Info request. The corresponding EPP element is displayed below the field name.

Table 25: Contact Info Request Fields Name Type Usage Description Valid values Contact ID Varchar2 (16) Mandatory The identifier of Length is 3 – 16 the contact to be alphanumeric queried characters Registrar Varchar2 (64) Optional The transaction Transaction ID identifier generated by the Registrar when submitting the request

Response The Contact Info Response Fields table lists the XML fields that may occur in the response to a Contact Info request. The corresponding EPP element is displayed below the field name.

Table 26: Contact Info Response Fields

70 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Info

Element Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Contact ID The client-supplied identifier for the information contact:id> Registry ID The identifier assigned by the Registry when the object was created Status One or more status indicators describing the status of the contact object Address Type The postal address information The is saved as localized: Name The name of the individual contact Organization The name of the organization with which an individual is affiliated, when applicable Address The address information associated with the contact, such as: • Street - One to three elements are permitted. These elements contain the contact’s street address • City - the name of the city where the contact resides • State or Province - the province in which the contact resides, when applicable • Postal code - the contact’s postal code, when applicable Country code - the contact’s two-character country code, as recognized by ISO Phone The contact’s telephone number

.CA Registry Guide for Registrars: Version 4.06 71 Contacts Chapter 6 Contact Info

Element Description Fax The contact’s fax number Email The contact’s email address Contact Sponsor ID The identifier of the sponsoring Registrar Creator ID The identifier of the Registrar that created the contact object in the Registry Creation Date The creation date and time that the contact object was created in the Registry Update ID The identifier of the Registrar that last updated the contact information. This field is not present if the contact object has never been updated Update Date The date and time of the most recent contact object modification This field is not present if the contact object has never been updated Preferred Language The contact’s preferred language for communication CIRA supports English and French CPR Category The acronym of the type of Registrant that can register a domain name. See the “Valid Canadian Presence Requirement values” on page 35 section of this document Individual or Non- The "Y" or "N" parameter that indicates whether the CPR Category is Individual an individual or non-individual legal type Y - indicates that the CPR category is an individual N - indicates that the CPR category is a non-individual Agreement Version The version of the CIRA agreement that was given assent by the Registrant Agreement Timestamp A timestamp that records the time that the CIRA agreement was accepted Originating IP Address The Registrant IP address associated with the current request, in either IPv4 or IPv6 format WHOIS Display The indicator that defines the display information about the contact in the WHOIS Values are: • PRIVATE - displays limited information • FULL - displays all available information

72 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Info

Element Description Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID The transaction identifier generated by the Registry when processing the request

Response / Error codes Response codes are returned with the response to a Contact Info request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages.

Table 27: Contact Info Response / Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully General response error codes The request failed due to a syntax error 2000 – Unknown command or Registry policy violation 2001 – Command syntax error 2002 – Command use error 2101 – Unimplemented command 2102 – Unimplemented option 2201 – Authorization error 2307 – Unimplemented object 2308 – Data management policy violation 2400 – Command failed Field-specific response error codes

.CA Registry Guide for Registrars: Version 4.06 73 Contacts Chapter 6 Contact Info

The Contact Name field is incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2303 – Object does not exist 2306 – Parameter value policy error 7010 – contact ID does not exist 7011 – Only the sponsor of the Contact ID can perform this function 7017 – The contact name is not a legal Canadian entity – see documentation 7028 – Invalid contact name format - length is 2 - 255 characters 7045 – The contact name contains a restricted word - your request is denied 7047 – Missing parameter - enter the contact's name

EPP Interface The following example is an EPP Contact Info request. 11aabb ABC-22345

The following example is a successful response to a Contact Info request.

Command completed successfully 11aabb roid1

74 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Check

Contact Middle-name LastName 123 Everywhere Street Ottawa ON K1R7S8 CA [email protected] 123 456 2010-01-07T18:18:53.0Z en CCT Y 2.0 2010-01-26T18:18:53.0Z 192.168.45.59 PRIVATE CIRA-000108-0000000004

Contact Check A successful Contact Check request determines whether a contact is available for use and whether a contact can be created in the Registry. When creating a new contact, the Registrar must generate a Registry-unique contact ID. A Registry Contact Check request can determine whether an ID is already in use. A single request can check from 1 to 15 contacts.

Request Contact Check Request Fields lists the XML fields that may be used in a Contact Check request. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 75 Contacts Chapter 6 Contact Check

Table 28: Contact Check Request Name Type Usage Description Valid Values Contact ID Varchar2 (16) Mandatory The identifier of the contact object Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response Contact Check Response Fields table lists the fields that may occur in the response to a Contact Check request. The corresponding EPP element is displayed below the field name. Table 29: Contact Check Response Fields

Element Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Contact ID Identifies the queried object Contains one of the following values: – A value of "true" means yes it can be provisioned – A value of "false" means no, the name registration cannot be provisioned at this time

76 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Check

Element Description Reason For each contact, a reason is provided when a contact cannot be created.The reason does not return a value, only descriptive text. The following reasons are returned for Contact Check: • Invalid contact ID format- range is 3-16, characters must be alphanumeric • Selected contact ID is not available Registrar Transaction ID If the request contains an optional Registrar Transaction ID, this value will be included in the response Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response / Error Codes Response codes are returned with the response to a Contact Check request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The following table lists the Contact Check response and error codes.

Table 30: Contact Check Response / Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully General response error codes The request failed due to a syntax error 2000 – Unknown command or Registry policy violation. 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2306 – Parameter value policy error 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed

.CA Registry Guide for Registrars: Version 4.06 77 Contacts Chapter 6 Contact Check

Contact ID check list is incorrect 2004 – Parameter value range error 2306 – Parameter value policy error 7002 – Contact ID check list has an invalid number of contact IDs - range is 1 - 15 Field-specific response error codes Contact ID field is incorrect 2003 – Required parameter missing 2306 – Parameter value policy error 7001 – Invalid contact ID format - range is 3 - 16, characters must be alphanumeric 7006 – Missing parameter - enter contact ID

EPP Interface The following example is an EPP Contact Check request. sh8017 sah8013 8013sah id1 ABC-12345

The following example is an EPP response to a successful Contact Check request Command completed successfully sh8017 sah8013 8013sah

78 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Create

id1 Selected contact ID is not available ABC-12345 CIRA-000000000903-0000000004 Contact Create A successful Contact Create request creates a contact object in the Registry. CIRA classifies each contact as either individual or non-individual based on information provided. Administrative and technical contacts must be individuals. Registrant contacts may be an individual or a non-individual but must supply information for Canadian presence compliance. Registrant contacts are required to accept the terms of the CIRA Registrant Agreement. See the “Understanding the CIRA Registrant Agreement” on page 36 of this document. To create a domain name successfully, a Registrar does not need to be the sponsor of the related hosts but must be the sponsor of all assigned contacts. When you subsequently create a domain name, you create relationships between the domain name and previously created contacts. If a contact is not associated with a registered domain name within 60 days after it is created, the contact status is set to pendingDelete. If the contact pendingDelete status remains for a further 30 days, the contact is deleted and the Registry sends a service message to the contact’s sponsor. There are three types of domain-contact relationships: • A single "Registrant" domain-contact object relationship denotes the person or organization that holds the domain name registration. If a contact object is to be used as a domain name Registrant then it must satisfy specific Registry requirements. • A single "Administrative Contact" domain-contact object relationship denotes the person who, along with the Registrant contact, is also notified of important changes to the domain name registration • From zero to three "Technical Contact" domain-contact object relationships denote people who typically administer technical information for a registered domain name.

Request Contact Create Request Fields lists the XML fields that may be used in a Contact Create request. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 79 Contacts Chapter 6 Contact Create

Table 31: Contact Create Request Fields Name Type Usage Description Valid Values Contact ID Varchar2 (16) Mandatory The Registrar- supplied contact identifier Address type Varchar2 (255) Optional The contact The only type supported type is "loc", indicating that the address is in a localized form Name Varchar2 (255) Mandatory The name of the This can be the contact name of an individual or an organization. See “About valid and invalid Contact names” on page 201 Organization Varchar2 (255) Optional The name of the If the contact organization with name is an which the contact individual, an is affiliated organization can be entered. Otherwise, it must be omitted. Street Varchar2 (255) Optional The street address There can be as many as three street addresses City Varchar2 (255) Optional The address city name Mandatory for Admin and Tech contacts State or Province Varchar2 (255) Mandatory The address See “Canadian province Provinces” on Optional for page 213 and Registrant “US States, contacts Territories, or Regions” on page 214

80 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Create

Table 31: Contact Create Request Fields Name Type Usage Description Valid Values Postal code Varchar2 (40) Mandatory The address See “Province postal code Codes” on Optional for page 213 Registrant contacts Country code Varchar2 (2) Mandatory The address See “Country country code Codes” on Optional for page 206 Registrant contacts Phone Varchar2 (50) Optional The contact’s See “Telephone telephone and Fax Mandatory for number Numbers” on Admin and Tech page 205 contacts Fax Varchar2 (50) Optional The contact’s fax See “Telephone number and Fax Numbers” on page 205 s Email Varchar2 (320) Mandatory The email Format is address [email protected] Optional for Registrant contacts Preferred Varchar2 (2) Mandatory The contact’s • English, enter Language preferred "en" language for • French, enter communication "fr" Originating IP Varchar2 (240) Optional The originating Address Registrant IP associated with the current request, in either IPv4 or IPv6 format CPR Category Varchar2 (20) Mandatory for The category “Understanding contacts Canadian Registrants” on Presence page 191 Optional for Admin and Tech contacts

.CA Registry Guide for Registrars: Version 4.06 81 Contacts Chapter 6 Contact Create

Table 31: Contact Create Request Fields Name Type Usage Description Valid Values Agreement Varchar2 (4) Mandatory for Version of the Version synchronously CIRA Registrant Registrant when displayed and the CIRA agreed to by the Registrant Registrant on the Agreement is Registrar website displayed and agreed to on the Registrar website. Must not be provided if the Registrar plans to direct the Registrant to the CIRA website within 7 days to agree to the Registrant Agreement. Optional for Admin and Tech contacts

82 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Create

Table 31: Contact Create Request Fields Name Type Usage Description Valid Values Agreement Value Varchar2 (1) Mandatory for An indication Y, N creating a contact has Registrant when agreed to CIRA’s the CIRA Registrant Registrant Agreement ("Y" Agreement is or "N") displayed and agreed to on the Registrar website. Must not be provided if the Registrar plans to direct the Registrant to the CIRA website within 7 days to agree to the Registrant Agreement. Optional for Admin and Tech contacts Created by Varchar2 (255) Optional The ID of the Reseller Registrar associated with the current request Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Registry Actions When a request creates a contact having CPR data but not having agreement data, the Registry performs the following actions until its Canadian presence status is determined by the Registry: The contact pending create status flag is set for any associated domain, the life cycle stage is set to Pending Create and the Pending Create status flag is set.

.CA Registry Guide for Registrars: Version 4.06 83 Contacts Chapter 6 Contact Create

Response The Contact Create Response Fields lists the XML fields that may occur in the response to a Contact Create request. The corresponding EPP element is displayed below the field name. Table 32: Contact Create Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Contact ID The contact identifier supplied by the Registrar Creation Date The date and time the contact was created in the Registry Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response Codes Response codes are returned with the response to a Contact Create request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. Table 33: Contact Create Response Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully 1001 – Command completed successfully; action pending General response error codes

84 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Create

The request failed due to a syntax error 2000 – Unknown command or Registry policy violation. 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2306 – Parameter value policy error 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection 7011 – Only the sponsor of the contact ID can perform this function Field-specific response error codes The Contact ID field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2302 – Object exists 7001 – Invalid contact ID format - range is 3 - 16, characters must be alphanumeric 7006 – Missing parameter - enter contact ID 7009 – Contact ID already exists 7010 – Contact ID does not exist The Contact Address field was incorrect 7027 – Only localized postal addresses are accepted at this time – type must be "loc" 7065 – Missing attribute - enter type for parameter postalInfo 7066 – CIRA policy permits only one postalInfo section

.CA Registry Guide for Registrars: Version 4.06 85 Contacts Chapter 6 Contact Create

The Contact Name field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2306 – Parameter value policy error 7017 – The contact name is not a legal Canadian entity – see documentation 7028 – Invalid contact name format - length is 2 - 255 characters 7045 – The contact name contains a restricted word - your request is denied 7047 – Missing parameter - enter the contact's name The Organization field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7021 – Organization cannot be entered when the CPR Category indicates a non-individual - see documentation 7029 – Invalid organization name format - length is 2 - 255 characters The Street field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7030 – Invalid street format - length is 2 - 255 characters 7046 – Missing parameter - provide at least one street entry The City field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7031 – Invalid city format - length is 2 - 255 characters

7032 – Missing parameter - enter the city

86 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Create

The Province or State field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7033 – Invalid province or state format - length is 2 - 255 characters - must be alphabetic 7034 – Invalid province code format - see documentation 7048 – The US state code is invalid - see documentation The Postal Code field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7008 – Missing parameter - enter the postal code 7035 – Invalid postal code format - length is 6 - 40 characters - must be alphanumeric 7049 – The zip code format is invalid – enter a valid numeric zip code between 5 and 10 characters The Country Code field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7036 – Invalid country code - see documentation 7056 – Missing parameter - enter the country code The (voice) Telephone Number field 2004 – Parameter value range error was incorrect 2005 – Parameter value syntax error 7037 – Invalid telephone number format - see documentation The Fax Number field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7038 – Invalid fax format - see documentation The Email Address field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7039 – Missing parameter - enter the email address 7040 – Invalid email address format - length is 6 - 320 characters - format: [email protected]

.CA Registry Guide for Registrars: Version 4.06 87 Contacts Chapter 6 Contact Create

The Preferred Language field was 2003 – Required parameter missing incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7042 – CIRA supports en (English) and fr (French), only 7057 – Missing parameter - enter a CIRA language preference The Originating IP Address 2004 – Parameter value range error 2005 – Parameter value syntax error 7043 – Invalid IP format - see documentation The Canadian Presence Requirement 2004 – Parameter value range error Category field was incorrect 2005 – Parameter value syntax error 7004 – Invalid CPR Category parameter - see documentation for valid CPR Category values 7052 – Invalid CPR value for Legal Representative – CPR category value must be LGR 7053 – Invalid CPR value for Trade or Official mark value – CPR category must be TMI, TMN, or OMK The CIRA Registrant Agreement fields 2005 – Parameter value syntax error are incorrect 7012 – The request must contain both values for all or none of CIRA Agreement Version, Contact Signed Agreement 7013 – Invalid CIRA Registrant Agreement Version 7015 – Invalid Contact Signed Agreement indicator 7068 – The CIRA Agreement data cannot be updated The CIRA Registrant Agreement fields 7012 – CIRA Agreement Version, Contact Signed are incorrect Agreement 7013 – Invalid Version of the CIRA Agreement 7015 – Registrant must agree to the CIRA Agreement The IP Address field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7043 – Invalid IP format - see documentation The Registrar Reseller’s ID field was 7071 – Invalid Reseller ID format - length must be less incorrect than 255 characters

88 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Create

The request failed due to a syntax error 2308 – Data management policy violation or Registry policy violation, in this case, 7074 – Missing parameter - enter a CPR category the CPR category is missing, the agreement has been provided. Registry Policy of CIRA policy

EPP Interface The following example is an EPP Contact Create request.

sh8021 John Doe Example Inc. 350 Sparks Street Suite 306 Ottawa ON K1R 7S8 CA +1.6132375335 +1.6132370534 [email protected] en 192.118.22.26 CCT 2.0 Y 12345 ABC-12345

The following example is an EPP response to a successful Create Contact request.

.CA Registry Guide for Registrars: Version 4.06 89 Contacts Chapter 6 Get Agreement

Command completed successfully sh8020 2010-05-27T17:52:21.0Z ABC-12345 CIRA-000001-0000000006

Get Agreement Registrars are encouraged to present the CIRA Registrant agreement to the Registrant from their website on behalf of CIRA. When a Registrar chooses to display the CIRA Registrant Agreement to their clients, they are responsible for getting the up-to-date copy of the Registrant Agreement via EPP and presenting it to the Registrant as prescribed. Registrars are required to present the agreement to each new Registrant. The agreement text will contain (XML-encoded) HTML tags for text emphasis,

Note CIRA requires the use of the and tags for the GetAgreement. See the following XML code example of a CIRA EPP request for GetAgreement

The following XML code is an example of a CIRA EPP request for GetAgreement:

get CIRA latest agreement en

The following XML code is an example of a CIRA EPP response for GetAgreement:

Command completed successfully

90 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Delete

en 2.0 <p align="center"><strong>DRAFT <br />Registrant Agreement<br / >Version 2.0, January 15, 2010</strong></p> <p>This agreement (the &ldquo;Agreement&rdquo;) is between you (the &ldquo;<strong>Registrant</strong>&rdquo;) and the Canadian Internet Registration Authority (&ldquo;<strong>CIRA</ strong>&rdquo;).</p> <p>In consideration of the registration by CIRA of the Domain Name applied for by the Registrant in the name of the Registrant, and other good and valuable consideration, the receipt and adequacy of which are hereby acknowledged, CIRA and the Registrant agree as follows:</ p> <p align="center"><strong>ARTICLE 1<br >INTERPRETATION</strong></p> …complete agreement here CIRA-000102-0000000002

Note The Registrant Agreement is readable HTML encoded and when it is passed through EPP, XML encoding is used to replace special characters. For example '&" was replaced with '&' (HTML converts the angle brackets, quotes, ampersands, etc. to the entity values to prevent the HTML parser from confusing it with XML markup.) However, your EPP client should remove the XML encoding.

Contact Delete A successful Contact Delete request deletes a contact object from the Registry.

Request The Registry will notify the Registrar of object relationships when a Contact Delete request is attempted and fails due to existing relationships.

Note The Registry will reject a request to delete a contact ID if the contact ID is associated with a domain. Update the domain to remove the relationship before deleting the contact.

The Contact Delete Request Fields table lists the fields used in a Contact Delete request. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 91 Contacts Chapter 6 Contact Delete

Table 34: Contact Delete Request Fields Name Type Usage Description Valid Values Contact ID Varchar2 (16) Mandatory The contact identifier of the contact object to be deleted Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response The Contact Delete Response Fields table lists the XML fields that may occur in the response to a Contact Delete request. the corresponding EPP element is displayed below the field name.

Table 35: Contact Delete Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID). Registry Transaction ID A transaction identifier generated by the Registry when processing the request.

92 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Delete

Response Codes Response codes are returned with the response to a Contact Delete request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The Contact Delete Response Codes lists Contact Delete response codes and their causes. Table 36: Contact Delete Response Codes

Cause Response Code The request was successful 1000 – Command completed successfully General response codes The request failed due to a 2000 – Unknown command syntax error or Registry policy 2001 – Command syntax error violation 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection Object association in effect 2305 – Object association prohibits operation Request not initiated by the 2201 – Authorization error contact’s sponsor 7011 – Only the sponsor of the contact ID can perform this function Status prohibits the request 2304 – Object status prohibits operation Field-specific response codes The Contact ID field was 2003 – Required parameter missing incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 2303 – Object does not exist 2306 – Parameter value policy error 7001 – Invalid contact ID format - range is 3 - 16, characters must be alphanumeric 7006 – Missing parameter – enter the contact ID 7010 – Contact ID does not exist

.CA Registry Guide for Registrars: Version 4.06 93 Contacts Chapter 6 Contact Update

EPP Interface The following example is an EPP Contact Delete request. 11aabb ABC-55555

The following example is an EPP response to a successful Contact Delete request.

Command completed successfully ABC-55555 CIRA-000000000108-0000000009

Contact Update A successful Contact Update request modifies a contact object in the Registry. An update request may contain a combination of add, delete, and change field operations; at least one of these operations must be specified. If more than one of these operations is specified, the operations are processed in the order: remove, add, and then change. The Registry rejects a request to set the WHOIS Privacy field in a Contact Create request, but will allow this field to be updated (for an Individual contact) using a subsequent Contact Update request. The Registry rejects a request to update CIRA Agreement fields. See the CIRA Registrant Agreement section of this document for information about the CIRA Agreement.

Note To delete a value when submitting a Contact Update request, leave the property field blank. Mandatory fields must contain valid values.

94 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Update

Request The Contact Update Request Fields table lists the fields used in a Contact Update request. The corresponding EPP element is displayed below the field name.

Table 37: Contact Update Request Fields Name Type Usage Description Valid Values Contact ID Varchar2 (16) Mandatory The Registrar- supplied contact identifier Added and Optional The field values Removed Field that can be Values removed Status values Varchar2 (50) Status of the When specifying contact object a value to be added or removed, only the attribute value is significant. The element text is not required to match a value for removal of a status See “Status values” on page 20 Changed Field Optional The set of field Values values that can be modified Name Varchar2 (255) Mandatory The name of the Must be a legal contact Canadian entity - see “Presenting CPR Categories” on page 34 Organization Varchar2 (255) Optional The name of the submitted when organization to the CPR which the contact Category is affiliated indicates an individual Street Varchar2 (255) Optional The contact’s At least one street street address address field must have data City Varchar2 (255) Optional The city where the contact resides

.CA Registry Guide for Registrars: Version 4.06 95 Contacts Chapter 6 Contact Update

Table 37: Contact Update Request Fields Name Type Usage Description Valid Values State or Province Varchar2 (255) Mandatory for The contact’s See “Province Canadians state or provincial Codes” on code page 213 Postal code Varchar2 (40) Optional The contact’s See “Postal postal code Codes” on page 205 Country code Varchar2 (2) Mandatory The contact’s See “Country country code Codes” on page 206 Phone number Varchar2 (50) Optional The contact’s See “Telephone phone number Numbers” Fax number Varchar2 (50) Optional The contact’s fax See “Telephone number and Fax Numbers” on page 205 Email Varchar2 (320) Mandatory The contact’s Format is email address [email protected] Optional for Registrant You cannot update the email address if it has been changed within the previous 60 days Preferred Varchar2 (2) Optional The preferred English, enter language language in “en” which the contact French, enter “fr” would like to correspond CPR Category Varchar2 (20) Mandatory The contact’s See“Valid CPR category Canadian Presence Requirement values” on page 35t

96 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Update

Table 37: Contact Update Request Fields Name Type Usage Description Valid Values WHOIS Privacy Varchar2 (20) Optional The privacy An individual can determining what PRIVATE contact is a non- is displayed (for information individual, you individuals only) can not update To find out if a on the WHOIS this data Registrant contact is an individual or not see “Registrant WHOIS Privacy” on page 36 Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response The Contact Update Response Fields table lists the fields that may occur in the response to a Contact Update request. The corresponding EPP element is displayed below the field name.

Table 38: Contact Update Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 8046 is "This status request cannot proceed at this time" Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID)

.CA Registry Guide for Registrars: Version 4.06 97 Contacts Chapter 6 Contact Update

Field Name / Description EPP Element Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response Codes The following response codes may be returned with the response to a Contact Update request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The Contact Update Responses Codes table lists response scenarios and the associated response codes.

Table 39: Contact Update Response Codes

Cause Response Code The request was successful 1000 - Command completed successfully General response codes The request failed due to a syntax error or 2000 – Unknown command Registry policy violation 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2306 – Parameter value policy error 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection 7011 – Only the sponsor of the contact ID can perform this function 7067 – The CIRA Individual parameter cannot be updated Authorization error 2201 – Authorization error 7011 – Only the sponsor of the contact ID can perform this function

98 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Update

Status flags were set incorrectly 2201 – Authorization error 2304 – Object status prohibits operation 7011 – Only the sponsor of the contact ID can perform this function 7016 – The specified value is already set 7018 – clientDeleteProhibited and clientUpdateProhibited are valid status values 7019 – You must remove the updateProhibited flag before you can update other Contact fields 7020 – You must have permission to enable this status value 7064 – The specified status value is not set WHOIS display setting 7061 – The WHOIS Display Setting cannot be updated for an Admin or Tech Contact 7062 – The WHOIS Display Setting cannot be updated for a Non-Individual Registrant 7063 – The WHOIS Display Setting cannot be updated for a Registrant who has not signed the CIRA Agreement Field-specific response codes The Contact ID field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2303 – Object does not exist 7001 – Invalid contact ID format - range is 3 - 16, characters must be alphanumeric 7006 – Missing parameter - enter contact ID 7009 – Contact ID already exists 7010 – Contact ID does not exist – For incorrect Removed, Added, and Changed field values, see the following individual fields for field-specific error codes

.CA Registry Guide for Registrars: Version 4.06 99 Contacts Chapter 6 Contact Update

The Contact Address field was incorrect 7027 – Only localized postal addresses are accepted at this time – type must be "loc" 7065 – Missing attribute - enter type for parameter postalInfo 7066 – CIRA policy permits only one postalInfo section The Contact Name field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2303 – Object does not exist 7017 – The contact name is not a legal Canadian entity 7028 – Invalid contact name format - length is 2 - 255 characters 7045 – The contact name contains a restricted word - your request is denied 7047 – Missing parameter - enter the contact's name 7055 – The contact name cannot be updated when the contact is linked to a domain The Organization Name field is incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7021 – Organization cannot be entered when the CPR Category indicates a non-individual - see documentation 7029 – Invalid organization name format - length is 2 - 255 characters The Street field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7030 – Invalid street format - length is 2 - 255 characters 7046 – Missing parameter - provide at least one street entry

100 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Update

The City field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7031 – Invalid city format - length is 2 - 255 characters 7032 – Missing parameter - enter the city The Province or State field was incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7033 – Invalid province or state format - length is 2 - 255 characters - must be alphabetic 7034 – Invalid province code - see documentation 7048 – The US state code is invalid - see documentation The Postal Code field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7008 – Missing parameter - enter the postal code 7035 – Invalid postal code format - length is 6 - 40 characters - must be alphanumeric 7049 – The zip code format is invalid – enter a valid numeric zip code between 5 and 10 characters The Country Code field was incorrect. 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7036 – Invalid country code - see documentation 7056 – Missing parameter - enter the country code The (voice) Telephone Number field was 2004 – Parameter value range error incorrect 2005 – Parameter value syntax error 7037 – Invalid telephone number format - see documentation The Fax Number field was incorrect 2004 – Parameter value range error Enter the Fax number in the same format 2005 – Parameter value syntax error as a telephone number. 7038 – Invalid fax format - see documentation

.CA Registry Guide for Registrars: Version 4.06 101 Contacts Chapter 6 Contact Update

The Email Address field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 7018 – Valid status values include clientDeleteProhibited, clientUpdateProhibited 7039 – Missing parameter - enter the email address 7040 – Invalid email address format - length is 6 - 320 characters – alphanumeric and dash (-) and underscore (_) characters format: [email protected] The Preferred Language field was 2003 – Required parameter missing incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 7042 – CIRA supports en (English) and fr (French), only 7057 – Missing parameter - enter a CIRA language preference The Canadian Presence Requirement 2004 – Parameter value range error Category field was incorrect 2005 – Parameter value syntax error 7004 – Invalid CPR Category parameter - see documentation for valid CPR Category values 7058 – The CPR Category cannot be updated when the original value was not set 7059 – The CPR Category cannot be updated to a Non-Individual category at this time - see documentation 7060 – The CPR Category cannot be updated to an Individual category at this time - see documentation 7067 – The CIRA Individual parameter cannot be updated

102 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Update

EPP Interface The following examples are EPP Contact Update requests. movingon Updated Name Field 32 Wish Bone Avenue Apt 1526 Ottawa ON K4M 1N6 CA [email protected] +1.6134952323 +1.6134952324 CIRA-domain-0000035

The following example is an EPP Contact Update request: francais +1.4162220000 fr CIRA-domain-0000036

.CA Registry Guide for Registrars: Version 4.06 103 Contacts Chapter 6 Contact Update

The following example is an EPP Contact Update request: deletable ABC-12345

The following example is an EPP response to a successful Contact Update request. Command completed successfully CIRA-domain-0000037 CIRA-000016-0000000143

The following example is the EPP response to an unsuccessful Contact Update request. Object does not exist 7010 Contact ID does not exist ABC-12345 CIRA-000115-0000000006

104 .CA Registry Guide for Registrars: Version 4.06 Chapter 6 Contacts Contact Update

.CA Registry Guide for Registrars: Version 4.06 105 Contacts Chapter 6 Contact Update

106 .CA Registry Guide for Registrars: Version 4.06 Chapter 7

Hosts This chapter describes EPP mapping for the provisioning and management of Internet host objects that are stored within the CIRA EPP repository. The mapping defines EPP request syntax as applied to host names. An EPP host object has attributes and associated values that can be viewed and modified by the sponsoring Registrar. When you create or update a host you must follow the rules that ensure that the domain name can still resolve even if there is an outage of any individual host or network. This means that two or more unique name servers must be defined for each protocol in use. Although you can use the IPv4 and IPv6 protocols concurrently, they are not interchangeable or compatible. Hence, if you want to use both protocols, you must provide data for two unique name servers that are accessible by IPv4 and two unique name servers that are accessible by IPv6. The host EPP requests are: • “Host Check” on page 113 - determines whether a host name is available for use and whether it can be created in the Registry • “Host Info” on page 108 - retrieves detailed host information • “Host Create” on page 116 - creates a host object, identified by its name, in the Registry • “Host Update” on page 122 - updates host information • “Host Delete” on page 130 - deletes a host object from the Registry Host Object A host object represents a Domain Name System (DNS) server that resolves domain names into IP addresses. From time to time CIRA may delete “orphan” registry host objects that are not referenced by any domain. Table 40: Host Object Properties

Field Name Description Name The host name comprising segments of alphanumeric characters delimited by period characters Host Address The IPv4 addresses of the host Host Address The IPv6 addresses of the host Sponsor ID The identifier of the sponsoring Registrar Creator ID The Registrar that created the domain object Creation Date The creation date and time of the domain object Updater ID The Registrar that last updated the domain information This element is empty if the host has never been updated Update Date The date and time of the most recent object modification This value is empty if the host has never been updated

.CA Registry Guide for Registrars: Version 4.06 107 Hosts Chapter 7 Host Info

Field Name Description Superordinate The relationship that the parent domain object has with the child host domain object The host object has a lesser relationship to a superior or superordinate domain object Example: ‘ns1.super.ca’ has a lesser or subordinate relationship to domain name ‘super.ca’

Status Values A host object always has at least one associated status value. Each status value is accompanied by text that describes the rationale for the status applied to the object. The sponsoring Registrar can explicitly add or remove status values prefixed with "client" using a Host Update request, but must not alter other status values. The Registry may change any status value.

Table 41: Host Status Values

Status Value Description clientDeleteProhibited, The Registry will reject requests to delete the object serverDeleteProhibited clientUpdateProhibited, The Registry will reject requests to update the object (other than serverUpdateProhibited to remove this status)

When the requested action has been completed, the Registry removes the pendingCreate, pendingDelete, or pendingUpdate status value. The Registry uses a service message to notify all Registrars involved in a pending transaction that the action has been completed or has been rejected and that the status of the object has changed.

Host Info A successful Host Info request retrieves detailed host information.

Request Host Info Request Fields table lists the XML fields that may be used in a Host Info request. The corresponding EPP element is displayed below the field name.

108 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Info

Table 42: Host Info Request Fields Name Type Usage Description Valid Values Name Varchar2 (255) Mandatory The identifier of Beginning and the host to be middle sections: queried must – contain alphanumeric characters – be separated by a period (.) contain from one to 63 characters may contain – hyphens (-) but the section may NOT begin or end with a (-). NO other special characters are permitted The last (TLD) section must: – contain only alphabetic characters – contain at least two characters Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

.CA Registry Guide for Registrars: Version 4.06 109 Hosts Chapter 7 Host Info

Response Host Info Response Fields table lists the XML fields that may occur in the response to a Host Info request. The corresponding EPP element is displayed below the field name.

Table 43: Table 2: Host Info Response Fields

Element Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is “This status request cannot proceed at this time” Name The name of the host Registry ID The system-generated repository object identifier that was assigned to the host object when the object was created Status One or more flags describing the status of the host object Host Address The IP addresses associated with the host object Sponsor ID The identifier of the sponsoring Registrar Creator ID The identifier of the Registrar object representing the Registrar that created the domain object Creation Date The creation date and time of the domain object in the Registry Updater ID The optional identifier of the Registrar that last updated the object. This element is empty if the object has never been updated Update Date The optional date and time of the most recent object modification. This value is empty if the host has never been updated Transfer Date The optional date and time of the most recent successful domain transfer This value is empty if the domain has never been transferred Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

110 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Info

Response and Error Codes Response codes are returned with the response to a Host Info request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. Host Info Response and Error Codes table lists Host Info response and error codes and their causes. Table 44: Host Info Response and Error Codes

Cause Response and Error Code The request was successful 1000 – Command completed successfully General response error codes The request failed due to a syntax error 2000 – Unknown command or Registry policy violation 2001 – Command syntax error 2002 – Command use error 2101 – Unimplemented command 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 6002 – Host name check list has an invalid number of host names - range is 1 - 15 6008 – Domain does not exist. Domain must exist before performing this function 6022 – Missing XML namespace declaration Field-specific response error codes The Host Name field is incorrect 2003 – Required parameter missing 2303 – Object does not exist 2306 – Parameter value policy error 6001 – Invalid host name format - see documentation 6006 – Missing parameter - enter host name 6010 – Host does not exist

.CA Registry Guide for Registrars: Version 4.06 111 Hosts Chapter 7 Host Info

EPP Interface The following example is an EPP Host Info request.

ns1.cira1.ca ABC-12345

The following example is a response to a successful EPP Host Info request.

Command completed successfully ns1.cira1.ca ns1.cira11-REP 18.28.82.89 abcd.0123.12.15.99.60 503 500 2010-02-25T20:14:51.0Z 500 2009-04-03T13:42:07.0Z 2009-06-05T19:46:07.0Z ABC-12345 CIRA-000000000104-0000000003

The following example is a response to an unsuccessful EPP Host Info request. The following response results when the request had a missing host:name tag.

112 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Check

Command syntax error ABC-12345 cira-000001-0000002

Host Check A successful Host Check request determines whether a host is available for use and whether a host can be created in the Registry. A single request can check from 1 to 15 host names.

Request Host Check Request Fields lists the XML fields that may be used in a Host Check Request. The corresponding EPP element is displayed below the field name.

Table 45: Host Check Request Fields Name Type Usage Description Valid Values Name Varchar2 (255) Mandatory The host name Comprised of segments of alphanumeric characters delimited by period characters, for example: ab1.cdefg.ca Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response Host Check Response Fields lists the XML fields that may occur in a response to a Host Check Request. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 113 Hosts Chapter 7 Host Check

Table 46: Host Check Response Fields

Field Name Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred lanugage. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Host Name The name of the checked host object Where “*” represents the value "true" or "false": • A value of "true" means it can be provisioned • A value of "false" means that the host name cannot be provisioned at the current time Reason For each host name, a reason is provided when a host name cannot be created.The reason does not return a value, only descriptive text. The following reasons are returned for Host Check: • Invalid host name format - see documentation • Selected Host is not available • Available, but domain does not exist Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response and Error Codes Response codes are returned with the response to a Host Check request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The Host Check Response and Error Codes lists the Host Check response and error codes.

114 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Check

Table 47: Host Check Response and Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully

General response / error codes The request failed due to a syntax error or 2000 – Unknown command Registry policy violation 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed Host name check list is incorrect 2306 – Parameter value policy error 6002 – Host name check list has an invalid number of host names – range is 1 - 15 Field-specific response / error codes Host name field was incorrect 2003 – Required parameter missing See “Host Check Request Fields” on 2306 – Parameter value policy error page 113 for proper host name format 6001 – Invalid host name format - see documentation 6006 – Missing parameter - enter host name

EPP Interface The following example is an EPP Host Check request.

ns1.example.com ABC-12345

.CA Registry Guide for Registrars: Version 4.06 115 Hosts Chapter 7 Host Create

The following example is a successful response to a Host Check request.

Command completed successfully ns1.example.ca ns2.example.ca Selected host name is not available ABC-12345 cira-000001-0000001

Host Create A successful Host Create request creates a host object identified by its name in the Registry. Hosts can be used as name servers in the Domain Name System (DNS). IP addresses are required to produce DNS glue records when a host is provisioned as a name server. When the host is created within the .CA domain: • It must be created with at least one IP address (one IPv4 format and/or one IPv6 format address, but not more than one) • The superordinate domain must already exist • The requesting Registrar must be the sponsor of the superordinate domain • When the host is not within the .CA domain, it must NOT have associated IP addresses.

Request The Host Create Request Fields table lists the Host Create request fields. The corresponding EPP element is displayed below the field name.

116 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Create

Table 48: Host Create Request Fields Name Type Usage Description Valid Values Host Name Varchar2 (255) Mandatory The host name Beginning and middle sections: must – contain alphanumeric characters – be separated by a period (.) contain from one to 63 characters may contain – hyphens (-) but the section may NOT begin or end with a (-). – NO other special characters Other special characters are permitted The last (TLD) section must contain: –only alphabetic characters – at least two characters Added and Varchar2 (240) Mandatory The IP addresses IPV4 or IPV6 Removed Field to be associated Values with the host Host Address

.CA Registry Guide for Registrars: Version 4.06 117 Hosts Chapter 7 Host Create

Table 48: Host Create Request Fields Name Type Usage Description Valid Values Added and Varchar2 (240) Mandatory The IP addresses The attribute Removed Field to be associated parameters are: Values with the host "v4" Is used to Host Address indicate the IPv4 address format (default) "v6" Is used to indicate the IPv6 address format Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response Host Create Response Elements lists the XML fields that may occur in the response to a host Create request. The corresponding EPP element is displayed below the field name. Table 49: Host Create Response Elements

Element Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred lanugage. For example the English human- readable description of response code 8046 is "This status request cannot proceed at this time" Host Name The host name supplied by the Registrar

118 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Create

Creation Date The date and time the host object was created in the Registry Registrar Transaction The transaction ID contained in the request (if the request specified a ID Registrar Transaction ID) Registry Transaction A transaction identifier generated by the Registry when processing the ID request

Response and Error Codes Response codes are returned with the response to a Host Create request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages Table 50: Host Create Response and Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully General response error codes The request failed due to a syntax error 2000 – Unknown command or Registry policy violation 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2303 – Object does not exist 2307 – Unimplemented object service 2400 – Command failed 6007 – Only the sponsor of the domain can perform this function 6008 – Domain does not exist - domain must exist before performing this function 6022 – Missing XML namespace declaration Field-specific response error codes

.CA Registry Guide for Registrars: Version 4.06 119 Hosts Chapter 7 Host Create

Cause Response / Error Code The Host Name field is incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2201 – Authorization error 2302 – Object exists 2303 – Object does not exist 2306 – Parameter value policy error 2308 – Data management policy violation 6001 – Invalid host name format - see documentation 6006 – Missing parameter - enter host name 6009 – Host already exists The Host Address field is incorrect 2003 – Required parameter missing 2306 – Parameter value policy error 6003 – Invalid IPv4 address format - see documentation 6004 – Invalid IPv6 address format - see documentation 6005 – Missing parameter - enter one IPv4 and/or one IPv6 IP address 6012 – An IPv4 IP address is already associated with this host 6013 – An IPv6 IP address is already associated with this host 6014 – The IPv4 IP address, as entered, does not exist 6015 – The IPv6 IP address, as entered, does not exist 6017 – CIRA policy states that only one valid IPv4 IP address is permitted 6021 – Do not provision an IP address against a host with a non-.CA domain - leave the IP address text field blank 6023 – CIRA policy states that only one valid IPv6 IP address is permitted

120 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Create

EPP Interface The following example is an EPP Host Create request.

ns1.cira20.ca 192.0.2.2 1080:0:0:0:8:800:2004:117A ABC-12345

The following example is a response to a successful EPP Host Create request:

Command completed successfully ns1.cira20.ca 2009-02-19T12:23:10.0Z ABC-12345 cira-000001-0000003

Entering name server data When you submit name server data, you must follow the rules that are in place to ensure that the domain name can resolve. CIRA supports both IPv4 and IPv6 address types for name servers. An IPv4 address is a unique 32-bit identifier that consists of a set of four numbers, in the range of 0 to 255, separated by periods. For example, 64.230.164.58 An IPv6 address is a unique 128-bit identifier. IPv6 notation consists of eight groups of four hexadecimal digits, separated by colons. For example, 2001:db8:0000:0000:0000:0000:0000:5b0f

Note This can only be done once in an address

You can set one, or one of each type, of the following IP address formats:

.CA Registry Guide for Registrars: Version 4.06 121 Hosts Chapter 7 Host Update

• IPv4 IP address •IPv6 IP address Contains the following attribute: • 'ip' identifies the IP address format The attribute parameters are: • "v4" is used to indicate the IPv4 address format (default) b – IPv4 uses a 32-bit address format – An example of the dot-decimal notation looks like: 195.0.6.177 The following IPv4 configurations are permitted: – only numeric characters – must have NO leading zeroes – each segment must have values within the 0 to 255 range • "v6" is used to indicate the IPv6 address format – IPv6 uses a 128-bit address format and are written as eight groups of four hexadecimal characters (0-9; a-f) in each group, with each group separated by a colon. An example of an IPv6 address looks like: 2009:0eb5:83f4:0000:2351:62b2:45ef:45a2 The following IPv6 configuration shortcuts are permitted: – remove leading zeroes in a group, for example: 0123 becomes 123 or 0000 becomes 0 – remove a group or consecutive groups of all zeroes and replace with"::". For example 1234:0000:4321... becomes 1234::4321 or 1234:0000:0000:4321 becomes 1234::4321

Note This may only be done once per address

– When specifying a value to be removed, only the attribute value is significant – The element text is not required to match a value for removal of a status value Host Update A successful Host Update request modifies host information: • Update a host name • Add or remove IPv4 and IPv6 IP addresses • Add or remove status flags An update request may contain a combination of add, delete, and change field operations; at least one of these operations must be specified. If more than one of these operations is specified, the operations are processed in the order: remove, add, and then change. Because CIRA only allows one IP address of each type per host name, to update an IP address, you must remove the old value and add the new value. Both these changes can be accomplished using a single request.

122 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Update

A Registrar can update a host object of which it is the sponsor. IP address and status can be updated as desired. There are special considerations for updating a host name. An update of a host name can succeed if all the domain names associated with it are also sponsored by the Registrar which sponsors the host. This is because of the implied effect of the host name change on those domain names; their resolution in the zone file will be different after the change. In the case of a legitimate need to change a host name and its prevention by the above condition, Registrars are advised to take the following action; • Create a new host object with the desired name and IP address. • Associate each of your sponsored domains with the new host individually. Updating a host name has an indirect effect on any domain to which it is assigned. The zone file information for the domain is changed. Following sponsorship requirements, a host name update should succeed if all affected domains are also sponsored by the Registrar who sponsors the domain being changed. If any affected domain name is sponsored by a different Registrar, the host name update is rejected. Updating the name of a host can impact associated domains that refer to the host. Host name changes do not require additional updates of associated domains to preserve existing associations. An exception to this occurs when changing external host name information that has associations with domains sponsored by a different Registrar. The changes can be provisioned by creating a new external host with a new name and the required new attributes.

Note From time to time CIRA may delete "orphan" registry host objects that are not referenced by any domain name. If a Registrar attempts to link a domain name to a non-CA host using a domain update request, and if the request is rejected with an error response indicating that the host object does not exist, the Registrar's system might "retry" the domain update operation after first (re)creating the host object in the registry

.CA Registry Guide for Registrars: Version 4.06 123 Hosts Chapter 7 Host Update

Request Host Update Request Fields table lists the fields used in a Host Update request. The corresponding EPP element is displayed below the field name. Table 51: Host Update Request Fields Name Type Usage Description Valid Values Host Name Varchar2 Mandatory The name of the Beginning and (255) host to be middle sections: updated must – contain alphanumeric characters – be separated by a period (.) contain from one to 63 characters may contain – hyphens (-) but the section may NOT begin or end with a (-). – NO other special characters Other special characters are permitted The last (TLD) section must contain: –only alphabetic characters – at least two characters IP addresses Varchar2 Optional IP addresses to be (100) associated with the host

124 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Update

Table 51: Host Update Request Fields Name Type Usage Description Valid Values Status values Varchar2 (50) Optional Status values to be associated with the object Added and Varchar2 (255) Optional The field value Removed Field that can be Values modified Host Name The host name Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response Host Update Response Elements table lists the XML fields that may occur in the response to a Host Update request. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 125 Hosts Chapter 7 Host Update

Table 50: Host Update Response Elements Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred lanugage. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID). Registry Transaction ID A transaction identifier generated by the Registry when processing the request.

Response / Error Codes Response codes are returned with the response to a Host Update request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. Host Update Response / Error codes table lists the Host Update response codes and their causes.

126 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Update

Table 51: Host Update Response / Error Codes

Cause Response / Error Code The request was 1000 – Command completed successfully successful General response error codes The request failed due to 2001 – Command syntax error a syntax error or Registry 2002 – Command use error policy violation 2100 – Unimplemented protocol version 2103 – Unimplemented extension 2307 – Unimplemented object service 6007 – Only the sponsor of the domain can perform this function 6008 – Domain does not exist. Domain must exist before performing this function 6022 – Missing XML namespace declaration Host’s sponsor 2201 – Authorization error 6011 – Only the sponsor of the host name can perform this function Status flags 2304 – Object status prohibits operation Field-specific response error codes Host Name field is 2003 – Required parameter missing incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 2302 – Object exists 2303 – Object does not exist 2306 – Parameter value policy error 2308 – Data management policy violation 6001 – Invalid host name format - see documentation 6006 – Missing parameter - enter host name 6010 – Host does not exist

.CA Registry Guide for Registrars: Version 4.06 127 Hosts Chapter 7 Host Update

Cause Response / Error Code Added field values are Address fields incorrect 2306 – Parameter value policy error 6003 – Invalid IPv4 address format - see documentation 6004 – Invalid IPv6 address format - see documentation 6005 – Missing parameter - enter one IPv4 and/or one IPv6 IP address 6012 – An IPv4 IP address is already associated with this host 6013 – An IPv6 IP address is already associated with this host 6014 – The IPv4 IP address, as entered, does not exist 6015 – The IPv6 IP address, as entered, does not exist 6017 – CIRA policy states that only one valid IPv4 IP address is permitted 6021 – Do not provision an IP address against a host with a non-.CA domain leave the IP address text field blank 6023 – CIRA policy states that only one valid IPv6 IP address is permitted Status flags 6016 – The specified status value is already set 6018 – clientDeleteProhibited and clientUpdateProhibited are valid status values 6019 – You must remove the updateProhibited flag before you can update other Host fields 6020 – You must have permission to enable this status value Removed field values are Address fields incorrect 2306 – Parameter value policy error 6005 – Missing parameter - enter one IPv4 and/or one IPv6 IP address 6014 – The IPv4 IP address, as entered, does not exist 6015 – The IPv6 IP address, as entered, does not exist Status flags 6019 – You must remove the updateProhibited flag before you can update other Host fields

128 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Update

Cause Response / Error Code Changed field values are 2306 – Parameter value policy error incorrect. 6001 – Invalid host name format - see documentation 6010 – Host does not exist

EPP Interface The following example is an EPP Host Update request.

hostname1.bob.on.ca 1080:0:0:0:8:800:2004:17A 1.1.1.1 hostname2.bob.on.ca ABC-12345

The following example is a response to a successful EPP Host Update request.

Command completed successfully ABC-12345 CIRA-000000000105-0000000010

.CA Registry Guide for Registrars: Version 4.06 129 Hosts Chapter 7 Host Delete

The following example is a response to an unsuccessful EPP Host Update request. This example is not successful because in the request, the change element was empty.

Command syntax error ABC-12345 cira-000001-0000005

Host Delete A successful Host Delete request deletes a host object.

Caution A host object cannot be deleted while it is associated with a domain object.

Request The Host Delete Request Fields table lists the fields used in a Host Delete request. The corresponding EPP element is displayed below the field name.

Table 52: Host Delete Request Fields Name Type Usage Description Valid Values Host Name Varchar2 (255) Mandatory The name of the host object to be deleted

Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response Host Delete Response Fields table lists the XML fields that may occur in the response to a Host Delete request. The corresponding EPP element is displayed below the field name.

130 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Delete

Table 53: Host Delete Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes CIRA Error Messages Usually CIRA includesa more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred lanugage. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Registrar Transaction ID The transaction identifier contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response / Error Codes Response codes are returned with the response to a Host Delete request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The following table lists the Host Delete response codes and their causes.

Table 54: Host Delete Response Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully General response error codes

.CA Registry Guide for Registrars: Version 4.06 131 Hosts Chapter 7 Host Delete

The request failed due to a syntax error 2001 – Command syntax error or Registry policy violation. 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2305 – Object association prohibits operation 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection Host’s sponsor 2201 – Authorization error 6011 – Only the sponsor of the host name can perform this function Status flags 2304 – Object status prohibits operation Field-specific response error codes Host Name field is incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2303 – Object does not exist 2306 – Parameter value policy error 6001 – Invalid host name format - see documentation 6006 – Missing parameter - enter host name 6010 – Host does not exist

EPP Interface The following example is an EPP Host Delete request:

hostname66.123.ca ABC-12345

132 .CA Registry Guide for Registrars: Version 4.06 Chapter 7 Hosts Host Delete

The following example is a response to a successful EPP request.

Command completed successfully ABC-12345 cira-000001-0000004

.CA Registry Guide for Registrars: Version 4.06 133 Hosts Chapter 7 Host Delete

134 .CA Registry Guide for Registrars: Version 4.06 Chapter 8

Domains This chapter describes the creation and management of domain names within the Registry. The Registry supports these query requests to retrieve information related to domain names: •The “Domain Check” on page 144 is used to determine whether a domain name is available for registration. •The “Domain Info” on page 138 is used to retrieve properties of an existing domain object. The Registry supports these transform requests to modify domain name information: •The “Domain Create” on page 148 is used to create a domain object •The “Domain Delete” on page 159 is used to delete a domain object •The “Domain Renew ” on page 164 is used to extend the registration period of a domain object •The “Domain Transfer” on page 180 is used to transfer the sponsorship of a domain object •The “Domain Update” on page 169 is used to modify the attributes of a domain object Domain Object A domain object represents an agreement covering the use of a domain name for a period of time.

About Valid Domain name formats A valid domain name must have the following: • A segment’s length must be between 2 to 63 characters • Number of segments permitted in new domain name registrations are: – 2 - general public (e.g. segment.ca), municipal (e.g. cityname.ca), provincial (e.g. province.ca) – 4 - municipal, only (e.g. city.ottawa.on.ca) When a domain name has 4 segments, the segment before the .ca must be a valid 2-character provincial code • the segment before the provincial code must be a valid Canadian city • the segment before the Canadian city must be an approved class • Valid classes (municipal prefixes) - city, hameau, hamlet, municipalite, municipality, police, town, village, ville • Municipal and provincial domain names are reserved specifically for municipalities and provinces/territories, respectively • Characters must be alphanumeric but hyphens (-) are permitted within a segment, for example, – domain-name.ca. Hyphens cannot start or end a segment

.CA Registry Guide for Registrars: Version 4.06 135 Domains Chapter 8 Domain Object

– A single request can check from 1 to 15 domain names.

Table 55: Domain Object Properties

Field Name Description Name The domain name comprising "segments" of alphanumeric characters delimited by period characters Alternate Name Reserved for future use (punycode name) Registry ID An object identifier generated by the Registry in accordance with the ICANN standard when the object was created Status 1 or more values described in “Status Values” on page 137 Registrant The identifier of the contact object that represents the person or organization that currently holds the domain name registration A domain name has exactly one Registrant Administrative The identifier of the contact object that represents the person authorized Contact by the Registrant to request confirm changes to the domain name A domain name has exactly one Administrative Contact Technical Contact The identifiers of the contact objects that represent people authorized by the Registrant to administer technical information for a domain name There may be from 0 to 3 technical contacts Hosts The names of host objects that represent delegated hosts. The number of hosts is either 0 or 2 through 13 Sponsor ID The identifier of the Registrar object representing the sponsoring Registrar Creator ID The identifier of the Registrar object representing the Registrar that created the domain object Creation Date The creation date and time of the domain object Expiry Date The expiry date and time of the domain name registration period. Not present if the domain name is not registered, for example, has pending create status Updater ID The identifier of the Registrar object representing the Registrar that last updated the domain name information This element is empty if the domain name has never been updated Update Date The date and time of the most recent domain object modification This value is empty if the domain name has never been updated Transfer Date The date and time of the most recent successful domain name transfer This element is empty if the domain name has never been transferred

136 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Object

Field Name Description AuthInfo An authorization password associated with the domain name This information is returned in a response only when: • The querying Registrar is the current sponsoring Registrar, or • The Registrar has supplied valid authorization information with the request Stage Of Life A value indicating the life cycle stage of the object One of: • Pending create • Add grace •Registered • Auto-renew grace • Redemption grace • To be released • Pending delete Stage Of Life End The date and time when the current stage of life ends Date Was Registered In Has the value "Y" if the domain object was registered in TBR Otherwise TBR has the value "N" Awaiting Registrant Reserved for future use Agreement Has the value "Y" if the Registrant currently associated with the domain object has not agreed to the CIRA Registrant Agreement Otherwise has the value "N" Municipal Reserved for future use Has the value "Y" if the domain object represents a domain request that is awaiting approval by Registry personnel Otherwise has the value "N"

Status Values A domain object always has at least one associated status value. Each status value is accompanied by text that describes the rationale for the status applied to the object. The sponsoring Registrar can explicitly add or remove status values prefixed with "client" using a Domain Update request, but must not alter other status values. The Registry may change any status value.

.CA Registry Guide for Registrars: Version 4.06 137 Domains Chapter 8 Domain Info

Table 56: Domain Status Values

Status Flag Description clientDeleteProhibited The Registry will reject requests to delete the object. serverDeleteProhibited serverHold The Registry will not publish DNS delegation information for clientHold the object serverRenewProhibited The Registry will reject requests to renew the object clientTransferProhibited The Registry will reject requests to transfer the object serverTransferProhibited clientUpdateProhibited No update is permitted to the domain name object serverUpdateProhibited No update is permitted to the domain name Registrant contact ID (denoted in this document by "serverUpdateProhibited (change registrant)" serverUpdateProhibited No update is permitted to the domain name object (denoted in this document by "serverUpdateProhibited (all))" pendingCreate A transform request has been processed for the object, but the pendingDelete action has not been completed by the Registry. Registry personnel can delay action completion for a variety of reasons, such as to allow for human review or third-party action. A transform request that is processed, but whose requested action is pending, is noted with response code 1001

Domain Info A successful Domain Info request retrieves information associated with an existing domain name. All available information is returned if the querying Registrar is the domain’s sponsor or if the request contains valid authorization information. Otherwise, only the following information is returned: • creation date • date that the domain object was last updated • domain name • expiry date •host • name servers • status

Request The Domain Info Request Fields table lists the XML fields that may be used in a Domain Info request. The corresponding EPP element is displayed below the field name.

138 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Info

Table 57: Domain Info Request Fields Name Type Usage Description Valid values Name Varchar2 (240) Mandatory The name of the May contain the domain following optional attribute: • "hosts" •"del" • "all" •"sub" • "none" Authorization Varchar2 (30) Optional The authorization information associated with the Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response The response to a successfully completed Domain Info request identifies the domain namespace. The optional elements that are returned are based on client authorization and Registry policies. The Domain Info Response Fields table lists the XML fields that may occur in a response to a Domain Info request. The corresponding EPP element is displayed below the field name. Table 58: Domain Info Response Fields

Element Description Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully"

.CA Registry Guide for Registrars: Version 4.06 139 Domains Chapter 8 Domain Info

Element Description CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 8046 is "This status request cannot proceed at this time" Domain Name The name of the domain Registry ID The identifier assigned by the Registry when the object was created Status One or more flags describing the status of the domain object Contains value for serverUpdatedProhibited Registrant The contact identifier that identifies the owner of the domain name A domain name has one and only one Registrant Contact Name The identifiers of the contacts associated with the domain name There are two domain name contact types: – admin - administrative, there must be 1 administrative contact – tech - technical, there may be from 0 to 3 technical contacts Subordinate Host The names of a subordinate host of the domain name Delegated Host The name of a delegated host Domain Sponsor ID The identifier of the sponsoring Registrar Creator ID The identifier of the Registrar that created the object in the registry Creation Date The creation date and time of the object in the registry Update ID The identifier of the Registrar that last updated the object This field is not present if the object has never been updated Update Date The date and time of the most recent domain object modification This field is not present if the domain name has never been updated Expiration Date The expiry date and time of the domain name registration period Transfer Date The date and time of the most recent successful domain name transfer This element is not present if the domain name has never been transferred

140 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Info

Element Description Authorization The authorization information associated with the domain name This information is returned only when: • The querying Registrar is the current sponsoring Registrar • The Registrar has supplied valid authorization information with the request Stage of Life The stage at which the domain name exists within the domain name life < End of Present Life The date and time that the domain name will exit the present life cycle Cycle Stage stage Registrar Transaction The transaction ID contained in the request, if the request specified a ID Registrar Transaction ID Registry Transaction A transaction identifier generated by the Registry when processing the ID request

Response and Error Codes Response codes are returned with the response to a Domain Info request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The Domain Info Response and Error Codes table lists the Domain Info response and error codes and their causes. Table 59: Domain Info Response and Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully General response error codes

.CA Registry Guide for Registrars: Version 4.06 141 Domains Chapter 8 Domain Info

The request failed due to a syntax error 2000 – Unknown command or Registry policy violation 2001 – Command syntax error 2002 – Command use error 2101 – Unimplemented command 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 8002 – Domain name check list has an invalid number of domain names - range is 1 - 15 Field-specific response error codes The Domain Name field is incorrect 2003 – Required parameter missing See “About Valid Domain name 2306 – Parameter value policy error formats” on page 135 8001 – Invalid domain name format - see documentation 8006 – Missing parameter - enter domain name 8010 – Domain name does not exist Authorization Information 2003 – Required parameter missing See the “See also the Canadian 2202 – Invalid authorization information Presence Requirements for Registrants 2306 – Parameter value policy error at http://www.cira.ca/assets/Documents/ Legal/Registrants/CPR.pdf.” on 8005 – Invalid password format – see documentation page 204 8036 – Missing parameter - enter password

EPP Interface The following example is an EPP Domain Info request. The element is optional. cira.ca cira123 ABC-12347

142 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Info

Response optional elements are returned based on request authorization information and whether the sponsoring Registrar issues the request. The following example is a response to a successful EPP Domain Info request issued by a Registrar who is the sponsor of the domain name.

Command completed successfully pc-case3.ca CIRA-lifecycle-00122 change registrant rant003 admin003 tech003 ns1.example.ca ns2.example.ca ns1.pc-case3.ca ns2.pc-case3.ca automatedRARsprint3 automatedRARsprint3 2009-12-08T16:25:01.0Z 2010-12-08T16:25:01.0Z password2 pending delete 2009-12-16T16:29:05.0Z ABC-12347 cira-000002-0000000005

.CA Registry Guide for Registrars: Version 4.06 143 Domains Chapter 8 Domain Check

The following example is a response to a successful EPP Domain Info request issued by a Registrar who is not the sponsor of the domain name.

Command completed successfully onetech.ca hostname1.onetech.ca hostname2.onetech.ca ready4change01.domain.ca 2010-01-28T13:27:42.0Z 2011-03-04T13:27:42.0Z registered 2011-03-04T13:27:42.0Z ABC-12347 CIRA-000105-0000000002

Domain Check A successful Domain Check request determines whether a domain name is available for use and whether a domain name registration can be successfully created in the Registry.

Request The EPP Domain Check Request Fields table lists the fields that may be used in a Domain Check request. The corresponding EPP element is displayed below the field name.

144 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Check

Table 60: EPP Domain Check Request Fields Name Type Usage Description Valid Values Domain Name Varchar2 (100) Mandatory The domain name See “About Valid Domain name The domain name formats” on length (including page 135 the .CA portion of the domain name) is from 5 – 100 characters Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Response When the result of the check request yields a "false" result, the domain name cannot be registered. Domain Check Response Fields table lists the fields that may occur in the response to a Domain Check request. The corresponding EPP element is displayed below the field name. Table 61: Domain Check Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 8046 is "This status request cannot proceed at this time"

.CA Registry Guide for Registrars: Version 4.06 145 Domains Chapter 8 Domain Check

Field Name / Description EPP Element Name The domain name supplied in the request. Contains one of the following values: A value of "true" means yes it can be provisioned A value of "false" means no, the name registration cannot be provisioned at this time Reason For each domain name, a reason is provided when a domain name cannot be registered.The reason does not return a value, only descriptive text. The following reasons are returned for Domain Check: • Invalid domain name format - see documentation •Registered • Restricted • Reserved Registrar Transaction If the request contains an optional Registrar Transaction ID, this value ID will be included in the response Registry Transaction A transaction identifier generated by the Registry when processing the ID request

Response and Error Codes Response codes are returned with the response to a Domain Check request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. Domain Check Request table lists the Domain Check response and error codes. Table 62: Domain Check Response and Error Codes

Cause Response / Error Code The request was successful 1000 – Command completed successfully General response error codes

146 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Check

The request failed due to a syntax error 2000 – Unknown command or Registry policy violation 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2306 – Parameter value policy error 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed Domain name check list is incorrect 2306 – Parameter value policy error 8002 – Domain check list has an invalid number of domains - range is 1 - 15 Field-specific response error codes Domain name field was incorrect 2003 – Required parameter missing 2306 – Parameter value policy error 8001 – Invalid domain name format - see documentation 8006 – Missing parameter - enter domain name 8010 – Domain name does not exist

EPP Interface The following example is an EPP Domain Check request. abc123.ca xyz987.ca ABC-12346

The following example is a response to a successful EPP Domain Check request.

.CA Registry Guide for Registrars: Version 4.06 147 Domains Chapter 8 Domain Create

Command completed successfully abc123.ca xyz987.ca ABC-12346 CIRA-000000000104-0000000002

Domain Create A successful Domain Create request creates a domain object in the Registry, and also creates relationships between the domain name and previously created contacts and hosts. There are three types of relationships between a domain name and related contacts: • A single "Registrant" contact-domain relationship denotes the individual or non-individual that that holds the domain name registration. If a contact object is to be used as a domain Registrant then it must satisfy Canadian presence requirements. See Canadian Presence Requirements for Registrants, on the CIRA website. • A single "Administrative Contact" contact-domain relationship denotes the individual who along with the Registrant, receives notifications about important changes to the domain name registration • From zero to three "Technical Contact" contact-domain relationships denote individuals who typically administers technical information for a registered domain name. A domain object may also have relationships with host objects in the Registry. Because the Registry does not permit a Registrar to create a host object for a host inside the domain name being registered before the domain object exists, the following procedure should be followed to register a domain name: 1 Perform a Domain Check request and stop if the domain name already exists in the Registry 2 For any associated contacts that do not already exist in the Registry, create associated contacts, ensuring that the contact that will be used as the Registrant has a value for CPR Category. 3 If the Registrar is displaying the CIRA Registrant Agreement, (in the manner prescribed by CIRA), agreement data, along with the CPR category data must be provided in the request. If the contact that will be used as the Registrant cannot agree to the CIRA Registrant Agreement

148 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Create

on the Registrar’s website, the Registrar must direct the Registrant to the CIRA Agreement page on the CIRA, provide them with their client ID and instruct them to agree to the CIRA Registrant Agreement within 7 days. CIRA does NOT send an email notification to the applicant Registrant informing them to do this. 4 For each related host that is outside the domain name being created, create a host object it if it does not already exist in the Registry. 5 Create the domain name in the Registry, including relationships to contacts and to hosts that are outside the domain name being created. 6 If there are related hosts that are inside the domain name being created: a Create associated hosts b Update the domain object to add relationships to these hosts.

Note To create a domain name, a Registrar is not required to be the sponsor of hosts that are assigned to the domain object. The Registrar must be the sponsor of all contacts that are assigned to a domain object.

Request Domain Create Request Fields lists the Domain Create request fields. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 149 Domains Chapter 8 Domain Create

Table 63: Domain Create Request Fields Name Type Usage Description Valid Values Name Varchar2 (240) Mandatory The domain name Mandatory Maximum number of segments, separated by period characters, is 4 Maximum number of characters per segment is 63 Characters must be alphanumeric or "-" "-" cannot appear at the start or end of a segment The last segment must be .ca Period Number (2) Optional The initial Period length is 1 domain validity - 10 years period Default value is 1 year Host Varchar2 (240) Optional Names of the Number of delegated host delegated host objects or host objects is either 0 attributes (name or 2-13 servers) Each host object associated with must be created the domain name in the Registry to provide before the host resolution can be associated services for the with a domain domain name name

150 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Create

Table 63: Domain Create Request Fields Name Type Usage Description Valid Values Registrant Varchar2 (255) Mandatory The identifier of Number of the existing Registrants per contact to be domain name is 1 associated with Must be validated the domain name as belonging to a as the Registrant. CPR category Must indicate agreement with the Registrant Agreement or the domain name will be in a pending state until this is completed Administrative Varchar2 (255) Mandatory The identifier of Number of Contact the existing administrative contact to be domain name is 1 associated with the domain name as the administrative contact. Technical Contact Varchar2 (255) Optional Existing Number of contacts to be per domain name associated with is 0 - 3 the domain object as technical contacts. Authorization Varchar2 (16) Mandatory The authorization Length is 6 - 16 Information password to be characters associated with Character values the domain object are: a - z, A - Z, 0 - 9 Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

.CA Registry Guide for Registrars: Version 4.06 151 Domains Chapter 8 Domain Create

Registry Actions A successful Domain Create request initiates the following Registry actions. See the “Domain Name Life Cycle” on page 20 section of this document. Table 64: Domain Create Registry Actions

Current Life Cycle Stage Registry Actions

Pending Create Sets the serverUpdatedProhibited change registrant and serverTransferProhibited status flags for 60 days Note: When the Registrant contact has not agreed to Reduces the Registrar financial balance CIRA Registrant Agreement the life cycle stage is set to Pending Create

Add Grace serverUpdateProhibited status flag set to change registrant Note: When the Registrant Sets the serverUpdatedProhibited with the value and serverTransferProhibited status flags for 60 days Registrant Agreement the Reduces the Registrar financial balance, if not previously reduced life cycle stage is set to Add Grace (see pendingCreate)

Response The Domain Create Response Fields lists the fields that may occur in the response to a Domain Create request. The EPP element is displayed below the field name. Table 65: Domain Create Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is “Command completed successfully”

152 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Create

Field Name / Description EPP Element CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is “This status request cannot proceed at this time” Name The domain name supplied by the Registrar Creation Date The date and time the domain name was created in the Registry Expiry Date The updated date and time when the domain name validation period will expire Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID) Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response Codes Response codes are returned with the response to a Domain Create request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. Domain Create Response Codes lists the Domain Create response codes and their causes.

Table 66: Domain Create Response Codes

Cause Response Code The request was successful 1000 – Command completed successfully 1001 – Command completed successfully, action pending General response codes

.CA Registry Guide for Registrars: Version 4.06 153 Domains Chapter 8 Domain Create

The request failed due to a syntax error 2000 – Unknown command or Registry policy violation 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2202 – Invalid authorization information 2303 – Object does not exist 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection Billing failure 8029 – Insufficient funds available to complete the request Field-specific response codes The Name field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2302 – Object exists 2306 – Parameter value policy error 8001 – Invalid domain name format - see documentation 8003 – Domain name is reserved and must be registered manually - Contact CIRA Support 8004 – Domain name conflict - see documentation 8006 – Missing parameter - enter domain name 8009 – Domain name already exists 8030 – Restricted domain name - CIRA policy prohibits operation

154 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Create

The Period field (length of term) is 2004 – Parameter value range error incorrect 2005 – Parameter value syntax error 2306 – Parameter value policy error 8015 – Invalid domain period format - enter an integer from 1 through 10 8026 – Invalid period format - must be “y” 8028 – Invalid period parameter value - new period plus existing period cannot exceed 10 years The Host field is incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2306 – Parameter value policy error 8007 – Invalid parameter - Domain must have 0 or 2 to 13 hosts 8008 – Unique IP address required for Host 8021 – Create the host on the Registry system before you assign it to a domain The Registrant field is incorrect 2003 – Required parameter missing A valid Registrant contact must be 2004 – Parameter value range error specified when the domain object is 2005 – Parameter value syntax error created 2201 – Authorization error 2303 – Object does not exist 2306 – Parameter value policy error 8012 – Missing parameter - enter Registrant ID 8022 – Create the contact on the Registry system before you assign it to a domain 8023 – Create the Registrant on the Registry system before you assign it to a domain 8024 – Invalid Registrant ID - valid CPR category required 8031 – Only the sponsor of the contact can perform this function

.CA Registry Guide for Registrars: Version 4.06 155 Domains Chapter 8 Domain Create

The Administrative Contact field is 2003 – Required parameter missing incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 2201 – Authorization error 2303 – Object does not exist 2306 – Parameter value policy error 8013 – Missing parameter - enter domain contact: admin 8022 – Create the contact on the Registry system before you assign it to a domain 8031 – Only the sponsor of the contact can perform this function 8032 – The administrative or technical contact must be an individual 8035 – Invalid administration contact parameter - enter 1 administrative contact 8038 – Contact-related roids are not supported 8039 – The specified contact is not associated with this domain object

156 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Create

The Technical Contact field was 2004 – Parameter value range error incorrect 2005 – Parameter value syntax error 2201 – Authorization error 2303 – Object does not exist 2306 – Parameter value policy error 8022 – Create the contact on the Registry system before you assign it to a domain 8031 – Only the sponsor of the contact can perform this function 8032 – The administrative or technical contact must be an individual 8033 – Technical contact must be unique 8034 – Invalid technical contact parameter - enter 0-3 technical contacts 8038 – Contact-related roids are not supported 8039 – the specified contact is not associated to this domain object The Authorization Information 2003 – Required parameter missing (password) field was incorrect 2202 – Invalid authorization information 2306 – Parameter value policy error 8005 – Invalid password format – see documentation 8036 – Missing parameter - enter password

EPP Interface The following is an example EPP Domain Create request. example.ca 6 hostname.example.net hostname.example.com nbtrust nbguy

.CA Registry Guide for Registrars: Version 4.06 157 Domains Chapter 8 Domain Create

nbguy nbtech nbadmin twelvemixmix CIRA-domain-0000065

The following is an example response to a successful Domain Create request. Command completed successfully example.ca 2009-08-27T17:52:21.0Z 2015-08-27T17:52:01.0Z CIRA-domain-0000065 CIRA-000001-0000000133

The following example is a response to an unsuccessful Domain Create request. Data management policy violation 8023 Create the Registrant on the Registry system before you assign it to a domain CIRA-domain-0000065 CIRA-000000000104-0000000011

158 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Delete

Domain Delete A successful Domain Delete request deletes a domain object in the Registry. Only the sponsoring Registrar (or the Registry) can delete a domain name. The sponsoring Registrar cannot delete the domain name unless it is in the Add Grace Period, Auto Renew Grace Period or Pending Create stage of the domain life cycle. When a domain name is deleted in the Add Grace Period or the Pending Delete stage of life, it goes to PendingDelete for 1 day and then becomes generally available. It is not added to the TBR list. If a domain name is deleted during the Auto Renew Grace Period, and is not subsequently renewed during the 30-day Redemption Grace Period, it is added to the TBR list.

Note A registrar is permitted to apply the status "clientHold" to a domain name during the Auto Renew Grace Period, in lieu of deleting it, in order to attract the attention of the Registrant who has fail to pay for their renew upon CIRA auto-renewing the domain name upon its expiry

A Registrar cannot delete a domain name when either of the following status flags is set: • clientDeleteProhibited • serverDeleteProhibited A Registrar cannot delete a domain name when: • it is in the pendingDelete, Registered, Redemption Grace, or TBR stage of life • it is associated with other objects, such as hosts or contacts You must remove any association between the domain name and other objects before you delete the domain name . When a domain name is associated with an existing subordinate host object (e.g. domain.ca is associated with hostname.domain.ca) the domain name must not be deleted until the host object is renamed or is moved to a different superordinate domain. Check for object relationships by using the Domain Info request.

Request The Domain Delete Request Fields table lists the Domain Delete request fields. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 159 Domains Chapter 8 Domain Delete

Table 67: Domain Delete Request Fields Name / EPP Type Usage Description Valid Values Element Name Varchar2 (240) Mandatory The domain name Maximum to be deleted number of segments, separated by period characters, is 4 Maximum number of characters per segment is 63 Characters must be alphanumeric or "-" "-" cannot appear at the start or end of a segment The last segment must be .ca Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Registry Actions A successful request initiates the following Registry actions. Table 68: Domain Delete Registry Actions

Current Life Cycle Stage Registry Actions pending create or add Sets life cycle stage to Pending Delete if the domain name is deleted grace during this life cycle stage Sets status flags serverTransferProhibited, serverUpdateProhibited, serverHold, and serverRenewProhibited Refunds all charges if the domain name is deleted during this life cycle stage

160 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Delete

Current Life Cycle Stage Registry Actions auto-renew Sets life cycle stage set to Redemption if the domain name is deleted during this stage Sets status flags serverTransferProhibited, serverUpdateProhibited, serverDeleteProhibited, and serverHold Refunds the most recent charge if the domain name is deleted during this life cycle stage

Response Domain Delete Response Fields table lists fields that may occur in the response to a Domain Delete request. The EPP element is displayed below the field name.

Table 69: Domain Delete Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is "Command completed successfully" CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is "This status request cannot proceed at this time" Registrar Transaction ID The transaction ID contained in the request (if the request specified a Registrar Transaction ID). Registry Transaction ID A transaction identifier generated by the Registry when processing the request.

Response Codes Response codes are returned in the response to a Domain Delete request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The following table lists the causes of response messages and the associated response codes. Table 70: Domain Delete Response Codes

.CA Registry Guide for Registrars: Version 4.06 161 Domains Chapter 8 Domain Delete

Cause Response Codes The request was successful 1000 – Command completed successfully General response codes The request failed due to a syntax 2000 – Unknown command error or Registry policy violation. 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection 8039 – CIRA policy prohibits the deletion of a municipal or provincial domain name Object association in effect 2305 – Object association prohibits operation Request not initiated by the 2201 – Authorization error domain’s sponsor 8011 – Only the sponsor of the domain name can perform this function Status prohibits the request 2304 – Object status prohibits operation Field-specific response codes The Name field was incorrect 2003 – Required parameter missing See Table 67: “Domain Delete 2004 – Parameter value range error Request Fields” on page 160 for 2005 – Parameter value syntax error valid domain name format 2303 – Object does not exist 2306 – Parameter value policy error 8001 – Invalid domain name format - see documentation 8006 – Missing parameter - enter domain name 8010 – Domain name does not exist

EPP Interface The following example is an EPP Domain Delete request.

162 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Delete

cira4.ca ABC-12350

The following example is a response to a successful EPP Domain Delete request.

Command completed successfully ABC-12350 CIRA-000000000106-0000000004

.CA Registry Guide for Registrars: Version 4.06 163 Domains Chapter 8 Domain Renew

Domain Renew A successful Domain Renew request extends the registration period of a domain name and sets the serverDeleteProhibited status flag. It also maintains existing status values. Use the Domain Info request prior to renewing a domain name to get the correct expiry date in the correct time zone (EST/EDT).

Request The Domain Renew Request Fields table lists the Domain Renew request fields. The corresponding EPP element is displayed below the field name.

Table 71: Domain Renew Request Fields Field Name / Type Usage Description Valid Values EPP Element Name Varchar2 (240) Mandatory The name of the Maximum domain object number of whose validity segments, period is to be separated by extended period characters, is 4 Maximum number of characters per segment is 63 Characters must be alphanumeric or "-" "-" cannot appear at the start or end of a segment The last segment must be .ca

164 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Renew

Table 71: Domain Renew Request Fields Field Name / Type Usage Description Valid Values EPP Element Expiry Date Timestamp with Mandatory The date on yyyy-mm-dd validity period the year the ends. domain name will Numeric expire characters mm indicates the separated by a "-" month (1 - 12) the For example, domain name will 2010-11-25 expire dd indicates the day (1-31) the domain name will expire Period Number (2) Optional The number of Period length is 1 to the registration Default value is 1 period of the year domain object. At any time, the period of the domain name cannot exceed 10 years Registry Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Registry Actions A successful Domain Renew request initiates the Registry actions listed in Domain Renew Registry Action. The .CA registry automatically renews domain names for one year upon expiry. The Registry action also includes the collection of renewal fees from the Registrar. The “Registered” life cycle stage ends at the expiry date of the domain name registration. The expiry date is derived by adding the length of term indicated in the Domain Renew request to the balance of the term remaining, if any. If no length of term is indicated in the request, the default value of one year is added to the domain name’s length of term.

.CA Registry Guide for Registrars: Version 4.06 165 Domains Chapter 8 Domain Renew

Table 72: Domain Renew Registry Action

Current Life Cycle Stage Registry Actions Pending Create Domain name remains in the pending create life cycle stage Reduces the Registrar financial balance Add Grace Domain name remains in the add grace life cycle stage Reduces the Registrar financial balance Registered Domain name remains in the registered life cycle stage Reduces the Registrar financial balance Auto-renew Updates the life cycle stage to registered Sets the serverDeleteProhibited status flag Maintains existing prohibition status flags, except clientHold Reduces the Registrar financial balance Redemption Domain name is moved into the registered life cycle stage Sets the prohibit delete status flag Removes the transfer and update prohibition status flags but maintains all other existing prohibition status flags Reduces the Registrar financial balance

Response The Domain Renew Response Fields table lists the Domain Renew response fields. The EPP element is displayed below the field name.

Table 73: Domain Renew Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is “Command completed successfully”

166 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Renew

CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 8046 is “This status request cannot proceed at this time” Name The fully qualified domain name supplied by the Registrar Expiry Date The updated date and time when the domain name validation period will expire Registrar Transaction The transaction ID contained in the request (if the request specified a ID Registrar Transaction ID) Registry Transaction A transaction identifier generated by the Registry when processing the ID request

Response Codes Response codes are returned with the response to a Domain Renew request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages. The Domain Renew Response Codes table lists the domain renew response codes.

Table 74: Domain Renew Response Codes

Cause Response Code The request was successful 1000 – Command completed successfully General response codes The request failed due to a 2000 – Unknown command syntax error or Registry 2001 – Command syntax error policy violation. 2002 – Command use error 2100 – Unimplemented protocol version 2400 – Command failed Authorization is incorrect 2201 – Authorization error 8011 – Only the sponsor of the domain name can perform this function Billing failure 2104 – Billing failure 8029 – Insufficient funds available to complete the request Status flags 2304 – Object status prohibits operation

.CA Registry Guide for Registrars: Version 4.06 167 Domains Chapter 8 Domain Renew

Field-specific response codes The Name field was 2003 – Required parameter missing incorrect 2004 – Parameter value range error 2005 – Parameter value syntax error 2303 – Object does not exist 8001 – Invalid domain name format - see documentation 8006 – Missing parameter - enter domain name 8010 – Domain name does not exist Expiry Date field was 2003 – Required parameter missing incorrect 2005 – Parameter value syntax error 2306 – Parameter value policy error 8017 – Invalid Current Expiry Date format - enter yyyy-mm-dd 8025 – Missing parameter - enter the current expiry date 8027 – Invalid Current Expiry Date - must match recorded expiry date The Period field (length of 2004 – Parameter value range error term) is incorrect 2005 – Parameter value syntax error 2306 – Parameter value policy error 8015 – Invalid domain period format - enter an integer from 1 through 10 8026 – Invalid period unit format - must be "y" 8028 – Invalid period parameter value - new period plus existing period cannot exceed 10 years

EPP Interface The following is an example EPP Domain Renew request.

example2.ca 2011-01-25 2

168 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Update

CIRA-12345

The following is an example response to a successful Domain Renew request. Command completed successfully example2.ca 2013-01-25T14:55:02.0Z CIRA-12345 CIRA-000019-0000000006

Domain Update A successful Domain Update request modifies a domain object in the Registry, and may also add or delete relationships between the domain name and previously created hosts and contacts. A Domain Update request may contain a combination of remove, add, and change field operations; at least one of these operations must be specified. If more than one of these operations is specified, the operations are processed in the following order: remove, add and then change. Only the sponsoring Registrar (or the Registry) can update a domain name. Even the sponsoring Registrar cannot update the domain name if either of the following status values are set at the time that the request is made: • clientUpdateProhibited • serverUpdateProhibited

Note The registry will refuse requests to update the domain object and will also refuse to modify the domain object if the status value set to "serverUpdateprohibited" with the value ‘change registrant’

A Domain Update request allows a contact id to be changed for a Registrant. However, an administrative contact cannot be changed, but must instead be removed and then a new one added within a single request.

.CA Registry Guide for Registrars: Version 4.06 169 Domains Chapter 8 Domain Update

Changing the Registrant id to a different one is not allowed if the serverUpdateprohibited with the value 'change registrant' status flag is set. The serverUpdateProhibited status flag is a CIRA extension to EPP. For example change registrant

For a Domain Update request to be successful, the resulting domain name and its contact associations must be valid according to the rules specified for Domain Create. When a domain name is first created, a Domain Update that would cause a Registrant to Registrant transfer is not permitted until the domain name is 60 days old. When making a calculation for this purpose, domain names are not considered to be fully created until the Registrant has agreed to the Registrant Agreement. In other words, the time that a domain name is in the pendingCreate status, (if applicable) does not count towards the 60-day grace period. Furthermore, domain updates that cause a Registrant to Registrant transfer cannot be followed by a second update of the same nature until 60 days later. CIRA also has a 60-day grace period that does not allow a domain:update that effects a Registrant to Registrant transfer to occur subsequent to a Registrar to Registrar transfer. Likewise, the reverse is also true; if a domain:update that effects a Registrant to Registrant transfer occurs, it is not possible to do a Registrar to Registrar transfer for 60 days. See “Domain Transfer” on page 180 for more information. CIRA will send an optionally co-branded email to both the Registrant’s and the Administrative contact’s email address, if available, when a domain name change modifies a domain name’s: • Registrant name • Registrant email address • Administrative Contact name • Administrative contact email address One email will be sent if the Registrant’s and the Administrative contact’s addresses are identical. Minor changes such as changing the case from uppercase to lower case for the above fields will not trigger the notification emails.

Request The Domain Update Request Fields table lists the Domain Update request fields. The corresponding EPP element is displayed below the field name.

Note When a field is empty, the previous field value is removed

170 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Update

Table 75: Domain Update Request Fields Field Name / Type Usage Description Valid Values EPP Element

Name Varchar2 (240) Mandatory The domain name Maximum number of segments, separated by period characters, is 4 Maximum number of characters per segment is 63 Characters must be alphanumeric or "-" "-" cannot appear at the start or end of a segment The last segment must be .ca See also “About Valid Domain name formats” on page 135 Added or Optional The set of field Removed Field values that can be Values removed

.CA Registry Guide for Registrars: Version 4.06 171 Domains Chapter 8 Domain Update

Table 75: Domain Update Request Fields Field Name / Type Usage Description Valid Values EPP Element

Host Name Varchar2 (240) Optional The host names The host names removed from the assigned to the domain name domain name Number of delegated host objects is either 0 or 2-13 Each host object must be created in the Registry before the host can be associated with a domain name

Contact Varchar2 (30) Optional Where "*" is Admin Identifiers either an Number of technical contact. contacts per domain name is 1 Must be created in the Registry before the domain name is created Tech Number of technical contacts per domain name is 0 - 3 Must be created in the Registry before the domain name is created

172 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Update

Table 75: Domain Update Request Fields Field Name / Type Usage Description Valid Values EPP Element

Status Values Varchar2 (50) The status flags See “Status associated with values” on the domain name page 20 Changed Optional The field values Field Values that can be modified Registrant The identifier of a Number of Contact contact having Registrants per relationship to the Must be validated domain name as belonging to a See also CPR category “Registered Life Must indicate Cycle Stage” on agreement with page 23 and the Registrant Domain Update Agreement to change Registrant Authorization Varchar2 (16) Optional The authorization Length is 6 - 16 Information password that is characters: associated with Character values the domain object are: a - z, A - Z, 0 - 9 Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Registry Actions If the Registrant or administrative contact has been changed, the Registry sends an email notification to the previous Registrant and administrative contact email addresses. If these have the same email address, only one email is sent.

Response The following table lists the fields that may occur in the response to a Domain Update request. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 173 Domains Chapter 8 Domain Update

Table 76: Domain Update Response Fields

Domain Update Response Fields Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes. Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is “Command completed successfully” CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 8046 is “This status request cannot proceed at this time” Registrar Transaction The transaction ID contained in the request (if the request specified a ID Registrar Transaction ID). Registry Transaction A transaction identifier generated by the Registry when processing the ID request.

Response Codes The following response codes may be returned with the response to a Domain Update request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages.

Table 77: Domain Update Response and Error Codes

Cause Response / Error Code The request was successful 1000 - Command completed successfully General response / error codes

174 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Update

Cause Response / Error Code The request failed due to a syntax error or 2000 – Unknown command Registry policy violation. 2001 – Command syntax error 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2202 – Invalid authorization information 2303 – Object does not exist 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection Field-specific response / error codes The Name field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2201 – Authorization error 2306 – Parameter value policy error 8001 – Invalid domain name format - see documentation 8006 – Missing parameter - enter domain name 8010 – Domain name does not exist

.CA Registry Guide for Registrars: Version 4.06 175 Domains Chapter 8 Domain Update

Cause Response / Error Code Remove field values are incorrect 2003 – Required parameter missing Field values that can be removed: 2004 – Parameter value range error • Host names 2201 – Authorization error • Contact identifiers 2203 – Object does not exist • Status flags 2304 – Object status prohibits operation 8006 – Only the sponsor of the domain name can perform this function 8007 – Domain must have 0 or between 2 and 13 hosts 8018 – clientUpdateProhibited, and clientDeleteProhibited are valid status values 8019 – You must remove the updateProhibited flag before you can update other Domain fields 8035 – Invalid parameter – Domains must have 1 contact type “admin” 8034 – Invalid parameter – Domains must have 0 to 3 contacts 8035 – Invalid administration contact parameter – domain names must have 1 administrative contact 8037 – The specified contact is not associated with this domain object 8039 – The specified contact is not associated with this domain object 8041 – The specified status flag is not associated with this domain object 8042 – The specified host is not associated with this domain object

176 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Update

Cause Response / Error Code Add field values are incorrect 2003 – Required parameter missing Field values that can be added: 2004 – Parameter value range error •Host 2005 – Parameter value syntax error • Contact identifiers 2201 – Authorization error • Status flags 2302 – Object exists 2304 – Object status prohibits operation 2306 – Parameter value policy error 8006 – Only the sponsor of the domain name can perform this function 8007 – Domain must have 0 or between 2 and 13 hosts 8016 – The specified status value is already set 8018 – clientUpdateProhibited, and clientDeleteProhibited are valid status values 8019 – You must remove the updateProhibited flag before you can update other Domain fields 8020 – You must have permission to enable this status value 8021 – Create the host on the Registry system before you assign it to a domain 8022 – Create the contact on the Registry system before you assign it to a domain 8031 – Only the sponsor of the contact can link the contact to a domain 8034 – Invalid technical contact parameter – enter 0 to 3 technical contacts 8035 – Invalid administrative contact parameter – enter 1 administrative contact 8038 – Contact-related roids are not supported 8039 – The specified contact is not associated to this domain object

.CA Registry Guide for Registrars: Version 4.06 177 Domains Chapter 8 Domain Update

Cause Response / Error Code Change field values are incorrect 2003 – Required parameter missing Field values that can be changed: 2004 – Parameter value range error • Registrant contact ID 2005 – Parameter value syntax error • New password 2201 – Authorization error 2202 – Invalid authorization information 2203 – Object does not exist 2304 – Object status prohibits operation 2306 – Parameter value policy error 8005 – Invalid password format see documentation 8006 – Only the sponsor of the domain name can perform this function 8018 – clientUpdateProhibited, and clientDeleteProhibited are valid status values 8023 – Create the Registrant on the Registry system before you assign it to a domain 8024 – Invalid Registrant ID – valid CPR category required 8031 – Only the sponsor of the contact can perform this function 8036 – Missing parameter - enter password 8038 – Contact-related roids are not supported 8039 – The specified contact is not associated with this domain object Authorization Information field values are 2202 – Invalid authorization information incorrect 2306 – Parameter value policy error 8005 – Invalid password format - see documentation

EPP Interface The following is an example EPP Domain Update request showing 3 updates.

178 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Update

domainupdate03.ca domainupdate05

The following is an example request to a successful Domain Update showing 4 update requests: domainupdate07.ca domainupdate05 newpassword domainupdate07.domain.ca

The following is an example response to a successful Domain Update: Command completed successfully

.CA Registry Guide for Registrars: Version 4.06 179 Domains Chapter 8 Domain Transfer

CIRA-000000000110-0000000009

The following is an example response to a successful Domain Update request.

Command completed successfully ABC-12345 cira-000002-0000000003

Domain Transfer A successful Domain Transfer request transfers the sponsorship of a domain name from another Registrar to the Registrar submitting the request. (Registrant to Registrant transfers are more formally referred to as "domain name updates", not "transfers".) A Registrar has two options when transferring a domain name: 1 Provide contact IDs for both the Registrant and the Administrative Contact for which the gaining Registrar is the sponsor. This allows a Registrant to Registrant update at the same time as the Registrar to Registrar transfer. The Registrant contact must have CPR category data and have agreed to the CIRA Registrant Agreement. 2 Do not provide contact IDs for either Registrant or the Administrative Contact. In this case, CIRA will automatically create copies of the existing contacts, assign new contact IDs, and set the sponsor to the gaining Registrar. The registry prohibits any domain name updates that re-assign the contact of the Registrant for the domain name for 60 days from the current transfer date. This is to prevent unauthorized transfers of domain names that cannot be corrected by CIRA. Registrars cannot execute a contact update to change the name of the contact that is used in the role of the Registrant for any domain name, regardless of grace period or stage of life. Only CIRA is allowed to change the name of a Registrant using a contact update.

Note After a successful transfer, the registry will prohibit another transfer from occurring for a period of 60 days from the current transfer date

Upon a successful transfer, CIRA automatically transfers the sponsorship of all hosts that are subordinate to a transferred domain name. For example, if domain "example.ca" is transferred and host object "ns1.example.ca" exists, the host is also transferred. Hosts that are transferred when a domain name is transferred are listed in the Domain Transfer response.

180 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Transfer

The request must include the authInfo for the domain name. The domain name cannot be transferred if either of the following status flags is set at the time that the request is made: • clientTransferProhibited • serverTransferProhibited If the transfer of a domain name is done during Auto Renew Grace Period the domain name will be placed in the registered stage of life with the delete prohibited status applied. If the transfer of a domain name is done during Redemption Grace Period the domain name will be placed in the registered stage of life with the delete prohibited status applied. For a Domain Transfer request to be successful, the resulting domain name and its contact. associations must be valid according to the rules specified in the Domain Create section of this document. When a domain name is first created, a Domain Transfer is not permitted until the domain name is 60 days old. When making a calculation for this purpose, domain names are not considered to be fully created until the Registrant has agreed to the Registrant Agreement. In other words, the time that a domain name is in the pendingCreate status, (if applicable) does not count towards the 60-day grace period. See “Domain Create” on page 148.

Note The gaining Registrar should change the domain name password after a successful domain transfer.

CIRA completes successful transfer requests immediately. It is not possible for the losing Registrar to approve or reject a transfer. A domain name cannot be transferred if the Registrar does not have sufficient funds for the transaction. A successful Registrar to Registrar transfer initiates a poll queue message from the Registry to the losing Registrar, informing the Registrar of the action. CIRA will send an optionally co-branded email to both the Registrant email address (if available) and Administrative Contact email address upon the successful transfer of a domain name (one email will be sent if the addresses are identical).

Domain Transfer Request The Domain Transfer Request Fields lists the Domain Transfer request fields. The corresponding EPP element is displayed below the field name.

.CA Registry Guide for Registrars: Version 4.06 181 Domains Chapter 8 Domain Transfer

Table 78: Domain Transfer Request Fields Field Name / Type Usage Description Valid Values EPP Element Name Varchar2 (240) Mandatory The domain name Maximum number of segments, separated by period characters, is 4 Maximum number of characters per segment is 63 Characters must be alphanumeric or "-" "-" cannot appear at the start or end of a segment The last segment must be .ca Authorization Varchar2 (16) Mandatory The authorization Length is 6 - 16 Information password for the characters domain object Character values are: a - z, A - Z, 0 - 9 Registrant Varchar2 (255) Optional The contact Number of identifier for the Registrants per However, both Registrant domain name is 1 Registrant and Administrative must be specified and if they are not specified CIRA copies the existing data for both contacts and auto-generates new IDs

182 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Transfer

Table 78: Domain Transfer Request Fields Field Name / Type Usage Description Valid Values EPP Element Administrative Varchar2 (255) Optional The contact Number of Contact identifier for the administrative However, both contact domain name is 1 Administrative must be specified and if they are not specified CIRA copies the existing data for both contacts and auto-generates new IDs Technical Varchar2 (255) Optional The optional Number of Contact contact technical contacts If Registrant and three) for the is 0 - 3 contacts were not technical contacts specified, CIRA copies the existing data for of up to 3 technical contacts and auto- generates new IDs Registrar Varchar2 (64) Optional If the request Transaction ID contains an optional Registrar Transaction ID, this value will be included in the response

Note Registrars must supply the correct authInfo of the domain name being transferred

Registry Actions A successful Domain Transfer request initiates the following Registry actions. • A successful transfer adds one year to the registration provided the registration does not exceed 10 years

.CA Registry Guide for Registrars: Version 4.06 183 Domains Chapter 8 Domain Transfer

• The gaining Registrar is always charged the one year transfer fee even if the registration period is not extended • The Registry queues a service message for the losing Registrant

Table 79: Domain Transfer Registry Actions

Current Life Cycle Stage Registry Actions auto-renew Sets life cycle stage to Registered. Sets status flag serverTransferProhibited for 60 days Sets status flag serverDeleteProhibited other Sets the status flags serverTransferProhibited and serverUpdateProhibited change registrant for 60 days

Response The Domain Transfer Response Fields table lists the fields that may occur in the response to a Domain Transfer request. The EPP element is displayed below the field name.

Table 80: Domain Transfer Response Fields

Field Name / Description EPP Element Response Code One or more four-digit response code numbers that indicate the success or failure of the request execution. When the request is processed successfully, only one response code is returned. An unsuccessful request can return multiple error response codes Each response code has an associated human-readable message in the Registrar’s preferred language. For example the English human- readable description of response code 1000 is “Command completed successfully” CIRA Error Messages Usually CIRA includes a more specific error code Each CIRA error message has an associated human-readable message in the Registrar’s preferred language. For example the English human-readable description of response code 8046 is “This status request cannot proceed at this time” Name The domain name Status server approved

184 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Transfer

Field Name / Description EPP Element Requesting Registrar’s The requesting (or gaining) Registrar’s ID ID Request Date The request date Losing Registrar’s ID The Losing Registrar’s ID. Losing Registrars do not have to approve a transfer Transfer Approval Date The server approved date of transfer. Approval is not required, therefore approval is always granted immediately Expiry Date The transfer process expiry date The date that the server approves the transfer Registrar Transaction ID The transaction ID contained in the request, if the request specified a Registrar Transaction ID Registry Transaction ID A transaction identifier generated by the Registry when processing the request

Response / Error Codes The following response codes may be returned with the response to a Domain Transfer request. When the request is successful, the response will usually contain a single 1000-series response code and message. An unsuccessful request can have a response that contains several response codes and messages.

Table 81: Domain Transfer Response / Error Codes

Cause Response / Error Code The request was successful 1000 - Command completed successfully General response / error codes

.CA Registry Guide for Registrars: Version 4.06 185 Domains Chapter 8 Domain Transfer

The request failed due to a syntax 2000 – Unknown command error or Registry policy 2001 – Command syntax error violation. 2002 – Command use error 2100 – Unimplemented protocol version 2101 – Unimplemented command 2103 – Unimplemented extension 2106 – Object is not eligible for transfer 2302 – Object exists 2304 – Object status prohibits operation 2307 – Unimplemented object service 2308 – Data management policy violation 2400 – Command failed 2500 – Command failed: server closing connection Billing Error 2104 – Billing failure 8029 – Insufficient funds available to complete the request Field-specific response / error codes The Name field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2306 – Parameter value policy error 8001 – Invalid domain name format - see documentation 8006 – Missing parameter - enter domain name 8010 – Domain name does not exist 8030 – Restricted domain name - CIRA policy prohibits operation 8037 – CIRA policy prohibits the transfer of a municipal or provincial domain name 8045 – You are already the sponsor of this domain

186 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Transfer

The Authorization Information 2003 – Required parameter missing (password) field was incorrect 2202 – Invalid authorization information 2306 – Parameter value policy error 8005 – Invalid password format – see documentation 8036 – Missing parameter - enter password 8044 – Invalid authInfo password Registrant field was incorrect 2003 – Required parameter missing 2004 – Parameter value range error 2005 – Parameter value syntax error 2201 – Authorization error 2303 – Object does not exist 2306 – Parameter value policy error 8012 – Missing parameter - enter Registrant ID 8023 – Create the Registrant on the Registry system before you assign it to a domain 8024 – Invalid Registrant ID - valid CPR category required 8031 – Only the sponsor of the contact can perform this function 8038 – Contact-related roids are not supported 8039 – The specified contact is not associated with this domain object

.CA Registry Guide for Registrars: Version 4.06 187 Domains Chapter 8 Domain Transfer

Administrative Contact field was • 2003 – Required parameter missing incorrect • 2004 – Parameter value range error • 2005 – Parameter value syntax error • 2201 – Authorization error • 2303 – Object does not exist • 2306 – Parameter value policy error • 8013 – Missing parameter - enter domain contact: admin • 8022 – Create the contact on the Registry system before you assign it to a domain • 8031 – Only the sponsor of the contact can perform this function • 8032 – The administrative or technical contact must be an individual • 8035 – Invalid administration contact parameter - enter 1 administrative contact • 8038 – Contact-related roids are not supported • 8039 – The specified contact is not associated with this domain object Technical Contact field was • 2003 – Required parameter missing incorrect • 2004 – Parameter value range error • 2005 – Parameter value syntax error • 2201 – Authorization error • 2303 – Object does not exist • 2306 – Parameter value policy error • 8014 – Missing parameter - enter domain contact: tech • 8022 – Create the contact on the Registry system before you assign it to a domain • 8031 – Only the sponsor of the contact can perform this function • 8032 – The administrative or technical contact must be an individual • 8034 – Invalid technical contact parameter - enter 0-3 technical contacts • 8038 – Contact-related roids are not supported • 8039 – The specified contact is not associated with this domain object • 8043 – Invalid contact type value parameter must be “admin” or “tech”

188 .CA Registry Guide for Registrars: Version 4.06 Chapter 8 Domains Domain Transfer

EPP Interface The following example is an EPP Domain Transfer request. domain.ca password Registrant admin tech

The following example is an EPP response to a successful Domain Transfer request. Command completed successfully domain.ca serverApproved automatedRARsprint3 2010-02-26T20:13:32.0Z RAR700 2010-02-26T20:13:32.0Z 2010-02-26T20:13:32.0Z CIRA-000000000112-0000000002

.CA Registry Guide for Registrars: Version 4.06 189 Domains Chapter 8 Domain Transfer

190 .CA Registry Guide for Registrars: Version 4.06 Appendix A

Appendix A Valid Formats and Data Values Appendix A describes valid formats and data values accepted by CIRA. Understanding legal types for Registrants A 'Legal type' is a category that the Registrant must fall into in order to meet the Canadian Presence Requirements. The Canadian Presence Requirements are set out in the General Registration Rules and the Registrant Agreement between CIRA and registrants.

Corporation (Canada or Canadian province or territory) A corporation under the laws of Canada or any province or territory of Canada, Charities, Cooperative, Council.

Registrant name format requirements The Registrant name must be the full legal name of the corporation and must be followed by the jurisdiction of incorporation (i.e. Canada, Ontario, NWT….), unless it is obvious from the corporation’s name. Canadian Internet Registration Authority (Canada) For Charities - the NFP should be included in the organization name - if it is a not-for-profit organization - you are also required to submit the registration number (i.e. 123456789 RR0001)

Table 82: Examples of valid and invalid Registrant names for the legal type 'Corporation' Valid Registrant name Invalid Registrant name The Foundation of Rosa (NFP) Smiths La fondation de Edward (OSBL) Smiths Consulting 123745 Canada Inc. Smiths Kennel Smith Corp. of Ontario Leatra SP Smith Ltée. Canada Smiths Corp.

Canadian citizen A Canadian citizen of the age of majority under the laws of the province or territory in Canada in which he or she resides or last resided.

Registrant name format requirements The Registrant’s name must be the full legal name of the Canadian Citizen who will hold the domain name registration as the name would appear on a passport, driver’s license or other identification document issued by a government.

.CA Registry Guide for Registrars: Version 4.06 191 Appendix A Understanding legal types for Registrants

The name may be followed by a space and “o/a xxxx” where “o/a” stands for “Operating As” and “xxxx” can be any alpha-numeric string designated by the applicant and subject to applicable rules and length restrictions (e.g. “John Doe o/a Doe Consulting Group”). The name may also be followed by a space and a degree granted to the Registrant by a recognized degree granting institution or a recognized professional designation which the Registrant has the right to use (i.e. PhD, MD, and DDS.) Full legal names of individuals may only consist of alphabetic characters and the special characters: single quote mark('), hyphen(-), period(.).

Table 83: Examples of valid and invalid Registrant names for the legal type 'Canadian citizen' Valid Registrant name Invalid Registrant name John Smith John Fred-Albert Doon PhD J. Doe Bernard St-James o/a St-James Services None Kathy Lynn Perse Personal (blank) Cool Gal Domain Administrator St-James Services Acme Sales Inc.

Permanent resident of Canada A permanent resident as defined in the Immigration and Refugee Protection Act (Canada) S.C. 2001, c.27, as amended from time to time, who is “ordinarily resident” (as defined below) in Canada and of the age of majority under the laws of the province or territory in Canada in which he or she resides or last resided. “Ordinarily resident in Canada” means an individual who resides in Canada for more than 183 days in the twelve month period immediately preceding the date of the applicable request for registration of the .ca domain name or sub-domain name and in each twelve month period thereafter for the duration of the domain name registration.

Registrant name format requirements The Registrant’s name must be the full legal name of the Permanent Resident who will hold the domain name registration as the name would appear on a driver’s license or other identification document issued by a government. The full legal name may be followed by a space and “o/a xxxx” where “o/a” stands for “Operating As” and “xxxx” can be any alpha-numeric string designated by the applicant and subject to applicable rules and length restrictions (e.g. “John Doe o/a Doe Consulting Group”). The name may also be followed by a space and a degree granted to the Registrant by a recognized degree granting institution or a recognized professional designation which the Registrant has the right to use (i.e. PhD, MD, and DDS.)

192 .CA Registry Guide for Registrars: Version 4.06 Appendix A Understanding legal types for Registrants

Full legal names of individuals may only consist of alphabetic characters and the special characters: single quote mark('), hyphen(-), period(.).

Table 84: Examples of valid and invalid Registrant names for the legal type 'Permanent resident of Canada' Valid Registrant name Invalid Registrant name John Smith John Fred-Albert Doon DDS J. Doe Bernard St-James o/a St-James Services F.A.D Kathy Lynn Perse Cool Gal St-James Services Acme Sales Inc.

Government or government entity in Canada Her Majesty the Queen in right of Canada, a province or a territory; an agent of Her Majesty the Queen in right of Canada, of a province or of a territory; a federal, provincial or territorial Crown corporation, government agency or government entity; or a regional, municipal or local area government.

Registrant name format requirements The Registrant’s name must be the complete official name of the entity that will hold the domain name registration, without any abbreviations. (A common abbreviation may follow the official name in parentheses). If the Registrant is not a government, the Registrant’s name must be followed by the name of the jurisdiction (i.e. Canada, province, territory, municipality, etc) to which the Registrant is related.

Table 85: Examples of valid and invalid Registrant names for the legal type 'Government or government entity in Canada' Valid Registrant name Invalid Registrant name Government of Alberta Toronto Sales Are Us Inc. Export Development Corporation (EDC) DCIOPEI (Canada) Deposit Insurance Corporation of Ontario John Doe (DCIO) City of Toronto

Canadian educational institution 1 A university or college which is located in Canada and which is authorized or recognized as a university or college under an Act of the legislature of a province or territory of Canada; or

.CA Registry Guide for Registrars: Version 4.06 193 Appendix A Understanding legal types for Registrants

2 A college, post-secondary school, vocational school, secondary school, pre-school or other school or educational institution which is located in Canada and which is recognized by the educational authorities of a province or territory of Canada or licensed under or maintained by an Act of Parliament of Canada or of the legislature of a province or territory of Canada

Registrant name format requirements The Registrant’s name must be the complete official name of the institution that will hold the domain name registration, without any abbreviations. A common abbreviation may follow the official name in parentheses. The Registrant name must be followed by the jurisdiction (e.g. name of province, municipality) in which the institution is accredited if not obvious from the Registrant’s name.

Table 86: Examples of valid and invalid Registrant name for the legal type 'Canadian educational institution' Valid Registrant name Invalid Registrant name L’ école de la ville (Ottawa) Sandhill Secondary School University of British Columbia (UBC) Sales Are Us Inc. St-John’s Middle School of Ottawa UBC Student Association Advanced Languages Institute of Ontario Professional Association of Teaching Professionals (ALI)(Ontario) of UdeM Joe Smith

Canadian unincorporated association This legal type is principally intended for religious congregations, social and sports clubs and community groups, council (not registered) or society (not registered) which are based and operating in Canada. An unincorporated organization, association or club: 1 at least 80% of whose members: (A) are ordinarily resident in Canada (if such members are individuals); or (B) meet the requirements of any one of the following Registrant Types: Corporation (Canada or Canadian province or territory), Canadian citizen, Permanent Resident of Canada, Partnership Registered in Canada, Trust established in Canada, Legal Representative of a Canadian Citizen or Permanent Resident; and 2 at least 80% of whose directors, officers, employees, managers, administrators or other representatives are ordinarily resident in Canada

Registrant name format requirements The Registrant’s name must be the complete name of the association that will hold the domain name registration, without any abbreviations. (A common abbreviation may follow the complete name in parentheses).

194 .CA Registry Guide for Registrars: Version 4.06 Appendix A Understanding legal types for Registrants

Table 87: Examples of valid and invalid Registrant names for the legal type 'Canadian unincorporated association' Valid Registrant name Invalid Registrant name St-Alban’s Reformed Church of Victoria ACDEN Archdiocese of Montréal St-Patrick’s Sun Youth Montréal Dartmouth Soccer Club Limited Citizens for the Protection of the Red River John Doe Toronto Junior Soccer Association

Canadian hospital A hospital which is located in Canada and which is licensed, authorized or approved to operate as a hospital under an Act of the legislature of a province or territory of Canada.

Registrant name format requirements The Registrant’s name must be the complete official name of the hospital that will hold the domain name registration, without any abbreviations. (A common abbreviation may follow the complete name in parentheses.) The Registrant’s name must be followed by the jurisdiction (i.e. name of province) which accredited the hospital if not obvious from the Registrant’s name.

Table 88: Examples of valid and invalid Registrant names for the legal type 'Canadian hospital' Valid Registrant name Invalid Registrant name Royal Victoria Hospital – Québec The dog hospital Sick Children’s Hospital of Ontario The cat veterinary Veteran’s Hospital Canada, Pointe Claire Dr. John Doe Children’s Hospital of Eastern Ontario Jane Doe (CHEO) John Doe Inc. SHUL Nurses Union Local 1455 NHCWA Manitoba Doctors Against Drugs (MDAD)

Partnership registered in Canada A partnership, more than 66 2/3 % of whose partners meet the requirements of one of the following Registrant Types: Corporation (Canada or Canadian province or territory), Canadian citizen, Permanent Resident of Canada, Trust established in Canada or a Legal Representative of a Canadian Citizen or Permanent Resident, which is registered as a partnership under the laws of any province or territory of Canada.

.CA Registry Guide for Registrars: Version 4.06 195 Appendix A Understanding legal types for Registrants

Registrant name format requirements The Registrant’s name must be the registered name of the partnership that will hold the domain name registration. The Registrant name must be followed by the jurisdiction of registration (i.e. Alberta) and the registration number.

Table 89: Examples of valid and invalid Registrant names for the legal type 'Partnership registered in Canada' Valid Registrant name Invalid Registrant name John Doe, LLP (Ontario) Mybusiness Inc. Xenon Partnership (Ontario) Fred Smith Doucett, Entwistle and Theedom LLP John Doe Partnership (Ontario) John Doe Partnership, British Columbia Rosa, Edward, Kelly, Partnership-Ottawa

Trade-mark registered in Canada by non-Canadian owner A Person which does not fall under any other legal type, but which is the owner of a trade-mark which is the subject of a registration under the Trade-marks Act (Canada) R.S.C. 1985, c.T-13 as amended from time to time, but in this case such permission is limited to a request to register a .ca domain name consisting of or including the exact word component of that registered trade-mark.

Note This legal type is only intended for Registrants which do not meet the requirements associated with any other legal type but which have a trade-mark registered in Canada. (Trade- marks subject of trade-mark applications and trade-marks registered in other jurisdictions, such as the United States, do not qualify.) The domain name to be registered must include the trade- mark. (i.e. If the trade-mark is AVEA this type of Registrant can register avea.ca or aveaisus.ca but not xyz.ca)

Registrant name format requirements The Registrant’s name must be the complete legal name of the trade-mark owner (not the trade- mark agent) holding the domain name registration without any abbreviations. (A common abbreviation may follow the complete name in parentheses.) The applicant must also insert the Canadian registration number of the trade-mark following the Registrant name.

Table 90: Examples of valid and invalid Registrant names for the legal type 'Trade-mark registered in Canada by non-Canadian owner' Valid Registrant name Invalid Registrant name Arcuros SPA - TMA1762466 Arcuros SPA

Canadian trade union A trade union which is recognized by a labour board under the laws of Canada or any province or territory of Canada and which has its head office in Canada.

196 .CA Registry Guide for Registrars: Version 4.06 Appendix A Understanding legal types for Registrants

Registrant name format requirements The Registrant’s name must be the complete official name of the trade union that will hold the domain name registration, without abbreviations. (A common abbreviation may follow the official name in parentheses.) The Registrant name must be followed by the jurisdiction in Canada which recognizes it (if it is not obvious from the Registrant’s name.)

Table 91: Examples of valid and invalid Registrant names for the legal type 'Canadian trade union' Valid Registrant name Invalid Registrant name Confédération des syndicats nationaux ZZCEUL local 237 (CSN) – Québec Canadian Union of Postal Workers (CUPW) Jean Smith Sales Are Us Inc.

Canadian political party A political party registered under a relevant electoral law of Canada or any province or territory of Canada.

Registrant name format requirements The Registrant’s name must be the complete official name of the political party holding the domain name registration, without abbreviations. (A common abbreviation may follow the official name in parentheses.) The Registrant name must also by followed by the jurisdiction in Canada in which it is registered (if it is not obvious from the official name).

Table 92: Examples of valid and invalid Registrant names for the legal type 'Canadian political party' Valid Registrant name Invalid Registrant name Progressive Conservative Party of Canada John Doe (PC) Union Nationale du Québec Sales Are Us Inc. Reform Party – Alberta Liberal Party ACCULD – Ontario National Liberation Front of Mexico

Canadian library, archive or museum An institution, whether or not incorporated, that: 1 is located in Canada; and 2 is not established or conducted for profit or does not form part of, or is not administered or directly or indirectly controlled by, a body that is established or conducted for profit in which is held and maintained a collection of documents and other materials that is open to the public or to researchers

.CA Registry Guide for Registrars: Version 4.06 197 Appendix A Understanding legal types for Registrants

Registrant name format requirements The Registrant’s name must be the complete legal name of the institution which will hold the domain name registration without abbreviations. (A common abbreviation may follow the complete name in parentheses.)

Table 93: Examples of valid and invalid Registrant names for the legal type 'Canadian library, archive or museum' Valid Registrant name Invalid Registrant name Royal Ontario Museum John Doe Musé des Beaux Arts de Montréal Sales Are Us Inc. My site Domain Administrator Biggs Bargain Books

Trust established in Canada A trust established and subsisting under the laws of a province or territory of Canada, more than 66 2/3 % of whose trustees meet the requirements of one of the following Registrant Types: Corporation (Canada or Canadian province or territory), Canadian citizen, Permanent Resident of Canada, or a Legal Representative of a Canadian Citizen or Permanent Resident.

Registrant name format requirements The Registrant’s name must be the complete official name of the trust, without any abbreviations. (A common abbreviation may follow the official name in parentheses.) The Registrant name must also indicate the total percentage of the trustees that meet one or more of the following requirements: Canadian citizen, permanent resident, Canadian corporation, legal representative.

Table 94: Examples of valid or invalid Registrant names for the legal type 'Trust established in Canada' Valid Registrant name Invalid Registrant name Marie Daigle Trust – (100%) John Doe Arbeit Trust – (70%) Sales Are Us Inc. Arbeit Trust (10%)

Aboriginal Peoples (individuals) indigenous to Canada Any individual belonging to any Inuit, First Nation, Metis or other people indigenous to Canada.

Registrant name format requirements The Registrant’s name must be the full legal name of the Aboriginal Person applying for the Registration as it would appear on a driver’s license or other identification document issued by government.

198 .CA Registry Guide for Registrars: Version 4.06 Appendix A Understanding legal types for Registrants

The Registrant may enter its full legal name followed by a space and “o/a xxxx” where “o/a” stands for “Operating As” and “xxxx” can be any alpha-numeric string designated by the applicant and subject to applicable rules and length restrictions (e.g. “John Doe o/a Doe Consulting Group”). The name may also be followed by a space and a degree granted to the Registrant by a recognized degree granting institution or a recognized professional designation which the Registrant has the right to use (i.e. PhD, MD, and DDS.) Full legal names of individuals may only consist of alphabetic characters and the special characters: single quote mark('), hyphen(-), period(.).

Table 95: Examples of valid and invalid Registrant names for the legal type 'Aboriginal Peoples (individuals) indigenous to Canada' Valid Registrant name Invalid Registrant name John Smith John Fred-Albert Doon DDS None Bernard St-James o/a St-James Services Personal (blank) Domain Administrator St-James Services Inc.

Aboriginal Peoples (groups) indigenous to Canada Any Inuit, First Nation, Metis or other people indigenous to Canada, and any collectivity of such Aboriginal peoples.

Registrant name format requirements The Registrant’s name must be the complete official name of the indigenous people a collectivity of Aboriginal Persons or, if there is no official name, the name by which the collectivity is commonly known.

Table 96: Examples of valid and invalid Registrant names for the legal type 'Aboriginal Peoples (groups) indigenous to Canada' Valid Registrant name Invalid Registrant name Carrier Sekani Tribal Council Acme Sales Inc. Helping Spirit Lodge Society John Jones

Indian Band recognized by the Indian Act of Canada Any Indian band as defined in the Indian Act, R.S.C. 1985, c. I-5, as amended from time to time, and any group of Indian bands.

Registrant name format requirements The name of Registrant must be the Indian Band Name as registered with the Department of Indian and Northern Affairs, Canada.

.CA Registry Guide for Registrars: Version 4.06 199 Appendix A Understanding legal types for Registrants

Note To verify the status or existence of an Indian Band, visit: http:// www.aboriginalcanada.gc.ca/ or contact them directly by telephone at 888-399-0111. The website is not authoritative.

Table 97: Examples of valid and invalid Registrant names for the legal type 'Indian Band recognized by the Indian Act of Canada' Valid Registrant name Invalid Registrant name Lac la Ronge Indian Band Mohawk Motors Sioux Sales Inc. Sales Are Us Inc. John Smith

Legal representative of a Canadian citizen or permanent resident An executor, administrator or other legal representative of a Person listed as a Canadian Citizen or Permanent Resident of Canada.

Note This legal type is only available to a person or entity that has been appointed by legal process to represent an individual who is not competent to represent him or herself. It is not available to anyone who represents a Canadian or foreign corporation in any capacity

Registrant name format requirements: The Registrant’s name must be the full legal name of the Canadian Citizen or Permanent Resident of Canada who is being represented as it would appear on a passport, driver’s license or other government identification document. This must be followed by the full legal name and capacity of at least one of the official representatives. Full legal names of individuals may only consist of alphabetic characters and the special characters: single quote mark('), hyphen(-), period(.).

Caution The representative should be identified as the Administrative Contact for these registrations

Table 98: Examples of valid and invalid Registrant names for the legal type 'Legal representative of a Canadian citizen or permanent resident' Valid Registrant name Invalid Registrant name John Smith (Jayne Smith, executor) Sales Are Us Inc. Arlenza SP Shingle LLP

200 .CA Registry Guide for Registrars: Version 4.06 Appendix A About valid and invalid Contact names

Official marks registered in Canada A Person which does not meet the requirements for any other legal type, but which is a Person intended to be protected by Subsection 9(1) of the Trade-marks Act (Canada) at whose request the Registrar of trade-marks has published notice of adoption of any badge, crest, emblem, official mark or other mark pursuant to Subsection 9(1), but in this case such permission is limited to a request to register a .ca domain name consisting of or including the exact word component of such badge, crest, emblem, official mark or other mark in respect of which such Person requested publications.

Note This legal type is only intended for Registrants which do not meet the requirements associated with any other legal type but which have an Official Mark registered in Canada. The domain name must include the official mark (i.e. if the official mark is WIPO, the Registrant can register wipo.ca but not intellectual-property.ca)

Registrant name format requirements The Registrant’s name must be the complete official name of the entity holding the domain name registration without any abbreviations. (A common abbreviation may follow the complete name in parentheses.) The registration number of the official mark must follow the Registrant Name.

Table 99: Examples of valid and invalid Registrant names for the legal type 'Official marks registered in Canada' Valid Registrant name Invalid Registrant name The United Nations Educational, Scientific John Doe Inc. and Cultural Organization (UNESCO) - 0970388 Arcuros SPA

Her Majesty the Queen Her Majesty Queen Elizabeth the Second and her successors.

Registrant name format requirements: The Registrant’s name must be that of Her Majesty the Queen or, after a succession, the name of her successor. About valid and invalid Contact names CIRA requires the Registrar to collect accurate information from the Registrant. Contacts without a valid Canadian presence cannot be assigned to the Registrant role. CIRA's registry checks for Canadian presence on a contact in the role of Registrant. Organization can only be used when a contact is an individual, because its intended use is to indicate which organization an actual person works for, and does not indicate the non-individual contact name. The following is a list that includes, but is not limited to, valid non individual names. When the category is non-individual, the contact must contain at least one of the following whole words in the name:

.CA Registry Guide for Registrars: Version 4.06 201 Appendix A About valid and invalid Contact names

Table 100: Valid non-individual names Valid non Individual Names bank banque caisse d'economie caisse d'epargne coop caisse de credit caisse populaire compagnie company cooperation cooperative cooprix corp corp. corporation credit union federation de federation of mutual fideicommis fiducie societes mutuelles insurance d'assurance associations inc inc. incorporated incorporee limited limitee limited ltd ltd. lte lte. ltee ltee. mutual benefit association s.a. s.a.r.f. s.c.c. savings union societe commerciale canadienne societe d'entraide societe d'epargne societe de fiducie societe de secours societe mutuelle economique mutuels d'assurance societe par actions trust ulc ulc. unlimited liability company limited liability llc sarl societe par actions a limited liability company responsabilite partnership limitee llp société à s.r.l. responsabilité limitée

The following is a list, that includes but is not limited to, invalid individual names. The category is individual and therefore, the contact name must not contain any of the following whole words: Table 101: Invalid individual names

Invalid Individual Names compagnie company corporation entreprise essentiel essentiels ergonomic ergonomics ergonomique event events evenement evenements farm farms ferme fermes film films financial financiere food foreign free fund funds gallerie gestion golf graphic graphics graphique graphiques group groupe halifax hamlet health hebdomadaire help hosting hotel hotels immobilier individu

202 .CA Registry Guide for Registrars: Version 4.06 Appendix A About valid and invalid Contact names

Invalid Individual Names individus individual individuals industrie industries industry information instruments interest international internet journal laboratoire laboratoires laboratory laboratories leasing liberal local location locations management manitoba mb mechanic mechanics medecine media medical montreal motel motels motoneige motoneiges motor motors nb network networking new brunswick newfoundland nf northerns nova scotia ns of office online ontario org. organisation organization ottawa outlet outlets pei photography photographie picture pictures product products production productions program programs properties property public publishing punk quarterly quebec realty remote rental rentals restaurant rights rues rural sa sask. saskatoon school services sex ski snowmobible snowmobibles societe society solution solutions sport sports student studio supply supplies system systems teacher teachers teaching technical technologie technology the theatre tm toronto treats trimestriel town ultimate universal universel university universite vacation vacations vancouver vente verte village ville virtual virtuel webmaster website weekly winnipeg xxx canada (tm) academic academie academy access admin administration administrations administrator adult adventure alb alberta alliance american animal animals animaux and arts assistance associate associates association autorite authority available band bc breakfast british business businesses calgary canadian canadien canadienne capital capitale care

.CA Registry Guide for Registrars: Version 4.06 203 Appendix A Authorization Information

Invalid Individual Names carpet carpets central city classic club clubs college comission commerce communication communications computer conseiller conseillers consultant consultants consultation consulting coop co-op cottages council country cyber cybercafe design designs development developpement digital disability disabilities disponible distribution district dns domain domains domaine domaines drink droits economic economique educational eglise electronic electronics electronique electroniques essential essentials

Note A Contact that is an individual cannot use invalid contact names for Administrative Contact and Technical Contact information

See also the Canadian Presence Requirements for Registrants at http://www.cira.ca/assets/ Documents/Legal/Registrants/CPR.pdf. Authorization Information The registration of domain names and other operations around the registered domain name are carried out only if the registrar is authorized for the change. An authorization password is usually associated with the domain. Information is returned in a response only when: • The querying Registrar is the current sponsoring Registrar, or • The Registrar has supplied valid authorization information with the request For example, CIRA regards any changes to the contact name information a critical change and requires authorization information. In this case, the request must include the authorization information for the domain. The Registrar must provide valid contact IDs for Registrant and administrative contact, and, if applicable, technical contacts. These contacts must be sponsored by the Registrar. In the case of a domain name transfer, The Registrar must have the authorization information, (a password) from the Registrant before the domain name can be transferred. Domain Names The following lists valid domain name formats and values. • Maximum 4 segments separated by period characters • Maximum segment length 63 characters • Segment characters must be alphanumeric or "-" • "-" must not appear at the start or end of a segment

204 .CA Registry Guide for Registrars: Version 4.06 Appendix A Email Addresses

• Last segment must be "ca" Email Addresses The following lists email valid format and values. • Length is 6 - 320 characters • Format: [email protected] IP Addresses The Registry supports both IPv4 and IPv6 address types. An IPv4 address is a 32-bit identifier that consists of a set of four numbers, each in the range of 0 to 255, separated by periods. For example, 64.230.164.58. An IPv6 address is a 128-bit identifier. IPv6 notation consists of eight groups of four hexadecimal digits, separated by colons. For example, 2001:db8:0000:0000:0000:0000:0000:5b0f CIRA supports entering IPV6 IP addresses in standard shorthand notations such as: • Removing the leading zeros in a group • Replacing one or more consecutive groups that consist entirely of zero values with two colons (::). This can only be done once in an address Postal Codes When the country code is CA, the postal code format is XNX NXN. Where X is a letter and N is a number, the space separating the first three characters from the second three characters, is optional. When the country code is US, the zip code format is NNNNN or NNNNN-NNNN. Where N is a numeric character, the hyphen character is used to separate the first five characters from the following four characters, if the 'zip plus four' format is used. Telephone and Fax Numbers The telephone number format must be as follows: a plus sign (+) followed by the country code followed by a period (.) followed by the telephone number, for example, +1.6135555555. You may add an extension number if required. To add the extension: • Web user enters the extension number into the extension field • EPP requests use the format: +1.6135555555 Phone or Fax number (including the plus (+) and dot (.) characters): •Min - 10 •Max - 17 Extension number (including the 'x' character): •Min - 0 •Max - 10 You can use numeric characters and the special characters contained in the example.

.CA Registry Guide for Registrars: Version 4.06 205 Appendix A Country Codes

Country Codes The Country Codes table lists the country names in alphabetical order and their corresponding country codes.

Country Code Afghanistan AF Aland Islands AX Albania AL Algeria DZ American Samoa AS Andorra AD Angola AO Anguilla AI Antarctica AQ Antigua & Barbuda AG Argentina AR Armenia AM Aruba AW Ascension Island AC Australia AU Austria AT Azerbaijan AZ Bahamas BS Bahrain BH Bangladesh BD Barbados BB Belarus BY Belgium BE Belize BZ Benin BJ Bermuda BM Bhutan BT Bolivia BO Bosnia and Herzegovina BA

206 .CA Registry Guide for Registrars: Version 4.06 Appendix A Country Codes

Country Code Botswana BW Bouvet Island BV Brazil BR British Indian Ocean Territory IO Brunei Darussalam BN Bulgaria BG Burkina Faso BF Burundi BI Cambodia KH Cameroon CM Canada CA Cape Verde CV Cayman Islands KY Central African Republic CF Chad TD Chile CL China CN Christmas Island CX Cocos (Keeling) Islands CC Columbia CO Comoros KM Congo CG Democratic republic of the Congo CD Cook Islands CK Costa Rica CR Côte D’ivoire (Ivory Coast) CI Croatia HR Cuba CU Cyprus CY Czech Republic CZ Denmark DK Djibouti DJ Dominica DM

.CA Registry Guide for Registrars: Version 4.06 207 Appendix A Country Codes

Country Code Dominican Republic DO Ecuador EC Egypt EG El Salvador SV Equatorial Guinea GQ Eritrea ER Estonia EE Ethiopia ET Falkland Islands (Malvinas) FK Faroe Islands FO Federated States of Micronesia FM Fiji FJ Finland FI France FR French Guiana GF French Polynesia PF French Southern Territories TF Gabon GA Gambia GM Georgia GE Germany DE Ghana GH Gibraltar GI Greece GR Greenland GL Grenada GD Guadeloupe GP Guam GU Guatemala GT Guernsey GG Guinea GN Guinea-Bissau GW Guyana GY

208 .CA Registry Guide for Registrars: Version 4.06 Appendix A Country Codes

Country Code Haiti HT Heard & McDonald Islands HM Holy See (Vatican City State) VA Honduras HN Hong Kong HK Hungary HU Iceland IS India IN Indonesia ID Iran IR Iraq IQ Ireland IE Isle of Man IM Israel IL Italy IT Jamaica JM Japan JP Jersey JE Jordan JO Kazakhstan KZ Kenya KE Kiribati KI (North) Korea, Democratic People’s Republic of KP (South) Korea, Republic of KR Kuwait KW Kyrgyzstan KG Lao People’s Democratic Republic LA Latvia LV Lebanon LB Lesotho LS Liberia LR Libya (Libyan Arab Jamahiriya) LY Liechtenstein LI

.CA Registry Guide for Registrars: Version 4.06 209 Appendix A Country Codes

Country Code Lithuania LT Luxembourg LU Macao MO Macedonia, the Former Yugoslav Republic of MK Madagascar MG Malawi MW Malaysia MY Maldives MV Mali ML Malta MT Marshall Islands MH Martinique MQ Mauritania MR Mauritius MU Mayotte YT Mexico MX Micronesia, Federated States of FM Moldova MD Monaco MC Mongolia MN Montenegro ME Montserrat MS Morocco MA Mozambique MZ Myanmar MM Namibia NA Nauru NR Nepal NP Netherlands NL Netherlands Antilles AN New Caledonia NC New Zealand NZ Nicaragua NI

210 .CA Registry Guide for Registrars: Version 4.06 Appendix A Country Codes

Country Code Niger NE Nigeria NG Niue NU Norfolk Island NF Northern Mariana Islands MP Norway NO Oman OM Pakistan PK Palau PW Palestine (Palestinian Territory, occupied) PS Panama PA Papua New Guinea PG Paraguay PY Peru PE Philippines PH Pitcairn Islands PN Poland PL Portugal PT Puerto Rico PR Qatar QA Réunion RE Romania RO Russia RU Rwanda RW Saint Barthélemy BL Saint Helena SH Saint Kitts and Nevis KN Saint Lucia LC Saint Martin MF Saint Pierre and Miquelon PM Saint Vincent and the Grenadines VC Samoa WS San Marino SM

.CA Registry Guide for Registrars: Version 4.06 211 Appendix A Country Codes

Country Code São Tomé and Principe ST Saudi Arabia SA Senegal SN Serbia RS Seychelles SC Sierra Leone SL Singapore SG Slovakia SK Slovenia SI Solomon Islands SB Somalia SO South Africa ZA South Georgia and the South Sandwich GS Islands Spain ES Sri Lanka LK Sudan SD Suriname SR Svalbard and Jan Mayen Islands SJ Swaziland SZ Switzerland CH Sweden SE Syria SY Taiwan TW Tajikistan TJ Tanzania TZ Thailand TH Timor-Leste TL Togo TG Tokelau TK Tonga TO Trinidad and Tobago TT Tunisia TN

212 .CA Registry Guide for Registrars: Version 4.06 Appendix A Province Codes

Country Code Turkey TR Turkmenistan TM Turks and Caicos Islands TC Tuvalu TV Uganda UG Ukraine UA United Arab Emirates AE United Kingdom (Great Britain) GB United States US US Minor Outlying Islands UM Uruguay UY Uzbekistan UZ Vanuatu VU Vatican City State (Holy See) VA Venezuela VE Vietnam VN British Virgin Islands VG United States Virgin Islands VI Wallis and Futuna WF Western Sahara EH Yemen YE Zambia ZM Zimbabwe ZW

Province Codes Table 89 lists the Canadian provinces in alphabetical order and their corresponding codes.

Canadian Provinces Code Alberta AB British Columbia BC Manitoba MB New Brunswick NB

.CA Registry Guide for Registrars: Version 4.06 213 Appendix A State, Territories and Region Codes of the United States

Newfoundland and Labrador NL Northwest Territories NT Nova Scotia NS Nunavut NU Ontario ON Prince Edward Island PE Quebec QC Saskatchewan SK Yukon YK State, Territories and Region Codes of the United States Table 90 lists the states, territories, and regions of the United States in alphabetical order and their corresponding state codes.

US States, Territories, or Regions Code Armed Forces Americas (except Canada) AA Armed Forces Africa AE Armed Forces Canada Armed Forces Europe Armed Forces Middle East Alaska AK Alabama AL Armed Forces Pacific AP American Samoa AS Arizona AZ Arkansas AR California CA Colorado CO Connecticut CT Delaware DE District of Columbia DC Federated States of Micronesia FM Florida FL Georgia GA Guam GU

214 .CA Registry Guide for Registrars: Version 4.06 Appendix A State, Territories and Region Codes of the United States

US States, Territories, or Regions Code Hawaii HI Idaho ID Illinois IL Indiana IN Iowa IA Kansas KS Kentucky KY Louisiana LA Maine ME Marshall Islands MH Maryland MD Massachusetts MA Michigan MI Minnesota MN Mississippi MS Missouri MO Montana MT Nebraska NE Nevada NV New Hampshire NH New Jersey NJ New Mexico NM New York NY North Carolina NC North Dakota ND Northern Mariana Islands MP Ohio OH Oklahoma OK Oregon OR Palau PW Pennsylvania PA Puerto Rico PR Rhode Island RI

.CA Registry Guide for Registrars: Version 4.06 215 Appendix A State, Territories and Region Codes of the United States

US States, Territories, or Regions Code South Carolina SC South Dakota SD Tennessee TN Texas TX Utah UT Vermont VT Virgin Islands VI Virginia VA Washington WA West Virginia WV Wisconsin WI Wyoming WY

216 .CA Registry Guide for Registrars: Version 4.06 Appendix B

Appendix B Scope Appendix "B" shows a preview to the upcoming changes within .CA Manager and notes some of the changes to the documentation and to the .CA Manager.

Revised CPR Categories The CPR categories will change six months after migration from the existing “Presenting CPR Categories” on page 34, to the new Canadian Presence Requirements.

Caution CIRA has published the planned change now to provide additional lead time to our Registrars. To ensure a "level playing field" do not "show" the revised list until after May 2011. CPR changes that will occur after migration Table 102: Comparisons of current CPR categories to the new CPR categories Current Current System New Acronym New system - Valid for “CPR Acronym - CPR category and Type CPR category category or name “Other CPR” parameter in the new system CCT "Canadian CCR "Canadian citizen CCR is valid for citizen", / Permanent "CPR_category" Individual legal resident" (CCR) parameter type – Individual legal type in new system RES "Permanent CCR Subsumed into CCR is valid for " Resident", "Canadian CPR_category" Individual legal Citizen / parameter type. Permanent Resident" – Individual legal CCO "Corporation", CCO Non individual Valid for Non individual legal type in the "CPR_category" legal type current system parameter

.CA Registry Guide for Registrars: Version 4.06 217 Appendix B Revised CPR Categories

Table 102: Comparisons of current CPR categories to the new CPR categories Current Current System New Acronym New system - Valid for “CPR Acronym - CPR category and Type CPR category category or name “Other CPR” parameter in the new system New category New category ABI Individual Valid for Aboriginal "Other_CPR". Person – Must be Individual legal submitted with type "CPR _category" set to "Other" New category New category ABN "Aboriginal Valid for Persons (Non- "Other_CPR". individual)" Must be (ABN) – Non- submitted with individual legal "CPR _category" type set to "Other" ABO "Aboriginal ABN All records ABO - no longer Peoples" – classified as ABO a valid category Individual legal in the old system type will be re- classified as "ABI" or "Individual Aboriginal Person" New category New category TMI "Trade-mark Valid for registered in "Other_CPR". Canada for an Must be individual" submitted with "CPR _category" set to "Other" New category New category TMN "Trade-mark Valid for registered in "Other_CPR". Canada for a Must be Non-individual" submitted with "CPR _category" set to "Other" TMK "Trade-mark No longer a valid TMK - No longer registered in category a valid category Canada" – Non- individual legal type

218 .CA Registry Guide for Registrars: Version 4.06 Appendix B Revised CPR Categories

Table 102: Comparisons of current CPR categories to the new CPR categories Current Current System New Acronym New system - Valid for “CPR Acronym - CPR category and Type CPR category category or name “Other CPR” parameter in the new system MAJ "Her Majesty the No longer a valid Use GOV GOV is valid for Queen" – Non- category "Other_CPR". individual legal Must be type submitted with "CPR_category" set to "Other" GOV "Government" – GOV Non-individual Valid for Non-individual legal type "Other_CPR". legal type Must be submitted with "CPR_category" set to "Other" LGR "Legal LGR "Legal Valid for representative" representative" "Other_CPR". – Individual – Individual Must be legal type legal type submitted with "CPR_category" set to "Other" TRS "Trust" – Non- TRS "Trust" – Non- Valid for individual legal individual legal "Other_CPR". type type Must be submitted with "CPR_category" set to "Other" PRT "Partnership" – PRT "Partnership" – Valid for Non-individual Non-individual "Other_CPR". legal type Must be legal type submitted with "CPR_category" set to "Other" ASS "Association" – ASN "Association" Valid for Non-individual (ASN) – Non- "Other_CPR". legal type Must be individual legal submitted with type (NOTE: "CPR_category" change of acro- set to "Other" nym)

.CA Registry Guide for Registrars: Version 4.06 219 Appendix B Revised CPR Categories

Table 102: Comparisons of current CPR categories to the new CPR categories Current Current System New Acronym New system - Valid for “CPR Acronym - CPR category and Type CPR category category or name “Other CPR” parameter in the new system TRD "Trade union" – TRD "Trade union" – Valid for Non-individual Non-individual "Other_CPR". Must be legal type legal type submitted with "CPR_category" set to "Other" PLT "Political party"– PLT "Political party"– Valid for Non-individual Non-individual "Other_CPR". legal type legal type Must be submitted with "CPR_category" set to "Other" EDU "Educational EDU "Educational Valid for institution"– "Other_CPR". institution"– Non-individual Must be legal type Non-individual submitted with legal type "CPR_category" set to "Other"

LAM "Library, LAM "Library, Valid for Archive, or Archive, or "Other_CPR". Must be Museum" – Museum" – submitted with Non-individual Non-individual "CPR_category" legal type legal type set to "Other" HOP "Hospital" (HOP) HOP "Hospital" Valid for – Non-individual (HOP) – Non- "Other_CPR". legal type Must be individual legal submitted with type "CPR_category" set to "Other" INB "Indian band" – INB "Indian band" – Valid for Non-individual Non-individual "Other_CPR". legal type Must be legal type submitted with "CPR_category" set to "Other"

220 .CA Registry Guide for Registrars: Version 4.06 Appendix B Revised CPR Categories

Table 102: Comparisons of current CPR categories to the new CPR categories Current Current System New Acronym New system - Valid for “CPR Acronym - CPR category and Type CPR category category or name “Other CPR” parameter in the new system OMK "Official marks" OMK "Official marks" Valid for (OMK) – Non- (OMK) – Non- "Other_CPR". individual legal Must be type individual legal submitted with type "CPR_category" set to "Other"

Registrars are required to initially display the following CPR categories to Registrants: • Canadian citizen / Permanent resident • Corporation •Other If a Registrant selects "Other", Registrants will be offered other CPR categories to choose from. The following The following table lists the Registrant CPR categories and identifies which CPR categories are classified as individual and non-individual Registrants. Table 103: CPR Categories Acronym CPR category CPR categories specific to individuals ABI Individual Aboriginal Person. CCR Canadian citizen / Permanent resident LGR Legal representative. SPS Sole Proprietorship. TMI Trade-mark registered in Canada for an Individual CPR categories specific to non-individuals ABN Aboriginal peoples ASN Association CCO Corporation EDU Educational institution GOV Government HOP Hospital. INB Indian Band LAM Library, archive, or museum OMK Official marks

.CA Registry Guide for Registrars: Version 4.06 221 Appendix B Changes to the Contact Create Request

Table 103: CPR Categories Acronym CPR category PLT Political party PRT Partnership TMN Trade-mark registered in Canada for a Non-individual TRD Trade union TRS Trust

Note From a policy perspective the CPR category menu item “Sole Proprietorship” is not an actual new category in the CIRA CPR policy.

About “Sole Proprietorship” When a Registrant selects “Sole Proprietorship”, it is stored as the SPS CPR category in the system, but for legal proceedings, individuals with the SPS CPR category, are considered to be “Canadian citizen or Permanent resident” under CIRA’s policy. For this reason, sole proprietorship is not listed as a new category in the policy document. From a technical perspective, it is a new category; from a policy perspective, it is not a new category. CIRA has created this new menu item to help Registrants who want to self identify as a sole proprietorship do so more easily. For an explanation of each CPR category, see the CIRA Policies, Rules, and Procedures document, Canadian Presence Requirements for Registrants at the following URL: http://www.cira.ca/assets/Documents/Legal/Registrants/CPR.pdf

Presenting CPR Categories to Registrants CIRA encourages Registrars to offer the following Canadian Presence Requirements (CPR category) choices to Registrants: 3 Canadian citizen / Permanent Resident 4 Corporation 5 Sole Proprietorship 6 Other Registrars display the other CPR categories to Registrants, only if they select “Other”. Presenting the CPR categories in this manner causes less Registrant confusion. Most Registrants self-identify by choosing one of the first two CPR categories presented to them as above. The “Canadian sole proprietorship” category will assist Registrants who are registering domain names in their name, as individuals, but for business purposes. Changes to the Contact Create Request The Contact Check request queries whether a subsequent Contact Create request would succeed and some optional fields will change.

222 .CA Registry Guide for Registrars: Version 4.06 Appendix B Changes to the Contact Create Request

Note In the following table the changes that are being considered and will be introduced at a later release are marked in bold.

Table 104: Contact Create Request Fields showing ALL planned changes in BOLD

Name Type Usage Description Valid Values Contact ID Varchar2 (16) Mandatory The Registrar- supplied contact identifier Address Varchar2 (255) Mandatory The contact The only type type supported type is "loc", indicating that the address is in a localized form Name contact name of an individual or an organization Organization Varchar2 (55) Optional The name of the If the contact organization with name is an which the contact individual, is affiliated organization can be entered. Otherwise, it must be omitted. Street Varchar2 (255) Mandatory The street address There can be as many as three street addresses City Varchar2 (255) Mandatory The address city name State or Province Varchar2 (255) Mandatory The address See “Postal Codes” province on page 205 and “State, Territories and Region Codes of the United States” on page 214 Postal code Varchar2 (40) Mandatory The address See “Postal postal code Codes” on page 205

.CA Registry Guide for Registrars: Version 4.06 223 Appendix B Changes to the Contact Create Request

Name Type Usage Description Valid Values Country code Varchar2 (2) Mandatory The address See “Country country code Codes” on page 206 Phone Varchar2 (50) Optional The contact’s See “Telephone telephone and Fax number Numbers” on page 205 Fax Varchar2 (50) Optional The contact’s fax See “Telephone number and Fax Numbers” on page 205” Email Varchar2 (320 ) Mandatory The email Format is address [email protected] d Preferred Language Varchar2 (2) Mandatory The contact’s • English, enter preferred "en" language for • French, enter communication "fr" Originating IP Varchar2 (240) Optional The originating See “IP Address Registrant IP Addresses” on associated with the current request, in either IPv4 or IPv6 format CPR Category Varchar2 (20) Mandatory The category Must be one of describing the following Canadian CPR categories: Presence ² CCR ² CCO ²SPS ²Other See the "Understanding Canadian Presence Requirements (CPR) categories" section of this document

224 .CA Registry Guide for Registrars: Version 4.06 Appendix B Changes to the Contact Create Request

Name Type Usage Description Valid Values CPR Other Varchar2 (20) Mandatory - The category When the when the CPR describing selected Category is Canadian parameter for "Other" Presence CPR Other is TMI, TMN or OMK, the request must provide the official number of the trade- or official-mark When the selected parameter for CPR Other is LGR, the request must also provide the legal name and capacity of the official representative. For example, an official representative can be the legal representative

.CA Registry Guide for Registrars: Version 4.06 225 Appendix B Changes to the Contact Create Request

Name Type Usage Description Valid Values Agreement Fields: Varchar2 Optional The values The request (4) must contain Agreement Version associated with values for ALL three fields Agreement Contact Signed See the Agreement •Agreement “Presenting CPR Version The page 34section of CIRA’s this document Agreement Registrant Checksum Agreement agreed to by the contact • An indication whether the contact has agreed to CIRA’s Registrant Agreement • A checksum of the legal agreement Trade or Official Varchar2 Mandatory The official Mandatory Mark (255) number, trade- when the mark parameter for CPR Other is RMI, TMN, or OMK Legal Varchar2 Mandatory The legal name Mandatory Representative (255) and capacity of when the representative parameter for CPR Other is LGR Otherwise do not use

226 .CA Registry Guide for Registrars: Version 4.06 Appendix B Changes to the Contact Create Request

Name Type Usage Description Valid Values Created by Reseller Varchar2 (255) Optional The ID of the Reseller associated with the current request Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

Table 105: Contact Update Request Fields Name Type Usage Description Valid Values Contact ID Varchar2 (16) Mandatory The Registrar- supplied contact identifier Added and Optional The field values Removed Field that can be Values removed Status values Varchar2 (50) Optional Status of the When specifying contact object a value to be added or removed, only the attribute value is significant. The element text is not required to match a value for removal of a status. Changed Field Optional The set of field Values values that can be modified

.CA Registry Guide for Registrars: Version 4.06 227 Appendix B Changes to the Contact Create Request

Table 105: Contact Update Request Fields Name Type Usage Description Valid Values Name Varchar2 (255) Mandatory The name of the Must be a legal contact Canadian entity - see the Canadian Presence Requirements Organization Varchar2 (255) Optional The name of the submitted when organization to the CPR which the contact Category is affiliated indicates an individual Street Varchar2 (255) Mandatory The contact’s At least one street street address address field must have data City Varchar2 (255) Mandatory The city where the contact resides State or Province Varchar2 (255) Mandatory The contact’s See “Province state or provincial Codes” on code page 213 and “State, Territories and Region Codes of the United States” on page 214 Postal code Varchar2 (40) Mandatory The contact’s See “Postal postal code Codes” on page 205 Country code Varchar2 (2) Mandatory The contact’s See “Country country code Codes” on page 206 Phone number Varchar2 (50) Optional The contact’s See “Telephone phone number and Fax Numbers” on page 205

Fax number Varchar2 (50) Optional The contact’s fax See “Fax number Numbers”

228 .CA Registry Guide for Registrars: Version 4.06 Appendix B Changes to the Contact Create Request

Table 105: Contact Update Request Fields Name Type Usage Description Valid Values Email Varchar2 (320) Mandatory The contact’s Format is email address [email protected] d You cannot update the email address if it has been changed within the previous 60 days Preferred Varchar2 (2) Optional The preferred • English, enter language language in "en" which the contact • French, enter would like to "fr" correspond CPR Category Varchar2 (20) Mandatory The contact’s Must be one of CPR categories: See the "Understanding • CCR Canadian • CCO Presence •SPS Requirements (CPR) •Other categories" section of this document CPR Other The CPR When the is not available parameter for in CPR CPR Other is Category TMI, TMN or OMK, the When the request must selected provide the parameter for official number CPR Other is of the trade- or LGR, the official-mark request must also provide the For example, an legal name and official capacity of the representative official can be the legal representative. representative

.CA Registry Guide for Registrars: Version 4.06 229 Appendix B Changes to the Contact Create Request

Table 105: Contact Update Request Fields Name Type Usage Description Valid Values Trade or Official Varchar2 (2-255) Mandatory The official Mandatory Mark trade mark or when the the contact or parameter for organization CPR Other is TMI, TMN, or OMK

Legal The contact’s Mandatory Representative legal when the parameter for CPR Other is LGR WHOIS Privacy Optional The privacy An individual can determining what PRIVATE is displayed information during a WHOIS A non-individual search must display FULL information or, in limited situations, CIRA can approve the PRIVATE information setting See WHOIS Privacy Registrar Varchar2 (64) Optional A transaction Transaction ID identifier generated by the Registrar when submitting the request

230 .CA Registry Guide for Registrars: Version 4.06 Appendix C

Appendix C This appendix summaries CIRA’s plans to provide reporting capabilities for the new EPP-based CIRA Registry. About Reports The new Registry provides reports listing contacts, domains, and financial transactions. It does not provide reports equivalent to some existing activity reports, because EPP service messages provide this capability. However, a report does show the registry objects that are in a “pending” state awaiting Registrant agreement to the CIRA Registrant Agreement.

Requesting Reports CIRA will generate reports upon request

Scheduling Reports will be run weekly, on a "batch" basis

Report Delivery Reports will be available through a secure file transfer mechanism such as SFTP. Each Registrar will have a distinct directory in which their files are stored for pickups.

Report Retention Each report will be available for a 1 month period after creation.

Report Format Each report will be contained in a single file whose name clearly identifies the report and its creation date. Reports are tab-separated text format with UTF-8 character encoding: each report is compress in ZIP format.

Activity Summary The Activity Summary summarizes Registrar activity for a specified period. Registrars select the monthly period and click the Get Activity Summary button. The report opens in a new browser window. The reports lists a total count for each event that is reported for the reporting period. Financial totals for each event are also listed.

.CA Registry Guide for Registrars: Version 4.06 231 Appendix C Activity Summary

Table 106: Financial Transactions Report request fields

Event count Total amount Lists the event for the count. The total count each Lists the total amount for each Events are domain create, domain reported event reported event delete, domain renew, domain update, domain transfer, contact create, contact delete, contact update, host create, host delete and host update

Pending Contacts The Pending Contacts report contains a row for each transaction that has a pendingCreate status. You can generate a report that is filtered according to a number of different Contact ID profile statuses. A complete list of the Contact IDs that you manage is returned according to the Contact ID status.

Table 107: Pending Contact Statuses Report request fields

Column Name EPP Element Number of Domains id The Registrar-supplied contact identifier status An indicator describing the status of the contact

Financial Transactions The Financial Transactions report contains a row for every transaction that affects the Registrar account balance. Table 108: Financial Transactions Report request fields

Column name EPP Element Description Date / time when transaction occurred Transaction type (register domain; renew domain; transfer domain; delete domain; Registrar deposit; Registrar withdrawal) Domain name Registrant contact ID Amount (in Canadian dollars)

232 .CA Registry Guide for Registrars: Version 4.06 Appendix C Reconciliation Reports

Financial Summary You can download Financial Summary Reports from the previous month. The reports are available in a PDF format. The Financial Summary Report for the previous month is available on the 4th of each subsequent month. For more information refer to the .CA Manager online help. Reconciliation Reports Reconciliation reports satisfy two business objectives: In the near term, Reconciliation Reports help Registrars understand detailed results of the data migration from the existing registry to the new registry. In the longer term, Reconciliation Reports provides information that Registrars can use to reconcile their databases with the registry.

Registrars The Registrar report contains information about the Registrar that is requesting the report. Table 109: The Registrar report request fields

Column name EPP Element Description clID An identifier in the form used by domain and host sponsor identifiers. name Language The preferred language Account Balance

Contacts Lists all of the contacts that you manage. Table 110: The Contacts Report request fields

Column name EPP Element Description id The Registrar-supplied contact identifier name The name of the contact voice The contact’s telephone number fax The contact’s fax number email The email address language The contact’s preferred language for communication originating Ip The originating Registrant IP Address address associated with the current request, in either IPv4 or IPv6 format

.CA Registry Guide for Registrars: Version 4.06 233 Appendix C Reconciliation Reports

Column name EPP Element Description cpr Category The category describing Canadian Presence individual A “Y” or “N” value indicating whether the CPR Category represents an individual or non- individual legal type whoisDisplaySetting A “FULL” or “PRIVATE” value indicating whether to include complete or partial contact information in a WHOIS response Cira Agreement The version of CIRA’s Registrant Version Agreement that was agreed to by the contact agreement Value An indication whether the contact has agreed to CIRA’s Registrant Agreement (“Y” or “N”) Trade Or Official The official number, trademark, or Mark official mark Legal Representative The legal name and capacity of the official representative createdByResellerId The ID of the Registrar Reseller associated with the current request crID crDate upID upDate roid The system generated repository object identifier authInfo The authorization information associated with the contact

Addresses Table 111: The Addresses Report request fields

Column name EPP Element Description id The Registrar-supplied contact identifier street1 The contact’s street address

234 .CA Registry Guide for Registrars: Version 4.06 Appendix C Reconciliation Reports

Column name EPP Element Description street 2 The contact’s street address street 3 The contact’s street address city The name of the city where the contact resides sp The province in which the contact resides pc The contact’s postal code cc The contact’s two-character country code, as recognized by ISO

Contact Statuses The contact statuses Table 112: The Contact Statuses Report request fields

Column name EPP Element Description id The Registrar-supplied contact identifier. status

Domains Use the Domain names request to generate a report that lists all of the domain name registrations that you manage. You can generate a report that is filtered according a number of different domain name statuses.

Sorting the list of domain names The list of domain names report can be sorted by the following criteria: • Domain number (numerically ascending) • Domain name (alphabetically ascending) • Domain status (alphabetically ascending) • Renewal date (numerically ascending) • Contact name (alphabetically ascending) • Contact number (numerically ascending) • Contact Status (alphabetically ascending) • Number of domains (numerically ascending)

.CA Registry Guide for Registrars: Version 4.06 235 Appendix C Reconciliation Reports

Table 113: Domains Report request fields

Column name EPP Element Description name The name of the domain name The name of the domain domainStageOfLife within the domain name life cycle domainStageOfLifeEnd will exit the present life cycle stage clID The identifier of the sponsoring Registrar crDate upID upDate trDate roid The system generated repository object identifier authInfo The authorization information associated with the domain The report may be extended to include additional information to provide a WHOIS-like report: Registrant contact ID Registrant name Registrant street Registrant city Registrant state / province Registrant postal Registrant country Registrant phone Registrant fax Registrant email Administrative Contact contact ID Administrative Contact name Administrative Contact street Administrative Contact city Administrative Contact state / province Administrative Contact postal Administrative Contact country Administrative Contact phone

236 .CA Registry Guide for Registrars: Version 4.06 Appendix C Reconciliation Reports

Column name EPP Element Description Administrative Contact fax Administrative Contact email First Technical Contact contact ID First Technical Contact name First Technical Contact street First Technical Contact city First Technical Contact state / province First Technical Contact postal First Technical Contact phone First Technical Contact fax First Technical Contact email host 1 host 2 host 3 host 4

Domain Statuses You can generate a report that is filtered according to a number of different domain name statuses. Table 114: Domain Statuses Report request fields

Column name EPP Element Description name The name of the domain status An indicator describing the status of the domain

Domain Contacts You can generate a report that is filtered according to Domain Contacts Table 115: Domain Contacts Report request fields

Column name EPP Element Description name The name of the domain contact The identifier of a contact associated with the domain name relationship A “registrant”, “admin”, or “tech” value indicating the relationship between the domain and the contact

.CA Registry Guide for Registrars: Version 4.06 237 Appendix C Reconciliation Reports

Hosts You can generate a report that is filtered according to Hosts Table 116: Hosts Report request fields

Column name EPP Element Description name The fully qualified domain name of a host ipv4 An IPv4 address associated with the host ipv6 An IPv6 address associated with the host crID crDate upID upDate trDate roid The system generated repository object identifier authInfo The authorization information associated with the domain

Host Statuses Table 117: Host Status Report request fields

Column name EPP Element Description name The fully qualified domain name of a host status An indicator describing the status of the host

Domain Hosts Table 118: Domain Host Report request fields

Column name EPP Element Description name The name of the domain name The fully qualified domain name of a host seq

238 .CA Registry Guide for Registrars: Version 4.06 Symbols activation .CA 9 domain name 42 .CA Manager 65 active 30 minutes inactivity 65 domain name 23 generate reports 65 active domain name municipal name 31 agreement 23 self management 65 activity .CA Manager 65 Numerics 300 seconds 49, 52 1 to 15 contacts 75 5 minutes 49, 52 1 to 15 domains 136 connection 54 14 days 43 results 65 183 days 192 add 2 135 IPv4 122 2nd level IPv6 122 domain name 18 status value 69 3rd level add grace domain level 18 current life cycle 152 domain name 18 deleting registrations 40 4 segments 204 period 40 4th level stage of life 41 domain level 18 Add Grace Period 63 characters 204 5 days 22 add grace period 22 A 60 days 22 ABI 218 cannot transfer 22 ABN 218 pending delete stage 22 ABO 35 refund 22 invalid category 218 address 80 aboriginal 199 loc 100 aboriginal individuals 198 address information aboriginal peoples contact info 71 individual 35 address type aboriginal persons 199 contact 67 about 9 contact create 80 accented IPv6 205 characters 18 admin accept contact type 140 agreement 38 Administrative Contact 15 account administrative contact 17, 31, 79 Registrar 65 1 contact name 140 accreditation contacts 67 CIRA 31 one 34 complete 32 Registrant 17 failure 32 agree test 32 options 37 action is pending contact 67

.CA Registry Guide for Registrars: Version 4.06 239 agreement authorization information 204 Canadian Presence Requirements 17 domain create 157 providing CIRA with access 37 error 142 timestamp 72 authorization password 137, 204 version 72 authorized 204 Agreement Page authorized Registrar 204 CIRA 38 Auto Renew 23 agreement value auto renew 40 contact create 83 Auto Renew Grace 41 agreement version automatic renewal Registrar website 69 45 days 40 all auto-renew 40 information 138 available alphanumeric 204 contact check request 75 character 102 domain check 144 alphanumeric characters 43 life cycle stage 21 domain check 135 domain name 136 B alpha-numeric string 192 balance ampersand .CA Manager 65 special character 48 band 199 angle bracket 48 billing failure 154 anniversary date button re-accreditation 31 I agree 37 annual general meetings 15 approved C CA 205 class 135 Canada archive country codes 206 non individual 35 Canadian citizen 34, 191, 200 archive museum 197 individual 35 ASN Canadian city 135 valid other 219 Canadian educational institution 194 ASS 35 Canadian entity 193 associated Canadian Presence 81 contact 148 contact update 102 association Canadian Presence Requirements 17, 31, 34 non-individual 35 complete contact information 34 authInfo 40, 43, 137 CPR 31 domain object 137 Canadian Presence Requirements (CPR) 34 TBR 43 Canadian presence status 83 authorization 204 Canadian registration number 196 domain info 139, 141 Canadian resident 193 domain pw 139 captcha 37 value 138 case sensitive authorization error password 49 contact update 98

240 .CA Registry Guide for Registrars: Version 4.06 caution identifying administrative contacts 200 clID cc 71 Login request 49 CCO 35, 217 client CCR 217 contact update request 69 CCT 35 EPP 45 ceation date client authorization 139 domain object 136 Client ID Certificate of Corporate Status 31 Login request 49 change client id CIRA WHOIS 36 Registrant contact identifier 31 change Registrant clientDeleteProhibited 70 new 24 client-supplied 71 new Registrant 24 clientTransferProhibited 41 changed field values clientUpdateProhibited 70 contact chg 95 CLOB 55 changes clTRID 49, 50 Registrant Agreement 37 contact info 70 character contact update 97 hyphen 18 domain check 145, 146 length 102 domain create 153 characters 200 domain info 139, 141 63 18 host info 110 two 18 host update 126 check request 145 poll acknowledgement 62 CIRA poll response field 55 accreditation 31 club 194 agreement fields 94 college 193 completing accreditation 31 communicate Registrant Agreement 31, 83 test client system 32 CIRA Error Messages 110 complete information contact delete 92 requirements 34 contact update 97 complete official name entity 201 domain info 140 completion extValue 50 testing 33 cira individual compliant parameter 72 privacy settings 36 CIRA membership 42 confirm CIRA Registant Agreement Registrant 31 pending create 37 connection 52 CIRA Registrant Agreement 36, 82 close 65 display 36 establishing 46 updating 38 contact CIRA WHOIS 15 add 94 restricted 19 city 95 CIRA-configured IP addresses 45 CPR category 39 city crDate 72 contact create 80 create contact 148

.CA Registry Guide for Registrars: Version 4.06 241 crID 72 street 80 delete 94 contact create request fields 79 fax 96 contact delete modify 94 clTRID 92 name 80 request 93 name of contact 95 Transaction ID 92 phone number 96 contact delete request 91 postal address 96 contact delete response 93 properties 67 contact ID 91 province 96 contact delete 92 Registrar Transaction ID 76 does not exist 93 ROID 71 property 67 signed agreement 69 range 78 street 95 contact id 41 upDate 72 contact info 70 upID 72 contact identifier 37, 84 version 38 contact info 70 WHOIS 72 address 71 contact address field 85 address type 71 contact check 75 CIRA Error Messages 71 CIRA Error Messages 76 Contact ID 70, 71 clTRID 76 extValue 71 contact ID 76 Name 71 false 76 organization 71 invalid range 78 pendingCreate 70 Registrar Transaction ID 77 pendingDelete 70 Registry Transaction ID 77 response code 71 response 76 ROID 71 response code 76 Status 71 true 76 contact info request 70 contact check request 75 response and error codes 73 response and error codes 77 contact info response 70 contact check response and error codes 77 contact name 204 contact create domain info 140 agreement version 82 contact object 91, 95 cc 81 address type 67 CIRA Error Message 84 administrative contact 136 city 80 agreement fields 69 clTRID 84 authorization information 68 contact ID 80, 84 city 68 creation date 84 contact identifier 67 extValue 84 country code 68 Registrar Transaction ID 84 CPR Category 68 Registry policy violation 77 create 67 Registry Transaction ID 84 delete 67 request 84 domain object 136 response 84 email 68

242 .CA Registry Guide for Registrars: Version 4.06 en 68 Country code fax 68 contact create 81 fr 68 country code 71, 205 identifier 76 CPR individual 68 category 96 IPv4 69 missing category 89 IPv6 69 new 217 name 67 CPR categories organization 68 new 217 phone 68 CPR Category 72 postal code 68 contact create 81 preferred language 68 CPR category 35 properties 67 information 36 province 68 mandatory 34 Registrar Reseller ID 69 CPR data 38 state 68 create street 68 contact object 67 timing 69 domain 38 update 67 domain object 135 WHOIS 68 host 39 contact object update 94 Registrant contact 34 contact objects 17 create new hosts 39 technical contacts 136 created by Reseller contact org 80, 95 contact create 83 contact pending creation date 72 create status flag 83 domain info 140 Contact Sponsor ID host object 107 identifier 72 Creator ID 72 Contact Update creator ID privacy settings 36 domain info 140 contact update 94, 101 domain object 136 60 days 96 crest as official mark 201 clTRID 97 critical change 204 contact ID 95 current transfer 41 Registrar Transaction ID 97 current version WHOIS Privacy 97 new version 38 contact update request 94 Contact Update Response Codes 98 D contact update response fields 97 data collection policy contacts 17 CIRA 46 managing 67 date 46 zero to three 148 value 48 corporate documents 31 dcp element 46 Corporation 34 decline 38 corporation defined extensions non-individual 35 CIRA 47

.CA Registry Guide for Registrars: Version 4.06 243 degree 192 number 136 delay performing 148 reduce 36 provisioning 146 delegated host reason 146 domain host 140 request 144 domain info 140 response 146 delete 91 single request 136 add grace period 22 Domain Check request 39 client delete prohibited 70 domain check response fields 145 contact object 67 domain create 38, 148 domain object 135 administrative contact 151 registration 40 administrative contact field 156 delete a domain authorization information 151 status flags set 159 CIRA Error Message 153 delete a domain object 159 creation date 153 delete host object 130 expiry date 153 delimited 136 host field 155 de-queuing 61 Name 150, 153 designated characters 193 period 150 Display Registrant 148 CIRA Registrant Agreement 36 Registrant field 155 display Registrar Transaction ID 151, 153 CIRA prescribed manner 42 Registry Transaction ID 153 Registrant Agreement 37 response code 152 Registrant information 15 response codes 153 DNS 17, 39 technical contact 151 resolve 22, 23 Domain Create Registry Actions 152 document conventions 9 domain create request 152 documentation Domain Create Request Fields 150 related information 10 domain create response fields 152 domain domain delete clID 140 sponsoring Registrar 159 create in Registry 149 domain delete request fields 159 domain info 138 domain info 139 exDate 153 contact type 140 exist 135 domain name 140 exists 138, 148 domain namespace 139 host object 108 optional attribute 139 modify 135 Registrar Transaction ID 141 one administrative contact 136 request 138 pw 151 response code 139 status values 138 update date 140 domain ceate request domain info optional attribute pending create 21 all 139 domain check 136 sub 139 CIRA Error Messages 145 domain life cycle hyphens 135 pending create 40

244 .CA Registry Guide for Registrars: Version 4.06 status 20 elections 15 domain name 18, 31, 135 electoral law 197 available 135 element contact types 140 sub-element 48 domain check 145 elements 47 length 145 email 31, 34 mapping 10 contact create 81 object 135 contact email address 72 period of time 135 customer service email address 42 segments 18, 135 customer service telephone number 42 string 18 invalid format 87 supplied 146 notifications 41 transfer prohibited 41 Registrar name 42 use 135 Registrar URL 42 domain name field valid format and values 205 error 142 emails domain name life cycle 40 not sent 42 domain name life-cycle emergency next phase 40 technical support telephone 10 domain name segment 18 empty 61 domain name status 15 empty queue 54 Domain Name System 17, 39 en 81, 88, 96 domain object end of a segment 204 add relationships 39 end of present life cycle domain create 148 domain info 141 host 136 entity identifier 136 manage domain 17 modify 135 entity holding domain 201 properties 135 entity reference 48 stage of life end 137 environment transfer 135 provide 45 domain sponsor ID EPP 9, 10, 45 domain info 140 error 48 domain transfer 40, 41 server 46 domain update 137 EPP Accreditation Test domain-contact mandatory 32 object relationship 79 EPP connections domain-contact relationships 79 Registrars 45 domains 17 EPP process dot 205 monitoring 31 double quote EPP response special character 48 example 104 driver’s license 200 EPP test environment 45 error codes E domain info 141 EDU 35, 220 error messages 92 educational institution 194 host create 118 non-individual 35

.CA Registry Guide for Registrars: Version 4.06 245 example 112 expiry date client login 51 domain object 136 client logout 53 extend registration contact delete request 94 domain object 135 contact delete response 94 extended date-time form 48 contact info request 74 extensible mark-up language 47 contact update request 104 Extensible Provisioning Protocol 45 contact update response 104 Hollenbeck 10 domain check 147 extension Domain Check response 147 second level domain name 19 domain create request 157 Extension number 205 domain info request 142 external host 123 EPP contact check 78 extValue 92, 97 EPP contact create 89 CIRA Error Message 48 EPP contact info request 74 CIRA Error Messages 97, 145 EPP contact update 103 host create 118 EPP contact update request 103 EPP create contact response 89 F EPP host info request 112 failed login 14 EPP response to poll request 60 fax greeting response 47, 90 contact create 81 host check request 115 contact fax number 72 host check response 116 fees host create request 121 Registrar 31 host create response 121 first 60 days host delete request 132 transfer registration 41 host delete response 133 first nation 199 host update 129 format host update response 129 characters 205 host update unsuccessful response 130 domain 135 login response 52 email address 205 poll acknowledgement request 63 invalid reseller id 88 response successful domain create 158 IPv6 uses 128-bit 122 response to poll acknowledgement 63 postal code 205 response unsuccessful domain create 158 telephone number 205 unsuccessful host info request 112 format IPv4 exceed 32-bit identifier 205 10-year period 40 formats existing domain name 204 3rd level and 4th level domain names 18 formatting legal name 193 fourth-level domain name 19 four numbers exit 32-bit identifier 19 life cycle 141 fourth-level domain name 18 expiration date fr 81, 88, 96 domain info 140 free expiry membership 15 funds 23

246 .CA Registry Guide for Registrars: Version 4.06 FULL 97 domain create 150 full legal name 199 name server 19 funds 23 range 19 types 19 G host address get agreement 90 host info 110 GOV 35, 219 IPv4 107 government IPv6 107 non-individual 35 host check government agency 193 1 to 15 113 government entity 193 CIRA Error Messages 114 government format requirements 193 clTRID 113, 114 government-issued 200 error codes 114 Grace period 21 extValue 114 grace period 20 false 114 new domain 21 host name 114 registering a new domain 21 incorrect 115 transaction 20 Name 113 grace periods reason 114 deletion of a domain name 21 Registrar Transaction ID 113, 114 greater than Registry policy violation 115 special character 48 Registry Transaction ID 114 greeting 46 request 113 response 47 request fields 113 greeting response 46 response code 114 Gregorian calendar 48 response fields 113 groups 199 single request 113 characters 122 svTRID 114 consecutive 122 true 114 eight 205 host create 116, 118 attribute parameters 118 H CIRA Error Messages 118 hello 46 clTRID 119 request 46, 47 creation date 119 hello request 46 field values 118 Her Majesty 201 host address 117 Her Majesty the Queen host name 117, 118 non-individual 35 IP address 116 hexadecimal 19, 121, 122, 205 IPv4 configurations 122 hexadecimal reference 48 IPv6 118 Hollenbeck 10 IPv6 configurations 122 HOP 35, 220 Registrar Transaction ID 118, 119 hospital 195 Registry policy violation 119 non-individual 35 Registry Transaction ID 119 host 19, 136 request 39 creation date 110 request fields 116 creator ID 110 requesting Registrar 116 delegated 136

.CA Registry Guide for Registrars: Version 4.06 247 response code 118 host object properties 107 response codes and messages 119 host objects 107, 148 response elements 118 host request 39 superordinate 116 host status svTRID 119 clientDeleteProhibited 108 host create response 119 host status value host delete 130, 131 host object 108 CIRA Error Messages 131 host update clTRID 131 add 122 host name 130 change 122 Registrar Transaction ID 130, 131 change field 129 Registry Transaction ID 131 CIRA Error Messages 126 response and error codes 131 CIRA policy IPv6 128 response code 131 clientDeleteProhibited 128 host delete request 130 clientUpdateProhibited 128 host delete response codes clTRID 125 causes 131 delete 122 host delete response fields 130 host name 124 host info 110 host’s sponsor 127 extValue 110 incorrect values 128 Registrar Transaction ID 109, 110 invalid IPv4 format 128 Registry Transaction ID 110 IP addresses 124 response code 110 IPv4 122 sponsor ID 110 modify fields 125 Transfer Date 110 new attributes 123 update date 110 permission 128 updater ID 110 process order 122 host info request 108 Registrar Transaction ID 125, 126 response codes 111 Registry policy violation 127 host info response fields 110 Registry Transaction ID 126 host name 109 removing 122 changes 123 status flags 122 check list 111 status values 125 checking 113 host update request 122 host info 110 status values 108 host object 114 host update request fields 124 missing parameter 127 host update response 125 range 115 host update sponsor update 122 Registrar 123 host name field hosts 17 error response 111 associated 39 host object 108, 130 checking 113 clientUpdatedProhibited 108 required sponsor 149 creator id 107 serverUpdateProhibited 108

248 .CA Registry Guide for Registrars: Version 4.06 HTML 47 13 hyphen 135, 192 inuit 199 hyphen character 205 Invalid hyphens 135 organization format 86 segments 135 invalid agreement 88 I contact address 100 ICANN 13 contact ID 99 ID contact ID format 85 contact 17 contact signed agreement 88 unique 17 CPR value 88 id format 100 reseller 38 host name format 127 identifier 71 IPv6 address format 128 contact info 70 organization 100 municipal 19 province code 101 immigration and refugee protection act 192 Reseller ID 88 inactivity 65 street format 86 INB 35, 220 version 88 incorrect invalid city domain name check 147 format 101 Reseller ID 88 invalid city format 86 indian act, R.S.C. 1985, c. I-5 199 invalid contact ID indian band 199 format 93 non-individual 35 invalid country code 101 indian band name 199 invalid IP format 88 indigenous people 198 invalid number Individual 72 Domain Check 147 individual invalid range 147 CPR category 68 invalid street format privacy settings 36 contact update 100 Registrant 17, 34 invalid zip code 87 relationship 148 IP address 110 individuals 34, 46 contact object 69 WHOIS privacy setting 36 host 19 information IPv6 121 hosts 108 physical location 38 returned 138 providing 38 institution 198 IP addresses 205 insufficient funds 154 IPv4 39, 81, 107, 118, 121, 205 TBR 44 32-bit identifier 19 interchangeable 39 interface TBR 42 Internet Corporation for Assigned Names and Numbers

.CA Registry Guide for Registrars: Version 4.06 249 IPv4 address 205 Pending Create 21 IPv4 format 116 pending create 152 IPv6 39, 81, 121 Pending Delete 21 IPv6 address 205 limit request 196 IPv6 format 116 limited IPv6 notation 121 attempts 33 limited request 201 J list jurisdiction 196 TBR 40 jurisdictions in Canada 197 loc 80, 100 address tag 85 K localized address form 80 key information 15 localized postal addresses 85 L login LAM 35, 220 .CA Manager 65 language preference failed 49 CIRA 88 five unsuccessful attempts 49 Law enforcement 16 response and error codes 50 laws 191 login request 49 legal category 35, 191 login response 50 legal institution 198 Logout legal name 191 response and error codes 53 legal name format 191 logout request 52 legal representative logout response 52 individual 35 losing Registrar legal type 35 transfer 40 CPR category 35 individual 35 M MAJ 35 non individual 35 mandatory 109 legal type and using Her Majesty 201 Mapping legal type marks 201 Contact 10 legal type recognized by indian act 199 domain 10 legal type representation 200 EPP 10 legal type trade-mark 196 mapping legal type who represents 200 Host 10 length of term markup period field 155 XML delimiters 48 less than maximum special character 48 10 years 40 LGR 35 maximum daily 22 valid other 219 maximum length library segments 135 non-individual 35 meet requirements licensed hospital 195 agreement 37 life cycle 83 Membership 15 life cycle stage membership add grace 152 offer 42

250 .CA Registry Guide for Registrars: Version 4.06 message name requirements 200 delivery to Registrant 16 name server 121 ID 62 host 19 poll response 61 name servers 39 Message Count defining 107 message id 62 namespace message count domain 139 poll 55 namespaces message ID XML 47 poll acknowledgement 61 National Security agencies 16 message queue 61 new message retrieval 61 update agreement 38 messages new authInfo 43 retrieving 54 new domain name metis 199 segments 135 modification new holders update date 107 domain name 42 modify new host change contact 94 create 39 contact 67 new Registrant contact information 67 different 24 modify contact object 94 new version msg 48 agreement 37 multi-level domain names 39 nfp 191 municipal 193 no segment 135 add grace period 43 segment example 135 Nominate municipal domain candidates for board 15 request 21 Non-Individual 72 municipal domain name non-individual use .CA Manager 39 Registrant 34 municipal domain names Non-Individual Registrant registering 31 WHOIS 99 municipal prefixes 135 non-individual Registrant valid classes 135 privacy settings 36 municipality 135 non-individual Registrants 221 museum privacy settings 36 non individual 35 normal business hours 10 notation N dot-decimal 122 Name IPv6 19, 205 contact 67 note trade-mark format 196 contact create 80 not-for-profit 191 domain info 139 not-for-profit charities 191 host info 109 notice of changes 38 name number domain object 136 delegated hosts 150 mandatory 34

.CA Registry Guide for Registrars: Version 4.06 251 domain names to check 136 other legal type 201 host 136 owner of a trade-mark 196 numeric character 205 P special characters 48 parameter I agree 38 O parent object domain object 108 domain check 144 partnership 195 object status prohibits operation 93 non-individual 35 obligations passport 200 accreditation 31 Password official badge 201 pw 49 official complete name 193 password 65 official emblem 201 pay official group name 199 renew 40 official mark 201 pc 81 official marks 201 contact create 81 non-individual 35 Pending Create official name 194 DNS 38 OMK 35, 221 municipal domain name 22 one day period status flag 83 pending delete 70 pending create 40 operations 204 approve request 22 optional CIRA Registrant agreement 21 email address 34 deleting registrations 40 phone number 34 domain create 152 optional attribute resolve 22 domain info 139 stage 40 optional element pending delete authInfo 142 1 day 40 ordinarily resident 192 deleting registrations 40 org pending period organization for contact 95 transfer 40 organization 80 perform contact 68 test 32 field name 86 period 192 original registrant IP address 69 permanent resident 192, 200 originating individual 35 IP Address 88 Phone originating IP Address contact telephone number 71 contact create request 81 phone originating IP address 72 contact create 81 Other 34 CPR category 34

252 .CA Registry Guide for Registrars: Version 4.06 phone number 34 present CPR requirements 34 Phone or Fax number 205 present the agreement 90 PLT 35, 220 Presenting the CPR categories 222 plus 205 privacy 20, 36 policies policy 41 data collection 46 privacy protection Policy Accreditation Test 33 non individual 36 political party 197 privacy protection settings 36 non-individual 35 PRIVATE 97 poll acknowledge 54 private Poll Acknowledgement privacy settings 36 response 62 professional designation 199 poll acknowledgement 61 prohibit Registry Transaction ID 62 domain update 41 response and error 62 transfers 41 poll acknowledgement request protocol success 62 greeting 46 Poll command 54 hello 46 poll command 54 IPv6 107 poll error codes 56 version 46 poll message retrieval 55 protocol version 46 poll queue province 80 service messages 56 provincial poll queues 20 reserved domain name 39 Poll request 54 segment 135 poll request 56 provincial domain name 19 additional information 60 PRT 35 message queue empty 61 valid other 219 response 55 public 135 poll request fields 54 privacy settings 36 poll response 55, 56 punycode name 136 poll response codes 56 polling 54 Q postal address 34 queries contact info 71 contacts 67 postal code querying Registrar 204 invalid format 87 questions 32 Predefined XML queue 54 entity references 48 empty 63 preferred service message 54 language 49, 50, 92, 96, 114, 139 queue message preferred language 72 poll acknowledgement 62 contact create 81 queued supported 88 service message 20 R reason CIRA Error Messages 50

.CA Registry Guide for Registrars: Version 4.06 253 contact check 77 Registrant contact 34 recognized degree 192 Registrant CPR categories 221 redemption 40 Registrant Identification Verification 38 redemption grace registrant name format requirements 191 30 day 40 registrant name formatting 198 period 40 registrant requirements and aboriginals 198 refund 40 Registrant TBR 43 Redemption Grace Period registrant types 194 30 days 25 Registrants insufficient funds 23 individual 17 reduce error 36 presenting categories 34 reducing Registrar 204 Registrar financial balance 152 brand image 42 refund 40 sponsorship 20 TBR 43 Registrar Advisory 37 regional government 193 Registrar Agreement 31 registered Registrar Deposit Account 31 domain name 23 Registrar financial balance 152 Registered stage 23 Registrar Policy Accreditation 32 registered trade-mark trade-mark act 196 Registrar services 31 Registrant 31, 41 Registrar Transaction ID 49, 50, 73 agreed 39 clTRID 50, 53, 55, 70, 141 contact 17, 67 contact create 83 CPR 68 contact delete 92 domain create 151 domain check 145, 146 domain info 140 domain info 139 domain object 136 Registrar-Provided Contact ID 37 domain-contact relationship 79 Registrars entity 17 re-sellers 38 holder 136 Registrar-specific 45 non-individual 17 registration 196 update same 24 not available 18 Registrant Agreement 37, 90 renewing 40 awaiting 137 registration fee awaiting Registrant Agreement 137 refund 22 N 137 registration number 191 reserved 137 Registration Rules 31 wrong version 88 Registration Services Department 10 Registry 139 resources 54 registry IP addresses 205 personnel 137 policy violation 77, 89 structure 9 unique contact ID 75

254 .CA Registry Guide for Registrars: Version 4.06 Registry ID request fields host info 110 poll acknowledgement 61 object identifier 136 request syntax registry policies host objects 107 Domain Info 139 requesting Registrar 41 Registry policy violation 111 requirements contact update 98 accreditation 32 domain create 154 RES 35 syntax error 85, 93 resData element 48 Registry Transaction ID 98 Reseller contact delete 92 ID 69 contact info 73 re-seller 38 domain check 146 Reseller ID domain info 141 invalid 88 svTRID 50, 53, 73 reserved 39, 137 relationship domain name 19 domain create 148 exclusive use 19 relationships 148 municipal 135, 137 contacts and hosts 39 provincial 135 domain 148 reserved domain names 135 domain-contact relationships 79 reset remove status 20 status value 69 resolve remove message 54 DNS 38 removing domain name 39 IPv6 122 working 39 renew response 46 automatic 40 host check 114 renew registrations response code automatic renewal 40 contact create 84 renewed contact delete 92 fourth level domain 19 contact update 97 report generation domain check 145 .CA Manager 31 domain info 141 request host info 110 contact create 79 logout 53 contact info 70 poll response result 55 domain check 136, 144 response code result logout 52 poll acknowledgement 62 programmatically 38 response code result code = "xxxx" 50 service messages 54 Response codes transform 67 host update 126 request check response host info 112 number 75 restricted request failed domain name 19 domain check 147 existing top level 18

.CA Registry Guide for Registrars: Version 4.06 255 Result code 48 two 135 retrieve valid 2 character 135 service message 20 semicolon 48 returned send valid TBR request 43 response codes 56 server protocol 45 RFC serverDeleteProhibited 70, 108 4930 10 servers 4931 10 accessible 39 4932 10 serverTransferProhibited 41 4933 10 serverUpdateProhibited 70 RFC 2246 45 service messages 20, 54 RFC 4930 46, 49 delete 54 RFCs session 4930, 4931, 4932, 4933 45 end 49 rights 36 set RIV 38 four numbers 19 Registrant Identification Verification 38 status values 20 ROID SGML 47 domain info 140 shortcuts roles IPv6 122 administrative 69 single RSU administrative contact 148 confirm password 32 Registrant 148 Rules single quote General Registration 17 special character 48 rules single quotes 192 host create 39 Sole Proprietorship 222 sp 80 S special character 48, 205 scrollable 37 < 48 second-level domain name 18, 19 ampersand 48 sections dash 102 CIRA Registrant Agreement 37 left angle bracket 48 segment 135 semicolon 48 63 characters special characters 48, 192 204 sponsor 20, 79 domain name 136 host update 127 last 205 sponsor ID segment characters 204 domain object 136 segment length 135, 204 sponsoring Registrar 107 segments sponsoring Registrar 204 allowable numbers 135 sponsorship characters 135 subordinate hosts 40 end 135 stage examples 135 deleting registrations 40 four 135 end of present life cycle 141 length 135, 204 minimum length 135

256 .CA Registry Guide for Registrars: Version 4.06 stage of life synchronous 83, 90 cycles 137 domain info 141 T domain object 137 tag ends 137 addr 71 present 141 clID 72 values 137 clTRID 49, 50, 53, 55, 73 state domain crDate 153 contact create 80 domain name 153 status 136 lang 49 applying 159 org 71 domain info 140 roid 71 host info 110 svTRID 49, 50, 53, 73 status flags trID 49 host update error response 127 upID 72 status value TBR 14, 42 add 137 domain names 18 contact object 69 interface 43 domain object 137 participation 43 host object 108 was registered 137 remove 137 TBR session 40, 42, 43, 44 status values 20, 95 TDM 35 steps technical request domain name registration 38 contact 67 submit Technical Accreditation transfer request 40 execution 32 subordinate 108 technical contact 17, 79 subordinate host 0 to 3 contacts 140 domain info 140 domain create 157 successful transfer 41 domain-contact relationship 79 sufficient funds 41 zero 148 superordinate zero to three 148 host object 108 technical contacts superordinate domain 0 to 3 136 host create 116 optional three 34 support upt to three 17 accreditation 32 technical difficulty 33 svTRID 49, 141 technical EPP domain check 146 test 32 domain create 153 technicalcontact domain info 141 webmaster 17 host info 110 telephone number host update 126 an extension number 205 poll response 56 temporary lock out 14 symbols test 45 not accepted 18 environment 45 process 32

.CA Registry Guide for Registrars: Version 4.06 257 testing transfer client system 32 domain 40 text fourth level domain name 19 agreement 37 Registrar to Registrar 40 Text conventions 9 sponsorship 40 text field transfer date CIRA Registrant Agreement 37 domain info 140 third-level domain name 18 domain object 136 three roles 17 transfer registration time 46 60 day period 41 value 48 transfer request 40 time period transferring a domain name 21 Registry Advisory 37 transform requests timestamp 72 contacts 67 TLD domain 135 top level domain name 18 transport layer security 45 TLS 45 TRD 35, 220 TMI 218 trDate TMK transfer date 140 - not valid category 218 TRS 35, 219 TMN 218 true To Be Released domain check 146 see also TBR domain names truncated 48 redemption grace 25 trust 198 top-level non-individual 35 domain 18 trust examples 198 top-level domain 18 twelve months 192 trade union 196 two colons non-individual 35 IPv6 20 trade union example 197 two-character 71 trade union valid name 197 trade-mark of non Canadian 196 U trade-mark registered in Canada underscore non-individual 35 special character 102 trade-marks 201 understand agreement 37 trade-marks act 196 understanding legal type 35, 191 trade-marks act (Canada) 201 unincorporated 194 Transaction ID 49, 73 unique Registrar Transaction ID 55 128-bit identifier 19, 121, 205 transaction ID 32-bit identifier 121 contact create 84 attributes 47 domain info 141 hosts 107 transaction identifier 131, 141 name servers 39 contact create 84 Universal Coordinated Time domain info 139, 141 UTC 48 Registrar 76

258 .CA Registry Guide for Registrars: Version 4.06 university 193 view Update 107 other technical documentation 10 update date 72 domain object 136 W host object 107 waiting for a new Registrant update ID signing CIRA Agreement 21 domain info 140 weekly update request 137 service message retrieval 20 updater ID WHOIS 97 domain object 136 contact information 72 host object 107 display 72 updates display setting 99 agreement 37 full 72 updating non individual 97 host name 123 policy 46 use cases 32 privacy protection 36 user name 65 privacy settings 36 UTC 48 private 72 time 46 wipo 201 V X v4 118 XML 47 valid data 48 authorization information 204 namespaces 47 Canadian city 135 XML fields classes 135 domain info 139 domain name 204 format domain name 135 Z zero 148 formats 191 groups 122 valid and invalid examples 192 zero to three valid invalid political party 197 technical contacts 79 valid naming 193 zero value valid values IPv6 notation 20 Canadian Presence Requirements 35 zeros legal types 35 leading 205 value removing 19 CIRA Error Messages 50 zone file date-time 48 host update 123 reason 50 Registrant agreement 69 status value 136 values zero 205 version agreement 72 new and old 38 updating agreement 38

.CA Registry Guide for Registrars: Version 4.06 259 260 .CA Registry Guide for Registrars: Version 4.06

.CA Registry Guide for Registrars

Version: 4.06 Release: June 3, 2011

Copyright © 2011 Canadian Internat Registry Authority All rights reserved. Printed in Canada