API Reference

Endpoint

GET /v1/customers/by

Query Parameters

cardNumber string

Card number to identify the customer

cardNumberFormat string

Allowed values:

DECIMAL

HEX_MSB

HEX_LSB

Default: DECIMAL

debtorId string

Unique ID of the debtor

qrCodeUuid deprecated string (uuid)

QR code UUID to identify the customer

barcode string

Barcode to identify the customer

pin string

PIN to identify the customer

customerNumber string

Customer number to identify the customer

Responses

Response Body application/json

Customer information

id integer(int64) required

Unique ID of the customer

Example: 1001

customerNumber

Customer number

Example: "1-12345"

firstName

First name of the customer

Example: "Edgar"

secondFirstName

Second first name of the customer

Example: "Thomas"

lastName

Surname of the customer

Example: "Bullock"

secondLastName

Second last name of the customer

Example: "Meyer"

dateOfBirth string(date)

Birthday of the customer

Example: "1952-05-04"

email

Email address of the customer

Example: "example@email.com"

gender

Gender of the customer

Allowed values:

`MALE`	Male gender of the customer
`FEMALE`	Female gender of the customer
`UNISEX`	Unisex gender of the customer

Example: "MALE"

street

Street of the customer

Example: "Am Bahnhof"

houseNumber

Number of the customer's house

Example: 89

zipCode

Zip code of the customer

Example: "12133"

city

City of the customer

Example: "Munich"

country string(ISO 3166-1)

Country of the customer

Example: "DE"

secondStreet

Second street line of the customer's address

Example: "Second Street"

cityPart

City part of the customer's address

Example: "Tegel"

district

District of the customer's address

Example: "District 12"

streetType

Street type of the customer's address

Example: "Avenue"

streetBlock

Street block of the customer's address

Example: "5th block"

portal

Portal of the customer's address

Example: "Portal 1"

stairway

Stairway of the customer's address

Example: "Right stairway"

door

Door of the customer's address

Example: "Door 1"

province

Province of the customer's address

Example: "Champagne"

additionalAddressInformation

Additional address information of the customer's address

Example: "Additional information"

floor

Floor of the customer's address

Example: "2nd floor"

buildingName

Building name

Example: "Empire State Building"

status required

Status of customer

Allowed values:

`MEMBER`	Customer with contracts attached
`PROSPECT`	Customer without contracts
`FORMER_MEMBER`	Customer is a former member

Example: "MEMBER"

cardNumbers array[object] deprecated

UID list of the customer card numbers in expected format. (The new property to use is accessMediums)

Example: ["1290158199"]

imageUrl

Url with an image to download. It will expire after 15 minutes

Example: "https://example.com"

phonePrivate

Private phone number of the customer

Example: "+49 30901820"

phonePrivateMobile

Private mobile phone number of the customer

Example: "+49 15223433333"

phoneBusiness

Business phone number of the customer

Example: "+49 30901820"

phoneBusinessMobile

Business mobile phone number of the customer

Example: "+49 15223433333"

idlePeriods array[object]

List of customer's idle periods

id integer(int64) required

Unique ID of the idle period

Example: 1000

startDate string(date) required

Start date of the idle period

Example: "2022-01-01"

endDate string(date) required

End date of the idle period

Example: "2022-10-01"

reason

Reason of the idle period

Example: "Illness"

contract

Contract information

id integer(int64) required

Unique ID of the contract

Example: 1000

rateName required

Rate name for the contract

Example: "Premium"

bankAccount

Customer's bank account information

accountHolder

The account holder of the bank account

Example: "Sven Hannawald"

bankName

Bank name of the customers

Example: "Deutsche Bank"

bic

Bic of the customers account

Example: "DEUTDEFFXXX"

iban

Iban of the customers account

Example: "DE91 1000 0000 0123 4567 89"

accessRefusal required

Indicates whether the customer has an access block currently

accessRestrictions array[object]

List of access restrictions of the customer

reason required

Reason for the restriction

Example: "Destroyed equipment"

startDate string(date)

Start date of the restriction

Example: "2024-01-01"

endDate string(date)

End date of the restriction

Example: "2024-06-30"

uuid

Customer's UUID

Example: "7be3932c-825b-4401-abff-29e9f9410bc7"

referralCode

Customer's referral code

Example: "20J6N"

studioId integer(int64)

Studio ID of the customer

Example: 1238735970

preferredLanguage

Basic language information

languageCode string(ISO 639-1) required

The language code

Example: "de"

countryCode string(ISO 3166-1)

The country code

Example: "DE"

additionalInformationFieldAssignments array[object]

List of additional information field assignments of the customer

additionalInformationFieldId integer(int64) required

The unique ID of the additional information field

Example: 1234567890

value required

The value of the additional information field assignment. For list fields this is the id of the selected item, for text fields this is the text value, for numeric fields must be positive or negative integers, for date fields this is the date in ISO-8601 format, and for boolean fields this is 'true' or 'false'.

thirdPartyId

Unique ID of the third party customer in the third party system

Example: "A1000"

accessMediums array[object]

List of access mediums of the customer

id integer(int64)

Unique identifier for the access medium

Example: 1234567890

type

Represents a type of access medium

Allowed values:

`CARD_NUMBER`	Card number
`PIN`	Personal identification number
`BARCODE`	Barcode content
`WALLET_PASS`	Wallet pass identifier

Example: "CARD_NUMBER"

value

Unique identifier for the access medium

Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST

reference

Reference to validation error

Example: "parent.child"

Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"