API Reference

Endpoint

GET /v1/customers/{customerId}/self-service/master-data

Path Parameters

customerId required integer (int64)

Unique ID of the customer

Responses

Response Body application/json

firstName required

First name of the customer

Example: "Edgar"

lastName required

Surname of the customer

Example: "Bullock"

gender required

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"

dateOfBirth string(date) required

Birthday of the customer

Example: "1952-05-04"

countryOfBirth string(ISO 3166-1)

Birth country of the customer

Example: "DE"

customerTitle required

Title of the customer

Allowed values:

`NONE`	No title
`DR`	Ph.D. title
`PROF`	Professor title

Example: "DR"

amendmentConfigurationStatus required

Status of the amendment configuration.

Allowed values:

`READ`	No changes to data are possible.
`CHANGES_REQUIRE_VERIFICATION`	Data can be changed, but needs verification to be applied to the customer.
`CHANGES_WITHOUT_VERIFICATION`	Data can be changed, will be applied to the customer with immediate effect.

Example: "CHANGES_REQUIRE_VERIFICATION"

pendingAmendment

id integer(int64)

Amendment proposal id

firstName required

First name of the customer

Example: "Edgar"

lastName required

Surname of the customer

Example: "Bullock"

gender required

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"

dateOfBirth string(date) required

Birthday of the customer

Example: "1952-05-04"

countryOfBirth string(ISO 3166-1)

Birth country of the customer

Example: "DE"

customerTitle required

Title of the customer

Allowed values:

`NONE`	No title
`DR`	Ph.D. title
`PROF`	Professor title

Example: "DR"

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"