KIP People API (Public)

Models.CreateCompanyRequest

object
namestringrequired

Name of the Company

addressLine1stringrequired

Address line 1

addressLine2string

Address line 2

addressLine3string

Address line 3

addressLine4stringrequired

City part of the address

Example:Gent

postalCodestringrequired

Postal code of the city

Example:9000

countrystringrequired

Country in which the company resides

Match pattern:[a-zA-Z]{2,4}

Example:BE

phoneNumberstringrequired

Phone number

<= 35 characters

mobilePhoneNumberstringrequired

Mobile phone number

<= 35 characters

emailstring(email)required

Standard e-mail to which invoices will be sent

Example:development@kinepolis.com

taxRegistrationNumberstringrequired

VAT registration number

Can’t change after create

Match pattern:[a-zA-Z0-9]{0,16}

Example:BE0415928179

companyRegistrationNumberstringrequired

Company registration number in case of no VAT (eg. Ondernemingsnummer in Belgium)

Can’t change after create

Match pattern:[a-zA-Z0-9]{0,16}

Example:0415928179

languagestringrequired

Language in which invoices will be sent

Match pattern:[a-zA-Z]{2,3}

Example:NL

Example

Models.ExtendedProfile

object
firstNamestringrequired
lastNamestringrequired
middleNamestring
genderstringrequired
emailstringrequiredread-only
createdAtstringread-only
modifiedAtstringread-only
preferredComplexstringrequired

Example:KBRG

kinepolisCountryCodestringrequiredread-only

Example:BE

mobilePhonestring

Example:+32470123456

preferredLanguagestringrequired

Example:NL

dateOfBirthstring(iso-date)required

Example:1996-01-01

accountCompletionPercentagenumber(decimal)read-only

>= 0<= 1

Example:0.5

membershipLevelstringread-only

Membership levels available for users, paid memberships cannot be set via the API

Allowed values:MyKinepolisKinepolisStudentCardKinepolisMovieClubGoldSilverPressStaff

Example

Models.GdprExport

object
jobIdstringrequired
Example

Models.LoyaltyCard

object
idstringrequired
numberstringrequired
Example

Models.Membership

object
membershipLevelstringrequired

Membership levels available for users, paid memberships cannot be set via the API

Allowed values:MyKinepolisKinepolisStudentCardKinepolisMovieClubGoldSilverPressStaff

Example