Customer accounts client
Api for creating, fetching and modifying customers account ids.
Get profile by customer account id
Get profile by customer account id
path Parameters
accountIdHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get profile by customer account id › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Get customer accounts
Get customer accounts by customer number.
path Parameters
customerNumberHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get customer accounts › Responses
OK
idCustomer account unique id.
createdAtWhen the customer account was created. ISO 8601 date format
createdByWho created the customer account.
customerNumberUnique customer number
customerAccountIdCustomer account id string
aliasAlias for the customer account
changedAtWhen the customer account was last changed. ISO 8601 date format
changedByWho changed the customer account.
isDefaultTrue if the account is the default account for the customer
Create a new customer account
Create a new customer account for the customer.
path Parameters
customerNumberHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a new customer account › Request Body
aliasCustomer account alias
accountIdCustomer account id.
isDefaultTrue if account is default for customer. Default false.
Create a new customer account › Responses
OK
idCustomer account unique id.
createdAtWhen the customer account was created. ISO 8601 date format
createdByWho created the customer account.
customerNumberUnique customer number
customerAccountIdCustomer account id string
aliasAlias for the customer account
changedAtWhen the customer account was last changed. ISO 8601 date format
changedByWho changed the customer account.
isDefaultTrue if the account is the default account for the customer
Delete a customer account tied to a customer profile
path Parameters
customerNumberCustomer number
accountIdCustomer account id
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Responses
OK
Patch a customer account. Follows the JSON Merge Patch RFC7396 standard.
A JSON merge patch document describes changes to be made to a target JSON document using a syntax that closely mimics the document being modified. Recipients of a merge patch document determine the exact set of changes being requested by comparing the content of the provided patch against the current content of the target document. If the provided merge patch contains members that do not appear within the target, those members are added. If the target does contain the member, the value is replaced. Null values in the merge patch are given special meaning to indicate the removal of existing values in the target.
See 'CustomerAccountPatchRequest' for available fields to patch.
path Parameters
customerNumberCustomer number
accountIdCustomer account id
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Patch a customer account. Follows the JSON Merge Patch RFC7396 standard. › Request Body
aliasCustomer account alias
isDefaultTrue if account is the default account for the customer.
Patch a customer account. Follows the JSON Merge Patch RFC7396 standard. › Responses
OK
idCustomer account unique id.
createdAtWhen the customer account was created. ISO 8601 date format
createdByWho created the customer account.
customerNumberUnique customer number
customerAccountIdCustomer account id string
aliasAlias for the customer account
changedAtWhen the customer account was last changed. ISO 8601 date format
changedByWho changed the customer account.
isDefaultTrue if the account is the default account for the customer