Prior to starting to work on the Integration Steps, your first task is to map data from the Organisations Data Layer to make sure your able to return all required fields for each endpoint.

This mapping process will allow you to identify early on any missing data and prioritise work on the Organisation side to have everything in place prior to starting the Integration Steps.

Models

A class diagram showing table relationships.

Fields

This table is a list of unique fields condensed from all requests/responses for Bright Kit.

Field	Format	Endpoints	Notes
id accountId	string	Search for account Get account	This is the account identifier used in most requests.
ssn personalId	string	Get account BankId auth	The personal number of the User.
orgnumber orgNumber	string	Search for account Get account	See Organisation Number . Used when the User is a company.
email	string	Search for account Get account	The email address of the User.
phonenumber phoneNumber	string	Search for account Get account	The phone number of the User.
displayName	string	Search for account Get account	The name your User will see in the profile section.
role	string	Search for account Get account
firstName	string	Search for account Get account
lastName	string	Search for account Get account
language	string	Search for account Get account
username	string	Search for account Get account	Use case: username/password login.
address	string	Get locations	Address of a location.
zipCode	string	Get locations	The post code for the address.
city	string	Get locations	The city for the address.
propertyType	string	Get locations	The type of property at this location.
numberOfResidents	string	Get locations	A count of residents at the location.
size	number	Get locations	The size of the property measured in m2 or sqft.
houseAge	string	Get locations	The age of the property.
wasteful	number	Get locations	A calculated value of how efficient an individual person considers themselves. 0.7 is low and 1.3 is high.
cars

Organisation Number

The orgNumber or orgnumber field should be populated by a company identifier which is both:

The preferred company identifier for that country
Is unique to that specific company

Country	Country Code	Identifier Type	Regex
Austria	AT	Firmenbuch Nummer: 012345P	/^(\d{6})([a-zA-Z])$/
Belgium	BE	VAT Number: 0123456789	/^(\d{10})$/
Bulgaria	BG	Registration Number: 012345678	/^(\d{9})$/
Cyprus	CY	Registration Number: HE 012345678	/^([h\|H][e\|E])?(\s\|-)?((\d{5,10}))$/
Czech Republic	CZ	ICO/VAT Number: 01234567	/^(\d{8})$/
Denmark	DK	CVR number: 01234567	/^(\d{7})(\s\|-)?(\d{1})$/
Estonia	EE	Trade Register Number: 01234567	/^(\d{8})$/
Finland	FI	AT number: 01234567	/^(\d{7})(\s\|-)?(\d{1})$/
France	FR	SIREN number: 012345678	/^(\d{9})$/
Germany	DE	HRB Number: HRB 01234 01234	/^([HRB])\d{5}\|\d{5})$/
Greece	GR	VAT Number: 012345678	/^(\d{9})$/
Hungary	HU	Registration/VAT Number: 01-23-456789	/^(\d{10})\|(\d{2})-(\d{2})-(\d{6})$/
Ireland	IE	CNIE number:	/^(\d{4,6})$/
Italy	IT	COFIS Registration Number: 01234567890	/^(\d{11,16})$/
Latvia	LV	Trade Register Number: 01234567890	/^(\d{11})$/
Lithuania	LT	Trade Register Number: 012345678	/^(\d{9})$/
Luxembourg	LU	IBLC VAT Number: A01234567	/^([a-z]\|[A-Z])?(\d{5,8})$/
Netherlands	NL	KVK Number: 01234567	/^(\d{8})$/
Norway	NO	Organisation number: 012 345 678	/^(\d{3}(\s\|-)?){3}$/
Poland	PL	KRS number: 0123456789	/^(\d{10})$/
Portugal	PT	Registration Number: 012345678	/^(\d{9})$/
Romania	RO	VAT Number: 0123456789	/^(\d{1,10})$/
Slovakia	SK	IČO/VAT Number: 01234567	/^(\d{8})$/
Spain	ES	Codigo Identificacion Fiscal: A01234567A	/^([a-zA-Z])(\d{6,8})([a-zA-Z])?$/
Sweden	SE	Registration Number: 0123456789	/^(\d{10})$/
Switzerland	CH	CHE number: CHE-012.345.678 "-" is the correct separator character. '‑', '‒', '–', '—', '―' is not accepted.	/^CHE-(\d{3}(.)){2}(\d{3})$/
United Kingdom	GB	CRO Number: AB012345	/^((([a-z]\|[A-Z])+([a-z]\|[A-Z]))\|(\d{2})?)(\d{6})$/
United States	US	EIN Number: 01-2345678	/^(\d{2}-\d{7})$/