Skip to content

Common Types

This page documents common data structures used throughout the API. These types appear in multiple endpoints and resources.

Address

Used for billing and shipping addresses throughout the API.

FieldTypeRequiredDescription
firstNamestringNoContact's first name (for shipping addresses only).
lastNamestringNoContact's last name (for shipping addresses only).
line1stringYesStreet address (e.g., "Trieda Andreja Hlinku"). Max 255 characters.
line2stringNoAdditional address info (e.g., unit number). Max 255 characters.
citystringYesCity name. Max 255 characters.
postalCodestringYesPostal code. Max 255 characters.
countrystringYesISO 3166-1 Alpha-2 country code (e.g., "SK", "CZ", "HU"). 2 chars.

Address Types

  • Billing Address: Contains core address fields only (no name fields)
  • Shipping Address: Includes optional firstName and lastName fields for delivery contact
  • Checkout Address: All fields have a maximum length of 255 characters

Example (Shipping Address):

json
{
  "firstName": "Anton",
  "lastName": "Čomáš",
  "line1": "Trieda Andreja Hlinku",
  "line2": "1/14A",
  "city": "Nitra",
  "postalCode": "949 01",
  "country": "SK"
}

Example (Billing Address):

json
{
  "line1": "Trieda Andreja Hlinku",
  "line2": "1/14A",
  "city": "Nitra",
  "postalCode": "949 01",
  "country": "SK"
}

Bank Account

Bank account information for expert payouts.

AttributeDescription
iban string, nullableSlovak IBAN (must start with SK, 24 characters).
json
{
  "iban": "SK3112000000198742637541"
}

Company

Company information for business registrations and invoicing.

AttributeDescription
businessId stringBusiness ID (e.g., IČO).
taxId stringTax ID (e.g., DIČ).
vatId string, nullableVAT ID (e.g., IČ DPH).
json
{
  "businessId": "10699595",
  "taxId": "421769982",
  "vatId": null
}

Coords

Geographic coordinates for real estate locations.

AttributeDescription
lat numberLatitude.
lng numberLongitude.
json
{
  "lat": 48.30734852531308,
  "lng": 18.086583509280644
}

Date of Birth

Date of birth structure for user registration.

FieldTypeDescription
dayintegerDay of month (1-31).
monthintegerMonth (1-12).
yearintegerYear of birth (1920-2010).
json
{
  "day": 15,
  "month": 6,
  "year": 1985
}