Schemas
UpdateDefaultContactsRequest
customerIdThe Customer for whom you want to set the Default Contacts
typeType of default contact to be returned. It can be one or more of following contacts types : Contact , CoopContact , UkContact , EuContact , CnContact , CoContact , CaContact , DeContact , EsContact .
registrantContactIdThe Registrant Contact of the domain name.
adminContactIdThe Administrative Contact of the domain name. Note Pass -1 for the following TLDs: .EU .NZ .RU .UK
techContactIdThe Technical Contact of the domain name. Note Pass -1 for the following TLDs: .EU .NZ .RU .UK
billingContactIdThe Billing Contact of the domain name. Note Pass -1 for the following TLDs: .AT .BERLIN .CA .EU .NL .NZ .RU .UK .LONDON
DefaultContactIdsDto
registrantContactIdRegistrant contact identifier.
adminContactIdAdministrative contact identifier.
techContactIdTechnical contact identifier.
billingContactIdBilling contact identifier.
CreateContactRequest
nameName of the contact. Max length 255 characters (general) or 50 characters (.EU). For AtContact, the name must consist of at least two words.
emailEmail address of the contact.
addressLine1First address line. Max length 64 characters. NycContact requires a physical NYC street address.
cityCity name. Max length 64 characters.
countryISO 3166-1 alpha-2 country code. UkServiceContact allows only GB, IM, JE, or GG.
zipcodeZIP or postal code. Max length 10 (general) or 16 (.EU). Validated against country.
phoneCountryCodeTelephone country code. Between 1 and 3 digits.
phoneTelephone number. Between 4-12 digits (general) or 4-13 digits (.RU).
customerIdCustomer under whom the contact is created.
typeContact type determining which TLD-specific extra fields apply.
Allowed values
| Value | Description |
|---|---|
| Contact | Standard contact |
| AtContact | Austria (.AT) contact — name must have at least two words |
| BrContact | Brazil admin/technical/billing contact — must not include organisationId |
| BrOrgContact | Brazil registrant contact — requires organisationId (CPF/CNPJ) |
| CaContact | Canada (.CA) contact — registrant requires CPR and agreement fields |
| ClContact | Chile (.CL) contact |
| CnContact | China (.CN) contact — may require organisationVerificationId |
| CoContact | Colombia (.CO) contact |
| CoopContact | Co-operative (.COOP) registrant — requires sponsorReference |
| DeContact | Germany (.DE) contact |
| EsContact | Spain (.ES) contact — requires esFormJuridica fields; state must be Spanish province |
| EuContact | European Union (.EU) contact — may require countryOfCitizenship |
| FrContact | France (.FR) contact |
| MxContact | Mexico (.MX) contact |
| NlContact | Netherlands (.NL) contact — requires legalForm on all contacts |
| NycContact | New York City (.NYC) contact — requires NYC street address |
| RuContact | Russia (.RU) contact — requires contractType and RU-specific fields |
| UkContact | United Kingdom (.UK) contact |
| UkServiceContact | UK service contact — country must be GB, IM, JE, or GG |
companyCompany name. Max length 255 (general) or 100 (.EU). EuContact may use NA when no company. RuContact requires at least two words or N A / Not Applicable. EsContact registrant individuals must omit company; admin/tech/billing contacts must be natural persons without company.
addressLine2Second line of address (optional).
addressLine3Third line of address (optional).
stateState or province. Max length 64 characters. When type is EsContact, use a Spanish province code from the allowed values table.
Allowed values
| Value | Description |
|---|---|
| Albacete | Province of Albacete |
| Alicante | Province of Alicante |
| Almeria | Province of Almería |
| Araba | Province of Araba |
| Asturias | Province of Asturias |
| Avila | Province of Ávila |
| Badajoz | Province of Badajoz |
| Barcelona | Province of Barcelona |
| Bizkaia | Province of Bizkaia |
| Burgos | Province of Burgos |
| Caceres | Province of Cáceres |
| Cadiz | Province of Cádiz |
| Cantabria | Province of Cantabria |
| Castellon | Province of Castellón |
| Ceuta | Autonomous city of Ceuta |
| Ciudad Real | Province of Ciudad Real |
| Cordoba | Province of Córdoba |
| Coruña, A | Province of A Coruña |
| Cuenca | Province of Cuenca |
| Gipuzkoa | Province of Gipuzkoa |
| Girona | Province of Girona |
| Granada | Province of Granada |
| Guadalajara | Province of Guadalajara |
| Huelva | Province of Huelva |
| Huesca | Province of Huesca |
| Illes Balears | Balearic Islands |
| Jaen | Province of Jaén |
| Leon | Province of León |
| Lleida | Province of Lleida |
| Lugo | Province of Lugo |
| Madrid | Province of Madrid |
| Malaga | Province of Málaga |
| Melilla | Autonomous city of Melilla |
| Murcia | Region of Murcia |
| Navarra | Province of Navarra |
| Ourense | Province of Ourense |
| Palencia | Province of Palencia |
| Palmas, Las | Province of Las Palmas |
| Pontevedra | Province of Pontevedra |
| Rioja, La | Province of La Rioja |
| Santa Cruz de Tenerife | Province of Santa Cruz de Tenerife |
| Segovia | Province of Segovia |
| Sevilla | Province of Sevilla |
| Soria | Province of Soria |
| Tarragona | Province of Tarragona |
| Teruel | Province of Teruel |
| Toledo | Province of Toledo |
| Valencia | Province of Valencia |
| Valladolid | Province of Valladolid |
| Zamora | Province of Zamora |
| Zaragoza | Province of Zaragoza |
faxCountryCodeFax country code (optional). Between 1 and 3 digits.
faxFax number (optional). Between 4-12 digits (general) or 4-13 digits (.RU).
localityTwo-letter ISO 3166-1 alpha-2 country code for the contact locality. Required when associating a contact with a .ASIA domain. Example: IN (India).
legalEntityTypeLegal entity type of the registrant. Required when associating a contact with a .ASIA domain.
Allowed values
| Value | Description |
|---|---|
| naturalPerson | Natural person |
| corporation | Corporation |
| cooperative | Cooperative |
| partnership | Partnership |
| government | Government |
| politicalParty | Political party |
| society | Society |
| institution | Institution |
| other | Other (requires otherLegalEntityType) |
otherLegalEntityTypeFree-text description of the legal entity type. Required when legalEntityType is other. Applies to .ASIA domain contacts.
identFormForm of identity document. Required when associating a contact with a .ASIA domain.
Allowed values
| Value | Description |
|---|---|
| passport | Passport |
| certificate | Certificate |
| legislation | Legislation |
| societyRegistry | Society registry |
| politicalPartyRegistry | Political party registry |
| other | Other (requires otherIdentForm) |
otherIdentFormFree-text description of the identity form. Required when identForm is other. Applies to .ASIA domain contacts.
identNumberIdentification document number for the chosen identForm. Required when associating a contact with a .ASIA domain.
organisationIdBrazilian tax ID (CPF) for an individual or organisation ID (CNPJ) for a company. Only Brazilian nationals or organizations can register .BR domains; this value must either not already be registered in the registrar database or have transferred authority to the registrar through the .BR registry web interface. Required only for BrOrgContact (registrant). Admin, technical, and billing contacts must use BrContact and must not include this value. Example: a valid CPF for an individual registrant or CNPJ for a company registrant.
cprThree-letter Canadian Presence Requirement (CPR) code for the registrant category. Required on the registrant contact for .CA domains.
Allowed values
| Value | Description |
|---|---|
| CCO | Corporation (Canada or Canadian province or territory) — 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 registered in Canada — Non-individual |
| MAJ | Her Majesty the Queen — Non-individual |
agreementVersionAgreement version string returned by the GetRegistrantAgreement API. Required on the registrant contact for .CA domains together with agreementValue.
agreementValueRegistrant agreement acceptance flag. Required on the registrant contact for .CA domains together with agreementVersion.
Allowed values
| Value | Description |
|---|---|
| y | Registrant agrees to the .CA Registrant Agreement |
sponsorReferenceSponsor ROID (co-operative reference) to associate with the contact. Required on the registrant contact for .COOP domains. Example: 12345.
organisationVerificationIdOrganization verification ID — any ID associated with the organization. Required when associating a contact with a .CN domain.
esFormJuridicaSpanish legal entity type code. The registrant may be a natural person or company; admin, technical, and billing contacts must be natural persons only. Required when associating a contact with a .ES domain.
Allowed values
| Value | Description |
|---|---|
| 1 | Natural person or individual |
| 39 | Economic Interest Grouping |
| 47 | Association |
| 59 | Sports Association |
| 68 | Trade Association |
| 124 | Savings Bank |
| 150 | Community Property |
| 152 | Condominium |
| 164 | Religious Order or Institution |
| 181 | Consulate |
| 197 | Public Law Association |
| 203 | Embassy |
| 229 | Municipality |
| 269 | Sports Federation |
| 286 | Foundation |
| 365 | Mutual Insurance Company |
| 434 | Provincial Government Body |
| 436 | National Government Body |
| 439 | Political Party |
| 476 | Trade Union |
| 510 | Farm Partnership |
| 524 | Public Limited Company / Corporation |
| 525 | Sports Public Limited Company |
| 554 | Partnership |
| 560 | General Partnership |
| 562 | Limited Partnership |
| 566 | Cooperative |
| 608 | Worker-owned Company |
| 612 | Limited Liability Company |
| 713 | Spanish (company) Branch |
| 717 | Temporary Consortium / Joint Venture |
| 744 | Worker-owned Limited Company |
| 745 | Provincial Government Entity |
| 746 | National Government Entity |
| 747 | Local Government Entity |
| 877 | Others |
| 878 | Designation of Origin Regulatory Council |
| 879 | Natural Area Management Entity |
esTipoIdentificacionSpanish identification document type. Required when associating a contact with a .ES domain.
Allowed values
| Value | Description |
|---|---|
| 1 | DNI or NIF — Spanish National Personal ID or company VAT ID number |
| 3 | NIE — Spanish resident alien ID number |
| 0 | Other ID — Passport, foreign ID, company registration, driver's license, etc. |
esIdentificacionIdentification number matching the chosen esTipoIdentificacion. Required when associating a contact with a .ES domain. Example: a DNI/NIF or NIE number.
countryOfCitizenshipTwo-letter ISO 3166-1 alpha-2 country code for citizenship. Required for .EU registrant contacts when the registrant is an individual and the country of residence is outside the EU/EEA. Example: US.
jobsTitleJob title of the contact at the company. Required on all contacts for .JOBS domains.
jobsWebsiteCompany website URL. Required on all contacts for .JOBS domains.
jobsIndustryTypeIndustry classification for the business the company conducts. Required on all contacts for .JOBS domains.
jobsIsAdminContactWhether this contact is the administrative contact. Required on all contacts for .JOBS domains.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
jobsIsAssociationMemberWhether the company is an association member. Required on all contacts for .JOBS domains.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
legalFormDutch legal form. Required on all contacts for .NL domains.
Allowed values
| Value | Description |
|---|---|
| PERSOON | Natural person |
| ANDERS | Other legal form |
contractTypeRussian contact classification. Mandatory when associating a contact with a .RU domain.
Allowed values
| Value | Description |
|---|---|
| ORG | Organization contact — requires org-r, address-r, and Russian org tax fields when applicable |
| PRS | Individual contact — requires birth-date, person-r, and passport |
birthDateBirth date in DD.MM.YYYY format. Mandatory for individual (PRS) .RU contacts. Example: 08.08.1900.
orgRLegally registered company name as on company formation documents, preferably in Russian, with at least two words. Mandatory for organization (ORG) .RU contacts.
personRRegistrant full name, preferably in Russian. Mandatory for individual (PRS) .RU contacts. Example: Ivan Ivanov.
addressRRegistrant address, preferably in Russian, with at least two words for organizations. Mandatory for organization (ORG) .RU contacts.
kpp9-digit territory-linked taxpayer number (KPP). Mandatory for Russian organization (ORG) .RU contacts when the country is Russia. Example: 123456789.
code10-digit taxpayer identification number (TIN). Mandatory for Russian organization (ORG) .RU contacts when the country is Russia. Example: 0987654321.
ruPassportPassport details for individual (PRS) .RU contacts: document number, issued by, and issued date. Example: 12 34 567890, issued by the 123 police station of Moscow, 30.01.1990.
usPurposeUS nexus application purpose for the registrant. Required on the registrant contact for .US domains.
Allowed values
| Value | Description |
|---|---|
| P1 | Business use for profit |
| P2 | Non-profit business, club, association, religious organization, etc. |
| P3 | Personal use |
| P4 | Education purposes |
| P5 | Government purposes |
usCategoryUS nexus category for the registrant. Required on the registrant contact for .US domains.
Allowed values
| Value | Description |
|---|---|
| C11 | Natural person who is a United States citizen |
| C12 | Natural person who is a permanent resident of the United States or its possessions or territories |
| C21 | US-based organization or company formed under US state, DC, territory, or federal law |
| C31 | Foreign entity or organization with a bona fide presence in the United States |
| C32 | Entity has an office or other facility in the United States |
GetDefaultContactsRequest
customerIdThe Customer for whom you want to get the Default Contacts
typeType of default contact to be returned. It can be one or more of following contacts types : Contact , CoopContact , UkContact , EuContact , CnContact , CoContact , CaContact , DeContact , EsContact .
ContactProfileDto
contactIdContact identifier.
customerIdCustomer identifier.
nameContact name.
companyCompany name.
typeContact type.
emailEmail address.
phoneCountryCodeTelephone country code.
phoneTelephone number.
faxCountryCodeFax country code.
faxFax number.
addressLine1Address line 1.
addressLine2Address line 2.
addressLine3Address line 3.
cityCity.
stateState or province.
countryCountry code.
zipcodePostal or ZIP code.
currentStatusCurrent contact status.
contactStatusContact status detail.
parentKeyParent key reference.
passwdcontactTypeclassNameclassKeyroidactionCompleteddescriptionentityTypeIdjumpConditionscreationDateContact creation date.
timestampLast update timestamp.
validBoolean. Whether the contact is valid. Possible values are true or false.
WHOIS validation details when returned in the response.
designatedAgentBoolean. Whether the contact is a designated agent. Possible values are true or false.
WhoisValidityDto
validBoolean. Whether the contact passes WHOIS validation. Possible values are true or false.
invalidDataValidation issues. String entries are returned as-is; object entries are serialized as JSON strings.
ContactSearchResultDto
contactIdContact identifier.
nameContact name.
companyCompany name.
typeContact type.
emailEmail address.
WHOIS validation details when returned in the response.
currentStatusphoneTelephone number.
phoneCountryCodeTelephone country code.
entityIdEntity identifier.
customerIdCustomer identifier.
creationDateContact creation date.
timestampLast update timestamp.
descriptionaddressLine1Address line 1.
addressLine2Address line 2.
addressLine3Address line 3.
cityCity.
stateState or province.
countryCountry code.
zipcodePostal or ZIP code.
faxFax number.
faxCountryCodeFax country code.
CreateContactResponse
contactIdContact identifier of the newly added contact.
DeleteContactResponse
actionStatusStatus of the associated action.
actionStatusDescDescription of the action status.
actionTypeDescDescription of the action type.
entityIdEntity identifier associated with the action.
eaqIdAction queue identifier.
actionTypeAction type identifier.
currentActionCurrent action state.
descriptionAdditional description of the action.
statusOverall status when the request fails.
messageError details when the request fails.
GetContactResponse
Contact profile details.
statusOverall status when the request fails.
messageError details when the request fails.
GetDefaultContactsResponse
Default contact identifiers by role.
Registrant contact profile when returned in the response.
Administrative contact profile when returned in the response.
Technical contact profile when returned in the response.
Billing contact profile when returned in the response.
actionStatusStatus of the associated action.
actionStatusDescDescription of the action status.
actionTypeDescDescription of the action type.
entityIdEntity identifier associated with the action.
eaqIdAction queue identifier.
actionTypeAction type identifier.
typeContact type.
statusOverall status when the request fails.
messageError details when the request fails.
transactionIdSearchContactsResponse
totalItemsTotal contacts matching the search.
itemsOnPageContacts returned on this page.
Matching contact entries.
UpdateDefaultContactsResponse
Default contact identifiers by role.
actionStatusStatus of the associated action.
actionStatusDescDescription of the action status.
actionTypeDescDescription of the action type.
entityIdEntity identifier associated with the action.
eaqIdAction queue identifier.
actionTypeAction type identifier.
typeContact type.
statusOverall status when the request fails.
messageError details when the request fails.
transactionId