Authentication admin

Api for verify credentials, generate and update password.

Verify credentials

POST

https://api.entur.io/customers/v2

/profiles/verify-credentials

Verify credentials for a customer. The customer is looked up based on the organisation Id of the logged on user, combined with the email address provided in the input.

Verify credentials › Headers

ET-Client-Name

string

Entur 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-Id

string

Correlation id

Verify credentials › Request Body

The fields used when verifying credentials

VerifyCredentialsRequest

email

string · maxLength: 80 · required

Email used for login. See property 'username' on CustomerResponse

password

string · minLength: 1 · maxLength: 100 · required

Password used for login.

lastSignInFrom

string · maxLength: 100

The place if login. Typically web or app. Typically used to display to the user where the last login was performed.

ErrorMessage[]

Verify credentials › Responses

A registered customer response

CustomerResponse

uuid

string · minLength: 32 · maxLength: 32 · required

A universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant

Example: 7018222E18CB5C46E05400144FF9F89C

status

string · enum · required

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

surname

string · maxLength: 50 · required

Surname.

changedAt

string · date-time · required

When the customer was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdAt

string · date-time · required

When the customer was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

firstName

string · maxLength: 50 · required

First and middle name.

profileType

string · enum · required

Type of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.

Enum values:

customerNumber

integer · int64 · required

Customer number.

organisationId

integer · int64 · required

The organisation the customer is registered with.

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

email

string · maxLength: 80

Contact email. May become different from username

vippsId

string · uuid

Vipps unique user identifier

emailOld

string · maxLength: 80

When customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.

parentId

object

Id of the parent customer. Used to connect different customer types.

username

string

Username the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerRef

string · maxLength: 40

Optional customer reference. Defaults to customer number if not set.

LocalDateResponse

Date as object

LocalDateResponse

Date as object

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

CustomerPreferenceResponse[]

The preferences connected to the customer.

lastSignInAt

string · date-time

When the customer last signed in. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

landlineNumber

string · maxLength: 20

Landline telephone number.

lastSignInFrom

string · maxLength: 100

Where the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.

EcardOwnershipResponse[]

The ecards connected to the customer.

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

PostalAddressResponse[]

The postal addresses connected to the customer.

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

CustomerAccountResponse[]

Customer accounts used for account based ticketing

CustomerConsent[]

The legacy consents connected to the customer.

customerAccountId

string · maxLength: 60

Customer account id used for account based ticketing

Example: XYZ:CustomerAccount:<uuid>

PersonnelTicketBearer

The personnel tickets connected to the customer. Deprecated. Does not contain updated information.

relatedCustomerNumbers

integer[]

The customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

POST/profiles/verify-credentials

curl https://api.entur.io/customers/v2/profiles/verify-credentials \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "password": "password",
  "lastSignInFrom": "lastSignInFrom",
  "validationErrors": [
    {
      "errorCode": 0,
      "longEnglish": "longEnglish",
      "shortEnglish": "shortEnglish",
      "longNorwegian": "longNorwegian",
      "shortNorwegian": "shortNorwegian"
    }
  ]
}'

Example Request Body

{
  "email": "email",
  "password": "password",
  "lastSignInFrom": "lastSignInFrom",
  "validationErrors": [
    {
      "errorCode": 0,
      "longEnglish": "longEnglish",
      "shortEnglish": "shortEnglish",
      "longNorwegian": "longNorwegian",
      "shortNorwegian": "shortNorwegian"
    }
  ]
}

json

Example Responses

{
  "id": 0,
  "uuid": "7018222E18CB5C46E05400144FF9F89C",
  "email": "email",
  "notes": [
    {
      "id": 0,
      "text": "text",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "changedBy": "changedBy",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "createdBy": "createdBy",
      "customerId": 0
    }
  ],
  "status": "A",
  "surname": "surname",
  "vippsId": "00000000-0000-0000-0000-000000000000",
  "emailOld": "emailOld",
  "parentId": {},
  "username": "username",
  "changedAt": "2019-04-05T14:30:30+02:00",
  "changedBy": "changedBy",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "createdBy": "createdBy",
  "firstName": "firstName",
  "countryCode": "+47",
  "customerRef": "customerRef",
  "dateOfBirth": {
    "day": 0,
    "year": 0,
    "month": 0
  },
  "dateOfDeath": {
    "day": 0,
    "year": 0,
    "month": 0
  },
  "nationality": "NOR",
  "preferences": [
    {
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "customerId": 0,
      "preference": {
        "id": 0,
        "isActive": true,
        "changedAt": "2019-04-05T14:30:30+02:00",
        "createdAt": "2019-04-05T14:30:30+02:00",
        "preferenceCode": "preferenceCode",
        "preferenceType": "preferenceType",
        "preferenceDescription": "preferenceDescription"
      },
      "preferenceId": 0,
      "preferenceValue": "preferenceValue"
    }
  ],
  "profileType": "S",
  "lastSignInAt": "2019-04-05T14:30:30+02:00",
  "givenConsents": [
    {}
  ],
  "customerNumber": 0,
  "expirationDate": "2019-04-05T14:30:30+02:00",
  "landlineNumber": "landlineNumber",
  "lastSignInFrom": "lastSignInFrom",
  "organisationId": 0,
  "ecardOwnerships": [
    {
      "id": 0,
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "ecardName": "ecardName",
      "customerId": 0,
      "bookingDate": "2019-04-05T14:30:30+02:00",
      "ecardNumber": 0,
      "shippingDate": "2019-04-05T14:30:30+02:00",
      "ecardOperator": 0,
      "endOfOwnership": "2019-04-05T14:30:30+02:00",
      "expirationDate": "2019-04-05T14:30:30+02:00",
      "startOfOwnership": "2019-04-05T14:30:30+02:00",
      "ecardNumber16digits": "ecardNumber16digits"
    }
  ],
  "emailVerifiedAt": "2019-04-05T14:30:30+02:00",
  "postalAddresses": [
    {
      "id": 0,
      "town": "town",
      "postCode": "postCode",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "customerId": 0,
      "verifiedAt": "2019-04-05T14:30:30+02:00",
      "countryCode": "NOR",
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "typeOfAddress": "P"
    }
  ],
  "telephoneNumber": "telephoneNumber",
  "changedByChannel": "changedByChannel",
  "createdByChannel": "createdByChannel",
  "customerAccounts": [
    {
      "id": 0,
      "alias": "Tommy",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "changedBy": "changedBy",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "createdBy": "createdBy",
      "isDefault": true,
      "customerNumber": 0,
      "customerAccountId": "ATB:CustomerAccount:abc58673cde-1c82-4bc5-989c-9d5eaa7ea866"
    }
  ],
  "customerConsents": [
    {
      "changedAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "customerId": 0,
      "consentCode": "consentCode",
      "consentChoice": true
    }
  ],
  "customerAccountId": "XYZ:CustomerAccount:<uuid>",
  "languagePreference": "NO",
  "personnelTicketBearer": {
    "changedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "bearerCustomerId": 0,
    "ticketRightOwner": "ticketRightOwner",
    "ticketRightBearer": "ticketRightBearer",
    "isSelfServedRetrieval": true
  },
  "relatedCustomerNumbers": [
    0
  ],
  "languagePreferenceISO6393": "NOB",
  "telephoneNumberVerifiedAt": "2019-04-05T14:30:30+02:00",
  "telephoneNumberNoCountryCode": "telephoneNumberNoCountryCode"
}

json

application/json

Generate password and send email/sms for customer

PUT

https://api.entur.io/customers/v2

/authentication/generate-password

Generates a new password for a profile identified by organisationId and email address. The new password is sent to the customer via email and/or sms.

Generate password and send email/sms for customer › Headers

Authorization

string · required · style: simple

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Generate password and send email/sms for customer › Request Body

Generate a new password for a profile identified by email and organisation id

GeneratePasswordRequest

email

string · pattern: ^[a-zA-Z0-9æøåÆØÅ.!#… · required

The email address identifying the profile

Example: customer@example.com

organisationId

integer · int64

The organisation the profile belongs to. Default is tenant organisation ID. Only Internal tenants are allowed to override the organisation id

Example: 1

Generate password and send email/sms for customer › Responses

No Content

No data returned

Set password

PUT

https://api.entur.io/customers/v2

/profiles/{customerNumber}/set-password

Set the password for the specified customer. This endpoint requires an Internal or Partner jwt-token.

Set password › path Parameters

customerNumber

integer · int64 · required · style: simple

Set password › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Set password › Request Body

The fields used for creating a new password for an user

NewPasswordRequest

newPassword

string · minLength: 1 · maxLength: 100 · required

The new password.

ErrorMessage[]

Set password › Responses

A registered customer response

CustomerResponse

uuid

string · minLength: 32 · maxLength: 32 · required

A universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant

Example: 7018222E18CB5C46E05400144FF9F89C

status

string · enum · required

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

surname

string · maxLength: 50 · required

Surname.

changedAt

string · date-time · required

When the customer was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdAt

string · date-time · required

When the customer was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

firstName

string · maxLength: 50 · required

First and middle name.

profileType

string · enum · required

Type of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.

Enum values:

customerNumber

integer · int64 · required

Customer number.

organisationId

integer · int64 · required

The organisation the customer is registered with.

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

email

string · maxLength: 80

Contact email. May become different from username

vippsId

string · uuid

Vipps unique user identifier

emailOld

string · maxLength: 80

When customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.

parentId

object

Id of the parent customer. Used to connect different customer types.

username

string

Username the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerRef

string · maxLength: 40

Optional customer reference. Defaults to customer number if not set.

LocalDateResponse

Date as object

LocalDateResponse

Date as object

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

CustomerPreferenceResponse[]

The preferences connected to the customer.

lastSignInAt

string · date-time

When the customer last signed in. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

landlineNumber

string · maxLength: 20

Landline telephone number.

lastSignInFrom

string · maxLength: 100

Where the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.

EcardOwnershipResponse[]

The ecards connected to the customer.

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

PostalAddressResponse[]

The postal addresses connected to the customer.

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

CustomerAccountResponse[]

Customer accounts used for account based ticketing

CustomerConsent[]

The legacy consents connected to the customer.

customerAccountId

string · maxLength: 60

Customer account id used for account based ticketing

Example: XYZ:CustomerAccount:<uuid>

PersonnelTicketBearer

The personnel tickets connected to the customer. Deprecated. Does not contain updated information.

relatedCustomerNumbers

integer[]

The customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

PUT/profiles/{customerNumber}/set-password

curl https://api.entur.io/customers/v2/profiles/:customerNumber/set-password \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "newPassword": "newPassword",
  "validationErrors": [
    {
      "errorCode": 0,
      "longEnglish": "longEnglish",
      "shortEnglish": "shortEnglish",
      "longNorwegian": "longNorwegian",
      "shortNorwegian": "shortNorwegian"
    }
  ]
}'

Example Request Body

{
  "newPassword": "newPassword",
  "validationErrors": [
    {
      "errorCode": 0,
      "longEnglish": "longEnglish",
      "shortEnglish": "shortEnglish",
      "longNorwegian": "longNorwegian",
      "shortNorwegian": "shortNorwegian"
    }
  ]
}

json

Example Responses

{
  "id": 0,
  "uuid": "7018222E18CB5C46E05400144FF9F89C",
  "email": "email",
  "notes": [
    {
      "id": 0,
      "text": "text",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "changedBy": "changedBy",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "createdBy": "createdBy",
      "customerId": 0
    }
  ],
  "status": "A",
  "surname": "surname",
  "vippsId": "00000000-0000-0000-0000-000000000000",
  "emailOld": "emailOld",
  "parentId": {},
  "username": "username",
  "changedAt": "2019-04-05T14:30:30+02:00",
  "changedBy": "changedBy",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "createdBy": "createdBy",
  "firstName": "firstName",
  "countryCode": "+47",
  "customerRef": "customerRef",
  "dateOfBirth": {
    "day": 0,
    "year": 0,
    "month": 0
  },
  "dateOfDeath": {
    "day": 0,
    "year": 0,
    "month": 0
  },
  "nationality": "NOR",
  "preferences": [
    {
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "customerId": 0,
      "preference": {
        "id": 0,
        "isActive": true,
        "changedAt": "2019-04-05T14:30:30+02:00",
        "createdAt": "2019-04-05T14:30:30+02:00",
        "preferenceCode": "preferenceCode",
        "preferenceType": "preferenceType",
        "preferenceDescription": "preferenceDescription"
      },
      "preferenceId": 0,
      "preferenceValue": "preferenceValue"
    }
  ],
  "profileType": "S",
  "lastSignInAt": "2019-04-05T14:30:30+02:00",
  "givenConsents": [
    {}
  ],
  "customerNumber": 0,
  "expirationDate": "2019-04-05T14:30:30+02:00",
  "landlineNumber": "landlineNumber",
  "lastSignInFrom": "lastSignInFrom",
  "organisationId": 0,
  "ecardOwnerships": [
    {
      "id": 0,
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "ecardName": "ecardName",
      "customerId": 0,
      "bookingDate": "2019-04-05T14:30:30+02:00",
      "ecardNumber": 0,
      "shippingDate": "2019-04-05T14:30:30+02:00",
      "ecardOperator": 0,
      "endOfOwnership": "2019-04-05T14:30:30+02:00",
      "expirationDate": "2019-04-05T14:30:30+02:00",
      "startOfOwnership": "2019-04-05T14:30:30+02:00",
      "ecardNumber16digits": "ecardNumber16digits"
    }
  ],
  "emailVerifiedAt": "2019-04-05T14:30:30+02:00",
  "postalAddresses": [
    {
      "id": 0,
      "town": "town",
      "postCode": "postCode",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "customerId": 0,
      "verifiedAt": "2019-04-05T14:30:30+02:00",
      "countryCode": "NOR",
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "typeOfAddress": "P"
    }
  ],
  "telephoneNumber": "telephoneNumber",
  "changedByChannel": "changedByChannel",
  "createdByChannel": "createdByChannel",
  "customerAccounts": [
    {
      "id": 0,
      "alias": "Tommy",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "changedBy": "changedBy",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "createdBy": "createdBy",
      "isDefault": true,
      "customerNumber": 0,
      "customerAccountId": "ATB:CustomerAccount:abc58673cde-1c82-4bc5-989c-9d5eaa7ea866"
    }
  ],
  "customerConsents": [
    {
      "changedAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "customerId": 0,
      "consentCode": "consentCode",
      "consentChoice": true
    }
  ],
  "customerAccountId": "XYZ:CustomerAccount:<uuid>",
  "languagePreference": "NO",
  "personnelTicketBearer": {
    "changedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "bearerCustomerId": 0,
    "ticketRightOwner": "ticketRightOwner",
    "ticketRightBearer": "ticketRightBearer",
    "isSelfServedRetrieval": true
  },
  "relatedCustomerNumbers": [
    0
  ],
  "languagePreferenceISO6393": "NOB",
  "telephoneNumberVerifiedAt": "2019-04-05T14:30:30+02:00",
  "telephoneNumberNoCountryCode": "telephoneNumberNoCountryCode"
}

json

application/json

Change password

PUT

https://api.entur.io/customers/v2

/profiles/{customerNumber}/change-password

Change password for a customer. This method will first validate that the given oldPassword is correct, before storing the new password. This endpoint requires an Internal or Partner jwt-token.

Change password › path Parameters

customerNumber

integer · int64 · required · style: simple

Change password › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Change password › Request Body

The fields used when verifying credentials

ChangePasswordRequest

newPassword

string · minLength: 1 · maxLength: 100 · required

The new user password.

oldPassword

string · minLength: 1 · maxLength: 100 · required

The old user password.

ErrorMessage[]

Change password › Responses

A registered customer response

CustomerResponse

uuid

string · minLength: 32 · maxLength: 32 · required

A universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant

Example: 7018222E18CB5C46E05400144FF9F89C

status

string · enum · required

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

surname

string · maxLength: 50 · required

Surname.

changedAt

string · date-time · required

When the customer was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdAt

string · date-time · required

When the customer was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

firstName

string · maxLength: 50 · required

First and middle name.

profileType

string · enum · required

Type of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.

Enum values:

customerNumber

integer · int64 · required

Customer number.

organisationId

integer · int64 · required

The organisation the customer is registered with.

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

email

string · maxLength: 80

Contact email. May become different from username

vippsId

string · uuid

Vipps unique user identifier

emailOld

string · maxLength: 80

When customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.

parentId

object

Id of the parent customer. Used to connect different customer types.

username

string

Username the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerRef

string · maxLength: 40

Optional customer reference. Defaults to customer number if not set.

LocalDateResponse

Date as object

LocalDateResponse

Date as object

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

CustomerPreferenceResponse[]

The preferences connected to the customer.

lastSignInAt

string · date-time

When the customer last signed in. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

landlineNumber

string · maxLength: 20

Landline telephone number.

lastSignInFrom

string · maxLength: 100

Where the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.

EcardOwnershipResponse[]

The ecards connected to the customer.

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

PostalAddressResponse[]

The postal addresses connected to the customer.

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

CustomerAccountResponse[]

Customer accounts used for account based ticketing

CustomerConsent[]

The legacy consents connected to the customer.

customerAccountId

string · maxLength: 60

Customer account id used for account based ticketing

Example: XYZ:CustomerAccount:<uuid>

PersonnelTicketBearer

The personnel tickets connected to the customer. Deprecated. Does not contain updated information.

relatedCustomerNumbers

integer[]

The customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

PUT/profiles/{customerNumber}/change-password

curl https://api.entur.io/customers/v2/profiles/:customerNumber/change-password \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "newPassword": "newPassword",
  "oldPassword": "oldPassword",
  "validationErrors": [
    {
      "errorCode": 0,
      "longEnglish": "longEnglish",
      "shortEnglish": "shortEnglish",
      "longNorwegian": "longNorwegian",
      "shortNorwegian": "shortNorwegian"
    }
  ]
}'

Example Request Body

{
  "newPassword": "newPassword",
  "oldPassword": "oldPassword",
  "validationErrors": [
    {
      "errorCode": 0,
      "longEnglish": "longEnglish",
      "shortEnglish": "shortEnglish",
      "longNorwegian": "longNorwegian",
      "shortNorwegian": "shortNorwegian"
    }
  ]
}

json

Example Responses

{
  "id": 0,
  "uuid": "7018222E18CB5C46E05400144FF9F89C",
  "email": "email",
  "notes": [
    {
      "id": 0,
      "text": "text",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "changedBy": "changedBy",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "createdBy": "createdBy",
      "customerId": 0
    }
  ],
  "status": "A",
  "surname": "surname",
  "vippsId": "00000000-0000-0000-0000-000000000000",
  "emailOld": "emailOld",
  "parentId": {},
  "username": "username",
  "changedAt": "2019-04-05T14:30:30+02:00",
  "changedBy": "changedBy",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "createdBy": "createdBy",
  "firstName": "firstName",
  "countryCode": "+47",
  "customerRef": "customerRef",
  "dateOfBirth": {
    "day": 0,
    "year": 0,
    "month": 0
  },
  "dateOfDeath": {
    "day": 0,
    "year": 0,
    "month": 0
  },
  "nationality": "NOR",
  "preferences": [
    {
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "customerId": 0,
      "preference": {
        "id": 0,
        "isActive": true,
        "changedAt": "2019-04-05T14:30:30+02:00",
        "createdAt": "2019-04-05T14:30:30+02:00",
        "preferenceCode": "preferenceCode",
        "preferenceType": "preferenceType",
        "preferenceDescription": "preferenceDescription"
      },
      "preferenceId": 0,
      "preferenceValue": "preferenceValue"
    }
  ],
  "profileType": "S",
  "lastSignInAt": "2019-04-05T14:30:30+02:00",
  "givenConsents": [
    {}
  ],
  "customerNumber": 0,
  "expirationDate": "2019-04-05T14:30:30+02:00",
  "landlineNumber": "landlineNumber",
  "lastSignInFrom": "lastSignInFrom",
  "organisationId": 0,
  "ecardOwnerships": [
    {
      "id": 0,
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "ecardName": "ecardName",
      "customerId": 0,
      "bookingDate": "2019-04-05T14:30:30+02:00",
      "ecardNumber": 0,
      "shippingDate": "2019-04-05T14:30:30+02:00",
      "ecardOperator": 0,
      "endOfOwnership": "2019-04-05T14:30:30+02:00",
      "expirationDate": "2019-04-05T14:30:30+02:00",
      "startOfOwnership": "2019-04-05T14:30:30+02:00",
      "ecardNumber16digits": "ecardNumber16digits"
    }
  ],
  "emailVerifiedAt": "2019-04-05T14:30:30+02:00",
  "postalAddresses": [
    {
      "id": 0,
      "town": "town",
      "postCode": "postCode",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "customerId": 0,
      "verifiedAt": "2019-04-05T14:30:30+02:00",
      "countryCode": "NOR",
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "typeOfAddress": "P"
    }
  ],
  "telephoneNumber": "telephoneNumber",
  "changedByChannel": "changedByChannel",
  "createdByChannel": "createdByChannel",
  "customerAccounts": [
    {
      "id": 0,
      "alias": "Tommy",
      "changedAt": "2019-04-05T14:30:30+02:00",
      "changedBy": "changedBy",
      "createdAt": "2019-04-05T14:30:30+02:00",
      "createdBy": "createdBy",
      "isDefault": true,
      "customerNumber": 0,
      "customerAccountId": "ATB:CustomerAccount:abc58673cde-1c82-4bc5-989c-9d5eaa7ea866"
    }
  ],
  "customerConsents": [
    {
      "changedAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "customerId": 0,
      "consentCode": "consentCode",
      "consentChoice": true
    }
  ],
  "customerAccountId": "XYZ:CustomerAccount:<uuid>",
  "languagePreference": "NO",
  "personnelTicketBearer": {
    "changedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "bearerCustomerId": 0,
    "ticketRightOwner": "ticketRightOwner",
    "ticketRightBearer": "ticketRightBearer",
    "isSelfServedRetrieval": true
  },
  "relatedCustomerNumbers": [
    0
  ],
  "languagePreferenceISO6393": "NOB",
  "telephoneNumberVerifiedAt": "2019-04-05T14:30:30+02:00",
  "telephoneNumberNoCountryCode": "telephoneNumberNoCountryCode"
}

json

application/json

Generate password

PUT

https://api.entur.io/customers/v2

/profiles/{organisationId}/{email}/generate-password

Generates a new password for a customer identified by organisationId (numeric) and email address. This endpoint requires an Internal or Partner jwt-token.

Generate password › path Parameters

organisationId

integer · int64 · required · style: simple

email

string · required · style: simple

Generate password › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Generate password › Responses

Return object when generating a new password

GeneratePasswordResponse

surname

string · maxLength: 50 · required

Customer surname.

firstName

string · maxLength: 50 · required

Customer first and middle name.

customerNumber

integer · int64 · required

Customer number.

organisationId

integer · int64 · required

Organisation id.

generatedPassword

string · maxLength: 100 · required

The new generated password.

customerRef

string · maxLength: 40

Customer reference

telephoneNumber

string · maxLength: 20

Telephone number for customer. This should be a cell phone number.

Temporary profiles client Profile connections

Build with Entur

Contribute

Terms & Policies

Authentication admin

Verify credentials

Verify credentials › Headers

Verify credentials › Request Body

Verify credentials › Responses

Generate password and send email/sms for customer

Generate password and send email/sms for customer › Headers

Generate password and send email/sms for customer › Request Body

Generate password and send email/sms for customer › Responses

Set password

Set password › path Parameters

Set password › Headers

Set password › Request Body

Set password › Responses

Change password

Change password › path Parameters

Change password › Headers

Change password › Request Body

Change password › Responses

Generate password

Generate password › path Parameters

Generate password › Headers

Generate password › Responses