# Schema Reference

The VPD service exposes a GraphQL (opens new window) endpoint. In GraphQL, you define exactly which fields you want in the response. This page documents all available queries and the types they return.

Only request the fields you actually need for your use case. For guidance on choosing the right query and fields, see the getting started chapter.

# Queries

# party

Search for parties by one or more arguments. Returns a list of matching parties ordered by relevance.

party(
  search: String       # Free-text search across all fields
  id: String           # Search by identifier — e.g. a KvK or VAT number, or even eConnectId
  name: String         # Search by party name
  postcode: String     # Filter by postal code
  city: String         # Filter by city
  country: String      # Filter by country — e.g. "NL" or "BE"
  lang: String         # Language for results — defaults to "nl"
  maxResults: Int      # Maximum number of results — defaults to 10
): [party]

# find

Best-effort match for a party when data quality or completeness is uncertain. Provide any combination of the available fields — all are optional.

find(args: {
  name: String            # Party name
  nameAdditional: String  # Additional or alternative name
  postcode: String        # Postal code
  country: String         # Country code — e.g. "NL"
  ids: {
    legal: String         # Company registration number — e.g. KvK
    vat: String           # VAT number
    iban: String          # IBAN
    oin: String           # OIN
    gln: String           # GLN
  }
}): [matchResult]

# company

Look up company type codes for a given country. Useful for resolving or displaying company legal form descriptions.

company(
  country: String!     # ISO two-letter country code — e.g. "NL" (required)
  search: String       # Search by (partial) company code name
  codes: [String]      # Look up one or more specific codes
  lang: String         # Language for results — defaults to "nl"
): [companyCode]

# sbi

Look up SBI (Standaard Bedrijfsindeling) sector codes — the Dutch industry classification standard.

sbi(
  search: String       # Search by (partial) sector code name
  codes: [String]      # Look up one or more specific codes
  lang: String         # Language for results — defaults to "nl"
): [sectorCode]

# nace

Look up NACE sector codes — the European industry classification standard.

nace(
  search: String       # Search by (partial) sector code name
  codes: [String]      # Look up one or more specific codes
  lang: String         # Language for results — defaults to "nl"
): [sectorCode]

# Types

# party

The main party type returned by the party query.

Field	Type	Description
`id`	`String`	The eConnect ID of the party
`type`	`String`	The party type
`isActive`	`Boolean`	Whether the party is currently active
`preferredName`	`String`	The legal name if available; otherwise the first trade name
`legalName`	`String`	The confirmed legal name of the party. Nullable — only set when the legal name is known with certainty
`tradeNames`	`[String]`	Trade names of the party
`description`	`String`	A description of the main activities
`identifiers`	`[partyIdentifier]`	Identifiers of the party — e.g. KvK, VAT, GLN
`sectorCodes`	`[activity]`	Sector codes associated with the party
`locations`	`[location]`	Known locations of the party
`website`	`String`	The party's website
`eDelivery`	`eDelivery`	The electronic delivery capabilities of the party
`highlights`	`[highlight]`	Highlighted text fragments showing which fields matched the search terms

# partyIdentifier

A named identifier associated with a party.

Field	Type	Description
`name`	`String`	The label of the identifier scheme — e.g. "KvK", "VAT"
`id`	`partyId`	The identifier value and scheme details

# partyId

The value and scheme details of an identifier.

Field	Type	Description
`schemeIdNumber`	`String`	The numeric identifier of the scheme
`schemeIdText`	`String`	The textual identifier of the scheme
`schemeAuthority`	`String`	The authority that manages this scheme
`value`	`String`	The identifier value
`text`	`String`	The full text representation of the identifier

# activity

A sector code associated with a party.

Field	Type	Description
`type`	`String`	The scheme identifier — e.g. "SBI", "NACE"
`value`	`String`	The sector code value
`text`	`String`	The full text representation of the sector code
`description`	`String`	A description of the sector

# location

A physical location associated with a party.

Field	Type	Description
`type`	`String`	The location type
`names`	`[String]`	Names associated with this location
`text`	`String`	The full address as a single formatted string. Convenient for display purposes
`identifiers`	`[locationIdentifier]`	Named identifiers of this location
`address`	`String`	The street name combined with the number, and numerAddition if present
`street`	`String`	The street name
`number`	`String`	The street number
`numberAddition`	`String`	Addition to the street number
`postcode`	`String`	The postal code
`city`	`String`	The city
`country`	`country`	The country
`latitude`	`Float`	Latitude coordinate
`longitude`	`Float`	Longitude coordinate

# locationIdentifier

A named identifier associated with a location.

Field	Type	Description
`name`	`String`	The label of the identifier
`id`	`locationId`	The identifier value and scheme details

# locationId

The value and scheme details of a location identifier.

Field	Type	Description
`scheme`	`Int`	The numeric scheme identifier
`authority`	`String`	The authority that manages this scheme
`value`	`String`	The identifier value
`text`	`String`	The full text representation

# country

A country represented as a structured object.

Field	Type	Description
`iso`	`String`	The ISO 3166-1 alpha-2 country code — e.g. "NL"
`name`	`String`	The country name in English
`native`	`String`	The country name in its native language

# eDelivery

The electronic delivery capabilities of a party.

Field	Type	Description
`accepts`	`[eDeliveryDocument]`	Document types the party can receive
`provides`	`[eDeliveryDocument]`	Document types the party can send

# eDeliveryDocument

A document type capability entry for a party on a specific channel.

Field	Type	Description
`channel`	`String`	The delivery channel — e.g. "Peppol"
`partyId`	`partyId`	The identifier used for this document exchange on this channel
`listedName`	`String`	The party's name as listed on the network
`documentName`	`String`	A human-readable name for the document type
`documentTypeId`	`String`	The technical document type identifier
`processId`	`String`	The process identifier
`family`	`String`	The document type family
`details`	`[keyValue]`	Additional channel-specific details

# keyValue

A generic key-value pair.

Field	Type	Description
`key`	`String`	The key
`value`	`String`	The value

# highlight

A search term highlight indicating which fields matched and where.

Field	Type	Description
`fieldName`	`String`	The name of the field that matched the search term
`matches`	`[String]`	Text fragments with the matching portion highlighted

# matchResult

A match result returned by the find() query.

Field	Type	Description
`eConnectId`	`String`	The eConnect ID of the matched party
`name`	`String`	The preferred name of the matched party
`address`	`String`	The address of the matched party as a single text string
`identifiers`	`[partyIdentifier]`	The identifiers of the matched party
`eDelivery`	`eDelivery`	The electronic delivery capabilities of the matched party

# companyCode

A company type code entry, returned by the company() query.

Field	Type	Description
`countryCode`	`String`	The country this code applies to
`value`	`String`	The company type code value
`text`	`String`	The full text representation
`description`	`String`	A description of the company type

# sectorCode

A sector code entry, returned by the sbi() and nace() queries.

Field	Type	Description
`type`	`String`	The sector code scheme identifier
`value`	`String`	The sector code value
`text`	`String`	The full text representation
`description`	`String`	A description of the sector

← Getting Started Overview →