To keep things simple, the Mollie API endpoints will always attempt to use the same structure when representing certain value objects.

The API references lists the data type used for each field and parameter of every endpoint. This guide contains a list of all data types used, along with an explanation of the way these data types are structured.

Identifiers

All API resources have their own unique identifier which are formatted as a string. Identifiers are prefixed so they are quickly identifiable as what kind of resource it refers to. For example, payment identifiers are prefixed with tr_ and customers with cst_. Identifiers have a maximum length of 32 characters, including the prefix.

Amount object

An amount object is always represented as follows.

`currency` string required

An ISO 4217 currency code.

`value` string required

A string containing the exact amount in the given currency.

Address object

An address object includes at least the following fields.

`givenName` string required

The given name (first name) of the person should be more than 1 character and cannot contain only numbers.

`familyName` string required

The family name (surname) of the person should be more than 1 character and cannot contain only numbers.

`streetAndNumber` string required

The street and street number of the address.

`streetAdditional` string optional

Any additional addressing details, for example an apartment number.

`postalCode` string optional

The postal code of the address. Required for countries that use postal codes. May only be omitted for these country codes:

AE AN AO AW BF BI BJ BO BS BV BW BZ CD CF CG CI CK CM DJ DM ER FJ GA GD GH GM GN GQ GY HK JM KE KI KM KN KP LC ML MO MR MS MU MW NA NR NU PA QA RW SB SC SL SO SR ST SY TF TK TL TO TT TV UG VU YE ZM ZW

`city` string required

The city of the address.

`region` string optional

The region of the address.

`country` string required

The country of the address in ISO 3166-1 alpha-2 format.

When providing an address object as parameter to a request, the following conditions must be met:

At least the streetAndNumber, city, and country fields should be provided to create a valid address.
The postalCode field is required for countries that have postal codes. See the list above.
For certain PayPal payments the region field is required. See the Create payment documentation for more information.

Boolean

In JSON structures, booleans should be passed as the JSON boolean type.

In query string parameters (e.g. GET requests) only the strings true and false are accepted.

Business Category

A token that represents the industry associated with the profile’s trade name or brand.

Possible values:

Animal Services
- PET_SHOPS Pet Shops, Pet Food, and Supplies
- VETERINARY_SERVICES Veterinary services
Building Services
- AC_AND_HEATING_CONTRACTORS A/C and heating contractors
- CARPENTRY_CONTRACTORS Carpentry contractors
- ELECTRICAL_CONTRACTORS Electrical contractors
- EQUIPMENT_TOOLS_FURNITURE_RENTAL_LEASING Equipment, tools or furniture rental/leasing
- GENERAL_CONTRACTORS General contractors
- SPECIAL_TRADE_CONTRACTORS Special trade contractors
Charity and Donations
- CHARITY_AND_DONATIONS Charity and Donations
- FUNDRAISING_CROWDFUNDING_SOCIAL_SERVICE Fundraising, crowdfunding and social service organizations
Digital Products
- APPS Apps
- BOOKS_MEDIA_MOVIES_MUSIC Books, media, movies, music
- GAMES Games
- SOFTWARE_AND_SUBSCRIPTIONS Software and subscriptions
Education
- CHILD_CARE_SERVICES Child care services
- COLLEGES_UNIVERSITIES Colleges or universities
- ELEMENTARY_SECONDARY_SCHOOLS Elementary or secondary schools
- OTHER_EDUCATIONAL_SERVICES Other educational services
- VOCATIONAL_SCHOOLS_TRADE_SCHOOLS Vocational schools or trade schools
Entertainment and Recreation
- AMUSEMENT_PARKS Amusement Parks, Circuses, Carnivals, and Fortune Tellers
- EVENT_TICKETING Event ticketing
- GAMING_ESTABLISHMENTS Gaming establishments, incl. billiards, pool, bowling, arcades
- MOVIE_THEATRES Movie theatres
- MUSICIANS_BANDS_ORCHESTRAS Musicians, bands, or orchestras
- ONLINE_GAMBLING Online gambling
- OTHER_ENTERTAINMENT_RECREATION Other entertainment and recreation
- SPORTING_RECREATIONAL_CAMPS Sporting and Recreational Camps
- SPORTS_FORECASTING Sports forecasting or prediction services
Financial Services
- CREDIT_COUNSELLING_REPAIR Credit counselling or credit repair
- DIGITAL_WALLETS Digital wallets
- INVESTMENT_SERVICES Investment services
- MONEY_SERVICES Money services or transmission
- MORTGAGES_INSURANCES_LOANS_FINANCIAL_ADVICE Mortgages, insurances, loans and financial advice
- SECURITY_BROKERS_DEALERS Security brokers or dealers
- TRUST_OFFICES Trust offices
- VIRTUAL_CRYPTO_CURRENCIES Virtual currencies and crypto currencies
Food and Drink
- CATERERS Caterers (prepare and delivery)
- FAST_FOOD_RESTAURANTS Fast food restaurants
- FOOD_PRODUCT_STORES Grocery stores, supermarkets and food product stores
- RESTAURANTS_NIGHTLIFE Restaurants, nightlife & other on-premise consumption
Lodging and Hospitality
- BOAT_RENTALS_LEASING Boat Rentals and Leasing
- CRUISE_LINES Cruise lines
- LODGING Hotels, Motels, Resorts, Inns and other lodging and hospitality
- PROPERTY_RENTALS_CAMPING Property rentals / Camping
Marketplaces
- MARKETPLACES Marketplaces
Medical Services
- DENTAL_EQUIPMENT_SUPPLIES Dental, lab and/or ophthalmic equipment and supplies
- DENTISTS_ORTHODONTISTS Dentists and orthodontists
- MEDICAL_SERVICES Doctors, physicians and other medical services
- DRUG_PHARMACIES_PRESCRIPTION Drug Stores, pharmacies and prescription medicine
- MEDICAL_DEVICES Medical devices
- MEDICAL_ORGANIZATIONS Medical organizations
- MENTAL_HEALTH_SERVICES Mental health services
- NURSING Nursing or personal care facilities and assisted living
- OPTICIANS_EYEGLASSES Opticians and eyeglasses
Membership Organizations
- SOCIAL_ASSOCIATIONS Civic, fraternal, or social associations
- MEMBERSHIP_FEE_BASED_SPORTS Gyms, membership fee based sports
- OTHER_MEMBERSHIP_ORGANIZATIONS Other membership organizations
Personal Services
- ADULT_CONTENT_SERVICES Adult content or services
- COUNSELING_SERVICES Counseling services
- DATING_SERVICES Dating services
- HEALTH_BEAUTY_SPAS Health and beauty spas
- LANDSCAPING_SERVICES Landscaping services
- LAUNDRY_DRYCLEANING_SERVICES Laundry or (dry)cleaning services
- MASSAGE_PARLOURS Massage parlours
- OTHER_PERSONAL_SERVICES Other personal services
- PHOTOGRAPHY_STUDIOS Photography Studios
- SALONS_BARBERS Salons or barbers
Political Organizations
- POLITICAL_PARTIES Political parties
Professional Services
- ACCOUNTING_AUDITING_BOOKKEEPING_TAX_PREPARATION_SERVICES Accounting, auditing, bookkeeping and tax preparation services
- ADVERTISING_SERVICES Advertising Services
- CLEANING_MAINTENANCE_JANITORIAL_SERVICES Cleaning and maintenance, janitorial services
- COMPUTER_REPAIR Computer repair
- CONSULTANCY Consultancy
- SECURITY_SERVICES Detective/protective agencies, security services
- DIRECT_MARKETING Direct marketing
- FUNERAL_SERVICES Funeral services and crematories
- GOVERNMENT_SERVICES Government services
- HOSTING_VPN_SERVICES Hosting and VPN services
- INDUSTRIAL_SUPPLIES_NOT_ELSEWHERE_CLASSIFIED Industrial supplies, not elsewhere classified
- LEGAL_SERVICES_ATTORNEYS Legal Services and Attorneys
- MOTION_PICTURES_DISTRIBUTION Motion picture / video tape production and/or distribution
- OTHER_BUSINESS_SERVICES Other business services
- PRINTING_PUBLISHING Printing and publishing
- REAL_ESTATE_AGENTS Real Estate Agents
- SANITATION_POLISHING_SPECIALTY_CLEANING Sanitation, polishing and specialty cleaning
- OFFICE_SUPPLIES Stationery / Office supplies
- TESTING_LABORATORIES_NOT_MEDICAL Testing laboratories (not medical)
- TRAINING_AND_COACHING Training and Coaching
- UTILITIES Utilities
Religious Organizations
- RELIGIOUS_ORGANIZATIONS Religious organizations
Retail
- CLOTHING_SHOES_ACCESSORIES (Sports) clothing, shoes and accessories
- COMMERCIAL_ART Art Dealers, Galleries, (commercial) Photography and Graphics
- BEAUTY_PRODUCTS Beauty products
- BOOKS_PERIODICALS_NEWSPAPERS Books, Periodicals and Newspapers
- HOME_IMPROVEMENT Building, home improvement and equipment
- GIFTS_SHOPS Cards, gifts, novelty and souvenir shops
- CBD_MARIJUANA_PRODUCTS CBD/Marijuana (related) products
- COFFEE_SHOPS Coffee shops / grow shops
- CONVENIENCE_STORES Convenience Stores, Specialty Markets, Health Food Stores
- GIFT_CARDS Credits, vouchers, gift cards (excl. SIM cards) for Non-Financial Institutions
- EROTIC_TOYS Erotic toys
- FLORISTS Florists, florist supplier
- FUEL_DEALERS Fuel dealers (i.e. oil, pertroleum)
- FURNITURE_FURNISHINGS_EQUIPMENT_STORES Furniture, Home Furnishings and Equipment Stores
- GAME_TOY_HOBBY_SHOPS Game, Toy and Hobby Shops
- OUTDOOR_EQUIPMENT Garden and outdoor equipment
- HOME_ELECTRONICS Home electronics & (personal) computers
- HOUSEHOLD_APPLIANCE_STORES Household appliance stores
- JEWELRY_WATCH_CLOCK_AND_SILVERWARE_STORES_UNDER_1000 Jewelry, Watch, Clock, and Silverware Stores (<1000 euro)
- MUSIC_STORES Music Stores, Instruments and Records
- OTHER_MERCHANDISE Other merchandise
- LIQUOR_STORES Package Stores–Beer, Wine, and Liquor
- PAID_TELEVISION_RADIO Paid television or radio services (cable/satellite)
- PRECIOUS_STONES_METALS_JEWELRY_OVER_1000 Precious Stones, Metals, Watches and Jewelry (>1000 euro)
- REPAIR_SHOPS Repair shops and related services, not elsewhere classified
- SECOND_HAND_STORES Second hand / used merchandise stores
- SPORTING_GOODS_SPECIALTY_RETAIL_SHOPS Sporting Goods Stores, Miscellaneous and Specialty Retail Shops
- SUPPLEMENTS_STORES Supplements, nutrition, vitamin stores
- TELECOM_EQUIPMENT Telecom equipment (i.e. chargers, phones)
- TELECOM_SERVICES Telecom services (incl. (anonymous) SIM cards)
- TOBACCO_PRODUCTS Tobacco, cigars, e-cigarettes and related products
- TRADERS_DIAMONDS Traders in diamonds
- TRADERS_GOLD Traders in gold
- WEAPONS_AMMUNITION Weapons or ammunition
Transportation
- COMMUTER_TRANSPORTATION Commuter transportation
- COURIER_SERVICES Courier services and Freight forwarders
- OTHER_TRANSPORTATION_SERVICES Other transportation services
- RIDESHARING Taxis, limos and ridesharing
Travel Services
- TRAVEL_SERVICES Travel agencies, tour operators and other traval services
Vehicles
- AUTOMOTIVE_PARTS_ACCESSORIES Auto(motive) parts and accessories
- CAR_TRUCK_COMPANIES Auto and truck sales and service dealers and leasing companies
- AUTOMOTIVE_SERVICES Automotive services
- BICYCLE_PARTS_SHOPS_SERVICE Bicycle (parts) shops and service
- CAR_BOAT_CAMPER_MOBILE_HOME_DEALER Car, boat, camper, mobile Home dealer
- CAR_RENTALS Car rentals
- MOTORCYCLE_PARTS_SHOPS_AND_DEALERS Motorcycle (parts) shops and dealers

Date

A string representing a date in YYYY-MM-DD format.

Datetime

A string representing a date and time in ISO 8601 format.

Legal Entity

Recognized form of an organization, defining how it legally operates and its setup.
Legal entity types vary by country.

Possible values:

Netherlands legal entities types:
- nl-bv - Besloten Vennootschap (BV)
- nl-cooperatie - Coöperatie
- nl-cv - Commanditaire Vennootschap (CV)
- nl-eenmanszaak - Eenmanszaak
- nl-eesv - Europees Economisch Samenwerkingsverband (EESV)
- nl-kerkgenootschap - Kerkgenootschap
- nl-kroondomein - Kroondomein
- nl-maatschap - Maatschap
- nl-nv - Naamloze Vennootschap (NV)
- nl-overheid - Overheidsinstantie
- nl-sce - Europese Coöperatieve Vennootschap (SCE)
- nl-se - Europese Naamloze Vennootschap (SE)
- nl-stichting - Stichting
- nl-trust - Trust
- nl-vereniging - Vereniging
- nl-vof - Vennootschap Onder Firma (VOF)
- nl-waarborgmaatschappij - Onderlinge Waarborgmaatschappij
Belgium legal entities types:
- be-autonoom-gemeentebedrijf - Autonoom gemeentebedrijf
- be-belgische-staat - Belgische Staat
- be-bv - Besloten Vennootschap
- be-bvba - Besloten Vennootschap met Beperkte Aansprakelijkheid (BVBA)
- be-comm-v - Gewone Commanditaire Vennootschap (GCV / Comm. V)
- be-comm-va - Commanditaire Vennootschap op Aandelen (CVA / Comm. VA)
- be-cv - Coöperatieve Vennootschap
- be-cvoa - Coöperatieve Vennootschap met Onbeperkte Aansprakelijkheid (CVOA)
- be-cvoha - Coöperatieve Vennootschap met Onbeperkte en Hoofdelijke Aansprakelijkheid (CVOHA)
- be-cvba - Coöperatieve Vennootschap met Beperkte Aansprakelijkheid (CVBA)
- be-economisch-samenwerkingsverband - Europees Economisch Samenwerkingsverband (EESV)
- be-eenmanszaak - Eenmanszaak
- be-eenmans-bvba - Eénpersoons-BVBA (EBVBA)
- be-europese-cooperatieve-vennootschap - Europese Coöperatieve Vennootschap (SCE)
- be-europese-vennootschap - Europese Naamloze Vennootschap (SE)
- be-ivzw - Internationale Vereniging Zonder Winstoogmerk (IVZW)
- be-kerkgenootschap - Kerkgenootschap
- be-landbouwvennootschap - Landbouwvennootschap (LV)
- be-maatschap - Maatschap
- be-nv - Naamloze Vennootschap (NV)
- be-politiek-publiek-rechtspersoon - Politieke Publiekrechtelijke Rechtspersonen
- be-s-bvba - Starters-BVBA (S-BVBA)
- be-stichting - Stichting
- be-stille-handelsvennootschap - Stille Handelsvennootschap
- be-tijdelijke-handelsvennootschap - Tijdelijke Handelsvennootschap
- be-trust - Trust
- be-vereniging-zonder-winstoogmerk - Vereniging Zonder Winstoogmerk (VZW)
- be-vof - Vennootschap Onder Firma (VOF)
Germany legal entities types:
- de-aktiengesellschaft - Aktiengesellschaft (AG)
- de-eingetragene-genossenschaft - Eingetragene Genossenschaft (e.G.)
- de-einzelunternehmen - Einzelunternehmen
- de-freiberufler - Freiberufler
- de-gesellschaft-burgerlichen-rechts - Gesellschaft bürgerlichen Rechts (GbR)
- de-gmbh - Gesellschaft mit beschränkter Haftung (GmbH)
- de-interessen-verienigung - Europäische Wirtschaftliche Interessenvereinigung
- de-kg - Kommanditgesellschaft (KG)
- de-kirchliche-stiftung - Kirchliche Stiftung
- de-korperschaft-offentlichen-rechts - Körperschaft öffentlichen Rechts
- de-nev - Nicht eingetragener Verein (n.e.V.)
- de-offentliches-unternehmen - Öffentliches Unternehmen
- de-ohg - Offene Handelsgesellschaft (OHG)
- de-partnergesellschaft - Partnergesellschaft
- de-se - Europäische Gesellschaft (SE)
- de-stiftung-des-privaten-rechts - Stiftung des privaten Rechts
- de-treuhandstiftung - Treuhandstiftung
- de-unternehmergesellschaft - Unternehmergesellschaft (UG)
- de-verein - Verein (e.V.)
Austria legal entities types:
- at-aktiengesellschaft - Aktiengesellschaft (AG)
- at-einzelunternehmen - Einzelunternehmen
- at-freie-berufe - Freie Berufe
- at-gesbr - Gesellschaft bürgerlichen Rechts (GesbR)
- at-gmbh - Gesellschaft mit beschränkter Haftung (GmbH)
- at-interessen-verienigung - Europäische Wirtschaftliche Interessenvereinigung
- at-keg - Kommandit - Erwerbsgesellschaft (KEG)
- at-kommanditgesellschaft - Kommanditgesellschaft (KG)
- at-korperschaft-offentlichen-rechts - Körperschaft öffentlichen Rechts
- at-oeg - Offene Erwerbsgesellschaft (OEG)
- at-offene-gesellschaft - Offene Gesellschaft (OG)
- at-offentliches-unternehmen - Öffentliches Unternehmen
- at-se - Europäische Gesellschaft (SE)
- at-stiftung - Stiftung
- at-trust - Trust
- at-verein - Verein
France legal entities types:
- fr-adl - Administration de l'état
- fr-association - Association
- fr-ct - Collectivité territoriale
- fr-entreprise-individuelle - Entreprise individuelle
- fr-auto-entrepreneur - Auto-entrepreneur
- fr-epa - Etablissement public administratif
- fr-fiducie - Fiducie
- fr-fondation - Fondation
- fr-gie - Groupement d'intérêt économique (GIE)
- fr-eurl - SARL unipersonnelle (ou EURL)
- fr-sarl - Société à responsabilité limitée (SARL)
- fr-sa - Société anonyme (SA)
- fr-sc - Société en commandite
- fr-sca - Société coopérative agricole (SCA)
- fr-sccp - Société coopérative commerciale particulière
- fr-sdm - Société d'assurance mutuelle
- fr-civile - Société civile
- fr-snc - Société en nom collectif (SNC)
- fr-se - Société européenne
- fr-sas - Société par actions simplifiée (SAS)
- fr-sasu - Société par actions simplifiée unipersonnelle (SASU)
Luxembourg legal entities types:
- lu-ei - Entreprise individuelle (EI)
- lu-lpf - Luxembourg Private Foundation (LPF)
- lu-sa - Société anonyme (S.A.)
- lu-sarl - Société à responsabilité limitée (SARL)
- lu-sarl-s - Société à responsabilité limitée simplifée (SARL-S)
- lu-sas - Société par actions simplifiée (SAS)
- lu-sc - Société civile (SC)
- lu-sca - Société en commandite par actions (SCA)
- lu-sci - Société civile immobilières (SCI)
- lu-scsp - Société en commandite special (SCSp)
- lu-secs - Société en commandite simple (SECS)
- lu-senc - Société en nom collectif (SENC)
- lu-trust - Trust
Spain legal entities types:
- es-autonomo - Autonomo
- es-asociacion - Asociación
- es-cb - Comunidad de Bienes (C.B.)
- es-comerciante-individual - Comerciante individual
- es-fiducia - Fiducia
- es-fundacion - Fundacion
- es-sa - Sociedad Anónima (S.A.)
- es-sr-src - Sociedad Regular Colectiva (S.R/S.R.C)
- es-se - Sociedad Anónima Europea (SE)
- es-sociedad-civil - Sociedad Civil
- es-sociedad-cooperativa - Sociedad Cooperativa
- es-sociedad-comanditaria - Sociedad en Comanditaria
- es-srl-sl - Sociedad de Responsabilidad Limitada (SRL/SL)
- es-srlu - Sociedad de Responsabilidad Limitada Unipersonal (SRLU)
Portugal legal entities types:
- pt-cooperativa - Cooperativa
- pt-eirl - Estabelecimento Individual de Responsabilidade Limitada (EIRL)
- pt-empresario-nome-individual - Empresário em Nome individual
- pt-fondo-fiduciario - Fondo Fiduciario
- pt-fundacao - Fundação
- pt-sociedade-anonima - Sociedade Anónima
- pt-sociedade-comandita - Sociedade em Comandita
- pt-sociedade-nome-colectivo - Sociedade em Nome Colectivo
- pt-sociedade-quotas - Sociedade por Quotas
- pt-sociedade-unipessoal-quotas - Sociedade Unipessoal por Quotas
Switzerland legal entities types:
- ch-ag - Aktiengesellschaft (AG)
- ch-eg - Einfache Gesellschaft (eG)
- ch-einzelunternehmen - Einzelunternehmen
- ch-genossenschaft - Genossenschaft
- ch-gmbh - Gesellschaft mit beschränkter Haftung (GmbH)
- ch-kg - Kommanditgesellschaft (KG)
- ch-kig - Kollektivgesellschaft (KIG)
- ch-kmag - Kommanditaktiengesellschaft (KmAG)
- ch-stiftung - Stiftung
- ch-trust - Trust
- ch-verein - Verein
Finland legal entities types:
- fi-avoin-yhtio - Avoin yhtiö
- fi-julkinen-osakeyhtio - Julkinen Osakeyhtiö
- fi-kommandiittiyhtio - Kommandiittiyhtiö
- fi-osakeythio - Osakeythiö
- fi-osuuskunta - Osuuskunta
- fi-rekisteroity-yhdistys - Rekisteroity Yhdistys
- fi-saatio - Säätiö
- fi-toiminimi - Toiminimi
Denmark legal entities types:
- dk-aktieselskab - Aktieselskab
- dk-anpartsselskab - Anpartsselskab
- dk-enkeltmandsvirksomhed - Enkeltmandsvirksomhed
- dk-interessentskab - Interessentskab
- dk-ivaerksaetterselskab - Iværksætterselskab
- dk-kommanditselskab - Kommanditselskab
- dk-stiftelse - Stiftelse
- dk-trust - Trust
Sweden legal entities types:
- se-ab - Aktiebolag (AB)
- se-ab-publ - AB (publ)
- se-ekonomisk-forening - Ekonomisk förening
- se-enkla-bolag - Enkla bolag
- se-enskild-firma - Enskild firma
- se-fillial-utlandskt-bolag - Fillial till utländskt bolag
- se-hb - Handelsbolag (HB)
- se-ideel-forening - Ideel förening
- se-kb - Kommanditbolag (KB)
- se-samriskforetag - Samriskföretag
- se-stiftelse - Stiftelse
- se-trust - Trust
Norway legal entities types:
- no-ans-da - Ansvarlig selskap (ANS/DA)
- no-as - Aksjeselskap (AS)
- no-asa - Allmennaksjeselskap (ASA)
- no-da - Selskap med delt ansvar (DA)
- no-enk - Enkeltpersonsforetak (ENK)
- no-ks - Kommandittselskap (KS)
- no-nuf - Norskregistrert utenlandsk foretak (NUF)
- no-samvirkeforetak - Samvirkeforetak
- no-statesforetak - Statesforetak
- no-stiftelse - Stiftelse
Italy legal entities types:
- it-associazione-non-riconosciuta - Associazione non riconosciuta
- it-associazione-riconosciuta - Associazione riconosciuta
- it-ditta-individuale - Ditta Individuale
- it-fondazione - Fondazione
- it-fondo-fiduciario - Fondo Fiduciario
- it-sapa - Società in accomandita per azioni (S.a.p.a.)
- it-sas - Società in accomandita semplice (S.a.s.)
- it-snc - Società in nome collettivo (S.n.c)
- it-societa-cooperativa - Società cooperativa
- it-spa - Società per azioni (S.p.A.)
- it-srl - Società a responsabilità limitata (S.r.l.)
- it-ss - Società semplice (S.s.)
Great Britain legal entities types:
- gb-llp - Limited Liability Partnership (LLP)
- gb-lp - Limited Partnership (LP)
- gb-ltd - Private Limited Company (Ltd.)
- gb-plc - Public Limited Company (PLC)
- gb-charitable-company - Charitable Company
- gb-general-partnership - General Partnership (GP)
- gb-sole-trader - Sole trader
- gb-trust - Trust
Other legal entities types:
- other - Other business entity

Locale

A string representing the country and language in the xx_XX format specified by ISO 15897.

Possible values: en_US en_GB nl_NL nl_BE fr_FR fr_BE de_DE de_AT de_CH es_ES ca_ES pt_PT it_IT nb_NO sv_SE fi_FI da_DK is_IS hu_HU pl_PL lv_LV lt_LT.

Phone number

All phone numbers must passed as strings in the E.164 format. For example, +31208202070.

Registration Office

Registration office that the organization was registered at (for Germany).

The following Registration offices are currently supported:

aachen - Aachen
ahaus - Ahaus
altenburg - Altenburg
amberg - Amberg
ansbach - Ansbach
apolda - Apolda
arnsberg - Arnsberg
arnstadt - Arnstadt
arnstadt-zweigstelle-ilmenau - Arnstadt Zweigstelle Ilmenau
aschaffenburg - Aschaffenburg
augsburg - Augsburg
aurich - Aurich
bad-hersfeld - Bad Hersfeld
bad-homburg-vor-der-hohe - Bad Homburg vor der Höhe
bad-kreuznach - Bad Kreuznach
bad-oeynhausen - Bad Oeynhausen
bad-salzungen - Bad Salzungen
bamberg - Bamberg
bayreuth - Bayreuth
berlin-charlottenburg - Berlin (Charlottenburg)
bielefeld - Bielefeld
boblingen - Böblingen
bocholt - Bocholt
bochum - Bochum
bonn - Bonn
braunschweig - Braunschweig
bremen - Bremen
bremervorde - Bremervörde
buckeburg - Bückeburg
chemnitz - Chemnitz
coburg - Coburg
coesfeld - Coesfeld
cottbus - Cottbus
darmstadt - Darmstadt
deggendorf - Deggendorf
dortmund - Dortmund
dresden - Dresden
duisburg - Duisburg
duren - Düren
dusseldorf - Düsseldorf
eisenach - Eisenach
erfurt - Erfurt
erkelenz - Erkelenz
eschwege - Eschwege
essen - Essen
flensburg - Flensburg
frankfurt-am-main - Frankfurt am Main
frankfurt-oder - Frankfurt/Oder
freiburg - Freiburg
friedberg - Friedberg
fritzlar - Fritzlar
fulda - Fulda
fulda-zweigstelle-hilders - Fulda Zweigstelle Hilders
furth - Fürth
geilenkirchen - Geilenkirchen
gelsenkirchen - Gelsenkirchen
gera - Gera
giessen - Gießen
gotha - Gotha
gottingen - Göttingen
greiz - Greiz
gutersloh - Gütersloh
hagen - Hagen
halle-saale - Halle (Saale)
hamburg - Hamburg
hameln - Hameln
hamm - Hamm
hanau - Hanau
hannover - Hannover
heidelberg - Heidelberg
heilbad-heiligenstadt - Heilbad Heiligenstadt
helmstedt - Helmstedt
hildburghausen - Hildburghausen
hildesheim - Hildesheim
hof - Hof
homburg - Homburg
hoxter - Höxter
ingolstadt - Ingolstadt
iserlohn - Iserlohn
jena - Jena
kaiserslautern - Kaiserslautern
kamen - Kamen
kassel - Kassel
kempten-allgau - Kempten (Allgäu)
kiel - Kiel
kleve - Kleve
koblenz - Koblenz
koln - Köln
konigstein - Königstein
korbach - Korbach
krefeld - Krefeld
landau - Landau
landshut - Landshut
langen - Langen
langenfeld - Langenfeld
lebach - Lebach
leipzig - Leipzig
lemgo - Lemgo
lennestadt - Lennestadt
limburg - Limburg
lubeck - Lübeck
ludwigshafen-am-rhein - Ludwigshafen am Rhein
luneburg - Lüneburg
mainz - Mainz
mannheim - Mannheim
marburg - Marburg
meiningen - Meiningen
memmingen - Memmingen
merzig - Merzig
minden - Minden
monchengladbach - Mönchengladbach
montabaur - Montabaur
muhlhausen - Mühlhausen
mulheim - Mülheim
munchen - München
munster - Münster
neubrandenburg - Neubrandenburg
neunkirchen - Neunkirchen
neuruppin - Neuruppin
neuss - Neuss
nidda - Nidda
nordhausen - Nordhausen
nurnberg - Nürnberg
offenbach-am-main - Offenbach am Main
oldenburg-oldenburg - Oldenburg (Oldenburg)
osnabruck - Osnabrück
ottweiler - Ottweiler
paderborn - Paderborn
passau - Passau
pinneberg - Pinneberg
possneck - Pößneck
possneck-zweigstelle-bad-lobenstein - Pößneck Zweigstelle Bad Lobenstein
potsdam - Potsdam
recklinghausen - Recklinghausen
regensburg - Regensburg
reutlingen - Reutlingen
rheinbach - Rheinbach
rostock - Rostock
rudolstadt - Rudolstadt
rudolstadt-zweigstelle-saalfeld - Rudolstadt Zweigstelle Saalfeld
saarbrucken - Saarbrücken
saarlouis - Saarlouis
schweinfurt - Schweinfurt
schwerin - Schwerin
seesen - Seesen
siegburg - Siegburg
siegen - Siegen
soltau - Soltau
sommerda - Sömmerda
sondershausen - Sondershausen
sonneberg - Sonneberg
springe - Springe
st-ingbert-st-ingbert - St. Ingbert (St Ingbert)
st-wendel-st-wendel - St. Wendel (St Wendel)
stadthagen - Stadthagen
stadtroda - Stadtroda
steinfurt - Steinfurt
stendal - Stendal
stralsund - Stralsund
straubing - Straubing
stuttgart - Stuttgart
suhl - Suhl
tostedt - Tostedt
traunstein - Traunstein
trier - Trier
ulm - Ulm
unna - Unna
viersen - Viersen
volklingen - Völklingen
walsrode - Walsrode
weiden-in-der-oberpfalz - Weiden in der Oberpfalz
weimar - Weimar
wesel - Wesel
wetzlar - Wetzlar
wiesbaden - Wiesbaden
wittlich - Wittlich
wuppertal - Wuppertal
wurzburg - Würzburg
zweibrucken - Zweibrücken

QR code object

`height` string

Height of the image in pixels.

`width` string

Width of the image in pixels.

`src` string

The URI you can use to display the QR code. Note that we can send both data URIs as well as links to HTTPS images. You should support both.

URL object

In v2 endpoints, URLs are commonly represented as objects with an href and type field.

`href` string

The actual URL string.

`type` string required

The content type of the page or endpoint the URL points to.