Contact API Reference

Methods

contact.activate(apikey, handle)

Activate a contact.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
Returns:

boolean – 1 if the operation succeeded
contact.available_currencies(apikey)

Lists available currencies for a contact.

Result depend on contact properties (BU and country).

Parameters:apikey (string) – API connection key
Returns:array – List of currencies
contact.balance(apikey)

Get contact financial balance.

Parameters:apikey (string) – API connection key
Returns:struct – Financial balance
contact.balance_fo(apikey)

Get contact financial balance with hosting grid information.

Parameters:apikey (string) – API connection key
Returns:struct – Financial balance
contact.balance_v5(apikey)

Get contact v5 financial balance.

Parameters:apikey (string) – API connection key
Returns:struct – Financial balance
contact.become_reseller(apikey)

Converts the contact to a reseller.

Parameters:apikey (string) – API connection key
Returns:boolean – 1 if contact is updated, otherwise raise an error
contact.can_associate(apikey, contact, params)

Check if a contact description can be associated to a domain.

Parameters:
Returns:

boolean – 1 on success, 0 otherwise
contact.can_associate_bulk(apikey, tlds, params)

Check if a contact description can be associated to a domain.

Parameters:
  • apikey (string) – API connection key
  • tlds (array) – Parameters
  • params (struct) – Parameters
Returns:

boolean – 1 on success, 0 otherwise
contact.can_associate_domain(apikey, handle, params)

Check if a contact can be associated to a domain.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
  • params (struct) – Parameters
Returns:

boolean – 1 on success, 0 otherwise
contact.can_associate_domain_fo(apikey, handle, params)

Test if a contact can create a domain

Parameters:
  • apikey (string) – API connection key
  • handle (struct) – Handle of the contact
  • params (struct) – Parameters
Returns:

boolean – 1 if the contact can be associated to the domain
contact.can_try_hosting(apikey)

Test if a contact can subscribe to hosting trial

Parameters:apikey (string) – API connection key
Returns:boolean – 1 if contact can subscribe, 0 otherwhise
contact.can_try_paas(apikey)

Test if a contact can subscribe to paas trial

Parameters:apikey (string) – API connection key
Returns:boolean – 1 if contact can subcsribe, 0 otherwhise
contact.clone(apikey, handle[, params=nil])

Clone a contact.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – The contact to clone
  • params (struct) – Parameters
Returns:

struct – Contact information
contact.count(apikey[, opts=nil])

Count contacts associated to the one represented by apikey.

New in version 3.2.7.

Note

Non reseller cannot have “associated” contacts and will always get 0 as result.

Parameters:
Returns:

int – Number of contacts
contact.count_bo(apikey[, opts=nil])

Count contacts associated to the one represented by apikey.

Parameters:
Returns:

int – Number of contacts
contact.count_v5(apikey[, opts=nil])

Count contacts associated to the one represented by sharing_entity.

This method does not check that the contact is permitted to do that, this is an underlying call from v5 that already check it.

Parameters:
Returns:

int – Number of contacts
contact.create(apikey, params)

Create a contact.

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

struct – Contact information
contact.create_dry_run(apikey, params)

Dry run method for create().

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

array – Validation errors
contact.create_minimal(apikey, params)

Create a contact id/handle for the v5 OAuth2 back reference.

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

struct – Contact information
contact.deactivate_bo(apikey, handle)

Deactivate a contact.

New in version 3.3.35.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
Returns:

boolean – 1 if the operation succeeded
contact.delete(apikey[, handle=nil])

Delete a contact.

If no handle is provided, the contact represented by apikey is deleted.

New in version 3.1.9.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
Returns:

boolean – 1 if the operation succeed
contact.delete_bo(apikey[, handle=nil])

Delete a contact without checking for access.

If no handle is provided, the contact represented by apikey is deleted.

New in version 3.3.5.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
Returns:

boolean – 1 if the operation succeed
contact.desc_extras(apikey, handle, opts)

Give the extra parameters needed for an update

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
  • opts (struct) – Filtering options
Returns:

struct – extras
contact.info(apikey[, handle=nil])

Get contact information.

If no handle is provided, information about the contact represented by apikey are returned.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
Returns:

struct – Contact information
contact.info_bo(apikey[, handle=nil])

Give all information on the given contact

Parameters:
  • apikey (string) – API connection key
  • handle (struct) – the contact handler
Returns:

struct – the contact in detail
contact.info_orga_v5(apikey[, handle=nil])

Return information about a contact which has a v5 role by asking Orga for informations

Parameters:
  • apikey (string) – API connection key
  • handle (struct) – the contact handle
Returns:

struct – organization parameters
contact.list(apikey[, opts=nil])

List contacts associated to the one represented by apikey.

Note

Non reseller cannot have “associated” contacts and will always get an empty result.

Parameters:
Returns:

list of struct – Contact information
contact.list_bo(apikey[, opts=nil])

List contacts associated to the one represented by apikey.

Parameters:
Returns:

struct – Contact information
contact.list_v5(apikey[, opts=nil])

List contacts associated to the one represented by sharing_entity.

This method does not check that the contact is permitted to do that, this is an underlying call from v5 that already check it.

Parameters:
Returns:

list of struct – Contact information
contact.merge_handle(apikey, new_handle, old_handle)

Do stuff related to merge an handle into a new one.

Parameters:
  • apikey (string) – API connection key
  • new_handle (struct) – the handle to merge into
  • old_handle (struct) – the merged handle
Returns:

string – merge result
contact.password_change(apikey, old_password, new_password)

Change the old password into the new password (if the old one is the correct one)

Parameters:
  • apikey (string) – API connection key
  • old_password (string) – the previous password
  • new_password (string) – the new password
Returns:

boolean – the status of the change (can raise if the old password ok)
contact.release(apikey, handle)

Release a contact from a reseller account.

A reseller account may manage multiple contacts. This method allows releasing one of them.

Note

Only resellers can use this method. It will have no effect for other kind of accounts.

New in version 3.2.9.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle of the contact to release
Returns:

boolean – 1 if the operation succeed
contact.release_v5(apikey, handle, params)

Release a contact and all its domains from a reseller account.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle of the contact to release
  • params (string) – Gandi handle of the contact to release
Returns:

struct – Operation contact_release
contact.resend_validation(apikey)

Ask the backend to send again the email validation mail.

New in version 3.2.12.

Parameters:apikey (string) – API connection key
Returns:boolean – 1 on success
contact.sudo(apikey[, handle=nil])

Give apikey information on the given contact

Parameters:
  • apikey (string) – API connection key
  • handle (struct) – the contact handler
Returns:

struct – the contact in detail
contact.update(apikey, handle, params)

Update a contact.

If the contact is associated to some domains, the same rules as in can_associate_domain() will be applied, and the domains will be updated if possible.

If no handle is provided, information about the contact represented by apikey are returned.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
  • params (struct) – Parameters
Returns:

struct – Contact information
contact.update_bo(apikey, handle, params)

Update a contact without checks.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
  • params (struct) – Parameters
Returns:

struct – Contact information
contact.update_bu_bo(apikey, handle, params)

Update a BU for a contact It’s for contat who refuses the migration to a new BU

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
  • params (struct) – Parameters
Returns:

boolean – 1 if contact is updated, otherwise raise an error
contact.update_dry_run(apikey, handle, params)

Dry run method for update().

Parameters:
  • apikey (string) – API connection key
  • handle (string) – Gandi handle
  • params (struct) – Parameters
Returns:

array – Validation errors
contact.validate_email(apikey, params)

Validate contact email address.

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

boolean – 1 if the operation succeed
contact.validate_email_bo(apikey, handle)

Force contact email address validation.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – The contact to validate
Returns:

boolean – 1 if the operation succeed
contact.reachability.count_bo(apikey[, opts=nil])

Count all the reachability objects.

Parameters:
Returns:

int – Number of reachability
contact.reachability.info(apikey, reachability)

Get Reachability information.

Parameters:
  • apikey (string) – API connection key
  • reachability (struct) – The reachability
Returns:

struct – Informations about the reachability
contact.reachability.list_bo(apikey[, opts=nil])

List all the reachability objects.

Parameters:
Returns:

list of struct – Reachability information
contact.reachability.resend(apikey, params)

Resend the reachability validation message to the contact. ICANN-accredited Registrars have to verify contact information. The contact.create(), contact.update() and domain.create() send messages to the created contact in order to validate its information. This method is about to resend immediately this verification message if the contact has not acknowledge the previous message. Use the contact.reachability.info() to get the validation status of the contact.

New in version 3.3.14.

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

boolean – 1 if succeed
contact.reachability.resend_v5(apikey, params)

Resend the reachability validation message to the owner contact of this domain. ICANN-accredited Registrars have to verify contact information. The contact.create(), contact.update() and domain.create() send messages to the created contact in order to validate its information. This method is about to resend immediately this verification message if the contact has not acknowledge the previous message. Use the contact.reachability.info() to get the validation status of the contact.

New in version 3.3.36.

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

boolean – 1 if succeed
contact.reachability.reset_bo(apikey, target)

Reset the reachability status

Parameters:
  • apikey (string) – API connection key
  • target (struct) – The contact to reset
Returns:

boolean – 1 if succeed
contact.reachability.unlock(apikey, reachability)

Validate the reachability and unhold all the domains

Parameters:
  • apikey (string) – API connection key
  • reachability (struct) – The reachability
Returns:

boolean – 1 if succeed
contact.reachability.validate(apikey, valid_hash)

Validate the reachability, without being connected

Parameters:
  • apikey (string) – API connection key or empty
  • valid_hash (string) – The validation key
Returns:

boolean – 1 if succeed
contact.shipping.count_bo(apikey, options)

Return the number of shipping addresses

Parameters:
Returns:

int – Number of contact registry
contact.shipping.delete(apikey[, handle=nil])

Delete the shipping address for the contact

Parameters:
  • apikey (string) – API connection key
  • handle (string) – the contact handle
Returns:

boolean – a boolean stating the operation
contact.shipping.get(apikey, handle, date)

Give the shipping address for a contact or an empty dict if none is defined.

Parameters:
  • apikey (string) – API connection key
  • handle (string) – the contact handle
  • date (string) – the validity date
Returns:

struct – the contact shipping address in detail
contact.shipping.get_bo(apikey, handle, date)

INTERNAL

Give the shipping address for a contact or an empty dict if none is defined.

Parameters:
  • apikey (string) – API connection key
  • handle (struct) – the contact handler
  • date (dateTime.iso8601) – the validity date
Returns:

struct – the contact in detail
contact.shipping.list_bo(apikey, options)

Return all the shipping addresses

Parameters:
Returns:

struct – the contact in detail
contact.shipping.set(apikey, shipping_address)

Set the shipping address for a contact

Parameters:
Returns:

struct – the contact shipping address in detail
contact.autofoa.count(apikey[, opts=nil])

This method returns the number of Right Delegations associated to the Contact represented by apikey

Warning

this method works only for Reseller Contacts

Parameters:
Returns:

int – number of AutoFoa
contact.autofoa.create(apikey, params)

This method creates a new Right Delegation and associates it to the Contact represented by apikey.

An email containing an authentication code used to activate Right Delegation will be sent upon completion of this call to the address for which the Delegation is being created.

The Right Delegation is created but not activated and can be activated using the link in the email or the api.contact.autofoa.validate API method.

Warning

this method works only for Reseller Contacts

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

struct – AutoFoa
contact.autofoa.delete(apikey, autofoa_id)

Given an ID this method deletes an existing Right Delegation associated to the Contact represented by apikey.

Warning

this method works only for Reseller Contacts

Parameters:
  • apikey (string) – API connection key
  • autofoa_id (int) – AutoFoa unique identifier
Returns:

boolean – 1
contact.autofoa.list(apikey[, opts=nil])

List all the Right Delegations associated to the Contact represented by apikey

Warning

this method works only for Reseller Contacts

Parameters:
Returns:

struct – list of AutoFoa
contact.autofoa.validate(apikey, autofoa_id, code)

This method is used to validate a Right Delegation.

It takes an ID and the authentication code which have been sent to the email on which the Right Delegation is to be set-up and activates the Right Delegation.

This is an alternative to validating the Right Delegation through the web.

Warning

this method works only for Reseller Contacts

Parameters:
  • apikey (string) – API connection key
  • autofoa_id (int) – AutoFoa unique identifier
  • code (int) – AutoFoa code
Returns:

boolean – 1

Parameters

ContactCheckDomain

parameter of contact.can_associate_domain_fo(), contact.can_associate_domain(), contact.can_associate() and internal.contact.can_associate_domain()

Name Default Type Mandatory
domain   string yes
the domain tld
admin   boolean no
the domain admin contact
api-version 3 string no
bill   boolean no
the domain bill contact
context   string no
the context in which this call is made
extra_parameters   struct no
the extra parameters needed to get the domain
owner   boolean no
the domain owner contact
tech   boolean no
the domain tech contact
tld_phase golive string no
the phase in which you want to domain
ContactType

used by BillingContactV5, ContactCreateFormDescriptionV5, ContactCreateFormDescription, ContactFoListOptions, ContactListOptions, ContactUpdateBOFormDescription, DomainContactV5, InternalContactListOptions, InternalPaymentListFilterOptions, MinimalBillingContactV5, MinimalContactCreateFormDescription and ReachabilityListOptions

Name Description
0 person
1 company
2 association
3 public body
4 reseller
ContactUpdateBU

parameter of contact.update_bu_bo()

Name Default Type Mandatory
bu_id   int no
bu_lock False boolean no
Context

used by ContactCheckDomain and DescExtraParameters

Name Description
  -
update api.contact.update
can_associate_domain api.contact.can_associate_domain
can_associate api.contact.can_associate
domain_transfer_in api.domain.domain_transfer_in
domain_create api.domain.create
domain_contact_change api.domain.contacts.set
DescExtraParameters

parameter of contact.desc_extras()

Name Default Type Mandatory
context   string no
domains   array of string no
ignore_contact False boolean no
roles   array of string no
tld_phase golive string no
type   int no
ExtraParameters

used by ContactCheckDomain and DomainContactV5

Changed in version 3.3.38: keys x-vn_registrant_ident_number, x-my_passport_number, x-vn_registrant_prefix, x-dk_ident_number, x-no_ident_number, x-pl_company_number, x-pl_vatid, x-al_id_type, x-dk_registrant_vatid, x-ma_vatid, x-vn_registrant_birth_date, x-au_registrant_domain_relation_type, x-ee_company_number, x-vn_company_number, x-xn--55qx5d_registrant_document_number, x-al_vatid, x-au_registrant_id_type, x-ax_business_number, x-au_registrant_id_number, x-ma_id_number, x-sa_company_number, x-eu_country_of_citizenship, x-xn--io0a7i_registrant_document_number, x-al_id_number, x-xn--io0a7i_registrant_document_type, x-pl_ident_number, x-au_registrant_organization, x-xn--fiqs8s_registrant_document_number, x-ax_id_number, x-fi_birthdate, x-cn_registrant_document_type, x-vn_registrant_job, x-dk_admin_vatid, x-zuerich_uid_number, x-xn--fiqs8s_registrant_document_type, x-ee_birthdate, x-xn--55qx5d_registrant_document_type, x-cn_registrant_document_number, x-au_registrant_domain_relation have been added.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Changed in version 3.3.37: keys x-az_admin_pp_id, x-az_registrant_pp_id, x-az_billing_pp_id, x-rs_company_number, x-it_nationality, x-az_registrant_company_number, x-tw_company_number, x-lt_registrant_legal_id, x-az_tech_pp_id have been added.
x-az_admin_pp_id parameter.
x-az_registrant_pp_id parameter.
x-az_billing_pp_id parameter.
.
x-it_nationality parameter.
x-az_registrant_company_number parameter.
.
x-lt_registrant_legal_id parameter.
x-az_tech_pp_id parameter.

Changed in version 3.3.36: keys x-uk_co_no, x-hr_non_eu_pm_business_number, x-it_registrant_entity_type, x-hr_ident_number, x-uk_contact_type have been added.
x-uk_co_no parameter.
.
x-it_registrant_entity_type parameter.
.
x-uk_contact_type parameter.

Changed in version 3.3.35: keys x-pt_tech_vatid, x-pt_registrant_vatid, x-fi_isfinish, x-fi_organization_type have been added.
x-pt_tech_vatid parameter.
x-pt_registrant_vatid parameter.
.
.

Changed in version 3.3.32: keys x-law_accreditation_id, x-law_jurisdiction_SP, x-law_accreditation_year, x-law_accreditation_body, x-law_jurisdiction_CC have been added.
x-law_accreditation_id parameter.
x-law_jurisdiction_SP parameter.
x-law_accreditation_year parameter.
x-law_accreditation_body parameter.
x-law_jurisdiction_CC parameter.

Changed in version 3.3.29: keys x-ca_official_rep_capacity, x-ca_official_rep have been added.
x-ca_official_rep_capacity parameter.
x-ca_official_rep parameter.

Changed in version 3.3.26: key x-ca_business_entity_type has been added.
x-ca_business_entity_type parameter.

Changed in version 3.3.23: keys x-es_tech_tipo_identification, x-es_owner_identification, x-es_bill_identification, x-es_admin_identification, x-es_bill_tipo_identification, x-es_owner_legalform, x-es_admin_tipo_identification, x-es_tech_identification, x-es_owner_tipo_identification have been added.
x-es_tech_tipo_identification parameter.
x-es_owner_identification parameter.
x-es_bill_identification parameter.
x-es_admin_identification parameter.
x-es_bill_tipo_identification parameter.
x-es_owner_legalform parameter.
x-es_admin_tipo_identification parameter.
x-es_tech_identification parameter.
x-es_owner_tipo_identification paramter.

Changed in version 3.3.19: keys x-es_tipo_identification, x-es_legalform, x-es_identification have been added.
x-es_tipo_identification parameter.
x-es_legalform parameter.
x-es_identification parameter.

Name Default Type Mandatory
birth_city   string no
contact birth city
birth_country   string no
contact birth country
birth_date   string no
contact birth date (YYYY-MM-DD)
birth_department   string no
contact birth department … or zipcode, use 99 if contact was born outside of France / DOM/TOM
brand_number   string no
company brand number
duns   string no
contact duns number
waldec   string no
contact waldec number
x-aero_ens_authid   string no
aero id (you can apply for an .aero id on http://www.information.aero/)
x-aero_ens_authkey   string no
aero password
x-al_id_number   string no
Id number used for AL registrant
x-al_id_type   string no
Type of document used for AL registrant
x-al_vatid   string no
VAT ID of AL registrant
x-au_registrant_domain_relation   string no
Specify the relationship between the organization name that belongs to the registrant and domain name
x-au_registrant_domain_relation_type   string no
Specify what makes the registrant eligible to register a .au, .net.au, .org.au or .com.au domain name
x-au_registrant_id_number   string no
x-au_registrant_id_type   string no
owner’s document type
x-au_registrant_organization   string no
The organization name that belongs to the registrant
x-ax_business_number   string no
business ID for a Moral Person.
x-ax_id_number   string no
ID number of a Physical Person.
x-az_admin_pp_id   string no
ID number for a Physical Person admin contact
x-az_billing_pp_id   string no
ID number for a Physical Person billing contact
x-az_registrant_company_number   string no
Company number for a Moral Person registrant contact
x-az_registrant_pp_id   string no
ID number for a Physical Person registrant contact
x-az_tech_pp_id   string no
ID number for a Physical Person tech contact
x-barcelona_intendeduse   string no
Intended use for domain name
x-barcelona_trademarkid   string no
Local Trademark ID.
x-ca_business_entity_type   string no
business entity type
x-ca_legaltype   string no
owner’s legal type
x-ca_official_rep   string no
official representative (for LGR)
x-ca_official_rep_capacity   string no
official representative capacity (for LGR)
x-ca_owner_name   string no
owner name (deprecated)
x-cat_intendeduse   string no
Intended use for domain name
x-cn_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .CN domains
x-cn_registrant_document_type   string no
Type of document used for CNNIC identification, for .CN domains
x-coop_sponsor   string no
Coop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
x-cy_reg_identity_no   string no
id card number or passport number if physical person, else registration number (SIREN)
x-dk_admin_vatid   string no
business ID for a Moral Person admin
x-dk_ident_number   string no
Danish personal identity number for individuals or companies. Individuals must match the format DDMMYY-NNNN where DD = day, MM = month, YY = century year and NNNN a 4-digits number. Companies must match the format NNNNNNNN
x-dk_registrant_vatid   string no
business ID for a Moral Person registrant
x-document_country   string no
Registrant’s country which issued the document
x-document_type   string no
Registrant’s document type
x-document_value   string no
Registrant’s document number
x-ee_birthdate   string no
Date of birth for EE physical person registrant
x-ee_company_number   string no
Company number for EE moral person registrant
x-es_admin_identification   string no
id of the admin contact
x-es_admin_tipo_identification   string no
type of id for admin
x-es_bill_identification   string no
id of the bill contact
x-es_bill_tipo_identification   string no
type of id for bill
x-es_identification   string no
id of the contact (deprecated)
x-es_legalform   string no
legal form of the organization (deprecated)
x-es_owner_identification   string no
id of the owner contact
x-es_owner_legalform   string no
legal form of the owner organization
x-es_owner_tipo_identification   string no
type of id for owner
x-es_tech_identification   string no
id of the tech contact
x-es_tech_tipo_identification   string no
type of id for tech
x-es_tipo_identification   string no
type of id (deprecated)
x-eu_country_of_citizenship   string no
Country of citizenship for registrant
x-eus_intendeduse   string no
Intended use for domain name
x-fi_birthdate   string no
Date of birth for non-FI physical person registrant
x-fi_business_number   string no
Registrant’s identification number for a moral person
x-fi_ident_number   string no
Registrant’s identification number for a physical person
x-fi_isfinish   string no
Whether or not domain registrant is Finish, for a physical or moral person
x-fi_organization_type   string no
Registrant organization type for a moral person
x-gal_intendeduse   string no
Intended use for domain name
x-hk_registrant_birth_date   string no
owner’s birth date (YYYY-MM-DD)
x-hk_registrant_document_number   string no
number of the above document
x-hk_registrant_document_origin_country   string no
country code (FR, GB, US…) of the origin country of the above document
x-hk_registrant_document_type   string no
owner’s document type
x-hk_registrant_other_document_type   string no
mandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
x-hr_ident_number   string no
Croatian identification number (OIB)
x-hr_non_eu_pm_business_number   string no
Local business registration number for non european moral persons when they are a contact for a HR domain
x-hu_idnumber   string no
id card number or passport number of the physical person
x-hu_owner_vatid   string no
vatid of the moral person
x-ie_registrant_cro_number   string no
Companies Registration Office in case the registrant type ie COM
x-ie_registrant_supporting_number   string no
Identifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
x-ie_registrant_type   string no
The contact’s Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
x-il_registrant_company_type   string no
x-it_nationality   string no
nationality of the owner
x-it_pin   string no
owner’s Italian fiscal code or the number of an identity document
x-it_registrant_entity_type   string no
owner entity type
x-jobs_website   string no
owner website information (deprecated)
x-kr_reg_identity_no   string no
Registrant’s Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
x-lt_registrant_legal_id   string no
owner legal entity identification code
x-ltda_authority   string no
authority where the contact is registred
x-ltda_licensenumber   string no
licence number
x-lv_admin_idnumber   string no
id card number or passport number mandatory for latvian physical persons
x-lv_idnumber   string no
id card number or passport number for latvian physical persons, or registration number for latvian companies
x-ma_id_number   string no
Id number of a physical person
x-ma_vatid   string no
VAT or Businness ID of a moral person
x-madrid_intendeduse   string no
Intended use for domain name
x-my_admin_contact_password   string no
Admin contact password record (For transfer only)
x-my_admin_contact_username   string no
Admin contact username as per Whois record (For transfer only)
x-my_business_number   string no
Registrant’s Business Number
x-my_organization_type   string no
Registrant’s Organization Type
x-my_passport_number   string no
Registrant’s passport ID number
x-no_ident_number   string no
Norwegian personal identity number for individuals or companies. Individuals must match the format DDMMYY-NNNKK where DD = day, MM = month, YY = century year, NNN a 3-digits number and KK the first and second checksum digits to validate the number. Companies must match the format NNNNNNNNN
x-no_registrant_identity   string no
Personal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits) (deprecated)
x-nu_registrant_idnumber   string no
Registrant’s id number or organization number
x-nu_registrant_vatid   string no
vatid of the moral person
x-nyc_extcontact   string no
Gandi Handle of the EXTContact
x-pl_company_number   string no
REGON number, ID of a moral person
x-pl_ident_number   string no
PESEL number, ID of a physical person
x-pl_vatid   string no
VAT (NIP) ID of a moral person
x-pro_authority   string no
authority where the contact is registred
x-pro_authoritywebsite   string no
link to the registration authority
x-pro_licensenumber   string no
licence number
x-pro_profession   string no
contact profession
x-promopixel_company_serial   string no
owner’s company serial (SIREN, SIRET, INSEE or RPPS)
x-pt_registrant_vatid   string no
owner’s VAT for company or ID card number for individual
x-pt_tech_vatid   string no
tech’s VAT for company or ID card number for individual
x-quebec_intendeduse   string no
Intended use for domain name
x-radio_intendeduse   string no
Intended use for domain name
x-ro_registrant_idnumber   string no
id card number or passport number if physical person, else registration number (SIREN)
x-rs_company_number   string no
The company’s number for Moral Person.
x-rs_reg_identity_no   string no
Registrant’s Residence Registration No. (13-digit)
x-rs_reg_tax_no   string no
Registrant’s GST/VAT number
x-ru_registrant_birth_date   string no
owner’s birth date (YYYY-MM-DD)
x-ru_registrant_kpp   string no
Territory-linked taxpayer number for PM registrants
x-ru_registrant_passport_data   string no
The number of the identity proof
x-ru_registrant_tin   string no
Taxpayer identification number for PM registrants
x-sa_company_number   string no
Company number for SA moral person registrant
x-scot_intendeduse   string no
Intended use for domain name
x-se_ident_number   string no
Swedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
x-se_registrant_vatid   string no
vatid of the moral person
x-sg_idnumber   string no
Registrant’s id number
x-sport_intendeduse   string no
Intended use for domain name
x-srl_authority   string no
authority where the contact is registred
x-srl_licensenumber   string no
licence number
x-swiss_enterpriseid   string no
Swiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
x-swiss_intendeduse   string no
Intended use for domain name
x-travel_uin   string no
an Unique Identification Number (deprecated)
x-tw_company_number   string no
The company’s number for Moral Person.
x-uk_co_no   string no
The registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
x-uk_contact_type   string no
Contact type as defined at NOMINET
x-us_app_purpose   string no
Domain application purpose
x-us_nexus_category   string no
Applicant category
x-vn_company_number   string no
Moral Person company number.
x-vn_registrant_birth_date   string no
Birth date (YYYY-MM-DD) of registrant if Physical Person
x-vn_registrant_ident_number   string no
ID number of a Physical Person.
x-vn_registrant_job   string no
Registrant Job
x-vn_registrant_prefix   string no
Honorifics/personal title of Physical Person
x-xn–55qx5d_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–55qx5d
x-xn--55qx5d_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–55qx5d domains
x-xn–fiqs8s_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–fiqs8s domains
x-xn--fiqs8s_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–fiqs8s domains
x-xn–io0a7i_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–io0a7i
x-xn--io0a7i_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–io0a7i domains
x-xxx_membership_contact   string no
owner contact membership ID, obtained on the xxx registry website.
x-xxx_sponsored_community   string no
yes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community
x-zuerich_uid_number   string no
Business Identification Number used in Switzerland (Unternehmens-Identifikationsnummer)
Lang

used by BillingContactV5, BuGuessFilter, ContactCreateFormDescriptionV5, ContactCreateFormDescription, ContactUpdateBOFormDescription, ContactUpdateFormDescription, CustomizedEmailListOptions, DomainContactV5, MinimalBillingContactV5, MinimalContactCreateFormDescription, NotificationSubscriptionListReturn, NotificationSubscriptionParam, PostItCreateV5, PostItCreate, PostItUpdate and TriggerNotificationReturn

Name Description
en english
es spanish
fr french
zh-hans simplified chinese
zh-hant traditional chinese
StateCode

used by ContactCreateFormDescriptionV5, ContactCreateFormDescription, ContactUpdateBOFormDescription, ContactUpdateFormDescription, MinimalContactCreateFormDescription and ShippingAddress

Name Description
  Australia
ACT Australian Capital Territory
NSW New South Wales
NT Northern Territory
QLD Queensland
SA South Australia
TAS Tasmania
VIC Victoria
WA Western Australia
  Canada
AB Alberta
BC British Columbia
MB Manitoba
NB New Brunswick
NL Newfoundland and Labrador
NS Nova Scotia
NT Northwest Territories
ON Ontario
PE Prince Edward Island
QC Quebec
SK Saskatchewan
YK Yukon
  Spain
A Alicante
AB Albacete
AL Almeria
AV Avila
B Barcelona
BA Badajoz
BI Vizcaya
BU Burgos
C A Coruna
CA Cadiz
CC Caceres
CO Cordoba
CR Ciudad Real
CS Castellon
CU Cuenca
GC Las Palmas
GI Girona
GR Granada
GU Guadalajara
H Huelva
HU Huesca
J Jaen
L Lleida
LE Leon
LO La Rioja
LU Lugo
M Madrid (deprecated)
MA Malaga
MD Madrid
MU Murcia
NA Navarra
O Asturias
OR Ourense
P Palencia
PM Baleares
PO Pontevedra
S Cantabria
SA Salamanca
SE Sevilla
SG Segovia
SO Soria
SS Guipuzcoa
T Tarragona
TE Teruel
TF Santa Cruz de Tenerife
TO Toledo
V Valencia
VA Valladolid
VI Alava
Z Zaragoza
ZA Zamora
  France
01 Guadeloupe
02 Martinique
03 Guyane
04 La Reunion
06 Mayotte
11 Ile-de-France
21 Champagne-Ardenne
22 Picardie
23 Haute-Normandie
24 Centre-Val de Loire
25 Basse-Normandie
26 Bourgogne
27 Bourgogne-France-Comte
28 Normandie
31 Nord-Pas-de-Calais
32 Hauts-de-France
41 Lorraine
42 Alsace
43 Franche-Comte
44 Grand-Est
52 Pays de la Loire
53 Bretagne
54 Poitou-Charentes
72 Aquitaine
73 Midi-Pyrenees
74 Limousin
75 Nouvelle-Aquitaine
76 Occitanie
82 Rhone-Alpes
83 Auvergne
84 Auvergne-Rhone-Alpes
91 Languedoc-Roussillon
93 Provence-Alpes-Cote d’Azur
94 Corse
BL Saint-Barthelemy
MF Saint-Martin
  United Kingdom
ABC Armagh, Banbridge and Craigavon
ABD Aberdeenshire
ABE Aberdeen city
AE Alderney
AGB Argyll and Bute
AGY Isle of Anglesey; Sir Ynys Mon
AH Armagh
AM Antrim
AN Avon
AND Ards and North Down
ANN Antrim and Newtownabbey
ANS Angus
BAS Bath and North-East Somerset
BBD Blackburn with Darwen
BDF Bedford
BE Berkshire
BF Bedfordshire
BFS Belfast
BGE Bridgend; Pen-y-bont ar Ogwr
BGW Blaenau Gwent
BIR Birmingham
BKM Buckinghamshire
BMH Bournemouth
BNH Brighton and Hove
BNS Barnsley
BOL Bolton
BPL Blackpool
BRC Bracknell Forest
BRD Bradford
BS Borders
BST Bristol city
BUR Bury
CA Cumbria
CAM Cambridgeshire
CAY Caerphilly; Caerffili
CBF Central Bedfordshire
CCG Causeway Coast and Glens
CD Clwyd
CE Cambridgeshire
CGN Ceredigion; Sir Ceredigion
CHE Cheshire East
CHW Cheshire West and Chester
CL Cleveland
CLD Calderdale
CLK Clackmannanshire
CMA Cumbria
CMN Carmarthenshire; Sir Gaerfyrddin
CON Cornwall
COV Coventry
CRF Cardiff; Caerdydd
CS Cheshire
CT Central
CW Cornwall
CWY Conwy
DAL Darlington
DBY Derbyshire
DD Dyfed
DE Derbyshire
DEN Denbighshire; Sir Ddinbych
DER Derby
DEV Devon
DG Dumfries & Galloway
DGY Dumfries and Galloway
DM Durham
DN Down
DNC Doncaster
DND Dundee city
DOR Dorset
DRS Derry and Strabane
DT Dorset
DUD Dudley
DUR Durham County
DV Devon
DY Derry
EAY East Ayrshire
EDH Edimbourg city
EDU East Dunbartonshire
ELN East Lothian
ELS Eilean Siar
ERW East Renfrewshire
ERY East Riding of Yorkshire
ES East Sussex
ESS Essex
ESX East Sussex
EX Essex
FAL Falkirk
FE Fife
FH Fermanagh
FIF Fife
FLN Flintshire; Sir y Fflint
FMO Fermanagh and Omagh
GAT Gateshead
GD Gwynedd
GE Gloucestershire
GL Greater London
GLG Glasgow city
GLS Gloucestershire
GM Greater Manchester
GN Grampian
GT Gwent
GWN Gwynedd
GY Guernsey
HAL Halton
HAM Hampshire
HD Highland
HE Hampshire
HEF Herefordshire
HLD Highland
HPL Hartlepool
HRT Hertfordshire
HS Hertfordshire
HU Humberside
HW Hereford & Worcester
IJ Buckinghamshire
IM Isle Of Man
IOS Isles of Scilly
IOW Isle of Wight
IVC Inverclyde
IW Isle of Wight
JY Jersey
KEN Kent
KHL Kingston upon Hull
KIR Kirklees
KT Kent
KWL Knowsley
LAN Lancashire
LBC Lisburn and Castlereagh
LCE Leicester
LDS Leeds
LE Lancashire
LEC Leicestershire
LI Lincolnshire
LIN Lincolnshire
LIV Liverpool
LN Lothian
LND London city
LS Leicestershire
LUT Luton
MAN Manchester
MDB Middlesbrough
MDW Medway
ME Merseyside
MEA Mid and East Antrim
MG Mid Glamorgan
MIK Milton Keynes
MLN Midlothian
MON Monmouthshire; Sir Fynwy
MRY Moray
MTY Merthyr Tydfil; Merthyr Tudful
MUL Mid Ulster
MX Middlesex
NAY North Ayrshire
NBL Northumberland
ND Northumberland
NE Nottinghamshire
NEL North East Lincolnshire
NET Newcastle upon Tyne
NFK Norfolk
NGM Nottingham
NK Norfolk
NLK North Lanarkshire
NLN North Lincolnshire
NMD Newry, Mourne and Down
NS Northamptonshire
NSM North Somerset
NTH Northamptonshire
NTL Neath Port Talbot; Castell-nedd Port Talbot
NTT Nottinghamshire
NTY North Tyneside
NWP Newport; Casnewydd
NY North Yorkshire
NYK North Yorkshire
OE Oxfordshire
OLD Oldham
ORK Orkney islands
OXF Oxfordshire
OY Orkney
PEM Pembrokeshire; Sir Benfro
PKN Perth and Kinross
PLY Plymouth
POL Poole
POR Portsmouth
POW Powys
PS Powys
PTE Peterborough
RCC Redcar and Cleveland
RCH Rochdale
RCT Rhondda, Cynon, Taff; Rhondda, Cynon, Taf
RDG Reading
RFW Renfrewshire
ROT Rotherham
RUT Rutland
SAW Sandwell
SAY South Ayrshire
SC Strathclyde
SCB Scottish Borders
SD Shetland
SE Staffordshire
SFK Suffolk
SFT Sefton
SG South Glamorgan
SGC South Gloucestershire
SHF Sheffield
SHN St Helens
SHR Shropshire
SK Suffolk
SKP Stockport
SL Scotland
SLF Salford
SLG Slough
SLK South Lanarkshire
SND Sunderland
SOL Solihull
SOM Somerset
SOS Southend-on-Sea
SR Surrey
SRY Surrey
SS Shropshire
ST Somerset
STE Stoke-on-Trent
STG Stirling
STH Southampton
STS Staffordshire
STT Stockton-on-Tees
STY South Tyneside
SWA Swansea; Abertawe
SWD Swindon
SX Sussex
SY South Yorkshire
TAM Tameside
TE Tyrone
TFW Telford and Wrekin
THR Thurrock
TOB Torbay
TOF Torfaen; Tor-faen
TRF Trafford
TS Tayside
TW Tyne & Wear
VGL Vale of Glamorgan, The; Bro Morgannwg
WA Wales
WAR Warwickshire
WBK West Berkshire
WDU West Dunbartonshire
WE Warwickshire
WG West Glamorgan
WGN Wigan
WI Western Isles
WIL Wiltshire
WKF Wakefield
WL West Lothian
WLL Walsall
WLN West Lothian
WLV Wolverhampton
WM West Midlands
WNM Windsor and Maidenhead
WOK Wokingham
WOR Worcestershire
WR Wiltshire
WRL Wirral
WRT Warrington
WRX Wrexham; Wrecsam
WS West Sussex
WSX West Sussex
WY West Yorkshire
YOR York
ZET Shetland islands
  Ireland
C Cork
CE Clare
CN Cavan
CW Carlow
D Dublin
DL Donegal
G Galway
KE Kildare
KK Kilkenny
KY Kerry
L Limerick
LD Longford
LH Louth
LM Leitrim
LS Laois
MH Meath
MN Monaghan
MP Mayo
OY Offaly
RN Roscommon
SO Sligo
T Tipperary
W Waterford
WH Westmeath
WW Wicklow
WX Wexford
  India
AP Andhra Pradesh
AR Arunachal Pradesh
AS Assam
CH Chandigarh
GO Goa
HP Himachal Pradesh
JK Jammu and Kashmir
KA Karnataka
KL Kerala
LA Ladakh
MA Maharashtra (deprecated)
MH Maharashtra
MN Manipur
MP Madhya Pradesh
OR Odisha
TN Tamil Nadu
TR Tripura
UP Uttar Pradesh
WB West Bengal
  Italy
AG Agrigento
AL Alessandria
AN Ancona
AO Aosta
AP Ascoli Piceno
AQ L’Aquila
AR Arezzo
AT Asti
AV Avellino
BA Bari
BG Bergamo
BI Biella
BL Belluno
BN Benevento
BO Bologna
BR Brindisi
BS Brescia
BZ Bolzano
CA Cagliari
CB Campobasso
CE Caserta
CH Chieti
CL Caltanissetta
CN Cuneo
CO Como
CR Cremona
CS Cosenza
CT Catania
CZ Catanzaro
EN Enna
FC Forli-Cesena
FE Ferrara
FG Foggia
FI Firenze
FR Frosinone
GE Genova
GO Gorizia
GR Grosseto
IM Imperia
IS Isernia
KR Crotone
LC Lecco
LE Lecce
LI Livorno
LO Lodi
LT Latina
LU Lucca
MC Macerata
ME Messina
MI Milano
MN Mantova
MO Modena
MS Massa Carrara
MT Matera
NA Napoli
NO Novara
NU Nuoro
OR Oristano
OT Olbia
PA Palermo
PC Piacenza
PD Padova
PE Pescara
PG Perugia
PI Pisa
PN Pordenone
PO Prato
PR Parma
PT Pistoia
PU Pesaro-Urbino
PV Pavia
PZ Potenza
RA Ravenna
RC Reggio Calabria
RE Reggio Emilia
RG Ragusa
RI Rieti
RM Roma
RN Rimini
RO Rovigo
RSM San Marin
SA Salerno
SI Siena
SO Sondrio
SP La Spezia
SR Siracusa
SS Sassari
SV Savona
TA Taranto
TE Teramo
TN Trento
TO Torino
TP Trapani
TR Terni
TS Trieste
TV Treviso
UD Udine
VA Varese
VB Verbania
VC Vercelli
VE Venezia
VI Vicenza
VR Verona
VT Viterbo
VV Vibo Valentia
  Japan
JP-01 Hokkaido
JP-02 Aomori
JP-03 Iwate
JP-04 Miyagi
JP-05 Akita
JP-06 Yamagata
JP-07 Fukushima
JP-08 Ibaraki
JP-09 Tochigi
JP-10 Gunma
JP-11 Saitama
JP-12 Chiba
JP-13 Tokyo
JP-14 Kanagawa
JP-15 Niigata
JP-16 Toyama
JP-17 Ishikawa
JP-18 Fukui
JP-19 Yamanashi
JP-20 Nagano
JP-21 Gifu
JP-22 Shizuoka
JP-23 Aichi
JP-24 Mie
JP-25 Shiga
JP-26 Kyoto
JP-27 Osaka
JP-28 Hyogo
JP-29 Nara
JP-30 Wakayama
JP-31 Tottori
JP-32 Shimane
JP-33 Okayama
JP-34 Hiroshima
JP-35 Yamaguchi
JP-36 Tokushima
JP-37 Kagawa
JP-38 Ehime
JP-39 Kochi
JP-40 Fukuoka
JP-41 Saga
JP-42 Nagasaki
JP-43 Kumamoto
JP-44 Oita
JP-45 Miyazaki
JP-46 Kagoshima
JP-47 Okinawa
  Mexico
AG Aguascalientes
BC Baja California
BS Baja California Sur
CH Chihuahua
CL Colima
CM Campeche
CO Coahuila
CS Chiapas
DF Distrito Federal
DG Durango
GR Guerrero
GT Guanajuato
HG Hidalgo
JA Jalisco
ME Mexico
MI Michoacan
MO Morelos
NA Nayarit
NL Nuevo Leon
OA Oaxaca
PB Puebla
QE Queretaro
QR Quintana Roo
SI Sinaloa
SL San Luis Potosi
SO Sonora
TB Tabasco
TL Tlaxcala
TM Tamaulipas
VE Veracruz
YU Yucatan
ZA Zacatecas
  Portugal
01 Aveiro
02 Beja
03 Braga
04 Braganca
05 Castelo Branco
06 Coimbra
07 Evora
08 Faro
09 Guarda
10 Leiria
11 Lisboa
12 Portalegre
13 Porto
14 Santarem
15 Setubal
16 Viana do Castelo
17 Vila Real
18 Viseu
20 Regiao Autonoma dos Acores
30 Regiao Autonoma da Madeira
  United States of America
AK Alaska
AL Alabama
AR Arkansas
AS American Samoa
AZ Arizona
CA California
CM No. Mariana Islands
CO Colorado
CT Connecticut
DC Dist. of Columbia
DE Delaware
FL Florida
GA Georgia
GU Guam
HI Hawaii
IA Iowa
ID Idaho
IL Illinois
IN Indiana
KS Kansas
KY Kentucky
LA Louisiana
MA Massachusetts
MD Maryland
ME Maine
MI Michigan
MN Minnesota
MO Missouri
MS Mississippi
MT Montana
NC North Carolina
ND North Dakota
NE Nebraska
NH New Hampshire
NJ New Jersey
NM New Mexico
NV Nevada
NY New York
OH Ohio
OK Oklahoma
OR Oregon
PA Pennsylvania
PR Puerto Rico
RI Rhode Island
SC South Carolina
SD South Dakota
TN Tennessee
TT Trust Territory
TX Texas
UT Utah
VA Virginia
VI Virgin Islands
VT Vermont
WA Washington
WI Wisconsin
WV West Virginia
WY Wyoming
UECountryIsoCitizenShip4EU

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
AT Austria
BE Belgium
BG Bulgaria
CY Cyprus
CZ Czech Republic
DE Germany
DK Denmark
EE Estonia
ES Spain
FI Finland
FR France
GR Greece
HR Croatia
HU Hungary
IE Ireland
IS Iceland
IT Italy
LI Liechstenstein
LT Lithuania
LU Luxembourg
LV Latvia
MT Malta
NL Netherlands
NO Norway
PL Poland
PT Portugal
RO Romania
SE Sweden
SI Slovenia
SK Slovak (Republic)
OperationStep

parameter of internal.operation.update_step() and operation.update_step()

used by CertificateOperationReturn, ChangeOwnerInfo, ChangeOwnerOperationReturn, DomainCreateOperationReturn, DomainDeleteOperationReturn, DomainDnssecOperationReturn, DomainReleaseOperationReturn, DomainRenewOperationReturn, DomainRestoreOperationReturn, DomainStatusUpdateOperationReturn, GoodiesOperationReturn, HostCreateOperationReturn, HostDeleteOperationReturn, HostUpdateOperationReturn, HostingOperationReturn, InternalOperationReturn, NsSetOperationReturn, OperationCreate, OperationListOptions, OperationListReturn, OperationReturn, SiteOperationReturn, TransferInOperationReturn and TransferinReturn

all operations are created in a BILL step, if they require billing. All hosting operations (as described in this documentation) are created in a WAIT state, as they do not need to be billed.
Name Description
BILL if the operation requires billing, this step means it’s currently working on billing
WAIT the billing is done, the operation is waiting to be processed.
RUN Gandi backends are currently handling the operation.
ERROR an error occurred while the operation was processing, no more processing will be performed..
DONE the operation is done, end of operation’s life, no more processing will be performed.
CANCEL the user decided to cancel the operation, no more processing will be performed.
SUPPORT the operation has failed in a way that makes it possible for our Support Team to repair and relaunch it. Our team might have to contact you in order to fix possible erroneous informations.
OperationType

used by CertificateOperationReturn, ChangeOwnerOperationReturn, DomainCreateOperationReturn, DomainDeleteOperationReturn, DomainDnssecOperationReturn, DomainReleaseOperationReturn, DomainRenewOperationReturn, DomainRestoreOperationReturn, DomainStatusUpdateOperationReturn, GoodiesOperationReturn, HostCreateOperationReturn, HostDeleteOperationReturn, HostUpdateOperationReturn, HostingOperationReturn, InternalOperationReturn, NsSetOperationReturn, OperationCreate, OperationListOptions, OperationListReturn, OperationReturn, SiteOperationReturn and TransferInOperationReturn

Name Description
autofoa_create -
autofoa_delete -
autofoa_validate -
automaticcredit_set_inactive -
certificate_create -
certificate_delete -
certificate_release -
certificate_renew -
certificate_replaced -
certificate_reseller_set -
certificate_update -
contact_create -
contact_delete -
contact_release -
contact_reseller_set -
contact_update -
cronflex_create -
cronflex_delete -
cronflex_update -
customized_email_update -
disk_attach -
disk_create -
disk_delete -
disk_detach -
disk_dup -
disk_pause -
disk_prepare -
disk_rollback_from -
disk_unpause -
disk_update -
disk_wipe -
domainpref_create -
domainpref_delete -
domainpref_update -
domain_authinfo -
domain_autorenew -
domain_change_contact -
domain_change_owner -
domain_clone_owner_for_resell er -
domain_contact_change -
domain_create -
domain_delete -
domain_delete_premium_dns -
domain_dnssec_add -
domain_dnssec_delete -
domain_dnssec_set -
domain_lock -
domain_mail_redir_add -
domain_mail_redir_del -
domain_ns_delete_advanced -
domain_ns_set -
domain_ns_set_advanced -
domain_ns_set_premium -
domain_push -
domain_redemption -
domain_release -
domain_renew -
domain_request_authinfo -
domain_reseller_set -
domain_restore -
domain_status_update -
domain_trade -
domain_transfer_in -
domain_transfer_out_ack -
domain_transfer_out_nak -
domain_transfer_reseller -
domain_unlock -
domain_update -
domain_update_contact -
domain_web_redir_add -
domain_web_redir_del -
domain_web_redir_update -
eoi_create -
eoi_delete -
eoi_done -
flex_activation -
flex_deactivation -
hosted_cert_create -
hosted_cert_delete -
hosting_account_product_add -
hosting_account_product_remov e -
hosting_account_product_renew -
hosting_account_product_updat e -
hosting_change_owner -
hosting_credit -
hosting_migration_disk -
hosting_migration_pvlan -
hosting_migration_vm -
host_create -
host_delete -
host_update_ip -
iface_attach -
iface_create -
iface_delete -
iface_detach -
iface_update -
ip_attach -
ip_create -
ip_delete -
ip_detach -
ip_update -
lb_create -
lb_delete -
lb_update -
mailboxv2_activate -
mailboxv2_create -
mailboxv2_deactivate -
mailboxv2_delete -
mailboxv2_migrate_v1 -
mailboxv2_patch -
mailboxv2_purge -
mailboxv2_renew -
mailboxv2_update -
mailbox_add -
mailbox_create -
mailbox_del -
mailbox_delete -
mailbox_purge -
mailbox_responder_activate -
mailbox_responder_deactivate -
mailbox_send_welcome_email -
mailbox_update -
notification_subscription_cre ate -
notification_subscription_del ete -
paas_console -
paas_disk_create -
paas_disk_delete -
paas_disk_renew -
paas_disk_update -
paas_lock -
paas_password_update -
paas_pause -
paas_restart -
paas_unlock -
paas_vm_create -
paas_vm_delete -
paas_vm_renew -
paas_vm_update -
paas_zone_alter -
packmail_activate -
packmail_autorenew -
packmail_deactivate -
packmail_downgrade -
packmail_renew -
packmail_upgrade -
prepaid_lock -
prepaid_unlock -
reachability_create -
reachability_done -
reachability_failed -
reachability_resend -
reachability_unlock -
rproxy_create -
rproxy_flush -
rproxy_iaas_create -
rproxy_iaas_delete -
rproxy_iaas_pause -
rproxy_iaas_renew -
rproxy_iaas_unpause -
rproxy_iaas_update -
rproxy_iaas_zone_alter -
rproxy_server_create -
rproxy_server_delete -
rproxy_server_update -
rproxy_update -
rproxy_vhost_create -
rproxy_vhost_delete -
rproxy_vhost_ssl -
sitebuilder_create -
sitebuilder_delete -
sitebuilder_lock -
sitebuilder_pause -
sitebuilder_renew -
sitebuilder_restore -
sitebuilder_unlock -
sitebuilder_update -
sitebuilder_zone_alter -
site_account_update -
site_activate -
site_create -
site_deactivate -
site_delete -
site_host_attach -
site_host_detach -
site_lock -
site_renew -
site_undelete -
site_unlock -
site_update -
site_upgrade -
sudoer_create -
sudoer_delete -
technical_template_apply -
vlan_create -
vlan_delete -
vlan_update -
vm_agent_update -
vm_conf -
vm_console_disable -
vm_console_enable -
vm_create -
vm_delete -
vm_meta_deinstall -
vm_meta_install -
vm_owner_change -
vm_pause -
vm_reboot -
vm_release_ai -
vm_reverse_set -
vm_set_state -
vm_start -
vm_stop -
vm_trigger_create -
vm_trigger_delete -
vm_unlock -
vm_update -
vm_upgrade -
watchdog_probe_create -
watchdog_probe_delete -
watchdog_probe_update -
watchdog_trigger_create -
watchdog_trigger_delete -
watchdog_trigger_update -
ReleaseContact

parameter of contact.release_v5()

Name Default Type Mandatory
api-version 5 string no
Taxes

used by BalanceReturn and BusinessUnit

Name Type
default int
ContactShortReturn

used by BoShippingAddressReturn and InternalContactReturn

Changed in version 3.3.18: key validation has been added.
validation parameter.

Name Type
bu_id string
email string
family string
given string
handle string
id int
lang string
orgname string
reachability string
validation string
vat_number string
ContactCheckDomainBulk

parameter of contact.can_associate_bulk()

Name Default Type Mandatory
admin   struct no
api-version 5 string no
bill   struct no
owner   struct no
tech   struct no
ContactClone

parameter of contact.clone()

Name Default Type Mandatory
password   string no
ContactCreateFormDescription

parameter of contact.can_associate(), contact.create_dry_run(), contact.create() and ote.create_user()

Name Default Type Mandatory
city   string yes
country   string yes
email   string yes
family   string yes
given   string yes
password   string yes
phone   string yes
streetaddr   string yes
type   string yes
accept_contract True boolean no
brand_number   string no
data_obfuscated True boolean no
GDPR opt in/out
extra_parameters   struct no
fax   string no
jo_announce_number   int or string no
jo_announce_page   int or string no
jo_declaration_date   string no
jo_publication_date   string no
lang   string no
mail_obfuscated   int, boolean or string no
Use Anti-spam email
mobile   string no
newsletter   int, boolean or string no
security_question_answer   string no
security_question_num   int or string no
siren   string no
state   string no
third_part_resell   int, boolean or string no
vat_number   string no
zip   string no
ContactFoListOptions

parameter of contact.count_v5() and contact.list_v5()

Name Default Type Mandatory
<date_updated   string no
>date_updated   string no
city   array of string or string no
country   string no
date_updated   string no
email   array of string or string no
family   array of string or string no
given   array of string or string no
handle   array of string or string no
items_per_page 100 int no
number of items returned for the pagination
orgname   array of string or string no
page 0 int no
page number for pagination offset
sharing_id   string no
sort_by   string no
used to sort returned items: city, country, date_updated, email, family, given, handle, orgname, streetaddr, type, zip
streetaddr   array of string or string no
type   string no
zip   array of string or string no
~email   string no
~family   string no
~given   string no
~handle   string no
~orgname   string no
ContactListOptions

parameter of contact.count() and contact.list()

Name Default Type Mandatory
<date_updated   string no
>date_updated   string no
city   array of string or string no
country   string no
date_updated   string no
email   array of string or string no
family   array of string or string no
given   array of string or string no
handle   array of string or string no
items_per_page 100 int no
number of items returned for the pagination
orgname   array of string or string no
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: city, country, date_updated, email, family, given, handle, orgname, streetaddr, type, zip
streetaddr   array of string or string no
type   string no
zip   array of string or string no
~email   string no
~family   string no
~given   string no
~handle   string no
~orgname   string no
ContactUpdateBOFormDescription

parameter of contact.update_bo()

Name Default Type Mandatory
accept_contract True boolean no
brand_number   string no
city   string no
country   string no
data_obfuscated True boolean no
email   string no
extra_parameters   struct no
family   string no
fax   string no
given   string no
jo_announce_number   int or string no
jo_announce_page   int or string no
jo_declaration_date   string no
jo_publication_date   string no
lang   string no
mail_obfuscated   int, boolean or string no
mobile   string no
newsletter   int, boolean or string no
phone   string no
siren   string no
state   string no
statut   string no
streetaddr   string no
third_part_resell   int, boolean or string no
tld   string no
type   string no
vat_number   string no
zip   string no
ContactUpdateFormDescription

parameter of contact.update_dry_run() and contact.update()

Name Default Type Mandatory
accept_contract True boolean no
brand_number   string no
city   string no
country   string no
data_obfuscated True boolean no
email   string no
extra_parameters   struct no
family   string no
fax   string no
given   string no
jo_announce_number   int or string no
jo_announce_page   int or string no
jo_declaration_date   string no
jo_publication_date   string no
lang   string no
mail_obfuscated   int, boolean or string no
mobile   string no
newsletter   int, boolean or string no
phone   string no
security_question_answer   string no
security_question_num   int or string no
siren   string no
state   string no
streetaddr   string no
third_part_resell   int, boolean or string no
vat_number   string no
zip   string no
EmailValidation

parameter of contact.validate_email()

Name Default Type Mandatory
value   string yes
the given hash
state valid_auto string no
is the mail valid or not
EmailValidationState

used by EmailValidation

Name Description
pending -
not_validated -
valid_auto validation from the mail link
valid_manual helpdesk validation
valid_legal legal validation
invalid this is not a valid mail
ExtraParameters

used by ContactCreateFormDescriptionV5, ContactCreateFormDescription, ContactUpdateBOFormDescription and ContactUpdateFormDescription

Changed in version 3.3.38: keys x-vn_registrant_ident_number, x-my_passport_number, x-vn_registrant_prefix, x-dk_ident_number, x-no_ident_number, x-pl_company_number, x-pl_vatid, x-al_id_type, x-dk_registrant_vatid, x-ma_vatid, x-vn_registrant_birth_date, x-au_registrant_domain_relation_type, x-ee_company_number, x-vn_company_number, x-xn--55qx5d_registrant_document_number, x-al_vatid, x-au_registrant_id_type, x-ax_business_number, x-au_registrant_id_number, x-ma_id_number, x-sa_company_number, x-eu_country_of_citizenship, x-xn--io0a7i_registrant_document_number, x-al_id_number, x-xn--io0a7i_registrant_document_type, x-pl_ident_number, x-au_registrant_organization, x-xn--fiqs8s_registrant_document_number, x-ax_id_number, x-fi_birthdate, x-cn_registrant_document_type, x-vn_registrant_job, x-dk_admin_vatid, x-zuerich_uid_number, x-xn--fiqs8s_registrant_document_type, x-ee_birthdate, x-xn--55qx5d_registrant_document_type, x-cn_registrant_document_number, x-au_registrant_domain_relation have been added.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Changed in version 3.3.37: keys x-az_admin_pp_id, x-az_registrant_pp_id, x-az_billing_pp_id, x-rs_company_number, x-it_nationality, x-az_registrant_company_number, x-tw_company_number, x-lt_registrant_legal_id, x-az_tech_pp_id have been added.
x-az_admin_pp_id parameter.
x-az_registrant_pp_id parameter.
x-az_billing_pp_id parameter.
.
x-it_nationality parameter.
x-az_registrant_company_number parameter.
.
x-lt_registrant_legal_id parameter.
x-az_tech_pp_id parameter.

Changed in version 3.3.36: keys x-uk_co_no, x-hr_non_eu_pm_business_number, x-it_registrant_entity_type, x-hr_ident_number, x-uk_contact_type have been added.
x-uk_co_no parameter.
.
x-it_registrant_entity_type parameter.
.
x-uk_contact_type parameter.

Changed in version 3.3.35: keys x-pt_tech_vatid, x-pt_registrant_vatid, x-fi_isfinish, x-fi_organization_type have been added.
x-pt_tech_vatid parameter.
x-pt_registrant_vatid parameter.
.
.

Changed in version 3.3.32: keys x-law_accreditation_id, x-law_jurisdiction_SP, x-law_accreditation_year, x-law_accreditation_body, x-law_jurisdiction_CC have been added.
x-law_accreditation_id parameter.
x-law_jurisdiction_SP parameter.
x-law_accreditation_year parameter.
x-law_accreditation_body parameter.
x-law_jurisdiction_CC parameter.

Changed in version 3.3.29: keys x-ca_official_rep_capacity, x-ca_official_rep have been added.
x-ca_official_rep_capacity parameter.
x-ca_official_rep parameter.

Changed in version 3.3.26: key x-ca_business_entity_type has been added.
x-ca_business_entity_type parameter.

Changed in version 3.3.23: keys x-es_tech_tipo_identification, x-es_owner_identification, x-es_bill_identification, x-es_admin_identification, x-es_bill_tipo_identification, x-es_owner_legalform, x-es_admin_tipo_identification, x-es_tech_identification, x-es_owner_tipo_identification have been added.
x-es_tech_tipo_identification parameter.
x-es_owner_identification parameter.
x-es_bill_identification parameter.
x-es_admin_identification parameter.
x-es_bill_tipo_identification parameter.
x-es_owner_legalform parameter.
x-es_admin_tipo_identification parameter.
x-es_tech_identification parameter.
x-es_owner_tipo_identification paramter.

Changed in version 3.3.19: keys x-es_tipo_identification, x-es_legalform, x-es_identification have been added.
x-es_tipo_identification parameter.
x-es_legalform parameter.
x-es_identification parameter.

Name Default Type Mandatory
birth_city   string no
contact birth city
birth_country   string no
contact birth country
birth_date   string no
contact birth date (YYYY-MM-DD)
birth_department   string no
contact birth department … or zipcode, use 99 if contact was born outside of France / DOM/TOM
brand_number   string no
company brand number
duns   string no
contact duns number
waldec   string no
contact waldec number
x-aero_ens_authid   string no
aero id (you can apply for an .aero id on http://www.information.aero/)
x-aero_ens_authkey   string no
aero password
x-al_id_number   string no
Id number used for AL registrant
x-al_id_type   string no
Type of document used for AL registrant
x-al_vatid   string no
VAT ID of AL registrant
x-au_registrant_domain_relation   string no
Specify the relationship between the organization name that belongs to the registrant and domain name
x-au_registrant_domain_relation_type   string no
Specify what makes the registrant eligible to register a .au, .net.au, .org.au or .com.au domain name
x-au_registrant_id_number   string no
x-au_registrant_id_type   string no
owner’s document type
x-au_registrant_organization   string no
The organization name that belongs to the registrant
x-ax_business_number   string no
business ID for a Moral Person.
x-ax_id_number   string no
ID number of a Physical Person.
x-az_admin_pp_id   string no
ID number for a Physical Person admin contact
x-az_billing_pp_id   string no
ID number for a Physical Person billing contact
x-az_registrant_company_number   string no
Company number for a Moral Person registrant contact
x-az_registrant_pp_id   string no
ID number for a Physical Person registrant contact
x-az_tech_pp_id   string no
ID number for a Physical Person tech contact
x-barcelona_intendeduse   string no
Intended use for domain name
x-barcelona_trademarkid   string no
Local Trademark ID.
x-ca_business_entity_type   string no
business entity type
x-ca_legaltype   string no
owner’s legal type
x-ca_official_rep   string no
official representative (for LGR)
x-ca_official_rep_capacity   string no
official representative capacity (for LGR)
x-ca_owner_name   string no
owner name (deprecated)
x-cat_intendeduse   string no
Intended use for domain name
x-cn_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .CN domains
x-cn_registrant_document_type   string no
Type of document used for CNNIC identification, for .CN domains
x-coop_sponsor   string no
Coop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
x-cy_reg_identity_no   string no
id card number or passport number if physical person, else registration number (SIREN)
x-dk_admin_vatid   string no
business ID for a Moral Person admin
x-dk_ident_number   string no
Danish personal identity number for individuals or companies. Individuals must match the format DDMMYY-NNNN where DD = day, MM = month, YY = century year and NNNN a 4-digits number. Companies must match the format NNNNNNNN
x-dk_registrant_vatid   string no
business ID for a Moral Person registrant
x-document_country   string no
Registrant’s country which issued the document
x-document_type   string no
Registrant’s document type
x-document_value   string no
Registrant’s document number
x-ee_birthdate   string no
Date of birth for EE physical person registrant
x-ee_company_number   string no
Company number for EE moral person registrant
x-es_admin_identification   string no
id of the admin contact
x-es_admin_tipo_identification   string no
type of id for admin
x-es_bill_identification   string no
id of the bill contact
x-es_bill_tipo_identification   string no
type of id for bill
x-es_identification   string no
id of the contact (deprecated)
x-es_legalform   string no
legal form of the organization (deprecated)
x-es_owner_identification   string no
id of the owner contact
x-es_owner_legalform   string no
legal form of the owner organization
x-es_owner_tipo_identification   string no
type of id for owner
x-es_tech_identification   string no
id of the tech contact
x-es_tech_tipo_identification   string no
type of id for tech
x-es_tipo_identification   string no
type of id (deprecated)
x-eu_country_of_citizenship   string no
Country of citizenship for registrant
x-eus_intendeduse   string no
Intended use for domain name
x-fi_birthdate   string no
Date of birth for non-FI physical person registrant
x-fi_business_number   string no
Registrant’s identification number for a moral person
x-fi_ident_number   string no
Registrant’s identification number for a physical person
x-fi_isfinish   string no
Whether or not domain registrant is Finish, for a physical or moral person
x-fi_organization_type   string no
Registrant organization type for a moral person
x-gal_intendeduse   string no
Intended use for domain name
x-hk_registrant_birth_date   string no
owner’s birth date (YYYY-MM-DD)
x-hk_registrant_document_number   string no
number of the above document
x-hk_registrant_document_origin_country   string no
country code (FR, GB, US…) of the origin country of the above document
x-hk_registrant_document_type   string no
owner’s document type
x-hk_registrant_other_document_type   string no
mandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
x-hr_ident_number   string no
Croatian identification number (OIB)
x-hr_non_eu_pm_business_number   string no
Local business registration number for non european moral persons when they are a contact for a HR domain
x-hu_idnumber   string no
id card number or passport number of the physical person
x-hu_owner_vatid   string no
vatid of the moral person
x-ie_registrant_cro_number   string no
Companies Registration Office in case the registrant type ie COM
x-ie_registrant_supporting_number   string no
Identifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
x-ie_registrant_type   string no
The contact’s Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
x-il_registrant_company_type   string no
x-it_nationality   string no
nationality of the owner
x-it_pin   string no
owner’s Italian fiscal code or the number of an identity document
x-it_registrant_entity_type   string no
owner entity type
x-jobs_website   string no
owner website information (deprecated)
x-kr_reg_identity_no   string no
Registrant’s Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
x-lt_registrant_legal_id   string no
owner legal entity identification code
x-ltda_authority   string no
authority where the contact is registred
x-ltda_licensenumber   string no
licence number
x-lv_admin_idnumber   string no
id card number or passport number mandatory for latvian physical persons
x-lv_idnumber   string no
id card number or passport number for latvian physical persons, or registration number for latvian companies
x-ma_id_number   string no
Id number of a physical person
x-ma_vatid   string no
VAT or Businness ID of a moral person
x-madrid_intendeduse   string no
Intended use for domain name
x-my_admin_contact_password   string no
Admin contact password record (For transfer only)
x-my_admin_contact_username   string no
Admin contact username as per Whois record (For transfer only)
x-my_business_number   string no
Registrant’s Business Number
x-my_organization_type   string no
Registrant’s Organization Type
x-my_passport_number   string no
Registrant’s passport ID number
x-no_ident_number   string no
Norwegian personal identity number for individuals or companies. Individuals must match the format DDMMYY-NNNKK where DD = day, MM = month, YY = century year, NNN a 3-digits number and KK the first and second checksum digits to validate the number. Companies must match the format NNNNNNNNN
x-no_registrant_identity   string no
Personal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits) (deprecated)
x-nu_registrant_idnumber   string no
Registrant’s id number or organization number
x-nu_registrant_vatid   string no
vatid of the moral person
x-nyc_extcontact   string no
Gandi Handle of the EXTContact
x-pl_company_number   string no
REGON number, ID of a moral person
x-pl_ident_number   string no
PESEL number, ID of a physical person
x-pl_vatid   string no
VAT (NIP) ID of a moral person
x-pro_authority   string no
authority where the contact is registred
x-pro_authoritywebsite   string no
link to the registration authority
x-pro_licensenumber   string no
licence number
x-pro_profession   string no
contact profession
x-promopixel_company_serial   string no
owner’s company serial (SIREN, SIRET, INSEE or RPPS)
x-pt_registrant_vatid   string no
owner’s VAT for company or ID card number for individual
x-pt_tech_vatid   string no
tech’s VAT for company or ID card number for individual
x-quebec_intendeduse   string no
Intended use for domain name
x-radio_intendeduse   string no
Intended use for domain name
x-ro_registrant_idnumber   string no
id card number or passport number if physical person, else registration number (SIREN)
x-rs_company_number   string no
The company’s number for Moral Person.
x-rs_reg_identity_no   string no
Registrant’s Residence Registration No. (13-digit)
x-rs_reg_tax_no   string no
Registrant’s GST/VAT number
x-ru_registrant_birth_date   string no
owner’s birth date (YYYY-MM-DD)
x-ru_registrant_kpp   string no
Territory-linked taxpayer number for PM registrants
x-ru_registrant_passport_data   string no
The number of the identity proof
x-ru_registrant_tin   string no
Taxpayer identification number for PM registrants
x-sa_company_number   string no
Company number for SA moral person registrant
x-scot_intendeduse   string no
Intended use for domain name
x-se_ident_number   string no
Swedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
x-se_registrant_vatid   string no
vatid of the moral person
x-sg_idnumber   string no
Registrant’s id number
x-sport_intendeduse   string no
Intended use for domain name
x-srl_authority   string no
authority where the contact is registred
x-srl_licensenumber   string no
licence number
x-swiss_enterpriseid   string no
Swiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
x-swiss_intendeduse   string no
Intended use for domain name
x-travel_uin   string no
an Unique Identification Number (deprecated)
x-tw_company_number   string no
The company’s number for Moral Person.
x-uk_co_no   string no
The registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
x-uk_contact_type   string no
Contact type as defined at NOMINET
x-us_app_purpose   string no
Domain application purpose
x-us_nexus_category   string no
Applicant category
x-vn_company_number   string no
Moral Person company number.
x-vn_registrant_birth_date   string no
Birth date (YYYY-MM-DD) of registrant if Physical Person
x-vn_registrant_ident_number   string no
ID number of a Physical Person.
x-vn_registrant_job   string no
Registrant Job
x-vn_registrant_prefix   string no
Honorifics/personal title of Physical Person
x-xn–55qx5d_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–55qx5d
x-xn--55qx5d_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–55qx5d domains
x-xn–fiqs8s_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–fiqs8s domains
x-xn--fiqs8s_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–fiqs8s domains
x-xn–io0a7i_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–io0a7i
x-xn--io0a7i_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–io0a7i domains
x-xxx_membership_contact   string no
owner contact membership ID, obtained on the xxx registry website.
x-xxx_sponsored_community   string no
yes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community
x-zuerich_uid_number   string no
Business Identification Number used in Switzerland (Unternehmens-Identifikationsnummer)
InternalContactListOptions

parameter of contact.count_bo(), contact.list_bo(), internal.contact.count_all() and internal.contact.list_all()

Name Default Type Mandatory
<date_created   string no
<date_updated   string no
>date_created   string no
>date_updated   string no
city   array of string or string no
contact_id   int no
country   string no
date_created   string no
date_updated   string no
email   array of string or string no
family   array of string or string no
given   array of string or string no
handle   array of string or string no
items_per_page 100 int no
number of items returned for the pagination
orgname   array of string or string no
page 0 int no
page number for pagination offset
reachability   string no
sort_by   string no
used to sort returned items: city, contact_id, country, date_created, date_updated, email, family, given, handle, orgname, reachability, status, streetaddr, type, zip
status   string no
streetaddr   array of string or string no
type   string no
zip   array of string or string no
~email   string no
~family   string no
~given   string no
~handle   string no
~orgname   string no
MinimalContactCreateFormDescription

parameter of contact.create_minimal()

Name Default Type Mandatory
email   string yes
given   string yes
lang   string yes
city   string no
country   string no
family   string no
orgname   string no
phone   string no
reseller   string no
siren   string no
state   string no
streetaddr   string no
type 0 string no
vat_number   string no
zip   string no
AuRegistrantIdType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
ABN Australian Business Number
ACN Australian Company Number
TM Trademark
ACT Australian Capital Territory
NSW New South Wales
NT Northern Territory
QLD Queensland
SA South Australia
TAS Tasmania
VIC Victoria
WA -
CaEntityType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
bank -
credit union -
savings union -
savings company -
company -
cooperation -
cooperative -
cooprix -
corp. -
federation of mutual insurance associations -
trust -
inc. -
ltd. -
lte. -
ltee. -
mutual benefit association -
nfp -
s.a. -
commercial company -
mutual insurance company -
ulc. -
llc -
sarl -
llp -
CaLegalType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

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

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
CUIT Código Único de Identificación Tributaria (Unique Code for Taxpaying Identification)
CNPJ Cadastro Nacional de Pessoas Jurídicas
CPF Cadastro de Pessoas Físicas
RUT Rol Único Tributario
ESLegalform

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
1 Individual
39 Economic Interest Group
47 Association
59 Sports limited company
68 Professional Association
124 Savings Bank
150 Community Property
152 Community of Owners
164 Order or Religious Institution
181 Consulate
197 Public Law Association
203 Embassy
229 Local Authority
269 Sports Federation
286 Foundation
365 Mutual Insurance Company
434 Regional Government Body
436 Central Government Body
439 Political Party
476 Trade Union
510 Farm Partnership
524 Public Limited Company
525 Sports Association
554 Civil Society
560 General Partnership
562 General and Limited Partnership
566 Cooperative
608 Worker-owned Company
612 Limited Company
713 Spanish Office
717 Temporary Alliance of Enterprises
744 Worker-owned Limited Company
745 Regional Public Entity
746 National Public Entity
747 Local Public Entity
877 Others (only for contacts outside of Spain)
878 Designation of Origin Supervisory Council
879 Entity Managing Natural Areas
ESTipoIdent

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
0 Other ID (for contacts outside of Spain)
1 DNI and NIF (for Spanish contacts)
3 NIE for foreigners (nationality not Spanish) with legal residence
ExtraCNIDNDocumentType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

The contact type for registrants associated with xn–55qx5d, xn–io0a7i, xn–fiqs8s or cn domains All documents except Passport must be in Chinese language
Name Description
HZ Passport for foreign individuals
SFZ Chinese ID card
WJLSFZ Foreign Permanent Resident ID Card
JGZ Chinese Officer’s identity card
TWJZZ Residence permit for Taiwan residents
GAJZZ Residence permit for Hong Kong, Macao
TWJMTX Travel passes for Taiwan Residents to Enter or Leave the Mainland
GAJMTX Exit-Entry Permit for Travelling to and from Hong Kong and Macao
JWJG Overseas Organization Certificate
QT Others
YYZZ Business License
ORG Organization Code Certificate
MBFQY Private Non-Enterprise Entity Registration Certificate
SYDWFR Public Institution Legal Person Certificate
LSZY Practicing License of Law Firm
SFJD Judicial Expertise License
GZJGZY Notary Organization Practicing License
MBXXBX Private School Permit
YLJGZY Medical Institution Practicing License
SHFWJG Social Service Agency Registration Certificate
SHTTFR Social Organization Legal Person Registration Certificate
TYDM Certificate for Uniform Social Credit Code
QTTYDM Others-Certificate for Uniform Social Credit Code
JJHFR Fund Legal Person Registration Certificate
ZJCS Religion Activity Site Registration Certificate
BDDM Military Code Designation
JDDWFW Military Paid External Service License
WGCZJG Resident Representative Offices of Foreign Enterprises Registration Form
WGZHWH Registration Certificate of Foreign Cultural Center in China
WLCZJG Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate
BJWSXX Beijing School for Children of Foreign Embassy Staff in China Permit
FIOrganizationType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
1 Company
2 Corporation
3 Institution
4 Political party
5 Township
6 Government
7 Public community
HkOwnerDocType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
HKID Hong Kong Identity Number
OTHID Other’s Country Identity Number
PASSNO Passport No.
BIRTHCERT Birth Certificate
OTHIDV Others Individual Document
BR Business Registration Certificate
CI Certificate of Incorporation
CRS Certificate of Registration of a School
HKSARG Hong Kong Special Administrative Region Government Department
HKORDINANCE Ordinance of Hong Kong
OTHORG Others Organization Document
IERegistrantType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
COM Irish company
CHA Irish charity
OTH Other
IlRegistrantCompanyType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
INC Incorporated
LTD Limited
AB Aktiebolag
SARL Société A Responsabilité Limitée
GMBH Gesellschaft mit beschränkter Haftung
LLC Limited Liability Company
ItEntityType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
2 Italian companies / one man companies
3 Italian freelance workers / professionals
4 Italian non-profit organizations
5 Italian Public organizations
6 Other italian entities
7 Foreigners who match 2 - 6
ItRegistrantNationalityIso

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
AT Austria
BE Belgium
BG Bulgaria
CH Switzerland
CY Cyprus
CZ Czech Republic
DE Germany
DK Denmark
EE Estonia
ES Spain
FI Finland
FR France
GB United Kingdom
GR Greece
HR Croatia
HU Hungary
IE Ireland
IS Iceland
IT Italy
LI Liechstenstein
LT Lithuania
LU Luxembourg
LV Latvia
MT Malta
NL Netherlands
NO Norway
PL Poland
PT Portugal
RO Romania
SE Sweden
SI Slovenia
SK Slovak (Republic)
SM San Marino
VA Holy See (Vatican City State)
MyOrganizationType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
ota000001 architect firm
ota000002 audit firm
ota000003 business pursuant to business registration act(rob)
ota000004 business pursuant to commercial license ordinance
ota000005 company pursuant to companies act(roc)
ota000006 educational institution accredited/registered by relevant government department/agency
ota000007 farmers organisation
ota000008 federal government department or agency
ota000009 foreign embassy
ota000010 foreign office
ota000011 government aided primary and/or secondary school
ota000012 law firm
ota000013 lembaga (board)
ota000014 local authority department or agency
ota000015 maktab rendah sains mara (mrsm) under the administration of mara
ota000016 ministry of defences department or agency
ota000017 offshore company
ota000018 parents teachers association
ota000019 polytechnic under ministry of education administration
ota000020 private higher educational institution
ota000021 private school
ota000022 regional office
ota000023 religious entity
ota000024 representative office
ota000025 society pursuant to societies act(ros)
ota000026 sports organisation
ota000027 state government department or agency
ota000028 trade union
ota000029 trustee
ota000030 university under the administration of ministry of
ota000031 valuer, appraiser and estate agent firm
TldPhaseDomainCreate

used by ContactCheckDomain, DescExtraParameters, DomainCreateContactForm and DomainCreate

Name Description
sunrise Open for trademark only
landrush Open to organizations
eap1 Early Access Period, phase 1 (most expensive)
eap2 Early Access Period, phase 2 (slightly less expensive)
eap3 Early Access Period, phase 3 (slightly less expensive)
eap4 … and so on, each TLD having a different set of EAPs, see domain.price() for a list for each TLD
golive Open for everyone
UKContactType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

The contact type for contacts associated to a .uk domain

Company number (x-uk_co_no) is mandatory for types beginning with a ●

Name Description
LTD ● UK Limited Company
PLC ● UK Public Limited Company
PTNR UK Partnership
STRA UK Sole Trader
LLP ● UK Limited Liability Partnership
IP ● UK Industrial/Provident Registered Company
IND UK Individual (representing self)
SCH ● UK School
RCHAR ● UK Registered Charity
GOV UK Government Body
CRC UK Corporation by Royal Charter
STAT UK Statutory Body
OTHER UK Entity that does not fit into any of the above (e.g. clubs, associations, many universities)
FIND Non-UK Individual (representing self)
FCORP Non-UK Corporation
FOTHER Non-UK Entity that does not fit into any of the above
USAppPurpose

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Stated purpose for the registration of an US domain
Name Description
P1 Business use for profit.
P2 Non-profit business, club, association, religious organization…
P3 Personal use.
P4 Education purposes.
P5 Government purposes.
USNexusCategory

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Category of the entity applying for registration of an US domain
Name Description
C11 A natural person who is a United States citizen.
C12 A natural person who is a permanent resident of the United States
C21 An entity or organization that has a bona fide presence in
C31 An entity or organization that regularly engages in lawful
C32 An entity or organization that has an office or other facility
SudoIdent

parameter of contact.reachability.unlock() and paas.cancel_delete_v5()

Name Default Type Mandatory
apikey   string yes
handle   string yes
ContactReachability

parameter of contact.reachability.resend()

Name Default Type Mandatory
reach_info   string yes
email address of the contact that will receive the reachability email
contact   string no
handle of the contact that must be validated. If not set, use the contact of the given api key
ContactReachabilityV5

parameter of contact.reachability.resend_v5()

Name Default Type Mandatory
fqdn   string yes
Reachability

parameter of contact.reachability.info() and contact.reachability.unlock()

Name Default Type Mandatory
reach_info   string yes
proto email string no
ReachabilityListOptions

parameter of contact.reachability.count_bo() and contact.reachability.list_bo()

Name Default Type Mandatory
status <ReachabilityStatus>   string no
<date_end   string no
>date_end   string no
contact_type   string no
date_end   string no
handle   string no
items_per_page 100 int no
number of items returned for the pagination
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: contact_type, date_end, handle, status
status   string no
ReachabilityStatus

used by InternalContactListOptions, ReachabilityListOptions and ReachabilityReturn

Name Description
pending the contact has not been validated yet, wait for validation
done the contact has not been validated
failed the contact is not valid
ShippingAddress

parameter of contact.shipping.set()

Name Default Type Mandatory
city   string yes
country   string yes
family   string yes
given   string yes
streetaddr   string yes
orgname   string no
state   string no
streetaddr2   string no
zip   string no
ShippingListOptions

parameter of contact.shipping.count_bo() and contact.shipping.list_bo()

Name Default Type Mandatory
<date   string no
handle   array of string or string no
items_per_page 100 int no
number of items returned for the pagination
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: handle
AutoFOAListOptions

parameter of contact.autofoa.count() and contact.autofoa.list()

Name Default Type Mandatory
<date_created   string no
<date_validated   string no
>date_created   string no
>date_validated   string no
date_created   string no
date_validated   string no
email   string no
items_per_page 100 int no
number of items returned for the pagination
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: date_created, date_validated, email
AutoFoaParams

parameter of contact.autofoa.create()

Name Default Type Mandatory
email   string no

Returns

BalanceReturn

returned by contact.balance_fo() and contact.balance()

Name Type
annual_balance int
grid string
grid_hosting string
outstanding_amount string
prepaid struct
taxes struct
BalanceV5Return

returned by contact.balance_v5()

Name Type
amount_for_next_grid int
annual_balance int
grid string
grid_type string
min_grid string
outstanding_amount string
prepaid struct
prepaid_monthly_invoice boolean
PrepaidReturn

returned by billing.prepaid.create(), billing.prepaid.info(), prepaid.create() and prepaid.info()

used by BalanceReturn and BalanceV5Return

Name Type
amount int
currency string
date_created dateTime.iso8601
date_updated dateTime.iso8601
id int
status string
warning_threshold string
ContactFoReturn

returned by contact.list_v5()

Name Type
brand_number string
bu struct
city string
community boolean
country struct
data_obfuscated int
email string
extra_parameters struct
family string
fax string
given string
handle string
id int
is_corporate boolean
jo_announce_number string
jo_announce_page string
jo_declaration_date string
jo_publication_date string
lang string
mail_obfuscated int
mobile string
newsletter int
orgname string
phone string
reachability string
security_question_answer string
security_question_num int
shippingaddress struct
siren string
state string
streetaddr string
third_part_resell int
type int
validation string
vat_number string
zip string
ContactMinimalReturn

returned by contact.create_minimal()

used by DomainContactReturn, EOIReturn and TransferoutReturn

Name Type
handle string
id int
ContactReturn

returned by contact.clone(), contact.create(), contact.info(), contact.list(), contact.update_bo() and contact.update()

Changed in version 3.3.18: key validation has been added.
validation parameter.

Changed in version 3.3.0: keys security_question_num, security_question_answer are deprecated and will be removed in the next major release.
.
.

Name Type
brand_number string
bu struct
city string
community boolean
country struct
data_obfuscated int
email string
extra_parameters struct
family string
fax string
given string
handle string
id int
is_corporate boolean
jo_announce_number string
jo_announce_page string
jo_declaration_date string
jo_publication_date string
lang string
mail_obfuscated int
mobile string
newsletter int
orgname string
phone string
reachability string
security_question_answer string
empty string
security_question_num int
0
shippingaddress struct
siren string
state string
streetaddr string
third_part_resell int
type int
validation string
vat_number string
zip string
ContactSudoReturn

returned by contact.sudo() and internal.contact.sudo()

Name Type
apikey string
handle string
InternalContactReturn

returned by contact.info_bo(), contact.list_bo(), internal.contact.info() and internal.contact.list_all()

Changed in version 3.3.18: key validation has been added.
validation parameter.

Name Type
account_password string
api_key string
birth_city string
birth_date string
birth_department string
brand_number string
bu struct
changed_ip string
city string
community boolean
country struct
data_obfuscated int
date_created dateTime.iso8601
email string
extra_parameters struct
family string
fax string
given string
handle string
id int
is_corporate boolean
jo_announce_number string
jo_announce_page string
jo_declaration_date string
jo_publication_date string
lang string
mail_obfuscated int
md5email string
mobile string
newsletter int
orgname string
phone string
reachability string
reseller struct
role string
security_question_answer string
security_question_num int
shippingaddress struct
siren string
state string
statut string
streetaddr string
third_part_resell int
type int
validation string
vat_number string
zip string
OperationInformation

used by CertificateOperationReturn, ChangeOwnerOperationReturn, DomainCreateOperationReturn, DomainDeleteOperationReturn, DomainDnssecOperationReturn, DomainReleaseOperationReturn, DomainRenewOperationReturn, DomainRestoreOperationReturn, DomainStatusUpdateOperationReturn, GoodiesOperationReturn, HostCreateOperationReturn, HostDeleteOperationReturn, HostUpdateOperationReturn, NsSetOperationReturn, OperationListReturn, OperationReturn, SiteOperationReturn and TransferInOperationReturn

Name Type
extras struct
additional informations
id string
label string
name given by the user to the associated product
product_action string
associated action
product_name string
product name if available
product_type string
associated product type in the catalog
quantity string
OperationReturn

returned by account.credit(), automaticcredit.create_fo(), billing.automaticcredit.create_fo(), billing.prepaid.create_prepaid_add_money(), contact.pref.create_bo(), contact.pref.create_fo(), contact.pref.delete_bo(), contact.pref.delete_fo(), contact.pref.update_bo(), contact.pref.update_fo(), contact.release_v5(), contact.reseller.set_v5(), contract.acceptance.update(), corporate.create(), corporate.delete(), corporate.option.create(), corporate.option.delete(), corporate.option.update(), corporate.renew(), corporate.update(), domain.clone_owner_for_reseller(), domain.contacts.set_v5(), domain.contacts.set(), domain.create_info_v5(), domain.mailbox.purge(), domain.mailbox.responder.activate(), domain.mailbox.responder.deactivate(), domain.mailboxv2.activate(), domain.mailboxv2.buy(), domain.mailboxv2.deactivate(), domain.mailboxv2.downgrade.apply(), domain.mailboxv2.migration.apply(), domain.mailboxv2.patch(), domain.mailboxv2.purge(), domain.mailboxv2.refund.apply(), domain.mailboxv2.upgrade.apply(), domain.nameservers.delete_advanced_dns(), domain.nameservers.delete_premium_dns(), domain.nameservers.set_advanced_dns(), domain.nameservers.set_premium_dns(), domain.packmail.autorenew(), domain.packmail.create(), domain.packmail.delete(), domain.packmail.renew(), domain.packmail.update(), domain.pref.create_bo(), domain.pref.delete_bo(), domain.pref.update_bo(), domain.reseller.set(), domain.transferout.accept(), domain.transferout.decline(), domain.transferout.proceed_v5(), domain.transferout.proceed(), flex.create(), flex.delete(), flex.update(), hosting.account.change_owner_to_v5(), hosting.account.credit(), hosting.rproxy.create(), hosting.rproxy.delete(), hosting.rproxy.probe.disable(), hosting.rproxy.probe.enable(), hosting.rproxy.probe.update(), hosting.rproxy.server.create(), hosting.rproxy.server.delete(), hosting.rproxy.server.disable(), hosting.rproxy.server.enable(), hosting.rproxy.update(), hosting.rproxy.vhost.alter_zone(), hosting.rproxy.vhost.create(), hosting.rproxy.vhost.delete(), hosting.trigger.create(), hosting.trigger.delete(), hosting.trigger.update(), hosting.vlan.create(), hosting.vlan.delete(), hosting.vlan.update(), internal.contact.pref.create(), internal.contact.pref.delete(), internal.contact.pref.update(), internal.domain.pref.create(), internal.domain.pref.delete(), internal.domain.pref.update(), internal.domain.transferout.accept(), internal.domain.transferout.decline(), notification.subscription.create(), notification.subscription.delete(), operation.create_bo(), operation.info_bo(), operation.info(), paas.change_version_v5(), paas.create_v5(), paas.delete_v5(), paas.notify_update_v5(), paas.pause_v5(), paas.renew_dry_run(), paas.renew_v5(), paas.restart_v5(), paas.update_v5(), paas.vhost.create_v5(), paas.vhost.delete_v5(), prepaid.create_prepaid_add_money(), reseller.email.delete(), reseller.email.update(), security.sudoer.create() and security.sudoer.delete()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
ReachabilityReturn

returned by contact.reachability.info() and contact.reachability.list_bo()

Name Type
date_created dateTime.iso8601
date_end dateTime.iso8601
handle string
hash_key string
proto string
reach_info string
required boolean
status string
BoShippingAddressReturn

returned by contact.shipping.list_bo()

Name Type
city string
contact struct
country string
date string
family string
given string
orgname string
state string
streetaddr string
streetaddr2 string
zip string
ShippingAddressReturn

returned by contact.shipping.get_bo(), contact.shipping.get(), contact.shipping.set() and internal.contact.shipping.get()

Name Type
city string
country string
family string
given string
orgname string
state string
streetaddr string
streetaddr2 string
zip string
AutoFoaReturn

returned by contact.autofoa.create() and contact.autofoa.list()

Name Type
date_created dateTime.iso8601
date_validated dateTime.iso8601
email string
id int