opensrs xml domain guide

OpenSRS API Specification for XML

October 3, 2014

2

Table of Contents

INTRODUCTION ......................................................................... 17

RESPONSE MESSAGES .................................................................... 17

SUBMITTING API COMMANDS WITHOUT END-USER CREDENTIALS

.................................................................................................. 18

REQUIRED PARAMETER.................................................................... 18

POTENTIAL ISSUES ........................................................................ 19

NOT PERMITTED: APPLY_TO_ALL FLAG .............................................. 19

INCORRECT CREDENTIALS ............................................................ 19

CONTACT SET ............................................................................. 20

EXAMPLES FOR CONTACT SET ............................................................. 21

DOMAIN CONTACTS ....................................................................... 23

DEFAULT CONTACT REQUIREMENTS.................................................. 29

EPP CONTACT REQUIREMENTS ....................................................... 30

.BE OWNER AND TECH CONTACT REQUIREMENTS .................................. 31

.CA OWNER, ADMIN, AND TECH CONTACT REQUIREMENTS ....................... 31

.DE ADMIN CONTACT REQUIREMENTS ............................................... 33

.DE OWNER CONTACT REQUIREMENTS .............................................. 33

.DE ZONE AND TECH CONTACT REQUIREMENTS .................................... 34

.ES POSTAL CODES ................................................................... 35

.EU OWNER AND TECH CONTACT REQUIREMENTS .................................. 36

.IT CONTACT REQUIREMENTS ........................................................ 37

.MX CONTACT REQUIREMENTS ....................................................... 39

.PRO CONTACT REQUIREMENTS ..................................................... 40

.UK TRANSFER-NO CHANGE-ADMIN CONTACT REQUIREMENTS ................... 40

.UK CONTACT REQUIREMENTS ....................................................... 41

TLD DATA ................................................................................. 42

.AERO REGISTRANT_EXTRA_INFO .................................................. 42

.ASIA CED_INFO ..................................................................... 43

.AU AU_REGISTRANT_INFO .......................................................... 44

.CL REGISTRANT_EXTRA_INFO ...................................................... 48

.COM.AR, .PT, AND .COM.PT REGISTRANT_EXTRA_INFO ..................... 49

.COM.BR TLD_DATA ................................................................. 49

.COOP REGISTRANT_EXTRA_INFO ................................................. 50

.DE REGISTRANT_EXTRA_INFO ..................................................... 50

.DK REGISTRANT_EXTRA_INFO ..................................................... 51

3

.FI. MY, AND .SG REGISTRANT_EXTRA_INFO .................................... 51

.FR REGISTRANT_EXTRA_INFO ...................................................... 52

.HK REGISTRANT_EXTRA_INFO ..................................................... 54

.HU, AND .CO.HU REGISTRANT_EXTRA_INFO .................................... 54

.IT IT_REGISTRANT_INFO ............................................................ 55

.JOBS REGISTRANT_EXTRA_INFO .................................................. 57

.LV AND .COM.LV REGISTRANT_EXTRA_INFO .................................... 58

.MX, .COM.MX, AND .CO.ZA REGISTRANT_EXTRA_INFO ..................... 59

.NO REGISTRANT_EXTRA_INFO ..................................................... 59

.NYC REGISTRANT_EXTRA_INFO .................................................... 60

.PM, .RE, .TF, .WF, AND .YT REGISTRANT_EXTRA_INFO ...................... 60

.PRO PROFESSIONAL_DATA ......................................................... 62

.RO, AND .COM.RO REGISTRANT_EXTRA_INFO ................................. 62

.RU REGISTRANT_EXTRA_INFO ..................................................... 63

.SE AND .NU REGISTRANT_EXTRA_INFO .......................................... 65

.TRAVEL REGISTRANT_EXTRA_INFO ............................................... 66

.US NEXUS ............................................................................. 66

.XXX IPR_DATA ....................................................................... 67

LOOKUP COMMANDS .................................................................. 69

BELONGS_TO_RSP ........................................................................ 70

REQUEST PARAMETERS FOR BELONGS_TO_RSP .................................... 70

RESPONSE PARAMETERS FOR BELONGS_TO_RSP .................................. 70

EXAMPLES FOR BELONGS_TO_RSP .................................................. 71

CIRA_EMAIL_PWD ......................................................................... 74

REQUEST PARAMETERS FOR CIRA_EMAIL_PWD .................................... 74

RESPONSE PARAMETERS FOR CIRA_EMAIL_PWD ................................... 74

EXAMPLES FOR CIRA_EMAIL_PWD ................................................... 75

GET_BALANCE ............................................................................. 77

REQUEST PARAMETERS FOR GET_BALANCE ......................................... 77

RESPONSE PARAMETERS FOR GET_BALANCE ....................................... 77

EXAMPLES FOR GET_BALANCE ....................................................... 78

GET_CA_BLOCKER_LIST .................................................................. 80

REQUEST PARAMETERS FOR GET_CA_BLOCKER_LIST ............................. 80

RESPONSE PARAMETERS FOR GET_CA_BLOCKER_LIST ............................ 81

EXAMPLES FOR GET_CA_BLOCKER_LIST ............................................ 82

GET_CERT .................................................................................. 84

REQUEST PARAMETERS FOR GET_CERT ............................................. 84

RESPONSE PARAMETERS FOR GET_CERT ............................................ 85

4

EXAMPLES FOR GET_CERT ............................................................ 87

GET_CONTRACT ......................................................................... 100

REQUEST PARAMETERS FOR GET_CONTRACT ..................................... 100

RESPONSE PARAMETERS FOR GET_CONTRACT ................................... 100

EXAMPLES FOR GET_CONTRACT ................................................... 101

GET_DELETED_DOMAINS ............................................................... 103

REQUEST PARAMETERS FOR GET_DELETED_DOMAINS .......................... 103

RESPONSE PARAMETERS FOR GET_DELETED_DOMAINS ......................... 105

EXAMPLES FOR GET_DELETED_DOMAINS ......................................... 106

GET (DOMAIN) ........................................................................... 109

REQUEST PARAMETERS FOR GET (DOMAIN) ...................................... 109

RESPONSE PARAMETERS FOR GET (DOMAIN) ..................................... 112

GET DOMAIN EXAMPLES ............................................................. 123

FOR TYPE = ADMIN OR TECH ........................................................... 123

FOR TYPE = ALL_INFO .................................................................. 130

FOR TYPE = CA_WHOIS_DISPLAY_SETTING ......................................... 143

FOR TYPE = DOMAIN_AUTH_INFO .................................................... 145

FOR TYPE = EXPIRE_ACTION ........................................................... 147

FOR TYPE = FORWARDING_EMAIL ..................................................... 150

FOR TYPE = LIST ......................................................................... 152

FOR TYPE = NAMESERVERS ............................................................ 155

FOR TYPE = OWNER, ADMIN, BILLING, OR TECH .................................... 157

FOR TYPE = RSP_WHOIS_INFO ........................................................ 159

FOR TYPE = STATUS ..................................................................... 163

FOR TYPE = TLD_DATA ................................................................. 166

FOR TYPE = WAITING HISTORY ........................................................ 177

FOR TYPE = WHOIS_PRIVACY_STATE ................................................. 179

FOR TYPE = XPACK_WAITING_HISTORY.............................................. 181

GET_DOMAIN_AFFILIATE_ID ........................................................... 184

REQUEST PARAMETERS FOR GET_DOMAIN_AFFILIATE_ID ...................... 184

RESPONSE PARAMETERS FOR GET_DOMAIN_AFFILIATE_ID ..................... 184

EXAMPLES FOR GET_DOMAIN_AFFILIATE_ID ..................................... 185

GET_DOMAINS_CONTACTS ............................................................. 187

REQUEST PARAMETERS FOR GET_DOMAINS_CONTACTS ........................ 187

RESPONSE PARAMETERS FOR GET_DOMAINS_CONTACTS ....................... 187

EXAMPLES FOR GET_DOMAINS_CONTACTS ....................................... 188

GET_DOMAINS_BY_EXPIREDATE ...................................................... 191

REQUEST PARAMETERS FOR GET_DOMAINS_BY_EXPIREDATE .................. 191

RESPONSE PARAMETERS FOR GET_DOMAINS_BY_EXPIREDATE ................ 192

EXAMPLES FOR GET_DOMAINS_BY_EXPIREDATE ................................ 193

5

GET_NOTES .............................................................................. 196

REQUEST PARAMETERS FOR GET_NOTES .......................................... 196

RESPONSE PARAMETERS FOR GET_NOTES ........................................ 197

EXAMPLES FOR GET_NOTES ........................................................ 197

GET_ORDER_INFO ...................................................................... 200

REQUEST PARAMETERS FOR GET_ORDER_INFO .................................. 200

RESPONSE PARAMETERS FOR GET_ORDER_INFO ................................ 200

EXAMPLES FOR GET_ORDER_INFO ................................................ 210

GET_ORDERS_BY_DOMAIN ............................................................ 238

REQUEST PARAMETERS FOR GET_ORDERS_BY_DOMAIN ........................ 238

RESPONSE PARAMETERS FOR GET_ORDERS_BY_DOMAIN ....................... 239

EXAMPLES FOR GET_ORDERS_BY_DOMAIN....................................... 240

GET_PRICE ............................................................................... 243

REQUEST PARAMETERS FOR GET_PRICE .......................................... 243

RESPONSE PARAMETERS FOR GET_PRICE ......................................... 244

EXAMPLES FOR GET_PRICE ......................................................... 244

GET_PRODUCT_INFO.................................................................... 246

REQUEST PARAMETERS FOR GET_PRODUCT_INFO ............................... 246

RESPONSE PARAMETERS FOR GET_PRODUCT_INFO.............................. 247

EXAMPLES FOR GET_PRODUCT_INFO .............................................. 249

GET_PRODUCTS ......................................................................... 262

REQUEST PARAMETERS FOR GET_PRODUCTS ..................................... 262

RESPONSE PARAMETERS FOR GET_PRODUCTS ................................... 263

EXAMPLES FOR GET_PRODUCTS ................................................... 265

GET_REGISTRANT_VERIFICATION_STATUS .......................................... 268

REQUEST PARAMETERS FOR GET_REGISTRANT_VERIFICATION_STATUS ...... 268

RESPONSE PARAMETERS FOR GET_REGISTRANT_VERIFICATION_STATUS..... 268

EXAMPLES FOR GET_REGISTRANT_VERIFICATION_STATUS ..................... 270

LOOKUP (DOMAIN) ...................................................................... 272

REQUEST PARAMETERS FOR LOOKUP (DOMAIN) .................................. 272

RESPONSE PARAMETERS FOR LOOKUP (DOMAIN) ................................ 273

EXAMPLES FOR LOOKUP (DOMAIN) ................................................ 274

NAME_SUGGEST (DOMAIN) ............................................................. 279

REQUEST PARAMETERS FOR NAME_SUGGEST (DOMAIN) ........................ 279

RESPONSE PARAMETERS FOR NAME_SUGGEST (DOMAIN) ...................... 284

EXAMPLES FOR NAME_SUGGEST (DOMAIN) ...................................... 287

UK_GET_BLOCKER_CONTACT .......................................................... 334

REQUEST PARAMETERS FOR UK_GET_BLOCKER_CONTACT ..................... 334

RESPONSE PARAMETERS FOR UK_GET_BLOCKER_CONTACT .................... 334

6

EXAMPLES FOR UK_GET_BLOCKER_CONTACT .................................... 335

PROVISIONING COMMANDS .................................................... 340

ACTIVATE (DOMAIN) .................................................................... 341

REQUEST PARAMETERS FOR ACTIVATE (DOMAIN) ................................ 341

RESPONSE PARAMETERS FOR ACTIVATE (DOMAIN) .............................. 341

EXAMPLES FOR ACTIVATE (DOMAIN) .............................................. 342

CANCEL_ACTIVE_PROCESS (.CA ORDER) ............................................ 344

REQUEST PARAMETERS FOR CANCEL_ACTIVE_PROCESS ........................ 344

RESPONSE PARAMETERS FOR CANCEL_ACTIVE_PROCESS ....................... 345

EXAMPLES FOR CANCEL_ACTIVE_PROCESS ....................................... 345

CANCEL_FREE_TRIAL ................................................................... 347

REQUEST PARAMETERS FOR CANCEL_FREE_TRIAL ............................... 347

RESPONSE PARAMETERS FOR CANCEL_FREE_TRIAL ............................. 348

EXAMPLES FOR CANCEL_FREE_TRIAL ............................................. 349

CANCEL_ORDER ......................................................................... 351

REQUEST PARAMETERS FOR CANCEL_ORDER ..................................... 351

RESPONSE PARAMETERS FOR CANCEL_ORDER ................................... 351

EXAMPLES FOR CANCEL_ORDER ................................................... 352

CANCEL_PENDING_ORDERS ............................................................ 355

REQUEST PARAMETERS FOR CANCEL_PENDING_ORDERS ....................... 355

RESPONSE PARAMETERS FOR CANCEL_PENDING_ORDERS ...................... 355

EXAMPLES FOR CANCEL_PENDING_ORDERS ...................................... 356

CREATE_TOKEN .......................................................................... 360

REQUEST PARAMETERS FOR CREATE_TOKEN ..................................... 360

RESPONSE PARAMETERS FOR CREATE_TOKEN .................................... 361

EXAMPLES FOR CREATE_TOKEN .................................................... 361

MODIFY (DOMAIN)....................................................................... 363

REQUEST PARAMETERS FOR MODIFY (DOMAIN) .................................. 363

FOR DATA = CA_WHOIS_DISPLAY_SETTING ........................................ 368

FOR DATA = CHANGE_IPS_TAG ....................................................... 369

FOR DATA = CIRA_REGISTRANT ....................................................... 370

FOR DATA = CONTACT_INFO........................................................... 373

FOR DATA = DOMAIN_AUTH_INFO .................................................... 375

FOR DATA = EXPIRE_ACTION .......................................................... 375

FOR DATA = FORWARDING_EMAIL .................................................... 376

FOR DATA = IT_WHOIS_DISPLAY_SETTING ......................................... 376

FOR DATA = PARKPAGE_STATE ........................................................ 377

FOR DATA = RSP_WHOIS_INFO ....................................................... 377

FOR DATA = STATUS .................................................................... 378

7

FOR DATA = UK_WHOIS_OPT ......................................................... 379

FOR DATA = WHOIS_PRIVACY_STATE ................................................ 380

RESPONSE PARAMETERS FOR MODIFY (DOMAIN) ................................ 381

MODIFY (DOMAIN) EXAMPLES ..................................................... 382

FOR DATA = CA_WHOIS_DISPLAY_SETTING ........................................ 382

FOR DATA = CHANGE_IPS_TAG ....................................................... 384

FOR DATA = CIRA_REGISTRANT ....................................................... 386

FOR DATA = CONTACT_INFO........................................................... 388

FOR DATA = DOMAIN_AUTH_INFO .................................................... 397

FOR DATA = EXPIRE_ACTION .......................................................... 399

FOR DATA = FORWARDING_EMAIL .................................................... 401

FOR DATA = IT_WHOIS_DISPLAY_SETTING ......................................... 403

FOR DATA = PARKPAGE_STATE ........................................................ 404

FOR DATA = RSP_WHOIS_INFO ....................................................... 405

FOR DATA = STATUS .................................................................... 407

FOR DATA = UK_WHOIS_OPT ......................................................... 410

FOR DATA = WHOIS_PRIVACY_STATE ................................................ 412

FOR TLD_DATA = CED_INFO (.ASIA) ............................................... 415

FOR TLD_DATA = IPR_DATA (.XXX) ................................................. 420

FOR TLD_DATA = IT_REGISTRANT_INFO (.IT) ..................................... 421

FOR TLD_DATA = NEXUS (.US) ....................................................... 424

FOR TLD_DATA =PROFESSIONAL_DATA (.PRO) .................................... 428

FOR TLD_DATA = REGISTRANT_EXTRA_INFO (.COOP) ........................... 431

FOR TLD_DATA = REGISTRANT_EXTRA_INFO (.JOBS) ........................... 433

FOR TLD_DATA = REGISTRANT_EXTRA_INFO (.RU) ............................... 435

PARSE CSR ............................................................................... 437

REQUEST PARAMETERS FOR PARSE_CSR .......................................... 437

RESPONSE PARAMETERS FOR PARSE_CSR ........................................ 438

EXAMPLES FOR PARSE_CSR ........................................................ 439

PROCESS_PENDING ..................................................................... 442

REQUEST PARAMETERS FOR PROCESS_PENDING ................................. 442

RESPONSE PARAMETERS FOR PROCESS_PENDING ............................... 443

EXAMPLES FOR PROCESS_PENDING DOMAIN ..................................... 444

EXAMPLES FOR PROCESS_PENDING TRUST_SERVICE ............................ 447

QUERY_APPROVER_LIST ................................................................ 449

REQUEST PARAMETERS FOR QUERY_APPROVER_LIST ........................... 449

RESPONSE PARAMETERS FOR QUERY_APPROVER_LIST .......................... 450

EXAMPLES FOR QUERY_APPROVER_LIST .......................................... 451

QUERY_QUEUED_REQUEST ............................................................. 455

REQUEST PARAMETERS FOR QUERY_QUEUED_REQUEST ........................ 455

RESPONSE PARAMETERS FOR QUERY_QUEUED_REQUEST ....................... 455

8

EXAMPLES FOR QUERY_QUEUED_REQUEST ....................................... 456

REDEEM (DOMAIN) ...................................................................... 458

REQUEST PARAMETERS FOR REDEEM DOMAIN .................................... 458

RESPONSE PARAMETERS FOR REDEEM DOMAIN .................................. 458

EXAMPLES FOR REDEEM DOMAIN .................................................. 459

RENEW (DOMAIN) ....................................................................... 461

REQUEST PARAMETERS FOR RENEW (DOMAIN) ................................... 461

RESPONSE PARAMETERS FOR RENEW (DOMAIN) ................................. 462

EXAMPLES FOR RENEW (DOMAIN) ................................................. 464

REQUEST_ON_DEMAND_SCAN ......................................................... 466

REQUEST PARAMETERS FOR REQUEST_ON_DEMAND_SCAN .................... 466

RESPONSE PARAMETERS FOR REQUEST_ON_DEMAND_SCAN ................... 466

EXAMPLES FOR REQUEST_ON_DEMAND_SCAN ................................... 467

RESEND_APPROVE_EMAIL .............................................................. 471

REQUEST PARAMETERS FOR RESEND_APPROVE_EMAIL ......................... 471

RESPONSE PARAMETERS FOR RESEND_APPROVE_EMAIL ........................ 471

EXAMPLES FOR RESEND_APPROVE_EMAIL ........................................ 472

RESEND_CERT_EMAIL .................................................................. 474

REQUEST PARAMETERS FOR RESEND_CERT_EMAIL .............................. 474

RESPONSE PARAMETERS FOR RESEND_CERT_EMAIL ............................ 474

EXAMPLES FOR RESEND_CERT_EMAIL ............................................ 475

REVOKE (DOMAIN) ...................................................................... 477

REQUEST PARAMETERS FOR REVOKE (DOMAIN) .................................. 477

RESPONSE PARAMETERS FOR REVOKE (DOMAIN) ................................ 478

EXAMPLES FOR REVOKE (DOMAIN) ................................................ 478

SEND_CIRA_APPROVAL_EMAIL ....................................................... 481

REQUEST PARAMETERS FOR SEND_CIRA_APPROVAL_EMAIL .................. 481

RESPONSE PARAMETERS FOR SEND_CIRA_APPROVAL_EMAIL ................. 482

EXAMPLES FOR SEND_CIRA_APPROVAL_EMAIL ................................. 482

SEND_REGISTRANT_VERIFICATION_EMAIL ........................................... 484

REQUEST PARAMETERS FOR SEND_REGISTRANT_VERIFICATION_EMAIL ...... 484

RESPONSE PARAMETERS FOR SEND_REGISTRANT_VERIFICATION_EMAIL ..... 484

EXAMPLES FOR SEND_REGISTRANT_VERIFICATION_EMAIL ..................... 485

SET_DOMAIN_AFFILIATE_ID ........................................................... 487

REQUEST PARAMETERS FOR SET_DOMAIN_AFFILIATE_ID ....................... 487

RESPONSE PARAMETERS FOR SET_DOMAIN_AFFILIATE_ID ..................... 487

EXAMPLES FOR SET_DOMAIN_AFFILIATE_ID ..................................... 488

SW_REGISTER (DOMAIN OR TRUST_SERVICE) ....................................... 490

REQUEST PARAMETERS FOR SW_REGISTER (DOMAIN OR TRUST_SERVICE) .. 490

9

NAMESERVER PAIR ....................................................................... 498

.BE REGISTRATIONS AND TRANSFERS ................................................ 499

.CA REGISTRATIONS .................................................................... 500

.EU REGISTRATIONS AND TRANSFERS ................................................ 502

.IT TRANSFERS ........................................................................... 504

.MOBI REGISTRATIONS ................................................................ 504

.NAME REGISTRATIONS ................................................................ 505

RESPONSE PARAMETERS FOR SW_REGISTER (DOMAIN OR TRUST_SERVICE) . 506

DOMAIN REGISTRATION EXAMPLES ................................................ 509

FOR DOMAIN = .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, AND .MOBI

............................................................................................. 509

FOR DOMAIN = .AERO ................................................................. 517

FOR DOMAIN = .ASIA .................................................................. 520

FOR DOMAIN = .AU ..................................................................... 524

FOR DOMAIN = .CA ..................................................................... 527

FOR DOMAIN = .DE ..................................................................... 532

FOR DOMAIN = .DK .................................................................... 536

FOR DOMAIN = .EU ..................................................................... 539

FOR DOMAIN = .FR ..................................................................... 541

FOR DOMAIN = .HU .................................................................... 544

FOR DOMAIN = .INFO .................................................................. 549

FOR DOMAIN = .IT ...................................................................... 552

FOR DOMAIN = .JOBS .................................................................. 561

FOR DOMAIN = .NAME ................................................................. 565

FOR DOMAIN = .PM, .RE, .TF, .WF, OR .YT ...................................... 568

FOR DOMAIN = .PRO ................................................................... 572

FOR DOMAIN = .SCOT ................................................................. 575

FOR DOMAIN = .US ..................................................................... 581

FOR DOMAIN = .XXX ................................................................... 584

FOR DOMAIN = NEW GTLD DURING SUNRISE PERIOD ............................. 590

FOR DOMAIN = NEW GTLD DURING CLAIMS PERIOD ............................... 598

DOMAIN TRANSFER EXAMPLES..................................................... 601

FOR DOMAIN = .AU ..................................................................... 604

FOR DOMAIN = .CA ..................................................................... 607

FOR DOMAIN = .DE ..................................................................... 609

FOR DOMAIN = .EU OR .BE ........................................................... 612

FOR DOMAIN = .IT ...................................................................... 615

EXAMPLES FOR WHOIS PRIVACY ..................................................... 619

UPDATE_ALL_INFO ...................................................................... 621

REQUEST PARAMETERS FOR UPDATE_ALL_INFO ................................. 621

RESPONSE PARAMETERS FOR UPDATE_ALL_INFO ................................ 622

EXAMPLES FOR UPDATE_ALL_INFO ................................................ 622

10

UPDATE_CONTACTS ..................................................................... 625

REQUEST PARAMETERS FOR UPDATE_CONTACTS ................................. 625

RESPONSE PARAMETERS FOR UPDATE_CONTACTS ............................... 626

EXAMPLES FOR UPDATE_CONTACTS ............................................... 627

UPDATE_ORDER ......................................................................... 630

REQUEST PARAMETERS FOR UPDATE_ORDER ..................................... 630

RESPONSE PARAMETERS FOR UPDATE_ORDER ................................... 637

EXAMPLES FOR UPDATE_ORDER ................................................... 638

UPDATE_PRODUCT ...................................................................... 645

REQUEST PARAMETERS FOR UPDATE_PRODUCT .................................. 645

RESPONSE PARAMETERS FOR UPDATE_PRODUCT ................................ 646

EXAMPLES FOR UPDATE_PRODUCT ................................................ 647

SUB-RESELLER COMMANDS ..................................................... 650

ACTING ON BEHALF OF SUB-RESELLERS .............................................. 651

EXAMPLE ............................................................................. 651

CREATE SUBRESELLER ................................................................... 654

REQUEST PARAMETERS FOR CREATE SUBRESELLER .............................. 654

RESPONSE PARAMETERS FOR CREATE SUBRESELLER ............................. 655

EXAMPLES FOR CREATE SUBRESELLER ............................................. 656

MODIFY SUBRESELLER ................................................................... 659

REQUEST PARAMETERS FOR MODIFY SUBRESELLER .............................. 659

RESPONSE PARAMETERS FOR MODIFY SUBRESELLER ............................ 660

EXAMPLES FOR MODIFY SUBRESELLER ............................................. 661

GET SUBRESELLER ....................................................................... 664

REQUEST PARAMETERS FOR GET SUBRESELLER .................................. 664

RESPONSE PARAMETERS FOR GET SUBRESELLER ................................. 664

EXAMPLES FOR GET SUBRESELLER ................................................. 666

PAY SUBRESELLER ....................................................................... 671

REQUEST PARAMETERS FOR PAY SUBRESELLER ................................... 671

RESPONSE PARAMETERS FOR PAY SUBRESELLER ................................. 671

EXAMPLES FOR PAY SUBRESELLER ................................................. 672

TRANSFER COMMANDS ............................................................ 674

CANCEL_TRANSFER...................................................................... 675

REQUEST PARAMETERS FOR CANCEL_TRANSFER ................................. 675

RESPONSE PARAMETERS FOR CANCEL_TRANSFER................................ 675

EXAMPLES FOR CANCEL_TRANSFER ................................................ 676

CHECK_TRANSFER ....................................................................... 678

REQUEST PARAMETERS FOR CHECK_TRANSFER .................................. 678

11

RESPONSE PARAMETERS FOR CHECK_TRANSFER ................................. 679

EXAMPLES FOR CHECK_TRANSFER ................................................. 681

GET_TRANSFERS_AWAY ................................................................ 685

REQUEST PARAMETERS FOR GET_TRANSFERS_AWAY ............................ 685

RESPONSE PARAMETERS FOR GET_TRANSFERS_AWAY .......................... 687

EXAMPLES FOR GET_TRANSFERS_AWAY .......................................... 689

GET_TRANSFERS_IN .................................................................... 692

REQUEST PARAMETERS FOR GET_TRANSFERS_IN ................................ 692

RESPONSE PARAMETERS FOR GET_TRANSFERS_IN .............................. 694

EXAMPLES FOR GET_TRANSFERS_IN .............................................. 697

PROCESS_TRANSFER .................................................................... 700

REQUEST PARAMETERS FOR PROCESS_TRANSFER ............................... 700

RESPONSE PARAMETERS FOR PROCESS_TRANSFER .............................. 700

EXAMPLES FOR PROCESS_TRANSFER .............................................. 701

RSP2RSP_PUSH_TRANSFER ............................................................ 703

REQUEST PARAMETERS FOR RSP2RSP_PUSH_TRANSFER........................ 703

RESPONSE PARAMETERS FOR RSP2RSP_PUSH_TRANSFER ...................... 704

EXAMPLES FOR RSP2RSP_PUSH_TRANSFER ...................................... 704

SEND_PASSWORD (TRANSFER) ........................................................ 707

REQUEST PARAMETERS FOR SEND_PASSWORD (TRANSFER) ................... 707

RESPONSE PARAMETERS FOR SEND_PASSWORD (TRANSFER) .................. 707

EXAMPLES FOR SEND_PASSWORD (TRANSFER) .................................. 708

TRADE_DOMAIN ......................................................................... 710

REQUEST PARAMETERS FOR TRADE_DOMAIN ..................................... 710

RESPONSE PARAMETERS FOR TRADE_DOMAIN ................................... 711

EXAMPLES FOR TRADE_DOMAIN ................................................... 712

BULK CHANGES COMMANDS..................................................... 720

BULK_TRANSFER......................................................................... 721

REQUEST PARAMETERS FOR BULK_TRANSFER (DOMAINS) ...................... 721

RESPONSE PARAMETERS FOR BULK_TRANSFER (DOMAINS) .................... 722

EXAMPLES FOR BULK_TRANSFER (DOMAINS) .................................... 723

SUBMIT (BULK_CHANGE) ............................................................... 727

REQUEST PARAMETERS FOR SUBMIT (BULK_CHANGE) .......................... 728

RESPONSE PARAMETERS FOR SUBMIT (BULK_CHANGE) ......................... 736

EXAMPLES FOR SUBMIT (BULK_CHANGE) ......................................... 736

SUBMIT_BULK_CHANGE (WHOIS PRIVACY) ......................................... 753

REQUEST PARAMETERS FOR SUBMIT_BULK_CHANGE ............................ 753

RESPONSE PARAMETERS FOR SUBMIT_BULK_CHANGE .......................... 754

12

EXAMPLES FOR SUBMIT_BULK_CHANGE .......................................... 754

PERSONAL NAMES SERVICE ..................................................... 756

NAME_SUGGEST (SURNAME) ........................................................... 757

REQUEST PARAMETERS FOR NAME_SUGGEST (SURNAME) ...................... 757

RESPONSE PARAMETERS FOR NAME_SUGGEST (SURNAME) ..................... 758

EXAMPLES FOR NAME_SUGGEST (SURNAME) ..................................... 759

SU_REGISTER ............................................................................ 763

REQUEST PARAMETERS FOR SU_REGISTER ....................................... 763

RESPONSE PARAMETERS FOR SU_REGISTER ...................................... 764

EXAMPLES FOR SU_REGISTER ...................................................... 765

QUERY (SURNAME) ...................................................................... 775

REQUEST PARAMETERS FOR QUERY (SURNAME).................................. 775

RESPONSE PARAMETERS FOR QUERY (SURNAME) ................................ 776

EXAMPLES FOR QUERY (SURNAME) ................................................ 777

UPDATE (SURNAME) ..................................................................... 780

REQUEST PARAMETERS FOR UPDATE SURNAME ................................... 780

RESPONSE PARAMETERS FOR UPDATE SURNAME ................................. 782

EXAMPLES FOR UPDATE SURNAME ................................................. 782

DELETE (SURNAME) ..................................................................... 788

REQUEST PARAMETERS FOR DELETE (SURNAME) ................................. 788

RESPONSE PARAMETERS FOR DELETE (SURNAME) ............................... 788

EXAMPLES FOR DELETE (SURNAME) ............................................... 789

NAMESERVER COMMANDS ....................................................... 791

ADVANCED_UPDATE_NAMESERVERS .................................................. 792

REQUEST PARAMETERS FOR ADVANCED_UPDATE_NAMESERVERS .............. 792

RESPONSE PARAMETERS FOR ADVANCED_UPDATE_NAMESERVERS ............ 793

EXAMPLES FOR ADVANCED_UPDATE_NAMESERVERS ............................ 794

CREATE (NAMESERVER) ................................................................. 797

REQUEST PARAMETERS FOR CREATE (NAMESERVER) ............................ 797

RESPONSE PARAMETERS FOR CREATE (NAMESERVER) ........................... 798

EXAMPLES FOR CREATE (NAMESERVER) ........................................... 798

DELETE (NAMESERVER) ................................................................. 807

REQUEST PARAMETERS FOR DELETE (NAMESERVER) ............................ 807

RESPONSE PARAMETERS FOR DELETE (NAMESERVER) ........................... 808

EXAMPLES FOR DELETE (NAMESERVER) ........................................... 808

GET (NAMESERVER) ..................................................................... 812

REQUEST PARAMETERS FOR GET (NAMESERVER) ................................ 812

RESPONSE PARAMETERS FOR GET (NAMESERVER) ............................... 812

13

EXAMPLES FOR GET (NAMESERVER) ............................................... 814

MODIFY (NAMESERVER) ................................................................. 819

REQUEST PARAMETERS FOR MODIFY (NAMESERVER) ............................ 819

RESPONSE PARAMETERS FOR MODIFY (NAMESERVER) ........................... 820

EXAMPLES FOR MODIFY (NAMESERVER) ........................................... 820

REGISTRY_ADD_NS ..................................................................... 824

REQUEST PARAMETERS FOR REGISTRY_ADD_NS ................................. 824

RESPONSE PARAMETERS FOR REGISTRY_ADD_NS ............................... 825

EXAMPLES FOR REGISTRY_ADD_NS ............................................... 826

REGISTRY_CHECK_NAMESERVER ...................................................... 829

REQUEST PARAMETERS FOR REGISTRY_CHECK_NAMESERVER .................. 829

RESPONSE PARAMETERS FOR REGISTRY_CHECK_NAMESERVER ................ 830

EXAMPLES FOR REGISTRY_CHECK_NAMESERVER ................................ 830

DNS ZONE COMMANDS............................................................. 834

CREATE_DNS_ZONE .................................................................... 835

REQUEST PARAMETERS FOR CREATE_DNS_ZONE ................................ 835

RESPONSE PARAMETERS FOR CREATE_DNS_ZONE ............................... 837

EXAMPLES FOR CREATE_DNS_ZONE............................................... 840

DELETE_DNS_ZONE ..................................................................... 845

REQUEST PARAMETERS FOR DELETE_DNS_ZONE ................................ 845

RESPONSE PARAMETERS FOR DELETE_DNS_ZONE ............................... 845

EXAMPLES FOR DELETE_DNS_ZONE ............................................... 846

FORCE_DNS_NAMESERVERS ........................................................... 848

REQUEST PARAMETERS FOR FORCE_DNS_NAMESERVERS ....................... 848

RESPONSE PARAMETERS FOR FORCE_DNS_NAMESERVERS ..................... 848

EXAMPLES FOR FORCE_DNS_NAMESERVERS ..................................... 849

GET_DNS_ZONE ......................................................................... 851

REQUEST PARAMETERS FOR GET_DNS_ZONE .................................... 851

RESPONSE PARAMETERS FOR GET_DNS_ZONE ................................... 851

EXAMPLES FOR GET_DNS_ZONE ................................................... 854

REQUEST PARAMETERS FOR RESET_DNS_ZONE .................................. 857

RESPONSE PARAMETERS FOR RESET_DNS_ZONE ................................ 858

EXAMPLES FOR RESET_DNS_ZONE ................................................ 861

SET_DNS_ZONE ......................................................................... 867

REQUEST PARAMETERS FOR SET_DNS_ZONE ..................................... 867

RESPONSE PARAMETERS FOR SET_DNS_ZONE ................................... 870

EXAMPLES FOR SET_DNS_ZONE ................................................... 872

14

DOMAIN FORWARDING COMMANDS ........................................ 879

CREATE_DOMAIN_FORWARDING ...................................................... 880

REQUEST PARAMETERS FOR CREATE_DOMAIN_FORWARDING .................. 880

RESPONSE PARAMETERS FOR CREATE_DOMAIN_FORWARDING ................ 880

EXAMPLES FOR CREATE_DOMAIN_FORWARDING ................................. 881

DELETE_DOMAIN_FORWARDING ....................................................... 883

REQUEST PARAMETERS FOR DELETE_DOMAIN_FORWARDING .................. 883

RESPONSE PARAMETERS FOR DELETE_DOMAIN_FORWARDING ................. 883

EXAMPLES FOR DELETE_DOMAIN_FORWARDING ................................. 884

GET_DOMAIN_FORWARDING ........................................................... 886

REQUEST PARAMETERS FOR GET_DOMAIN_FORWARDING ...................... 886

RESPONSE PARAMETERS FOR GET_DOMAIN_FORWARDING ..................... 886

EXAMPLES FOR GET_DOMAIN_FORWARDING ..................................... 888

SET_DOMAIN_FORWARDING ........................................................... 893

REQUEST PARAMETERS FOR SET_DOMAIN_FORWARDING ....................... 893

RESPONSE PARAMETERS FOR SET_DOMAIN_FORWARDING ..................... 895

EXAMPLES FOR SET_DOMAIN_FORWARDING ..................................... 895

USER COMMANDS .................................................................... 899

ADD (SUBUSER) ......................................................................... 900

REQUEST PARAMETERS FOR ADD (SUBUSER) ..................................... 900

RESPONSE PARAMETERS FOR ADD (SUBUSER) ................................... 901

EXAMPLES FOR ADD (SUBUSER) ................................................... 901

DELETE (SUBUSER) ...................................................................... 903

REQUEST PARAMETERS FOR DELETE (SUBUSER) ................................. 903

RESPONSE PARAMETERS FOR DELETE (SUBUSER) ............................... 903

EXAMPLES FOR DELETE (SUBUSER)................................................ 904

GET (SUBUSER).......................................................................... 906

REQUEST PARAMETERS FOR GET (SUBUSER) ..................................... 906

RESPONSE PARAMETERS FOR GET (SUBUSER) ................................... 906

EXAMPLES FOR GET (SUBUSER).................................................... 907

GET (USERINFO) ......................................................................... 909

REQUEST PARAMETERS FOR GET (USERINFO) .................................... 909

RESPONSE PARAMETERS FOR GET (USERINFO)................................... 909

EXAMPLES FOR GET (USERINFO) ................................................... 912

MODIFY (SUBUSER) ..................................................................... 915

REQUEST PARAMETERS FOR MODIFY (SUBUSER) ................................. 915

RESPONSE PARAMETERS FOR MODIFY (SUBUSER) ............................... 916

EXAMPLES FOR MODIFY (SUBUSER) ............................................... 916

15

AUTHENTICATION COMMANDS ................................................ 918

CHANGE (OWNERSHIP) ................................................................. 919

REQUEST PARAMETERS FOR CHANGE (OWNERSHIP) ............................. 919

RESPONSE PARAMETERS FOR CHANGE (OWNERSHIP) ........................... 920

EXAMPLES FOR CHANGE (OWNERSHIP) ........................................... 920

CHANGE (PASSWORD) .................................................................. 922

REQUEST PARAMETERS FOR CHANGE (PASSWORD) .............................. 922

RESPONSE PARAMETERS FOR CHANGE (PASSWORD) ............................ 922

EXAMPLES FOR CHANGE (PASSWORD) ............................................ 923

SEND_AUTHCODE ....................................................................... 925

REQUEST PARAMETERS FOR SEND_AUTHCODE ................................... 925

RESPONSE PARAMETERS FOR SEND_AUTHCODE ................................. 925

EXAMPLES FOR SEND_AUTHCODE ................................................. 926

SEND_PASSWORD (DOMAIN) ........................................................... 928

REQUEST PARAMETERS FOR SEND_PASSWORD (DOMAIN) ...................... 928

RESPONSE PARAMETERS FOR SEND_PASSWORD (DOMAIN) .................... 929

EXAMPLES FOR SEND_PASSWORD (DOMAIN) .................................... 929

COOKIE/SESSION COMMANDS ................................................ 931

DELETE (COOKIE) ....................................................................... 932

REQUEST PARAMETERS FOR DELETE (COOKIE) ................................... 932

RESPONSE PARAMETERS FOR DELETE (COOKIE) ................................. 932

EXAMPLES FOR DELETE (COOKIE) ................................................. 933

QUIT (SESSION) ......................................................................... 935

REQUEST PARAMETERS FOR QUIT (SESSION) .................................... 935

RESPONSE PARAMETERS FOR QUIT (SESSION) ................................... 935

EXAMPLES FOR QUIT (SESSION) ................................................... 935

SET (COOKIE) ............................................................................ 937

REQUEST PARAMETERS FOR SET (COOKIE) ....................................... 937

RESPONSE PARAMETERS FOR SET (COOKIE)...................................... 938

EXAMPLES FOR SET (COOKIE)...................................................... 939

UPDATE (COOKIE) ....................................................................... 942

REQUEST PARAMETERS FOR UPDATE (COOKIE) .................................. 942

RESPONSE PARAMETERS FOR UPDATE (COOKIE) ................................. 942

EXAMPLES FOR UPDATE (COOKIE) ................................................. 943

16

WHOIS PRIVACY COMMAND .................................................... 946

CHANGE_WP_EXPIRY_DATE ............................................................ 947

REQUEST PARAMETERS FOR CHANGE_WP_EXPIRY_DATE ....................... 947

RESPONSE PARAMETERS FOR CHANGE_WP_EXPIRY_DATE ...................... 948

EXAMPLES FOR CHANGE_WP_EXPIRY_DATE ...................................... 948

APPENDIX A: SPECIAL CONSIDERATIONS FOR ASYNCHRONOUS

REGISTRIES ............................................................................. 956

APPENDIX B: CUSTOMIZING THE TRANSFER APPROVAL URL ... 957

REGULAR TRANSFERS ................................................................... 957

BULK TRANSFERS ........................................................................ 958

TRANSFERS AWAY ....................................................................... 958

APPENDIX C: ENCODING TYPES FOR IDNS............................... 960

REVISIONS AND UPDATES ....................................................... 965

17

Introduction

Welcome to the OpenSRS API guide for the registration and management of domain names and domain related services. This document is intended for OpenSRS Resellers who offer domains and supporting services to their customers.

Using this document, you can provide OpenSRS functionality to your customers by integrating the API commands into your website that can send XML requests to OpenSRS over HTTPS Post. You can also use the API commands to run queries or automate tasks you would otherwise perform manually using the OpenSRS Reseller Web Interface (RWI).

Response Messages

The process returns a response message to a client in answer to an action that was executed on its behalf. Responses contain data appropriate for the action that was executed. In some cases, this may be simple strings; in other cases, this may be lists of information. This response is returned in the form of an XML document.

Common fields

There are a few common fields that all responses share, regardless of the action to which they are responding. The following fields comprise a standard response message. Some actions only use standard response messages.

Parameter name Definition/Value

protocol The protocol that is being used (XCP).

action In the case of responses, this is always REPLY.

response_code Response code (meaning is action-specific).

response_text Response text (meaning is action-specific).

is_success Indicates whether the command was successful. Returns 0 if

not successful and 1 if the action was successful.

Optional fields

In addition, the structure may contain the following fields, depending on the specific action that was requested.

Parameter name Definition/Value

attributes A hash that contains any specific parameters or attributes to be

sent along with the action request.

18

Submitting API commands without end-

user credentials

You can submit API commands without specifying a username and password or a cookie.

Note: The only exception is the change (password) command.

Before you can submit commands without end-user credentials, you must establish a secure connection with the OpenSRS server using a private key (use either CBC:Blowfish or HTTPS-Post).

Required parameter

When you submit API commands without end-user credentials, you must include the domain parameter to identify the domain that will be affected by the command.

Example

0.9

XCP

modify

domain

example.com

nexus_info

....

.

19

Potential issues

Not permitted: apply_to_all flag

The apply_to_all flag is normally used to apply a change to all domains in the Reseller's profile; however, you cannot use the apply_to_all flag when you submit commands without credentials. If you submit the apply_to_all flag without credentials, the command will fail.

Incorrect credentials If end-user credentials are submitted, but they are incorrect, the command will fail.

20

Contact Set

Rather than including the entire contact set in every command example in this guide, where it is required, contact details are listed in a separate topic.

Every command that requires contact details contains an ellipsis (...) that links to the topic where the contact_set parameter is defined.

Example

This example shows a portion of the sw_register command with a link to the contact_set example.

0.9

DOMAIN

0

0

... see "Contact Set"

...

21

Examples for contact set

...

Owen

Ottway

+1.4165550123x1902

+1.4165550124

[email protected]

Example Inc.

32 Oak Street

Suite 500

Owner

SomeCity

CA

US

90210

Adler

Adams

+1.4165550123x1812

+1.4165550125

[email protected]

Example Inc.

32 Oak Street

Suite 100

Admin

Santa Clara

CA

US

22

90210

Bill

Burton

+1.4165550123x1248

+1.4165550136

[email protected]

Example Inc.

32 Oak Street

Suite 200

Billing

Santa Clara

CA

US

90210

Tim

Tucker

+1.4165550123x1243

+1.4165550125

[email protected]

Example Inc.

32 Oak Street

Suite 100

Tech

Santa Clara

CA

US

90210

23

...

Domain contacts

The following tables list the contacts that are required for each gTLD and ccTLD.

gTld Owner Admin Billing Tech

.aero

.asia

.biz

.coop

.com

.info

.jobs

.mobi

.name

.net

.org

.pro

.tel

.xxx

ccTld Owner Admin Billing Tech

.ac

.ae

.af (.af,

.com.af,

.net.ag, .org.af)

.ag (.ag, .co.ag,

.com.ag,

24


.net.ag,

.nom.ag, .org.ag)

.ai (.com.ai,

.net,ai, .off.ai,

.org.ai)

.am

.ar (.com.ar)

.as

.at

.au (.asn.au,

.com.au,

.net.au, .id.au,

.org.au)

.be

.br (.com.br)

.bz

.ca

.cc

.cd

.ch

.cl

.cm

.co.cm

.com.cm

.net.cm

.co (.co, .com.co,

.net.co, .nom.co)

.cx

.cz

.de

.dk

25


.ec (.ec,

.com.ec, .fin.ec,

.info.ec,

.med.ec,

.net.ec, .pro.ec)

.es (.es,

.com.es,

.nom.es, .org.es)

.eu

.fi

.fm

.fr

.gd

.gg (.gg,

.co.gg, .net.gg,

.org.gg)

.gl (.gl, .co.gl,

.com.gl, .net.gl,

.org.gl)

.gr (.com.gr,

.edu.gr, .net.gr,

.org.gr)

.gs

.gy (.gy,

.co.gy,

.com.gy, .net.gy)

.hk

.hm

.hn (.hn, .com.hn,

.net.hn, .org.hn)

.hr (.com.hr)

.ht (.ht,

.com.ht,

.info.ht, .net.ht,

.org,ht)

.hu (.hu, .co.hu)

.il (.co.il)

.im (.im, .co.im,

26


.com.im,

.net.im, .org.im)

.in (.in, .co.in,

.firm.in, .gen.in,

.ind.in, .net.in,

.org.in)

.io

.is

.it

.je (.je, .co.je)

.jp

.kg

.ki (.biz.ki,

.com.ki,

.info.ki,

.mobi.ki,

.net.ki, .tel.ki)

.kr

.co.kr

.la

.lc (.lc, .co.lc,

.com.lc, .l.lc,

.net.lc, .org.lc,

.p.lc)

.li

.lt

.lu

.lv

.com.lv

.ly (.ly, .com.ly)

.ma

.co.ma

.md

.me

27


.mn

.ms

.mu

.mx (.mx,

.com.mx)

.my (.my,

.com.my, .net.my,

.org.my)

.nl

.no

.nu

.nz (.co.nz,

.net.nz, .org.nz)

.pe (.pe,

.com.pe, .net.pe)

ph (.ph, .com.ph,

.net.ph, .org.ph)

.pl (.pl, .biz.pl

.com.pl, .edu.pl,

.info.pl, .net.pl,

.nom.pl, .org.pl,

.shop.pl, .waw.pl)

.pm

.pr (.com.pr)

.pt (.pt, .com.pt)

.pw

.qa

.re

.ro (.ro, .com.ro)

.ru (.ru, .com.ru)

.sb (.com.sb,

.net.sb, .org.sb)

28


.sc

.com.sc

.net.sc

.org.sc

.se

.sg

.sh

.si

.so (.so, .com.so,

.net.so, .org.so)

.sr

.st

.sx

.tc

.tf

.tk

.tl

.tm

.to

.tv

.tw (.tw,

.com.tw, .org.tw,

idv.tw)

.ua (.com.ua)

.uk (.co.uk,

.ltd.uk, .me.uk,

.net.uk,

.org.uk, .plc.uk)

.us

29


.uy (.com.uy)

.vc (.vc, .com.vc,

.net.vc, .org.vc)

.ve (.co.ve,

.com.ve)

.vg

.wf

.ws

.yt

.za (.co.za)

Default contact requirements

Note: Fields cannot contain leading or trailing white-spaces.

Parameter name

Obligation Format/Constraints

first_name Required Maximum 64 alphanumeric characters.

last_name Required Maximum 64 alphanumeric characters.

org_name Required Maximum 64 alphanumeric characters.

address1 Required Maximum 100 alphanumeric characters.

address2 Optional Maximum 100 alphanumeric characters.


city Required Maximum 64 alphanumeric characters.

state Required if

country =

.CA, .US, or .ES

Not required for .NL

Maximum 32 alphanumeric characters.

postal_code Required Maximum 32 alphanumeric characters.

Note: For .NL, ensure that the postal code does not include any spaces.

country Required 2 letter ISO country code.

phone Required Maximum 20 characters, in the format

+CCC.NNNNNNNNNNxEEEE, where C = country code, N = phone number, and E = extension

30

Parameter name


(optional).

fax Optional Maximum 20 alphanumeric characters.

email Required Maximum 255 alphanumeric characters, validated according to rfc822.

EPP contact requirements

Parameter name









state Required if country = CA or

US

Not required for .NL

Maximum 32 alphanumeric characters.


Note: For .NL, ensure that the postal code does not include any spaces.


phone Required Maximum 20 alphanumeric characters, syntax verified according to EPP.

fax Optional Maximum 20 alphanumeric characters, in the

format +CCC.NNNNNNNNNNxEEEE, where C =

country code, N = phone number, and E =

extension (optional).

email Required Maximum 64 characters to left of and 63 characters right of "@" sign, alphanumeric characters,

validated according to rfc822.

31

.BE owner and tech contact requirements

Two contacts are required for .BE domains: 'owner' and 'tech'. If you submit other contact types, they are ignored.

Parameter name


first_name Required Maximum length: 64 alphanumeric characters.

last_name Required Maximum length: 64 alphanumeric characters.

org_name Required Maximum length: 64 alphanumeric characters.

address1 Required Maximum length: 100 alphanumeric characters.

address2 Optional Maximum length: 100 alphanumeric characters.


city Required Maximum length: 64 alphanumeric characters.

state Required if

country = CA or

US

Maximum length: 32 alphanumeric characters.

postal_code Required Maximum length: 20 alphanumeric characters.

country Required Maximum length: 2 alphanumeric characters.

phone Required Maximum length: 20 alphanumeric characters, in

the format +CCC.NNNNNNNNNNxEEEE, where C =



fax Optional Maximum length: 20 alphanumeric characters,

syntax verified according to EPP.

email Required Maximum length: 255 alphanumeric characters,


lang Required Maximum length: 2 alpha characters, must be one

of designated languages for .BE (see the language

list for .BE).

vat Optional Valid Value-Added Tax registration number of the

contact.

.CA owner, admin, and tech contact requirements

Parameter name




org_name Optional for individuals


32

Parameter name





city Required for admin and tech; optional

for owner


state Required for admin and tech; optional

for owner

A valid 2 letter code for the Canadian province.

Alberta = AB

British Columbia = BC

Manitoba = MB

New Brunswick = NB

Newfoundland and Labrador = NL

Northwest Territories = NT

Nova Scotia = NS

Nunavut = NU

Ontario = ON

Prince Edward Island = PE

Quebec = QC

Saskatchewan = SK

Yukon = YT

postal_code Required for

admin and

tech; optional

for owner


country Required for

admin and

tech; optional

for owner

Maximum length: 2 alphanumeric characters

phone Required for

admin and

tech; optional

for owner

Maximum length: 20 alphanumeric characters, in




fax Optional Maximum length: 20 alphanumeric characters.

email Required for

admin and

tech; optional

for owner

Maximum length: 255 alphanumeric characters,


33

Parameter name


lang Required The contact's preferred language. The default is

English.

Allowed values are:

EN = English

FR = French

.DE admin contact requirements

Parameter name









state Required if

country = CA

or US





the format +CCC.NNNNNNNNNNxEEEE, where C = country code, N = phone number, and E =


fax Optional Maximum length: 20 alphanumeric characters, if

not null syntax verified according to EPP.



Additional rules

SUM (org_name address1 address2 address3) not to exceed 255 characters.

.DE owner contact requirements

Parameter name



34

Parameter name








state Required if

country = CA or

US








fax Optional Maximum length: 20 alphanumeric characters, if not null syntax verified according to EPP.

email Required Maximum length: 255 alphanumeric characters, validated according to rfc822.

Additional rules

SUM (first_name last_name address1 address2 address3 postal_code city) must not exceed 248 characters.

SUM (org_name address1 address2 address3) not to exceed 255 characters.

.DE zone and tech contact requirements

Note: Submit .DE zone contact information as contact type billing.

Parameter name









35

Parameter name


state Required if

country = CA or

US








fax Required Maximum length: 20 alphanumeric characters, if not null syntax verified according to EPP.


Additional rules

SUM(org_name address1 address2 address3) not to exceed 255 characters.

.ES postal codes

When registering a .ES name, the postal code must correspond to the province for each of the contacts. Refer to the chart below for the two digit postal code prefix that applies to each province.

Postal code prefix

Province Postal code prefix

Province

01 Araba 27 Lugo

02 Albacete 28 Madrid

03 Alicante 29 Malaga

04 Almeria 30 Murcia

05 Avila 31 Navarr

06 Badajoz 32 Ourense

07 Illes Balears 33 Asturias

08 Barcelona 34 Palencia

09 Burgos 35 Palmas, Las

10 Caceres 36 Pontevedra

36

Postal code prefix

Province Postal code prefix

Province

11 Cadiz 37 Salamanca

12 Castellon 38 Santa Cruz de Tenerife

13 Ciudad Real 39 Cantabria

14 Cordoba 40 Segovia

15 Corua, A 41 Sevilla

16 Cuenca 42 Soria

17 Girona 43 Tarragona

18 Granada 44 Teruel

19 Guadalajara 45 Toledo

20 Gipuzkoa 46 Valencia

21 Huelva 47 Valladolid

22 Huesca 48 Bizkaia

23 Jaen 49 Zamora

24 Leon 50 Zaragoza

25 Lleida 51 Ceuta

26 Rioja, La 52 Melilla

.EU owner and tech contact requirements

Only two contacts are accepted for .EU domains: 'owner' and 'tech'. If you submit other contact types, they are ignored.

Parameter name








city Required Maximum length: 64 alphanumeric character

37

Parameter name


state Optional Maximum length: 32 alphanumeric characters.

postal_code Optional Maximum length: 20 alphanumeric characters.

country Required Maximum length: 2 alphanumeric characters, for

owner contact the country must be one of the

designated countries for .EU (see the country list

for .EU).

phone Required Maximum length: 15 alphanumeric characters, in the format +CCC.NNNNNNNNNN, where C =

country code and N = phone number.

fax Optional Maximum length: 20 alphanumeric characters, if

not null syntax verified according to EPP.


lang Required Maximum length: 2 alpha characters, must be one

of designated languages for .EU (see the language

list for .EU).

vat Optional Valid Value-Added Tax registration number of the

requesting contact.

.IT contact requirements

Parameter name




org_name Required if

entity_type is

not 1






state Required Maximum length: 32 alphanumeric characters.

If country = IT, province must be a valid Italian

province. (See

http://en.wikipedia.org/wiki/ISO_3166-2:IT ).

38

Parameter name



If country = IT, postal_code must be a valid Italian postal code. (See

http://en.wikipedia.org/wiki/List_of_postal_codes_i n_Italy)

country Required The ISO 3166-1 country code for the owner

contact. Maximum length: 2 alphanumeric

characters. (See nationality_code for

requirements.)

Note: Be sure to use capital letters.





fax Optional Maximum length: 20 alphanumeric characters, if not null syntax verified according to EPP.



entity_type Required A numeric entry that indicates the type of domain

owner.

Valid values are:

1Italian and foreign natural persons

2Companies/one man companies

3Freelance workers/professionals

4Non-profit organizations

5Public organizations

6Other subjects

7Foreigners who match 2-6

nationality_

code

Optional The ISO 3166-1 code for the nationality of the

domain owner. Maximum length: 2 alphanumeric

characters.

If entity_type = 1, nationality or owner's country or both must be an EU country.

If entity_type = 2-6, this value must be IT.

If entity_type = 7, this value must match owner's

country and must be an EU country other than IT.

Note: Be sure to use capital letters.

39

Parameter name


reg_code Required An identifying number, usually the VAT or Codice

Fiscale (numeric tax code). The value that you

need to enter depends on the entity type of the

registrant.

Italian citizens must enter their Codice

Fiscale.

Non Italians not living in Italy can enter

n.a.

Italian companies, freelancers, and other

subjects must enter their 11 digit VAT

number or tax indentification number.

Italian non-profit organizations must enter

their VAT number or tax identification

number; however, if they do not have

one,they can enter n.a.

Non Italian entities other than persons

(organizations, freelancers, companies,

etc.) may enter their VAT number or n.a.

.MX contact requirements

Parameter

name

Obligation

Format/Constraints








state/province

Required if

country = CA,

MX, or US

A valid 2 letter code for the state or province



phone Required Maximum 20 alphanumeric characters, syntax

40

Parameter name

Obligation

Format/Constraints

verified according to EPP.

fax

Optional

Maximum 20 alphanumeric characters, in the

format +CCC.NNNNNNNNNNxEEEE, where C =



email

Required

Maximum 64 characters to left of and 63 characters

right of "@" sign, alphanumeric characters,


.PRO contact requirements

The PRO registry does not support extensions in phone and fax numbers. If you include an extension in the number, for example, +1.4165550123x1234,

the string will be accepted, but the registry drops the extension part of the number and the resulting number becomes +1.4165550123.

.UK transfer-no change-admin contact requirements

Note: The admin contact information is only used by OpenSRS, and the information is not forwarded to the .UK registry.

Parameter name


first_name Optional Maximum length: 64 alphanumeric characters.

last_name Optional Maximum length: 64 alphanumeric characters.

org_name Optional Maximum length: 64 alphanumeric characters.




city Optional Maximum length: 64 alphanumeric characters.

state Optional Maximum length: 32 alphanumeric characters.

postal_code Optional Maximum length: 32 alphanumeric characters.

country Optional Maximum length: 2 alphanumeric characters

phone Optional Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE, where C =


extension (optional), 7 bit ASCII only.


41

Parameter name



.UK contact requirements

Note: Technical contact information is not required or accepted for .UK.

Parameter name




org_name Optional Maximum length: 64 alphanumeric characters.





state Required if

country = CA or US





the format +CCC.NNNNNNNNNNxEEEE, where C = country code, N = phone number, and E = extension (optional).




42

TLD Data

The tld_data associative array contains that contains additional information that is required by some registries, such as the residency of the registrant. For instance, .ASIA domains require Charter Eligibility Declaration (CED) information to demonstrate that at least one of the contacts is a member of the .ASIA community, and this information is provided within the tld_data associative array, under ced_info.

The allowed values for tld_data are:

au_registrant_infoEligibility requirements for .AU registrants.

br_register_numberLegal Brazilian identifier.

ced_infoCharter Eligibility Declaration (CED) information for .ASIA domains.

ipr_dataSponsored Community information associated with .XXX domains.

it_registrant_infoRegional presence requirements for .IT domains.

nexusAmerican presence requirements for .US domains.

professional_dataThe professional designation information that is associated with the .PRO domain.

registrant_extra_infoAdditional parameters that are required by various domain registries. See below for specific requirements for each TLD.

The tld_data information is used by the following commands: sw_register,

modify domain, get domain, get_order_info, and trade domain (.FR only).

.AERO registrant_extra_info

Registration of .AERO domains is restricted to members of the aviation community such as airlines, airports, and qualifying companies and individuals.

To prove that they meet the requirements, registrants must provide an Eligibility and Name Selection (ENS) ID and password, which can be obtained

by applying to the registry through this site: http://www.nic.aero/registration/manage_your_aero_id/apply.

Parameters within the registrant_extra_info associative array are described below.

Parameter name Definition/Value sw_register (request)

aero_ens_id Eligibility and Name Selection (ENS)

identifier

Required

aero_ens_password Eligibility and Name Selection (ENS)

password

Required

43

.ASIA ced_info

The ced_info associative array contains Charter Eligibility Declaration (CED)

information to satisfy regional presence requirements of the .ASIA registry, including the stated purpose of the domain, the category of the registrant

and the country code validator.

Parameters within the ced_info associative array are described below.

Parameter name

Definition/Value sw_ register (request)

modify domain (request)

get domain (response)

get_order

_info

(response)

contact_

type The contact that is the

designated CED Contact.

Allowed values are owner, admin, tech, or billing.

Required Required Always

returned

Always

returned

id_number Identification number or

code of reference for the

specified id_type, for

example, a passport

number.


returned

Always

returned

id_type The type of ID used to

validate the CED

information.

Allowed values are passport, certificate (of

Incorporation or business

registration), legislation

(act, decree or legislation

chartering the formation of

an entity), societyRegistry,

politicalPartyRegistry, or

other.

Note: If you specify other, you must also

submit the id_type_info parameter.


returned

Always

returned

id_type_info A description of the id type;

the maximum number of

characters allowed is 255.

Required if

id_type =

other

Required if

id_type =

other

Returned if

id_type =

other

Returned if

id_type =

other

legal_entity

_type The legal entity type of the

CED.

Allowed values are

naturalPerson,

corporation,

cooperative,

partnership,


returned

Always

returned

44

Parameter name


modify domain (request)

get domain (response)

get_order _info

(response)

government, politicalParty, society,

institution, or other.

Note: If you specify other, you must also submit the

legal_entity_type_info

parameter.

legal_entity_

type_info

A description of the legal entity type; the maximum

number of characters allowed is 255.

Required if

legal_

entity_

type =

other

Required if

legal_

entity_

type =

other

Returned if

legal_

entity_

type =

other

Returned if

legal_

entity_

type =

other

locality_city The city where the CED

contact resides.

Optional Optional Returned if

submitted

in the order

Returned if

submitted

in the order

locality_

country County code from the list of

qualifying countries. For a

definition of the

geographical boundaries of

the Asia/Australia/Pacific

region, see

http://www.icann.org/mont

real/geo-regions-topic.htm

Required Required Always returned

Always returned

locality_

state_prov

The state or province

where the CED contact

resides.

Optional Optional Returned if

submitted

in the order

Returned if

submitted

in the order

.AU au_registrant_info

The au_registrant_info associative array contains information about specific requirements that registrants of .AU domains must meet.

Parameters within the au_registrant_info associative array are described below.

Parameter name


get domain

(response) get_order_ info (response)

eligibility_id The identifier of the eligibility document.

Important: This number will be verified, and if you

submit an incorrect

Required for

.ASN.AU,

.COM.AU

.NET.AU, and

.ORG.AU

Always returned

Returned if

submitted in

the order

45

Parameter name


get domain


number, the registration will fail.

Note: This

value is

optional for .ID.AU unless

you specify an

eligibility_id_

type, in which

case this value is required.

eligibility_id

_type

The Eligibility ID type. The

allowed values depend on

the eligibility_type

specified.

Allowed value for Charity

is ABN.

Allowed value for Club is

ABN.

Allowed values for

Incorporated

Association are ACT BN,

NSW BN, NT BN, QLD BN, SA BN, TAS BN, VIC

BN, and WA BN.

Allowed values for Non-

profit Organization are

ABN, ACT BN, ACN,

NSW BN, NT BN, QLD BN, SA BN, TAS BN, VIC BN, WA BN, and OTHER.

Allowed value for Trade

Union is OTHER.

Allowed value for

Company is ACN.

Allowed value for

Registered Business is

OTHER.

Allowed value for Sole

Trader is ABN.

Allowed value for Trademark Owner is

TM.

Allowed value for Pending

Trademark Owner is

Required for

.ASN.AU,

.COM.AU,

.NET.AU, and

.ORG.AU

Always

returned

Returned if

submitted in

the order

46

Parameter name


get domain


TM.

Allowed value for

Partnership is ABN.

eligibility_

name

The name on the eligibility

ID document.

Required for

.ASN.AU,

.COM.AU,

.NET.AU, and

.ORG.AU

Returned if

submitted in

the order

Returned if

submitted in

the order

eligibility_

type

The reason that the

registrant is eligible for the

domain name. The

eligibility_type must

correspond to the

eligibility_name. For

example, if the registrant is using their company

name to register the

domain, then their

eligibility_type is

Company. If they are

using their Registered

Business Name to register

the domain, then their

eligibility_type is

Registered Business,

even if they are also a company.

Allowed values for

.ASN.AU and .ORG.AU

domains are:

Charity Club Incorporated

Association

Non-profit Organization

Trade Union

Allowed values for

.COM.AU and .NET.AU

domains are: Company Partnership Pending TM Owner

Required Always returned

Always returned

47

Parameter name


get domain


Registered Business

Sole Trader Trademark

Owner

Allowed value for .ID.AU

domains is

Citizen/Resident

policy_

reason

Indicates the reason the

registrant is entitled to the

domain name.

Allowed values are:

1The name exactly matches

the acronym or

abbreviation of the

registrant's

company or trading

name, organization

or association

name, or

trademark.

2The name is connected closely

and substantially to the registrant. This

is the default.

Required Returned if

submitted in

the order

Returned if

submitted in

the order

registrant_

id The registrant identifier. Must correspond to the

registrant_id_type value (that is, the ABN or ACN),

Important: This number

will be verified, and if you

submit an incorrect

number, the registration

will fail.

Required if registrant_

id_type = ACN or ABN

Always returned

Alwa

opensrs xml domain guide

Documents