customers
Operations addressed under /customers — 30 operations.
update-bnpl-virtual-card-by-token
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-update-bnpl-virtual-card-by-token service definition through PUT /api/customers/bnpl-virtual-cards/by-card-token/{cardToken}.
Request and response fields are declared on the routing target update-bnpl-virtual-card-by-token; this entry declares none of its own.
path Parameters
cardTokenupdate-bnpl-virtual-card-by-token › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-dynamic-get-customer-information-by-citizen-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-information-by-citizen-id; this entry declares none of its own.
path Parameters
citizenIdaurax-bff-dynamic-get-customer-information-by-citizen-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
birthDatebirthPlacecitizenIdcitizenIdTypecustomerIdcustomerNumbercustomerTypeemailsfullNamegenderNameisActiveloansmaritalStatusmotherMaidenSurnamephonesaurax-bff-service-dynamic-get-customer-number-by-citizenid
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-number-by-citizenid; this entry declares none of its own.
path Parameters
citizenidaurax-bff-service-dynamic-get-customer-number-by-citizenid › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
customerNumbercustomerSubTypecustomerTypeidisCustomerisDefaultaurax-bff-redirect-get-individual-customer-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-individual-customer-list; this entry declares none of its own.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-individual-customer-list › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
addressNameaddressTextaddressTypeaddressTypeIdbirthCountryIdbirthDatebirthPlacecitizenidcitizenidTypecloseDateclosedDateclosedReasonconsentconsentItemDimensionIdconsentItemIdconsentItemIdsconsentSourceIdcreatedDatecreatedOrganizationIdcustomerIdcustomerNumbercustomerStatuscustomerSubTypecustomerTypedeathDateestablishCountryDivisionIdestablishCountryIdestablishDatefatherNamefreeZonefullNamegendergivenNameidindividualCustomerIdisApprovedisBlackListisCardDeliveryAddressisContactisDefaultisFreeZoneCustomerisPoliticallyExposedisSignedisVerifiedmaidenSurnamemainOrganizationIdmaritalStatusmiddleNamemotherMaidenSurnamemotherNamenaceIdnameonboardedDateonboardedOrganizationIdorganizationTypepwfCustomerIdrecordTyperegistryOfficeCountryDivisionIdregistryOfficeCountryIdresidencysegmentNameseparatorMarksubOrganizationTypesurnametransactionIdversionNoaurax-bff-redirect-get-customer-summary-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-summary-by-id; this entry declares none of its own.
Declared as Route-bound but absent from the route template, so not sendable: id.
aurax-bff-redirect-get-customer-summary-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
addressIdbirthDatecitizenidcitizenidTypecustomerNumbercustomerStatuscustomerSubTypecustomerTypefullNameisDefaultisPotentialmainOrganizationIdmiddleNamenameonboardedDateresidencysurnameaurax-bff-service-dynamic-create-verified-customer-bpm-bff
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target create-verified-customer-bff; this entry declares none of its own.
Response body, read from the service source
The route declares its response as CreateVerifiedCustomerDto.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid | no |
CustomerNumber | string | no |
Member names are the service's declaration names.
Headers
partnerCodeaurax-bff-service-dynamic-create-verified-customer-bpm-bff › Request Body
citizenidcustomerSubTypephoneNumberemailkycStatusworkingTypeaurax-bff-service-dynamic-create-verified-customer-bpm-bff › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bff-service-dynamic-get-email-address-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-email-address-by-id; this entry declares none of its own.
path Parameters
idemailIdaurax-bff-service-dynamic-get-email-address-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
customerIdemailidisContactisDefaultaurax-bff-service-dynamic-get-light-customer-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-light-customer-by-id; this entry declares none of its own.
path Parameters
idquery Parameters
includeaurax-bff-service-dynamic-get-light-customer-by-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
addressIdbirthCountryIdbirthDatebirthPlacecitizenidcitizenidTypecloseDateclosedDateclosedReasoncreatedDatecreatedOrganizationIdcustomerNumbercustomerStatuscustomerSubTypecustomerTypedeathDatefatherNamefreeZonefullNamegendergivenNameidindividualCustomerIdisBlackListisDefaultisFreeZoneCustomerisPoliticallyExposedlanguageIdmaidenSurnamemainOrganizationIdmaritalStatusmiddleNamemotherMaidenSurnamemotherNamenaceIdnameonboardedDateonboardedOrganizationIdorganizationTyperecordTyperegistryOfficeCountryDivisionIdregistryOfficeCountryIdresidencysubOrganizationTypesurnametransactionidaurax-bff-service-dynamic-get-phone-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-phone-by-id; this entry declares none of its own.
path Parameters
idphoneIdaurax-bff-service-dynamic-get-phone-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
customerIdidisContactisDefaultphoneNumberphoneTypeaurax-bff-service-dynamic-change-customer-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target change-customer-status; this entry declares none of its own.
path Parameters
idaurax-bff-service-dynamic-change-customer-status › Request Body
customerStatusclosedReasonaurax-bff-service-dynamic-change-customer-status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-dynamic-get-customer-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-list; this entry declares none of its own.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-dynamic-get-customer-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
create-customer-ui-bpm.bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-create-customer-ui-bpm service definition through POST /customers.
Request and response fields are declared on the routing target create-customer-ui-bpm; this entry declares none of its own.
create-customer-ui-bpm.bpmn › Request Body
birthDatecitizenidcitizenidTypecreatedOrganizationIdcustomerSubTypecustomerTypeisPoliticallyExposedmainOrganizationIdnameonboardedOrganizationIdsurnamebirthCountryIdbirthPlaceconsentItemIdscustomerNumberdeathDatedmsIdfatherNamefullNamegendergivenNamemaidenSurnamemaritalStatusmiddleNamemotherMaidenSurnamemotherNamenaceIdpersonRegistrationreserveCustomerNumberresidencysectorNaceIdcreate-customer-ui-bpm.bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-virtual-iban-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-bnpl-virtual-iban-list; this entry declares none of its own.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-virtual-iban-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
closeDatecustomerIdfecidvirtualIbanaurax-bff-dynamic-get-customer-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as CustomerDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
CorporateCustomer | CorporateCustomerDto | no |
UnlimitedCompanyCustomer | UnlimitedCompanyCustomerDto | no |
Addresses | List<AddressItem> (collection) | no |
AddressesUI | List<AddressItemUI> (collection) | no |
Emails | List<EmailAddressItem> (collection) | no |
Identities | List<IdentityDto> (collection) | no |
Nationalities | List<NationalityItem> (collection) | no |
Occupations | List<OccupationItem> (collection) | no |
Phones | List<PhoneItem> (collection) | no |
Residentials | List<ResidentialItem> (collection) | no |
ConsentItemIds | List<Guid> (collection) | no |
CustomerChecks | List<CustomerCheckDto> (collection) | no |
CustomerAuthorities | List<CustomerAuthorityDto> (collection) | no |
CustomerRelationships | List<CustomerRelationshipDto> (collection) | no |
CustomerTaxpayers | List<CustomerTaxpayerDto> (collection) | no |
CustomerAttributes | List<CustomerAttributeDto> (collection) | no |
CustomerRepresentativeAssignments | List<CustomerRepresentativeAssignmentDto> (collection) | no |
Member names are the service's declaration names.
path Parameters
idaurax-bff-dynamic-get-customer-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
birthCountryIdbirthDatebirthPlacecitizenidcitizenidTypecloseDateclosedDateclosedReasonconsentItemIdscreatedOrganizationIdcustomerNumbercustomerStatuscustomerSubTypecustomerTypedeathDatefatherNamefreeZonefullNamegendergivenNameidindividualCustomerIdisBlackListisDefaultisFreeZoneCustomerisPoliticallyExposedmaidenSurnamemainOrganizationIdmaritalStatusmiddleNamemotherMaidenSurnamemotherNamenaceIdnameonboardedDateonboardedOrganizationIdorganizationTyperecordTyperegistryOfficeCountryDivisionIdregistryOfficeCountryIdresidencysubOrganizationTypesurnameupdate-customer-ui-bpm.bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-edit-customer-ui-bpm service definition through PUT /customers/{id}.
Request and response fields are declared on the routing target edit-customer-ui-bpm; this entry declares none of its own.
path Parameters
idPresent in this route template but not among the Route-bound fields of the routing target edit-customer-ui-bpm, whose own path is decoupled from this one.
update-customer-ui-bpm.bpmn › Request Body
birthDatecitizenidcitizenidTypecreatedOrganizationIdcustomerSubTypecustomerTypeidindividualCustomerIdisPoliticallyExposedmainOrganizationIdnameonboardedOrganizationIdsurnamebirthCountryIdbirthPlaceclosedDateconsentItemIdsdeathDatefatherNamefullNamegendergivenNamemaidenSurnamemaritalStatusmiddleNamemotherMaidenSurnamemotherNamenaceIdresidencysectorNaceIdtaxNoupdate-customer-ui-bpm.bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-account-total-balance
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-account-total-balance; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-account-total-balance › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-account-details
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-account-details; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-account-details › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-address-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-address-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-address-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
addressNameaddressTextaddressTypeaddressTypeIdcustomerIdidisCardDeliveryAddressisContactisDefaultisVerifiedaurax-bff-redirect-get-customer-attribute-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-attribute-list-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-customer-attribute-list-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
attributeKeyattributeValuebeginDatecustomerIdendDateidisDigitalaurax-bff-redirect-get-bnpl-virtual-iban-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-bnpl-virtual-iban-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-bnpl-virtual-iban-by-customer-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
closeDatecustomerIdfecidvirtualIbanaurax-bff-redirect-get-email-address-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-email-address-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-email-address-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerIdemailidisContactisDefaultisVerifiedaurax-bff-redirect-get-identity-card-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-identity-card-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-identity-card-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerIdididentityTypeIdaurax-bff-redirect-get-nationality-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-nationality-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-nationality-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
countryIdcustomerIdidpriorityaurax-bff-redirect-get-occupation-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-occupation-list-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-occupation-list-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
fieldIdfieldValuetypeIdaurax-bff-redirect-get-customer-phone-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-phone-list-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-customer-phone-list-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerIdidisContactisDefaultisVerifiedphoneNumberphoneTypeaurax-bff-redirect-get-customer-profile-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-profile-list-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-customer-profile-list-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerIdidprofileaurax-bff-redirect-get-customer-shareholder-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-shareholder-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-customer-shareholder-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerRelationshipIdendDateidshareRatestartDateaurax-bff-redirect-get-customer-representative-assignment-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-representative-assignment-list; this entry declares none of its own.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-customer-representative-assignment-list › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerIdendDateidorganizationIdrepresentativeUserIdstartDateaurax-bff-redirect-get-residential-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-residential-list-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-residential-list-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
countryIdcustomerIdidpriorityaurax-bff-redirect-get-customer-tax-payer-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-tax-payer-list-by-customer-id; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-get-customer-tax-payer-list-by-customer-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
companyTypecountryIdcustomerIddescriptionfatcaReasonidtaxNumbertaxNumberNotReasontaxpayerClasstaxpayerPersonTypetaxpayerType