Skip to content
Search
Getting started
Platform
Reference
API reference
Information
address-types
create-address-type
post
update-address-type
put
delete-address-type
delete
get-address-type-field-list
get
create-address-type-field
post
get-address-type-field-by-id
get
update-address-type-field
put
delete-address-type-field
delete
has-address-field-usage
get
has-address-type-usage
get
batch
customer-batch
post
batch-catalog
customer-batch-catalog
post
blacklists
create-black-list
post
is-black-list-exist-by-citizenid
get
update-black-list
put
delete-black-list
delete
caches
customer-get-cache-key-list
get
customer-refresh-cache
post
compensating-transactions
customer-commit-compensating-transaction
post
customer-rollback-compensating-transaction
post
consent-items
create-consent-item
post
get-consent-item-list-by-customer-id
get
get-consent-item-dimension-list
get
get-consent-item-by-id
get
update-consent-item
put
delete-consent-item
delete
create-consent-service-map
post
get-consent-service-map-by-id
get
update-consent-service-map
put
delete-consent-service-map
delete
create-consent-item-dimension
post
get-consent-item-dimension-by-id
get
update-consent-item-dimension
put
delete-consent-item-dimension
delete
has-consent-item-dimension-usage
get
has-consent-item-usage
get
consents
get-consent-list
get
create-consent
post
update-consent-customer-by-id
put
control-consent
get
get-consent-detail-list
get
get-consent-by-id
get
update-consent
put
delete-consent
delete
create-consent-detail
post
get-consent-detail-by-id
get
update-consent-detail
put
delete-consent-detail
delete
customer-configs
get-customer-config-list
get
create-customer-config
post
get-customer-config-by-id
get
update-customer-config
put
delete-customer-config
delete
customer-groups
create-customer-group
post
update-customer-group
put
delete-customer-group
delete
get-customer-group-member-list
get
create-customer-group-member
post
get-customer-group-member-by-id
get
update-customer-group-member
put
delete-customer-group-member
delete
customer-number-citizenid-maps
get-customer-number-citizenid-map-list
get
create-customer-number-citizenid-map
post
check-customer-number-by-citizenid
get
get-customer-number-citizenid-map-by-id
get
update-customer-number-citizenid-map
put
delete-customer-number-citizenid-map
delete
customer-number-reserves
create-customer-reserved
post
is-customer-reserved
get
update-customer-reserved
put
delete-customer-reserved
delete
customer-rules
create-customer-rule
post
update-customer-rule
put
delete-customer-rule
delete
execute-customer-rule-formula
post
customer-segments-range
create-customer-segment-range
post
update-customer-segment-range
put
delete-customer-segment-range
delete
data-migrations
Returns data migration records
get
identity-types
create-identity-type
post
update-identity-type
put
delete-identity-type
delete
get-identity-type-field-list
get
create-identity-type-field
post
get-identity-type-field-by-id
get
update-identity-type-field
put
delete-identity-type-field
delete
has-identity-type-field-usage
get
has-identity-type-usage
get
key-formats
customer-get-key-format-list
get
customer-create-key-format
post
customer-get-key-format-id-by-code
get
customer-reset-key-format-counter-by-code
put
customer-get-key-format-by-id
get
customer-update-key-format
put
customer-get-key-format-item-id-by-key-format-id
get
customer-get-key-format-item-by-key-format-id
get
customer-create-key-format-item
post
customer-delete-key-format-item
delete
localizations
customer-get-localization-list
get
customer-create-localization
post
customer-get-localization-by-code
get
customer-get-localization-by-id
get
customer-update-localization
put
customer-delete-localization
delete
customer-get-localization-translation-by-localization-id
get
customer-create-localization-translation
post
customer-update-localization-translation
put
customer-delete-localization-translation
delete
naces
create-nace
post
update-nace
put
delete-nace
delete
occupation-types
create-occupation-type
post
update-occupation-type
put
delete-occupation-type
delete
create-occupation-type-field
post
get-occupation-type-field-by-id
get
update-occupation-type-field
put
delete-occupation-type-field
delete
create-occupation-type-field-map
post
get-occupation-type-field-map-by-id
get
update-occupation-type-field-map
put
delete-occupation-type-field-map
delete
has-occupation-field-usage
get
has-occupation-type-usage
get
parameters
customer-get-parameter-list
get
customer-create-parameter
post
customer-get-parameter-by-code
get
customer-get-parameter-default-value-by-parameter-code
get
customer-get-parameter-value-list-by-parameter-code
get
customer-get-parameter-by-id
get
customer-update-parameter
put
customer-delete-parameter
delete
customer-get-parameter-default-value
get
customer-update-parameter-field-value
put
customer-delete-parameter-field-value
delete
customer-get-parameter-field-list
get
customer-create-parameter-field
post
customer-update-parameter-field
put
customer-delete-parameter-field
delete
customer-get-parameter-value-list
get
customer-create-parameter-value
post
customer-update-parameter-value
put
customer-delete-parameter-value
delete
customer-get-parameter-field-value-list
get
customer-create-parameter-field-value
post
potential-persons
get-potential-person-list
get
create-potential-person
post
get-potential-person-by-id
get
update-potential-person
put
delete-potential-person
delete
customers--address-multiple-default-control
check-addresses-contains-multiple-default
post
customers--addresses
get-address-list
get
create-address
post
get-address-by-id
get
update-address-by-id
put
delete-address
delete
customers--attributes
get-customer-attribute-list
get
create-customer-attribute
post
get-customer-attribute-by-id
get
update-customer-attribute
put
delete-customer-attribute
delete
customers--authorities
get-customer-authority-list
get
get-customer-authority-list-by-customer-id
get
create-customer-authority
post
get-customer-authority-by-id
get
update-customer-authority
put
delete-customer-authority
delete
customers--basic-info
get-customer-basic-info-by-id
get
customers--bnpl-virtual-cards
get-bnpl-virtual-card-list
get
create-bnpl-virtual-card
post
get-bnpl-virtual-card-by-id
get
update-bnpl-virtual-card
put
delete-bnpl-virtual-card
delete
customers--bnpl-virtual-ibans
create-bnpl-virtual-iban
post
get-bnpl-virtual-iban-by-id
get
delete-bnpl-virtual-iban
delete
customers--by-citizenid
get-customer-id-by-citizenid
get
get-customer-summary-by-citizen-id
get
customers--by-customer-number
get-customer-id-by-customer-number
get
customers--by-email
check-customer-exist-by-email-address
get
customers--by-phone
get-customer-id-by-phone-number
get
check-customer-exist-by-phone-number
get
is-customer-exist-by-phone-number
get
customers--checks
get-customer-check-by-customer-id
get
create-customer-check
post
get-customer-check-by-id
get
delete-customer-check
delete
customers--corporates
get-corporate-customer-by-customer-id
get
create-corporate-customer
post
update-corporate-customer
put
customers--disableds
get-customer-disabled-list
get
create-customer-disabled
post
get-customer-disabled-by-id
get
update-customer-disabled
put
delete-customer-disabled
delete
customers--emails
get-email-address-list
get
create-email-address
post
update-email-address
put
delete-email-address
delete
customers--general
create-customer
post
update-customer
put
customers--identities
get-identity-list
get
create-identity
post
get-identity-card-by-id
get
update-identity-field
put
delete-identity-card
delete
create-identity-field
post
customers--identity-cards
get-identity-card-list
get
customers--individuals
get-individual-customer-by-customer-id
get
create-individual-customer
post
update-individual-customer
put
customers--mail-multiple-default-control
check-mails-contains-multiple-default
post
customers--nationalities
get-nationality-list
get
update-batch-nationality
put
create-nationality
post
get-nationality-by-id
get
update-nationality
put
delete-nationality
delete
customers--occupations
get-occupation-list
get
update-occupation
put
create-occupation
post
get-occupation-by-id
get
customers--phone-multiple-default-control
check-phones-contains-multiple-default
post
customers--phones
get-phone-list
get
create-phone
post
update-phone
put
delete-phone
delete
customers--potentials
create-potential-customer
post
update-potential-customer
put
customers--preferences
get-customer-preference-list
get
create-customer-preference
post
get-customer-preference-by-id
get
update-customer-preference
put
delete-customer-preference
delete
customers--profiles
get-customer-profile-list
get
create-customer-profile
post
get-customer-profile-by-id
get
update-customer-profile
put
delete-customer-profile
delete
customers--publish-create-bnpl-virtual-card
publish-create-bnpl-virtual-card
post
customers--publish-create-customer-application
publish-create-customer-application
post
customers--publish-create-virtual-iban
publish-create-virtual-iban
post
customers--relationships
get-customer-relationship-list
get
get-customer-shareholder-list
get
get-customer-relationship-list-by-customer-id
get
create-customer-relationship
post
get-customer-relationship-by-id
get
update-customer-relationship
put
delete-customer-relationship
delete
get-customer-shareholder-list-by-relationship-id
get
create-customer-shareholder
post
get-customer-shareholder-by-id
get
update-customer-shareholder
put
delete-customer-shareholder
delete
customers--residentials
get-residential-list
get
update-batch-residential
put
create-residential
post
get-residential-by-id
get
update-residential
put
delete-residential
delete
customers--segments
get-customer-segment-list
get
create-customer-segment
post
get-customer-current-segment-by-customer-id
get
get-customer-segment-by-id
get
update-customer-segment
put
delete-customer-segment
delete
customers--taxpayers
get-customer-taxpayer-list
get
create-customer-taxpayer
post
get-customer-taxpayer-by-id
get
update-customer-taxpayer
put
delete-customer-taxpayer
delete
customers--unlimited-companies
get-unlimited-company-customer-by-customer-id
get
create-unlimited-company-customer
post
update-unlimited-company-customer
put
customers--user
update-customer-user-id
put
customers--verified-info
create-verified-info
post
Schemas
Menu
Customer
Customer
Schemas
PlatformError
The body a mapped failure returns. One `error` object; `error.code` is the only place the code appears. Not every failure carries it — see the individual statuses.
error
object
·
required
