Need help? Call Live Support at +31 (0) 38 453 07 59

Get contact

Used to get a contact

The response fields marked with Gateway are only available on gateway accounts and only for users with the VIEW_REGISTRY_ACCOUNT permission.

  • GETMethod
  • /v2/customers/customer/contacts/handleURL
URL fields
Name Type Description Restrictions
customer String The handle of the customer
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
handle String The contact handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Contact has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
customer String Required The customer handle
handle String Required The contact handle
brand String Required The brand
organization String Optional The name of the organization
name String Required The name of the person
addressLine List <String> Required The address lines
postalCode String Required Postal code
city String Required The city
state String Optional The state
country String Required The ISO 3166-1 alpha2 country code
email String Required The email address
voice String Required The voice telephone number
fax String Optional The fax telephone number
registries List <String> Optional List of registries the contact exists at
properties Map <String, Map <String, String>> Optional Contact registry properties, nested map of registry and the contact properties for that registry
createdDate Timestamp Required The date the contact was created
updatedDate Timestamp Optional The date the contact was last updated
disclosedFields List <Enum> Optional List of fields disclosed (in RDAP) where this contact is used for a domain. Country and state are allways publicly available.

Possible values:

  • registryContactId: Registry Contact ID (contact:roid)
  • email: Contact e-mail
  • name: Contact name
  • organization: Contact organization
  • addressLine: Contact address lines
  • city: Contact city or locality
  • postalCode: Contact postal code
  • voice: Contact phone number
  • fax: Contact fax number
  • state: Contact state
  • country: Contact country
validations List < validations > Optional Categories the contact has validated
registryAccounts List < registryAccounts > Optional Gateway The associated contact objects at registries
verifications List < verifications > Optional CONTACT_VERIFICATION Verifications performed for this contact
validations
Name Type Required / Optional Description
validatedOn Timestamp Required The date the contact has validated this category
version Integer Required The version of the category terms the contact has validated
category String Optional The validation category
registryAccounts
Name Type Required / Optional Description
registry String Required The registry
registryAccount String Required The registry account
id String Required The contact ID at the registry
authCode String Optional The auth code of the contact name
roid String Optional The registry Repository Object Identifier
intendedUsage List <Enum> Optional The allowed usages for this contact

Possible values:

  • REGISTRANT
  • ADMIN
  • BILLING
  • TECH
verifications
Name Type Required / Optional Description
verificationDate Timestamp Required The date the contact has been verified
method Enum Required The verification method

Possible values:

  • REACHABILITY: Person or company is reachable
  • ELECTRONIC_DOCUMENT: Electronic document
  • PHYSICAL_DOCUMENT: Physical document
  • EID_AUTH: Electronic ID authentication
  • TRANSACTION: Transaction of data
  • DATA: Data extraction
proof Enum Required The verification proof

Possible values:

  • LOG_RECORD: transaction log record (e-mail, address or voice log record)
  • ID_CARD: ID card
  • PASSPORT: Passport
  • POPULATION_REGISTER: National register of residents
  • RESIDENCE_PERMIT: Official residence document
  • DRIVERS_LICENCE: Driver's license
  • COMPANY_REGISTER: National register of companies
  • COMPANY_STATEMENT: Any company statement (e.g. annual financial statements
  • BANK_ACCOUNT: Record of payment (e.g. via direct debit or credit card)
  • ONLINE_PAYMENT_ACCOUNT: Record of payment via online payment
  • UTILITY_ACCOUNT: Utility bill
  • BANK_STATEMENT: Bank statement
  • TAX_STATEMENT: Tax statement
  • ADDRESS_DATABASE: Database of addresses
externalId String Required The ID of the verification at the external provider
claims List <Enum> Required Set of claims that are made with this verification

Possible values:

  • EMAIL: E-mail
  • ADDRESS: Address
  • ORGANIZATION: Organization
  • NAME: Name
  • VOICE: Voice
createdDate Timestamp Required The date the verification was created
updatedDate Timestamp Optional The date the verification was last updated

Failed requests

Generic errors can be expected.

URL fields
The handle of the customer
The contact handle
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/customers/customer/contacts/handle

Response