Register (domain)
Submits a new registration or transfer order that obeys the reseller's 'process immediately' flag setting.
Helpful Links
TLD Reference Chart - opensrs.help/tlds
Request parameters for sw_register (domain)
Standard parameters
- action = sw_register
- object = domain
- registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter name | Obligation | Definition/Value |
|---|---|---|
affiliate_id | Optional | The unique identifier of an RSP's affiliate, which allows the RSP to track orders coming through different affiliates. Specify a valid affiliate ID (max 256 char). |
auth_info | Optional for transfer orders | The transfer authcode for the domain. If provided, the authcode field will be pre-filled when the registrant clicks on the transfer approval link. |
auto_renew | Optional | Used to set domain to auto-renew.
|
change_contact | Optional | Used to change contact information for
|
comments | Optional | Adds additional notes to the order, for |
contact_set | Required | A collection of associative arrays containing contact information for each contact type (owner, admin, billing, tech). See "Contact Set". Notes: For .NL, state is NOT required. For .ES domains registrations, the postal code must correspond to the province for each of the contacts. See “.ESpostalcodes” for a list of the postal code prefixes that apply to each province. For .IT domain registrations, if the entity_type is anything other than 1, org_name is required, and you must include the admin associative array. If entity_type = 1, the admin contact is assumed to be the same as the owner and you do not need to submit it. |
custom_ nameservers | Nameservers | An indication of whether to use the RSP's default nameservers, or those provided in the 'sw_register' request.
|
custom_transfer_nameservers | Required for .EU transfers - If not submitted, the nameserver list is ignored | This flag is only used if reg_type = transfer, and indicates whether to use the nameservers provided in the request.
|
custom_tech_contact | Required for | An indication of whether to use the RSP's tech contact info, or the tech contact info provided in the 'sw_register' request.
|
dns_template | Optional | Specify the name of the DNS template that you want to use to enable DNS and assign initial DNS records, or specify blank to enable DNS without defining any records.
The template name can be a maximum of 50 characters. If this parameter is specified, the nameservers are automatically set to the nameservers for the DNS service:
For information on creating a DNS template, |
domain | Required for domain registrations and domain vetted certificates | The domain name to be acted upon in the sw_register request. |
encoding_type | Optional | The encoding type for the domain. Submit a valid three-character language tag. For a list of allowed values, see "Appendix C: EncodingTypesforIDNs". If you submit the reg_domain parameter to link two profiles, and the previously registered domain contains multilingual characters, the reg_domain value must also be in Punycode format. For a list of the languages supported for each TLD, see the gTLDandccTLDReferenceCharton the OpenSRS website. |
f_lock_domain | Optional | Allows you to lock the domain so that it cannot be transferred away. To allow a transfer on a locked domain, the domain must first be unlocked. Even if submitted, this setting is not applied to TLDs where locking is not supported such as .DE, .UK, .CH, .NL, .FR, IT, BE, and AT.
|
f_parkp | Optional | Enables the Parked Pages Program. When the Parked Pages Program is enabled, a customized page containing contextual ads is displayed. The ads generate revenue whenever a visitor clicks on one of the links, and that revenue is shared with you, the reseller.
Parked Pages functionality is available for new and transferred domain registrations for these TLDs: .COM, .NET, .ORG, .INFO, .BIZ, If Parked Pages is enabled, DNS settings entered at registration are saved for future use and the Parked Pages nameservers are used instead. For transfers, the DNS settings that were entered with the transfer request are used. If DNS settings were not submitted at the time of transfer, the pre-transfer DNS settings are used. If the domain was using the Parked Pages DNS at the time of transfer, and DNS settings are not provided, the domain continues to use the Parked Pages DNS.
|
f_whois_privacy | Optional | Allows you to enable WHOIS Privacy for new .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, .MOBI, .CC, .CO, and .TV registrations.
|
handle | Required | Indicates how to process the order.
|
Intended_use | Optional | Intended_use attribute is optional, but it is recommended that you submit an appropriate response for your .scot registration. If no response is submitted, OpenSRS will send one on your behalf, but we cannot guarantee it will be accepted by the registry.
|
link_domains | Optional | Indicates whether to link this domain with others. This parameter is only used when ordering multiple domains over multiple calls to sw_register. Also, it is only used if the user does not wish to associate the new registrations with an existing domain/profile in OpenSRS. The first sw_register call to OpenSRS should have link_domains set to 1. The return to this call contains an OpenSRS order ID. This value is used as the master_order_id in the subsequent calls to sw_register for the remainder of the domain list list.
Note: Only the first call to sw_register should contain the attribute link_domains. |
master_order_id | Required for domain registrations if link_domains =1 | The order ID returned by the first sw_register call for a group of domains that are to be linked (via the link_domains parameter). |
nameserver_list | Required for .EU transfers | A list of nameserver pairs, each of which contain a nameserver's name and sort order. (Minimum two required). For allowed values, see the Nameserver_list table below. If dns_template is specified, the nameservers are automatically set to the nameservers for the DNS service:
|
ownerconfirm address | Required for .DE, .BE, .EU, and .IT transfers | The email address to which to send messages regarding a .BE, .DE, .EU or .IT transfer.
|
period | Required for new domain registrations only | The length of the registration period. Allowed values are 1 – 10, depending on the TLD, that is, not all registries allow for a 1-year registration. The default is 2, which is valid for all TLDs. |
premium_price_to_verify | Optional - used only if reg_type = premium | Submits the premium domain price and verifies that it is the same as the list price. If the submitted price does not match the Tucows list price, the command will fail. Allowed value is the price for the premium domain, in the format nnn.nn. |
reg_domain | Optional | An existing, active domain name in OpenSRS that is owned by the registrant. Providing this parameter links the newly registered or transferred domain to the profile of the existing domain. |
reg_username | Required for domain registrations | The username of the registrant. |
reg_password | Required for domain registrations | The registrant's password. |
reg_type | Required for domain registrations | The type of registration being requested:
|
tld_data | Required for: | An associative array that contains additional information required by the registry, such as the residency of the registrant. If you submit a request that contains this array, you must also include data = tld_data.
For information on the allowed values for each of these, see TLD Data. |
trademark_smd | Required for Sunrise orders of the new gTLDs | The Signed Mark Data (SMD) that is issued by the Trademark Clearinghouse (TMCH) when the corresponding trademark is registered with TMCH, and which serves as proof of trademark rights. When submitting sunrise orders for the new gTLDs, you must also submit the following parameters and values: reg_type = sunrise and handle = save. |
legal_type | Required for .CA registrations and transfers | Domain name owner's legal classification. Possible values are as follows ABO—Aboriginal Please note: To change the legal type of a .CA domain during a transfer from another registrar, you must also submit the change_contact parameter. |
Nameserver pair
Each element of the nameserver_list array contains the following pair, expressed as an associative array:
Parameter name | Obligation | Definition/Value |
|---|---|---|
name | Required | The fully qualified domain of the nameserver. |
sortorder | Required | The sort order of the nameserver.
|
Response parameters for sw_register (domain)
The Reseller Agent (RSA) can respond with a 250 response_code, which indicates that the action was submitted for processing in an asynchronous registry. When the registry's reply is received by OpenSRS, it is processed. Performing a get userinfo command indicates if there is an action currently waiting on a domain.
Standard parameters
- action = reply
- object = domain or trust_service
- is_success = a Boolean is returned, indicating success or failure of the request
- response_code = response code indicating outcome of the request
- response_text = message describing the outcome of the request
Domain order attributes
If the request is successful, the attributes associative array may include the following:
Parameter name | Obligation | Definition/Value |
|---|---|---|
admin_email | Optional | Returns the admin email contact from the order. |
async_reason | Returned for asynchronous requests | Indicates the reason that the request was asynchronous. Allowed values are:
|
cancelled_orders | Optional | A list of pending orders for this domain that are cancelled by the successful registration of the domain. |
error | Returned when an order fails. | A text description of the errors that occurred in a failed transaction. |
forced_pending | Returned if the order has been forced to pending queue. | Orders that cannot be processed (insufficient funds, domain already taken, and so on) are forced to the pending queue. |
id | Returned if | The ID of the order, which can be used in RWI queries. |
queue_request_id | Returned if the order has been queued. | The ID of the request as it appears in the queue. |
registration_code | Returned if | The registration code returned by the registry. |
registration_text | Returned if is_success = true | The registration text returned by the registry. |
transfer_id | Returned if | ID number of the transfer. |
whois_privacy_state | Returned if is_success = true | Returns the state of WHOIS Privacy. Allowed values are enabled, disabled, enabling (in process), or disabling (in process). |
Domain registration examples
For domain = .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, and .MOBI
Example 1
About this example:
- This is a new domain name registration.
- This registration creates a new user profile.
- No custom tech contact is set.
- Custom nameservers are set.
- WHOIS Privacy feature enabled at time of registration.
- Parked Pages service activated (for qualifying TLDs).
- User is requesting the domain to lock once it is registered.
- Two pending orders are cancelled by the successful registration of this
domain.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">SW_REGISTER</item>
<item key="attributes">
<dt_assoc>
<item key="f_parkp">Y</item>
<item key="affiliate_id"></item>
<item key="auto_renew"></item>
<item key="comments">Sample comment</item>
<item key="domain">example2rwetw42tt4t.com</item>
<item key="reg_type">new</item>
<item key="reg_username">daniel</item>
<item key="reg_password">adf3wyt444fvfc3</item>
<item key="f_whois_privacy">1</item>
<item key="period">1</item>
<item key="link_domains">0</item>
<item key="custom_nameservers">1</item>
<item key="f_lock_domain">1</item>
<item key="reg_domain"></item>
<item key="contact_set">
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Admin</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1812</item>
<item key="state">CA</item>
<item key="address2">Suite 100</item>
<item key="last_name">Adams</item>
<item key="email">[email protected]</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550125</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Adler</item>
</dt_assoc>
</item>
<item key="owner">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Owner</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1902</item>
<item key="state">CA</item>
<item key="address2">Suite 500</item>
<item key="last_name">Ottway</item>
<item key="email">[email protected]</item>
<item key="city">SomeCity</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550124</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Owen</item>
</dt_assoc>
</item>
<item key="billing">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Billing</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1248</item>
<item key="state">CA</item>
<item key="address2">Suite 200</item>
<item key="last_name">Burton</item>
<item key="email">[email protected]</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550136</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Bill</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns1.systemdns.com</item>
<item key="sortorder">1</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns2.systemdns.com</item>
<item key="sortorder">2</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="encoding_type"></item>
<item key="custom_tech_contact">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">
Domain registration successfully completed. WHOIS Privacy successfully enabled. Domain successfully locked.
</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">[email protected]</item>
<item key="whois_privacy_state">enabled</item>
<item key="registration_text">Domain registration successfully completed. WHOIS Privacy successfully enabled. Domain
successfully locked.</item>
<item key="registration_code">200</item>
<item key="id">3735281</item>
<item key="cancelled_orders">
<dt_array>
<item key="0">3764860</item>
<item key="1">3764861</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Example 2
About this example:
- This is a new domain name registration.
- This registration is based on another domain (example.com).
- No custom tech contact is set.
- DNS template is applied.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">SW_REGISTER</item>
<item key="attributes">
<dt_assoc>
<item key="reg_username">daniel</item>
<item key="reg_password">adf3wyt444fvfc3</item>
<item key="period">10</item>
<item key="dns_template">newdnstemplate</item>
<item key="affiliate_id"></item>
<item key="link_domains">0</item>
<item key="custom_nameservers">0</item>
<item key="auto_renew"></item>
<item key="f_lock_domain">0</item>
<item key="domain">example2342343333.net</item>
<item key="reg_type">new</item>
<item key="contact_set">
<dt_assoc>
<item key="owner">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Owner</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1902</item>
<item key="last_name">Ottway</item>
<item key="address2">Suite 500</item>
<item key="state">CA</item>
<item key="email">[email protected]</item>
<item key="city">SomeCity</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550124</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Owen</item>
</dt_assoc>
</item>
<item key="admin">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Admin</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1812</item>
<item key="last_name">Adams</item>
<item key="address2">Suite 100</item>
<item key="state">CA</item>
<item key="email">[email protected]</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550125</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Adler</item>
</dt_assoc>
</item>
<item key="billing">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Billing</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1248</item>
<item key="last_name">Burton</item>
<item key="address2">Suite 200</item>
<item key="state">CA</item>
<item key="email">[email protected]</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550136</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Bill</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="reg_domain">example2rwetw42tt4t.com</item>
<item key="encoding_type"></item>
<item key="custom_tech_contact">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Domain registration successfully completed.</item>
<item key="attributes">
<dt_assoc>
<item key="registration_code">435</item>
<item key="id">3735283</item>
<item key="forced_pending">3735283</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Example 3
About this example:
- This is a new domain name registration.
- No custom tech contact is set.
- DNS is enabled but no records are defined.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">SW_REGISTER</item>
<item key="attributes">
<dt_assoc>
<item key="f_parkp">Y</item>
<item key="reg_username">daniel</item>
<item key="reg_password">sadfl222ksdflsdkjf</item>
<item key="dns_template">*blank*</item>
<item key="affiliate_id"></item>
<item key="auto_renew"></item>
<item key="domain">example.com</item>
<item key="reg_type">new</item>
<item key="f_whois_privacy">1</item>
<item key="period">1</item>
<item key="link_domains">0</item>
<item key="custom_nameservers">1</item>
<item key="f_lock_domain">1</item>
<item key="reg_domain"></item>
<item key="encoding_type"></item>
<item key="custom_tech_contact">0</item>
<item key="contact_set">
<dt_assoc>
<item key="owner">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Owner</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1902</item>
<item key="last_name">Ottway</item>
<item key="address2">Suite 500</item>
<item key="state">CA</item>
<item key="email">[email protected]</item>
<item key="city">SomeCity</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550124</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Owen</item>
</dt_assoc>
</item>
<item key="admin">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Admin</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1812</item>
<item key="last_name">Adams</item>
<item key="address2">Suite 100</item>
<item key="state">CA</item>
<item key="email">[email protected]</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550125</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Adler</item>
</dt_assoc>
</item>
<item key="billing">
<dt_assoc>
<item key="country">US</item>
<item key="address3">Billing</item>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1248</item>
<item key="last_name">Burton</item>
<item key="address2">Suite 200</item>
<item key="state">CA</item>
<item key="email">[email protected]</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550136</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Bill</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Response
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">Domain registration successfully completed
Domain successfully locked.
Whois Privacy successfully enabled.</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">[email protected]</item>
<item key="registration_text">Domain registration successfully completed
Domain successfully locked.
Whois Privacy successfully enabled.</item>
<item key="registration_code">200</item>
<item key="id">177411</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Updated 23 days ago