Domain Create

Resource path: /Domain/Create

The command is intended to register a new domain; while there are dozens of optional parameters, only a few are required, other parameters can be safely ignored and used only if and when you really need them.

HTTPS POST/GET Request parameters:

Parameter name	Description
ApiKey	The API key that we provided to you when you requested API access for your account
Password	The password we provided when you requested API access for your account
Domain	Domain name including extension (ex: example.com)
CloneContactsFromDomain (optional contacts cloning from an existing domain)	If CloneContactsFromDomain is used then any other contact related parameter is ignored. This parameter has to contain a domain name you already registered. It also has to be "Compatible" with the domain being registered. "Compatible" means that it has to support the same contact types and with the same data. Ex 1: a .com domain cannot be set as the value of this parameter when registering a .eu or a .uk domain because they support different contact types and/or format. Ex 2: a .com domain cannot be set as the value of this parameter when registering a .asia domain because they have different fields. For a .asia, at least one of the contacts has to have some additional data that a .com doesn't have. For simplicity we suggest to use CloneContactsFromDomain only for domains of the same extension
<contactType>_<contactField> (mandatory unless you used CloneContactsFromDomain)	The parameter is used to specify the corresponding whois data for the domain you are registering: Valid values for contactType are: Registrant Admin Technical Billing For .Com/.Net/.Asia/.Biz/.Info/.Mobi and .Org domains the following contactTypes are all mandatory: Registrant, Admin, Technical and Billing. For each contactType the following contactFields are mandatory: FirstName LastName Email PhoneNumber Street City CountryCode PostalCode While for each contactType the following contactFields are optional: Organization Street2 Street3 Please refer to the table <contactField> for the complete list of all contactFields and the corresponding meaning and usage. Examples: Registrant_FirstName Registrant_LastName Registrant_Organization (optional) Registrant_Email Registrant_PhoneNumber Registrant_Street Registrant_Street2 (optional) Registrant_Street3 (optional) Registrant_City Registrant_CountryCode Registrant_PostalCode Admin_FirstName Admin_LastName Admin_Email .... Technical_FirstName Technical_LastName Technical_Email .... Billing_FirstName Billing_LastName Billing_Email ... Following comments apply to .ASIA ONLY Accordingly to Asia Charter Eligibility Declaration, at least one CED contact is mandatory for .asia domains and it needs to be attached to one of the mandatory contactTypes. For CED contacts the following fields are mandatory DotAsiaCedLocality DotAsiaCedEntity DotAsiaCedIdForm Possible field values for DotAsiaCedEntity are: naturalPerson, corporation, cooperative, partnership, government, politicalparty, society, institution and other If DotAsiaCedEntity is set to ‘other’ then the DotAsiaCedEntityOther field is also mandatory Possible field values for DotAsiaCedIdForm are: passport, certificate, legislation, societiesregistry, policalpartyregistry, other If DotAsiaCedIdForm is ‘other’ then the DotAsiaCedIdFormOther field is also mandatory And optional CED fields are DotAsiaCedCity DotAsiaCedIdNumber DotAsiaCedStateProvince Following comments apply to .EU ONLY For Eu domains, only the Registrant contactType is supported and the following contactFields are mandatory: FirstName LastName Language Email PhoneNumber Street City CountryCode PostalCode And the following contactFields are optional: Company Street2 Stree3 Following comments apply to .UK ONLY For Uk domain, only the Registrant and Admin contactType are mandatory. There can be up to 3 admin contacts however just one is mandatory. If you need setting the second and the third admin contact use the construct: <contactType>_<cardinality>_<contactField> where contactType has to be "admin", cardinality can assume values "2" or "3" where 2 stands for second and 3 stands for third. and contactField possible values are described below. By example, if you want to add two admin contacts you will have the following fields in your request: admin_firstname, admin_lastname, ..., admin_2_firstname, admin_2_lastname, .... For Registrant contactType, mandatory contactFields are: FirstName LastName And optional contactFields are Organization DotUkOrgType DotUkRegistrationNumber DotUkOptOut For Admin contact, mandatory contactFields are: FirstName LastName Email Street CountryCode PostalCode Note that the following contactFields: Street, CountryCode and PostalCode are mandatory for the first admin contact only. For the second and third admin contacts those fields are ignored. You can also add the following optional contactFields to each contactType: PhoneNumber DotUkMobile City County Following comments apply to .FR/.RE/.PM/.TF/.WF/.YT For those domains, Registrant and Admin contactTypes are supported and the following contactFields are mandatory: Email PhoneNumber Street City CountryCode PostalCode And the following contactFields are optional: Street2 Stree3 For registrant and admin contact types Identification Information is needed and following fields are mandatory: dotFRContactEntityType there are following 5 types of holder type: INDIVIDUAL for Individual COMPANY for company TRADEMARK for TradeMark owner ASSOCIATION for association OTHER for other types For INDIVIDUAL following fileds are mandatory FirstName LastName dotFRContactEntityBirthDate [YYYY-MM-DD] dotFrContactEntityBirthPlaceCountryCode And following fields are optional * dotFRContactEntityBirthCity dotFRContactEntityBirthPlacePostalCode dotFRContactEntityRestrictedPublication * if user provides FR as birth place country code then birth city and birth place postal code are also mandatory For COMPANY following fields are mandatory dotFRContactEntityName Optional fields: dotFRContactEntityVat, dotFRContactEntitySiren, dotFRContactEntityDuns. For TRADEMARK following fields are mandatory dotFRContactEntityName dotFRContactEntityTradeMark Optional fields: dotFRContactEntityVat, dotFRContactEntitySiren, dotFRContactEntityDuns. For ASSOCIATION follow fields are mandatory dotFRContactEntityName dotFrContactEntityWaldec Or dotFRContactEntityDateOfAssocation [YYYY-MM-DD] dotFRContactEntityDateOfPublication [YYYY-MM-DD] dotFRContactEntityAnnounceNo dotFRContactEntityPageNo Optional fields: dotFRContactEntityVat, dotFRContactEntitySiren, dotFRContactEntityDuns. For OTHER following fields are mandatory dotFRContactEntityName dotFROtherContactEntity Optional fields: dotFRContactEntitySiren, dotFRContactEntityTradeMark, dotFRContactEntityVat, dotFRContactEntityDuns. For registrant contact following fields can be updated: restricted publication for individual ContactEntity email phone no mailing address For admin contact anything can be updated Also for COMPANY, TRADEMARK, ASSOCIATION and OTHER entity types you can specify the DUNS (Data Universal Numbering System): http://en.wikipedia.org/wiki/Data_Universal_Numbering_System For Domain Create/Trade Registrant and Admin Contact are needed while for Transfer only Admin contact is needed, registrant contact not needed. Following comments apply to .IT ONLY dotitEntityType (for Registrant contact only) Allowed values: 1,2,3,4,5,6,7 where: 1. Italian and foreign natural persons 2. Companies/one man companies 3. Freelance workers/professionals 4. non-profit organizations 5. public organizations 6. other subjects 7. foreigners who match 2-6. dotitNationality (for Registrant contact only) Must be one of the ISO 3166-1 codes (e.g.: IT, FR, NL, ..). If the Registrant is not a natural person (registrant_dotitEntityType 1) it must be equal to the registrant country code value. If the Registrant is a natural person (registrant_dotitEntityType = 1), the registrant country code and Nationality (registrant_dotitNationality) fields may differ but at least one of them must correspond to the ISO 3166-1 code of a country belonging to the European Union. dotitRegCode (for Registrant contact only) If the requester is an Italian natural person it contains his/her Codice Fiscale. For foreigners it can contain a document number. For associations without VAT number and numeric tax code must be equal to "n.a.". In all the other cases must be equal to VAT number (in the 11 numbers format if registrant_dotitNationality=IT) or the numeric tax code. dotitHideWhois Possible field values: YES, NO. If the "dotitHideWhois" field is marked as "NO" the Registrant address details will be displayed on the public WHOIS. dotitProvince For Italian (IT) the province must contain the two letters corresponding to an Italian province. For other country field must contain province/state/region name. For natural person only Registrant contact is needed, Admin contact not needed. .IT terms and conditions You have to obtain the contact data and the explicit acceptance of any declaration of the assumption of responsibility for the registration of domain names on the basis of the registration form (see full text of terms ans condition: http://internetbs.net/ResellerRegistrarDomainNameAPI/nicit_terms.html). The following parameters are mandatory for domain registration, trade and transfer operation: dotItTerm1 (Declarations and assumptions of liability) Possible field values: YES, NO. If NO is used the request will fail. dotItTerm2 (Consent to the processing of personal data for registration) Possible field values: YES, NO. If NO is used the request will fail dotItTerm3 (Consent to the processing of personal data for diffusion and accessibility via the Internet) Possible field values: YES, NO. Both values allow to complete operation. dotItTerm4 (Explicit Acceptance of the following points) Possible field values: YES, NO. If NO is used the request will fail clientIp IP address of user requesting the operation. You must show full text of terms and conditions to your customer before domain registration, trade and transfer operation. If the transfer is from another registrar and not from a maintainer the contact data will be ignored. Following comments apply to .US ONLY Following parameters are required for Registrant contact only: usPurpose - It specifies the intended purpose of the domain name registration. Allowed values are: P1, P2, P3, P4 and P5 where: P1 - Business use for profit P2 - Non-profit business, club, association, religious organization, etc. P3 - Personal use P4 - Educational purposes P5 - Government purposes usNexusCategory - It specifies the Nexus category to which the registering organization belongs. Allowed values: C11, C12, C21, C31 and C32 where: C11 - A natural person who is a US Citizen C12 - A natural person who is a Permanent Resident C21 - An entity or organization that is (i) incorporated within one of the fifty US states, the District of Columbia, or any of the US possessions or territories, or (ii) organized or otherwise constituted under the laws of a state of the US, the District of Columbia or any of its possessions and territories (including federal, state, or local government of the US, or a political subdivision thereof, and non-commercial organizations based in the US.) C31 - A foreign organization that regularly engages in lawful activities (sales of goods or services or other business, commercial, or non-commercial, including not for profit relations) in the United States. C32 - Organization has an office or other facility in the US usNexusCountry** - It is required if the usNexusCategory is C31 or C32 and ignored in all other cases. It has to be a valid 2 letters country code (Ex: BS, GB, FR, :)
<contactType>_ <cardinality>_ <contactField> (optional and for .uk only)	Used exclusively for .uk domains when you need a second and a third contactType of the same kind. See <contactType>_<contactField> for more details. Examples:
Period (optional)	The period for which the domain is registered for. Presently the only valid values are 1Y, 2Y up to 10Y where Y stands for years. By default 2Y is used.
Ns_list (optional)	List of name servers, delimited by comma. After each name server you can optionally glue one or more IP separated by a single space character. Example (two nameservers without glue records): ns1.example.com, ns2.example.com Example 2 (two nameservers with one glue record each): ns1.example.com 192.5.4.3, ns2.example.com 201.9.21.72 You can also glue multiple IP to each name server separating each IP by a single space character. Example 3 (two nameservers, the first one with two IP addresses and second one with a single IP address): ns1.example.com 144.1.2.3 211.4.5.6, ns2.example.com 177.24.25.116
transferAuthInfo (optional)	If not provided, for domains supporting it, will be automatically generated by us. It is also called Transfer key, EPP AUTH info, domain secret, domain password. It is not supported for EU, UK, .BE domains.
registrarLock (optional)	To prevent your domain from being stolen, the default value is ENABLED. You can set ENABLED or DISABLED. You need to change it to DISABLED just before you need to transfer your domain away. It is not supported for all domains because not all registries are offering this feature. Please use the /domain/check command to see if it is allowed or not for an extension.
telHostingAccount (required only for .tel domains)	This field is required only for .tel domains and it is ignored for all other domains. It represents the account name where the domain should be placed under the .tel hosting platform. If the account exists and the password is correct the domain will be placed under this account. If the account does not exist it will be created first and then the domain will be placed under that account. An email will be sent to the registrant with instructions on how to login and manage the .tel domain after registration or when a transfer has been completed. NOTE: There is no relation between you account on our website, and the user and password for .tel control panel. For more details please read: http://www.telnic.org/faq.html
telHostingPassword (required only for .tel domains)	This field is required only for .tel domains and it is ignored for all other domains. It represents the .tel hosting account password. The password is required even if the account already exists in order to validate the user owns that account by knowing the password and he/she is not placing the domain under the wrong .tel Hosting account by mistake.
telHideWhoisData (optional and only for .tel domains)	Possible values are YES and NO. The default value is set to NO. This field will be ignored if the registrant is a company (i.e. the registrant_organization field was not empty). It is valid only for individuals. If the value is set to YES the public whois will only show partial contact data (i.e. contact names)
privateWhois (optional)	By default it is set to DISABLE, possible values are FULL, PARTIAL and DISABLE. It is not supported for all domains. Please use the /domain/check command to see if it is allowed or not for an extension. If you try to use FULL or PARTIAL for a domain that does not support Private Whois a message will be returned along with the response: NOTADMITTED. For /domain/update the command will not perform any update if this parameter is present and will return an error message.
AutoRenew (optional)	Enable or disable domain automatic renewal. Possible values are YES, NO. Default value is NO.
discountCode (optional)	If you have a discount code that would grant you a better price you can use it here. If the discount code is provided and it does not exist or it is not valid anymore it will show up as an error.
ResponseFormat (optional)	This specifies how the response will be returned. Possible values are TEXT, JSON and XML. The default value is TEXT however we encourage you to use JSON for easier result parsing (please refer to http://www.json.org for more details about JSON).

<contactField> possible values:

<contactField>	Description
Firstname	Contact first name
Lastname	Contact last name
Organization (optional)	The company name
CountryCode	The country code
City	The city
Email	The email address of the contacts
Street	The line 1 of street address
Street2 (optional)	The line 2 of street address
Street3 (optional)	The line 3 of street address
PostalCode	The address postal code
PhoneNumber	The phone number (format:+1.23456789)
Fax (optional)	The fax number (format:+1.23456789). Currently it is only suppported for .uk but will be supported for all domains in the future)
ObfuscateEmail (optional)	It is only supported for .com/.net/.tv domain contacts and it means it will replace in the email shown in the public whois the "@" with "(at)" and the "." with "(dot)" (without quotes). Possible values are 1 and 0. 1 means to obfuscate and 0 means to not obfuscate. By default it is 1. Note that when private whois is enabled for a domain the email will be shown in the public whois without any obfuscation even if you set this parameter to 1. It only has effect when the Private Whois service is disabled.
dotUKOrgType (required only for .uk)	Organization type. It is used only for .uk domain contacts (registrant contact only). Possible values are: LTD* for UK Limited Company PLC for UK Public Limited Company PTNR for UK Partnership STRA for UK Sole Trader LLP for UK Limited Liability Partnership IP for UK Industrial/Provident Registered Company IND for UK Individual (self representing) SCH for UK School RCHAR for UK Registered Charity GOV for UK Government Body CRO for UK Corporation by Royal Charter STAT for UK Statutory Body OTHER for UK Entity that does not fit into any of the above FIND for Non-UK Individual (self representing) FCORP for Non-UK Corporation FOTHER for Non-UK Entity that does not fit into any of the above
dotUkOrgNo (optional and only for .uk)	Organization number. It is mandatory if dotUKOrgType is one of the following: LTD, PLC, LLP, IP, SCH, RCHAR
dotUKOptOut (optional and only for .uk)	Option to hide data in the public whois. Possible values: Y (yes hide) and N (no do not hide). It can be specified only for IND organization type
dotUKLocality (required only for .uk)	Locality for .uk contacts
dotUKCounty (required only for .uk)	County for .uk contacts
dotUKMobile (optional and only for .uk)	The mobile phone number for .uk registrant contact
dotUKRegistrationNumber (optional and only for .uk)	The company registration number for .uk registrant contact. It is not optional for some organization types (‘LTD’ , ‘PLC’ , ‘LLP’ , ‘IP’ , ‘SCH’ , ‘RCHAR’)
dotASIACedLocality (optional and only for .asia)	Charter eligibility declaration locality for .asia contacts. Mandatory for at least one of the contacts that are assigned to a domain.
dotASIACedCity (optional and only for .asia)	Charter eligibility declaration city for .asia contacts. Mandatory for only one of the contacts that are assigned to a domain.
dotASIACedStateProvince (required only for .asia)	Charter eligibility declaration state/province for .asia contacts. Mandatory for only one of the contacts that are assigned to a domain.
dotASIACedEntityType (required only for .asia)	Legal entity type for Charter eligibility declaration (also for .asia and also mandatory for one of the contacts attached to a .asia domain). Possible values are: naturalPerson, corporation, cooperative, partnership, government, politicalParty, society, institution, other
dotASIACedEntityOther (optional and only for .asia)	Entity type if CED_entity_type is set to "other".
dotASIACedIdForm (required only for .asia)	The identification form for the charter eligibility declaration. Possible values are: passport, certificate, legislation, societiesRegistry, politicalPartyRegistry, other. If other is set the CED_if_other field must be set
dotASIACedIdNumber (required only for .asia)	The CED identification number of the identification form specified.
dotASIACedIdFormOther (optional and only for .asia)	The identification form.
dotFRContactEntityType (mandatory)	The registrant/admin entity type.
dotFRContactEntityBirthDate (mandatory for INDIVIDUAL ContactEntityType)	Birth date of the registrant/admin if it is an INDIVIDUAL ContactEntity
dotFRContactEntityBirthPlaceCountryCode (mandatory for INDIVIDUAL ContactEntity type)	Birth country of the registrant/admin if it is an INDIVIDUAL ContactEntity
dotFRContactEntityBirthCity(optional but mandatory if birth country code is fr)	Birth city of the registrant/admin if it is an INDIVIDUAL ContactEntity
dotFRContactEntityBirthPlacePostalCode(optional but mandatory if birth country code is fr)	Birth place postal code of the registrant/admin if it is an INDIVIDUAL ContactEntity
dotFRContactEntityRestrictedPublication (optional)	Restricted publication, option for individual ContactEntity, values are 1 for restricted, 0 for non-restricted. Default is non-restricted
dotFRContactEntityName(mandatory for company, trademark, association and other ContactEntity type)	For company, trademark, association and other ContactEntity type ContactEntity name is mandatory
dotFRContactEntitySiren(Mandatory for company ContactEntity type)	Siren number for company ContactEntity type
dotFRContactEntityTradeMark(Mandatory for trade mark ContactEntity type)	TradeMark number for trademark owner ContactEntity type
dotFRContactEntityWaldec	Indicates the identifier Waldec linked to an association. If this identifier is provided, this is sufficient to identify an association.
dotFRContactEntityDateOfAssocation	Date of association [YYYY-MM-DD] for association ContactEntity type
dotFRContactEntityAnnounceNo	Will contain the date of publication in the official gazette for association ContactEntity type
dotFRContactEntityDateOfPublication	Date of Publication [YYYY-MM-DD] of the announcement for association ContactEntity type
dotFRContactEntityPageNo	Page number of the announcement for association ContactEntity type
dotFROtherContactEntity	Other ContactEntity type value. Describes the entity type if it is none of the mentioned ones.
dotFRContactEntityVat (optional)	This Vat field is optional and can be used with any entity type.
dotFRContactEntityDUNS (optional)	DUNS - Data Universal Numbering System. This will be used by the registry along with the SIREN, VAT, Trademark for verifying the registrant. If false contact details are provided the registry might delete the domain.

Returned data:

STATUS=SUCCESS or PENDING or FAILURE
TRANSACTID=Transaction ID reference
Domain=domain name
DomainExpiration=Date
privateWhois=DISABLED or FULL or PARTIAL

Example:

https://testapi.internet.bs/Domain/Create?ApiKey=testapi&Password=testpass&CloneContactsFromDomain=test-api-domain11.com&Domain=example.net

Result:

transactid=820b6791e386b31b354e613a6371c7bc
currency=USD
price=13.9
product_0_price=13.9
product_0_status=SUCCESS
product_0_domain=example.com
product_0_expiration=2010/04/02

Example:

https://testapi.internet.bs/Domain/Create?ApiKey=testapi&Password=testpass&Domain=testing-apitest.com&registrant_firstname=api-firstname&registrant_lastname=api-lastname&registrant_organization=api-company&registrant_street=api-street&registrant_countrycode=bd&registrant_postalcode=123456789&registrant_email=api.reg@email.com&registrant_obfuscateemail=1&registrant_phonenumber=%2B880.1913949283&technical_firstname=api-firstname&technical_lastname=api-lastname&technical_organization=api-company&technical_street=api-street&technical_countrycode=bd&technical_postalcode=123456789&technical_email=api.tech@email.com&technical_phonenumber=%2B880.1913949283&admin_firstname=api-firstname&admin_lastname=api-lastname&admin_organization=api-company&admin_street=api-street&admin_countrycode=bd&admin_postalcode=123456789&admin_email=api.admin@email.com&admin_phonenumber=%2B880.1913949283&registrant_city=city&technical_city=city&admin_city=city&billing_firstname=api-firstname&billing_lastname=api-lastname&billing_organization=api-company&billing_street=api-street&billing_countrycode=bd&billing_postalcode=123456789&billing_email=api.admin@email.com&billing_phonenumber=%2B880.1913949283&registrant_city=city&technical_city=city&billing_city=city&privatewhois=partial&period=4y

Result:

transactid=83d2537eba3982b572697e7ade070d04
currency=USD
price=30.6
product_0_privatewhois=partial
product_0_price=30.6
product_0_status=SUCCESS
product_0_domain=testing-apitest.com
product_0_expiration=2013/05/04

<< Back API Home Next >>

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

2Checkout.com ist ein bevollmaechtigter Wiederverkaeufer fuer Internet.bs Corp.

Gegründet im Jahr 2003

Domain Create