Knowledge Base

Check for answers to your questions by searching by keywords, or check categories below.

5 Domains API: How to retrieve TLD specific customer additional data

This is a series of articles dedicated to demonstrating how to get acquainted with Openprovider Zones API methods. To get more information about our API in general, please use our documentation portal as your reference.

 

In the previous article we have covered additional domain fields that are required by some domain registries for a given TLD.

 

Apart from domain specific attributes there also can exist customer(handle) specific data. For the very purpose of requesting those fields one can utilise the following endpoint: 

Entering Geo Fence iconUse endpoint path below. Base URL is determined by both the target environment and API version.
GET {base_url}/domains/additional-data/customers

REQUEST VALUES

Name Type Description
domain.name string  Required.
domain.extension string  Required.

REQUEST EXAMPLE

curl -X GET \
'https://api.cte.openprovider.eu/v1beta/domains/additional-data/customers?domain.name=domain&domain.extension=ru' \
-H 'Authorization: Bearer eca82663f*******76d063d8f6196'

RESPONSE EXAMPLE

{
"data": [
{
"name": "companyNameCyrillic",
"description": "Company name in Cyrillic",
"type": "text"
},
{
"name": "companyNameLatin",
"description": "Company name in Latin",
"type": "text"
},
{
"name": "firstNameCyrillic",
"description": "First name in Cyrillic",
"type": "text"
},
{
"name": "firstNameLatin",
"description": "First name in Latin",
"type": "text"
},
{
"name": "lastNameCyrillic",
"description": "Last name in Cyrillic",
"type": "text"
},
{
"name": "lastNameLatin",
"description": "Last name in Latin",
"type": "text"
},
{
"name": "middleNameCyrillic",
"description": "Middle name in Cyrillic",
"type": "text"
},
{
"name": "middleNameLatin",
"description": "Middle name in Latin",
"type": "text"
},
{
"name": "passportIssueDate",
"description": "Passport issue date",
"type": "text"
},
{
"name": "passportIssuer",
"description": "Passport issuer",
"type": "text"
},
{
"name": "passportSeries",
"description": "Passport series",
"type": "text"
},
{
"name": "passportNumber",
"description": "Passport number",
"type": "text"
},
{
"name": "taxPayerNumber",
"description": "Tax payer number",
"type": "text"
},
{
"name": "mobilePhoneNumber",
"description": "Mobile phone number with SMS",
"type": "text"
},
{
"name": "postalAddressCyrillic",
"description": "Postal address",
"type": "text"
},
{
"name": "legalAddressCyrillic",
"description": "Legal address",
"type": "text"
},
{
"name": "birthDate",
"description": "Birth date is required",
"type": "text"
},
{
"name": "isPrivateEnterpreneur",
"description": "Whether the contact is the private enterpreneur.",
"type": "check"
}
]
}

RESPONSE VALUES

Name Type Description
name string  
required   if the field is mandatory or optional
type   field type, e.g. text, check, select, multiselect
options   possible values & value descriptions
description    

Was this article helpful?
1 out of 1 found this helpful