Your browser don't permit web-fonts to be installed. Our websites use web-fonts based icons. For a better experience please allow your browser to use web-fonts.
¡Trabaja con nosotros!
Deutsch | English | Español

Chapter 2. Methods

2.1. Account

The account object provides methods concerning to your account.

2.1.1. account.changepassword

Change current password.

2.1.1.1. Input

Table 2.1. Parameters

ParameterDescriptionTypeRequiredDefault
usernameCustomers username text64 true 
currentpasswordThrows EPP1200 if provided password doesn't matches current password password true 
passwordCustomers password password true 
testingExecute command in testing mode boolean falsefalse

2.1.1.2. Output

No additional return parameters

2.1.2. account.check

Check whether you have currently a session.

2.1.2.1. Input

No parameters allowed

2.1.2.2. Output

Table 2.2. Parameters

ParameterDescriptionTypeOptional
userYour username text64  

2.1.3. account.createAccount

Create a new account.

2.1.3.1. Input

Table 2.3. Parameters

ParameterDescriptionTypeRequiredDefault
usernameThe username for logging in. username true 
passwordThe password for logging in. password true 
titleAccount user gender title. addressTitle true 
firstnameAccount user first name. text64 true 
lastnameAccount user last name. text64 true 
orgAccount user organisation. token0255 false 
streetAccount user address: Street. text64 true 
pcAccount user address: Postal code. text10 true 
cityAccount user address: City. text64 true 
ccAccount user address: Country. country true 
voiceAccount user's phone number. phone true 
faxAccount user's fax number, if exists. phoneoptional false 
wwwAccount user's website address. token0255 false 
emailAccount user's email address. email true 
defaultImportNSImport nameservers automatically on update. Defaults to FALSE. boolean falsefalse
mailListIdOne or more maillist IDs to subscribe account user to. array_int false 
languageAccount user's interface language. Defaults to DE. language falseDE
alreadyVerified Set to TRUE if account mail address has already been validated. In this case, no validation email will be sent. Defaults to FALSE. boolean falsefalse
frontend Frontend URL for validation/activation link, if a verification mail needs to be sent. toke0255 false 

2.1.3.2. Output

No additional return parameters

2.1.4. account.info

Get your account details.

2.1.4.1. Input

No parameters allowed

2.1.4.2. Output

Table 2.4. Parameters

ParameterDescriptionTypeOptional
accountIdAccount id int  
customerIdCustomer id int  
usernameUsername text64  
titleSalutation title addressTitle  
firstnameCustomers firstname text64  
lastnameCustomers lastname text64  
orgCustomers organisation/company text064  
streetCustomers street text64  
pcCustomers postal code text10  
cityCustomers city text64  
ccCustomers country country  
voiceCustomers phone number phone  
faxCustomers fax number phoneoptional  
wwwCustomers web address token0255  
emailCustomers email address email  
servicePinCustomers service pin int  
crDateCustomers date of account creation dateTime  
secureModeCustomers secure mode boolean  
signPdfsCustomer gets signed pdfs boolean  
summaryInvoiceCustomer gets summary invoice boolean  
mailListIdList of subscribed mail-list-ids array_int Yes
languageCustomers language language  
notificationEmailCustomer gets notification emails boolean  
notificationQueueCustomer uses notification queue boolean  
lowBalanceCustomers low balance notification value float  
paymentTypeCustomers type of payment paymentType  
bankAccHolderCustomers name of bank account holder token255  
bankNameCustomers name of bank token255  
bankCodeCustomers bank code token255  
bankAccHolderNoCustomers bank account number text64  
vatCustomers vat int  
vatNoCustomers company vat number vatNo  
whoisProviderDefault whois provider token255  
whoisUrlDefault whois url token255  
defaultRegistrantDefault registrant contact handle int  
defaultAdminDefault administrative contact handle int  
defaultTechDefault technical contact handle int  
defaultBillingDefault billing contact handle int  
defaultNssetDefault nameserver set int  
defaultWebDefault web nameserver entry token0255 Yes
defaultMailDefault mail nameserver entry text0255 Yes
defaultImportNSImport NS in case of Domain Transfer boolean Yes
lastLoginDate of last login dateTime  
loginCountCount of logins int  
rowsPerPageDefault rows per page value int  
tfa2-factor-authentification method tfaMethod  
lastIPCustomers ip address of last access ip  
verificationCustomers data verfication pending flag int  
emailBillingCustomers email address for billing email  
emailAutomatedEmail address for automated emails email  
currencycurrency customercurrency  
isResellerDefines if the customer is a reseller or not boolean  
supplimentInvoiceTextSuppliment text to the invoice text0100  

2.1.5. account.lock

Lock your account

2.1.5.1. Input

No parameters allowed

2.1.5.2. Output

No additional return parameters

2.1.6. account.login

Log in to API.

2.1.6.1. Input

Table 2.5. Parameters

ParameterDescriptionTypeRequiredDefault
userYour username text64 true 
passYour password password true 
case-insensitiveCase insensitivity for username boolean falsefalse

2.1.6.2. Output

Table 2.6. Parameters

ParameterDescriptionTypeOptional
customerIdCustomers id int  
accountIdCustomers account id int  
tfa2-factor-authentification method tfaMethod  
builddateAPI date of build text64  
versionAPI version int  

2.1.7. account.logout

Log out from API.

2.1.7.1. Input

No parameters allowed

2.1.7.2. Output

No additional return parameters

2.1.8. account.unlock

Unlock your account

2.1.8.1. Input

Table 2.7. Parameters

ParameterDescriptionTypeRequiredDefault
tanYour TAN (Transaction number) text10 false 

2.1.8.2. Output

No additional return parameters

2.1.9. account.update

Update customers account data.

2.1.9.1. Input

Table 2.8. Parameters

ParameterDescriptionTypeRequiredDefault
usernameCustomers username username false 
titleCustomers salutation title addressTitle false 
firstnameCustomers firstname text64 false 
lastnameCustomers lastname text64 false 
orgCustomers organisation/company token0255 false 
streetCustomers street text64 false 
pcCustomers postal code text10 false 
cityCustomers city text64 false 
ccCustomers country country false 
voiceCustomers phone number phone false 
faxCustomers fax number phoneoptional false 
wwwCustomers web address token0255 false 
emailCustomers email address email false 
emailAutomatedCustomers automated email address emailoptional false 
emailBillingCustomers email address for billing emailoptional false 
servicePinCustomers service pin text64 false 
summaryInvoiceCustomer gets summary invoice boolean false 
mailListIdOne or more mail-list-id(s) array_int false 
languageCustomers language language false 
notificationEmailCustomer get notification emails boolean false 
notificationQueueCustomer uses notification queue boolean false 
lowBalanceCustomers low balance notification value float_signed false 
bankAccHolderCustomers name of bank account holder token255 false 
bankCodeCustomers bank code text64 false 
bankNameCustomers name of bank text64 false 
bankAccHolderNoCustomers bank account number text64 false 
vatNoCustomers company vat number vatNoInternational false 
whoisProviderDefault whois provider token0255 false 
whoisUrlDefault whois url token0255 false 
defaultRegistrantDefault registrant contact handle int false 
defaultAdminDefault admin contact handle int false 
defaultTechDefault tech contact handle int false 
defaultBillingDefault billing contact handle int false 
defaultNssetDefault nameserver set int false 
defaultWebDefault web nameserver entry token0255 false 
defaultMailDefault mail nameserver entry text0255 false 
defaultImportNSImport NS in Case of Domain Transfer boolean false 
supplimentinvoicetextSuppliment text to the invoice text0100 false 
passwordCustomers password password false 
rowsPerPageDefault rows per page value int false 
isResellerIs Customer a reseller? boolean_3 false 
testingExecute command in testing mode boolean falsefalse

2.1.9.2. Output

No additional return parameters