XUND API Documentation

VirtualService

Virtual Services are non-located services. They can be used to display partner managed custom services at the end of the Check flow.


The basic structure includes all possible Virtual Service properties, that is refined by Virtual Service sub-types. The exact sub-types define the accessible properties by Virtual Service type. This structure can represent all of them with optional properties.

Structure

Property name

Property type

Property description

id

string

ID of the service

name

string

Name of the Service

description

string

Description of the Service

type

VirtualServiceType

Type of the Virtual Service

gender

Gender?

Gender of the service, where available

phone

string?

Telephone number, null if does not exist

email

string?

E-mail of the Service, null if does not exist

url

string?

URL of the service, where available

specializations

Array<{
id: string
name: string
type: GenericSpecializationType
}>?

Array of service specializations

See GET /v1/services/features/:countryCode endpoint about available properties.

insurers

string[]?

Optional IDs of service’s supported insurers

openingHours

OpeningHours?

Opening hours, for each day of the week, in format of arrays of open sections

Day 0 means Monday

See GET /v1/services/features/:countryCode endpoint about available properties.

monogram

string

Monogram of the Service

profileImageUrl

string?

Publicly available profile photo / logo of the service