{ "openapi": "3.1.0", "info": { "title": "Mobile BFF Service", "version": "42565c68377d", "summary": "DgCore platform API surface for the Mobile BFF Service domain.", "description": "The Mobile BFF Service domain: 39 operations across 22 resource groups.\n\nThis is the published contract, not a description of a running deployment: the environment\nyou were granted may carry operations this document does not, and may not carry every\noperation listed here." }, "servers": [ { "url": "https://{gateway}/mobile-bff-service", "description": "The full route is `https:///mobile-bff-service/`. The service segment is fixed; the gateway host is the one you were granted. Substitute it below.", "variables": { "gateway": { "default": "gateway.example" } } } ], "tags": [ { "name": "assignments", "description": "Operations addressed under `/assignments` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "confirm-otp", "description": "Operations addressed under `/confirm-otp` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "consent-items", "description": "Operations addressed under `/consent-items` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-application", "description": "Operations addressed under `/customer-application` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-loan-collections", "description": "Operations addressed under `/customer-loan-collections` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customers", "description": "Operations addressed under `/customers` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "generate-pwf-otp", "description": "Operations addressed under `/generate-pwf-otp` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan", "description": "Operations addressed under `/loan` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "occupation-types", "description": "Operations addressed under `/occupation-types` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "otp-items", "description": "Operations addressed under `/otp-items` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-change-user-password", "description": "Operations addressed under `/pwf-change-user-password` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-initate-activation", "description": "Operations addressed under `/pwf-initate-activation` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-login", "description": "Operations addressed under `/pwf-login` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-reset-pass", "description": "Operations addressed under `/pwf-reset-pass` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-verify-and-login", "description": "Operations addressed under `/pwf-verify-and-login` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "reset-pwf-otp", "description": "Operations addressed under `/reset-pwf-otp` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "screenshot-logs", "description": "Operations addressed under `/screenshot-logs` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "send-sms-otp", "description": "Operations addressed under `/send-sms-otp` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "slip-transactions", "description": "Operations addressed under `/slip-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "template-types", "description": "Operations addressed under `/template-types` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "user-devices", "description": "Operations addressed under `/user-devices` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "users", "description": "Operations addressed under `/users` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } ], "paths": { "/api/confirm-otp": { "post": { "operationId": "mobile-bff-confirm-otp-bpm", "tags": [ "confirm-otp" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "confirm-otp-bpm", "description": "Invokes the `mobile-bff-confirm-otp-bpm` service definition through `POST /api/confirm-otp`.\n\nRequest and response fields are declared on the routing target `confirm-otp-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "oneTimePassword": { "type": "string", "x-aura-field-code": "oneTimePassword", "x-aura-encrypted": true }, "otpName": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } }, "required": [ "oneTimePassword", "otpName", "transactionId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-confirm-otp-bpm", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/confirm-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customer-application/parameters/by-code/{code}/values": { "get": { "operationId": "mobile-bff-service-dynamic-customer-application-get-parameter-value-list-by-parameter-code", "tags": [ "customer-application" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-dynamic-customer-application-get-parameter-value-list-by-parameter-code", "description": "Request and response fields are declared on the routing target `customer-application-get-parameter-value-list-by-parameter-code`; this entry declares none of its own.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "parameterCode" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterValueId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "paramKey": { "type": "integer", "format": "int32", "x-aura-field-code": "paramKey" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-dynamic-customer-application-get-parameter-value-list-by-parameter-code", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/customer-application/parameters/by-code/{code}/values", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterValueDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParamKey", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" } ] } } }, "/api/customers/by-citizenid/{citizenid}/customernumber": { "get": { "operationId": "mobile-bff-redirect-get-customer-number-by-citizenid", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-customer-number-by-citizenid", "description": "Request and response fields are declared on the routing target `get-customer-number-by-citizenid`; this entry declares none of its own.", "parameters": [ { "name": "citizenid", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "properties": { "customerDatas": { "type": "array", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "isCustomer": { "type": "boolean", "x-aura-field-code": "isCustomer" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "x-aura-field-code": "customerDatas" } }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "isCustomer": { "type": "boolean", "x-aura-field-code": "isCustomer" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-customer-number-by-citizenid", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/customers/by-citizenid/{citizenid}/customernumber", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/summary": { "get": { "operationId": "mobile-bff-get-customer-summary-by-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-get-customer-summary-by-id", "description": "Request and response fields are declared on the routing target `get-customer-summary-by-id`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isPotential": { "type": "boolean", "x-aura-field-code": "isPotential" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "customerProfiles" } }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-customer-summary-by-id", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/customers/summary", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/by-customer-id": { "get": { "operationId": "mobile-bff-redirect-get-loan-list-by-customer-id", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-loan-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-loan-list-by-customer-id`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: customerId.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus" }, "allotmentQueryId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentQueryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanAmount" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelReason": { "type": "string", "x-aura-field-code": "cancelReason" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAccountId" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerRiskId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRiskId" }, "earlyPaymentDiscountRate": { "type": "number", "format": "decimal", "x-aura-field-code": "earlyPaymentDiscountRate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "loanExchangeRate" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "latePenaltyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "latePenaltyRate" }, "loanCloseDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanCloseDate" }, "loanCloseType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCloseType" }, "loanDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanDate" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "parentLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentLoanId" }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanStatus" }, "statusContext": { "type": "string", "x-aura-field-code": "loanStatusContext" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-loan-list-by-customer-id", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/loan/by-customer-id", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-list-by-customer-id`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/loan/external-firm/details-by-external-reference/{externalReference}": { "get": { "operationId": "mobile-bff-service-dynamic-get-loan-details-by-external-reference", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-dynamic-get-loan-details-by-external-reference", "description": "Request and response fields are declared on the routing target `get-loan-details-by-external-reference`; this entry declares none of its own.", "parameters": [ { "name": "externalReference", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "externalReference" } }, { "name": "partnerCode", "in": "header", "required": true, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 1, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus" }, "allotmentQueryId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentQueryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanAmount" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelReason": { "type": "string", "x-aura-field-code": "cancelReason" }, "collateralUsages": { "type": "array", "items": { "type": "object", "properties": { "collateralUsageId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" } }, "x-aura-field-code": "collateralUsages" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAccountId" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerRiskId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRiskId" }, "delegations": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "delegationAmount" }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationBeginDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationEndDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delegationId" }, "loanDelegationDetail": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loanDelegationDetail" } }, "loanDelegationId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanDelegationId" }, "productCategoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "productCategoryId" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "delegationStatus" } }, "x-aura-field-code": "delegations" } }, "disbursements": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "disbursementAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "disbursementDate": { "type": "string", "format": "date-time", "x-aura-field-code": "disbursementDate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "externalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorAccountId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "disbursementId" }, "internalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorAccountId" }, "isCancel": { "type": "boolean", "x-aura-field-code": "isCancel" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "disbursementStatus" } }, "x-aura-field-code": "disbursements" } }, "earlyPaymentDiscountRate": { "type": "number", "format": "decimal", "x-aura-field-code": "earlyPaymentDiscountRate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" } }, "x-aura-field-code": "expenses" } }, "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "externalTransactionid": { "type": "string", "x-aura-field-code": "externalTransactionid" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "guarantors": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "guarantorId" }, "proximity": { "type": "integer", "format": "int32", "x-aura-field-code": "proximity" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "guarantorStatus" } }, "x-aura-field-code": "guarantors" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "latePenaltyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "latePenaltyRate" }, "loanCloseDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanCloseDate" }, "loanCloseType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCloseType" }, "loanDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanDate" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "merchants": { "type": "array", "items": { "type": "object", "x-aura-field-code": "merchants" } }, "orders": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanOrderAmount" }, "billNo": { "type": "string", "x-aura-field-code": "billNo" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "externalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "orderId" }, "internalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorId" }, "orderDate": { "type": "string", "format": "date-time", "x-aura-field-code": "orderDate" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanOrderStatus" } }, "x-aura-field-code": "orders" } }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "parentLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentLoanId" }, "paybackPlans": { "type": "array", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "calculateInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "calculateInstallmentDate" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentNo" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isManual": { "type": "boolean", "x-aura-field-code": "isManual" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "loanPaybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "principalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "principalAmount" }, "profitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "profitAmount" }, "remainingPrincipalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingPrincipalAmount" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" }, "taxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "taxAmount" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } } }, "x-aura-field-code": "installments" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "monthlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyRate" }, "paybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "paybackPlanId" }, "totalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmount" }, "totalPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPaymentAmount" }, "xirr": { "type": "number", "format": "decimal", "x-aura-field-code": "xirr" } }, "x-aura-field-code": "paybackPlans" } }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanStatus" }, "vendorExternalId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-dynamic-get-loan-details-by-external-reference", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/loan/external-firm/details-by-external-reference/{externalReference}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDetailsDto", "payload": "LoanDetailsDto", "collection": false, "members": [ { "name": "ChannelType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Disbursements", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollateralUsages", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Expenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Orders", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Delegations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Guarantors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ReturnPayments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Insurances", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Merchants", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PoolDefinitionRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" }, { "code": "ERR_LOAN_91", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MULTIPLE_ROW_FOUND" } ] } } }, "/api/loan/get-customer-unpaid-installment-list": { "get": { "operationId": "mobile-bff-redirect-get-unpaid-installment-list-by-customer-id-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-unpaid-installment-list-by-customer-id-bpmn", "description": "Request and response fields are declared on the routing target `get-unpaid-installment-list-by-customer-id-bpmn`; this entry declares none of its own.\n\nRead from the caller's token, not from the request: customerId.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "currentDate": { "type": "string", "format": "date", "x-aura-field-code": "currentDate" }, "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" }, "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "upcomingPaymentAmount": { "type": "number", "x-aura-field-code": "upcomingPaymentAmount" }, "upcomingPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "upcomingPaymentDate" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "currentDate": { "type": "string", "format": "date", "x-aura-field-code": "currentDate" }, "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" }, "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "upcomingPaymentAmount": { "type": "number", "x-aura-field-code": "upcomingPaymentAmount" }, "upcomingPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "upcomingPaymentDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "currentDate": { "type": "string", "format": "date", "x-aura-field-code": "currentDate" }, "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" }, "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "upcomingPaymentAmount": { "type": "number", "x-aura-field-code": "upcomingPaymentAmount" }, "upcomingPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "upcomingPaymentDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-unpaid-installment-list-by-customer-id-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/loan/get-customer-unpaid-installment-list", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/installment-payment-amount": { "get": { "operationId": "mobile-bff-service-dynamic-calculate-installment-payment-amount-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-dynamic-calculate-installment-payment-amount-bpmn", "description": "Request and response fields are declared on the routing target `calculate-installment-payment-amount-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "installmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" } }, "required": [ "installmentId" ] } } }, "description": "The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `installmentId`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "installmentId" ] }, "dropped_mandatory_field_names": [ "installmentId" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-dynamic-calculate-installment-payment-amount-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/loan/installment-payment-amount", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/installments-debt-amount": { "post": { "operationId": "mobile-bff-redirect-calculate-installments-debt-amount-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-calculate-installments-debt-amount-bpmn", "description": "Request and response fields are declared on the routing target `calculate-installments-debt-amount-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "installmentIdList": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentIdList" } } }, "required": [ "installmentIdList" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "totalRemainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingAmount" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "totalRemainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "totalRemainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-calculate-installments-debt-amount-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/loan/installments-debt-amount", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/{id}/details": { "get": { "operationId": "mobile-bff-redirect-get-loan-details-by-id", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-loan-details-by-id", "description": "Request and response fields are declared on the routing target `get-loan-details-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus" }, "allotmentQueryId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentQueryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanAmount" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelReason": { "type": "string", "x-aura-field-code": "cancelReason" }, "collateralUsages": { "type": "array", "items": { "type": "object", "properties": { "collateralUsageId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" } }, "x-aura-field-code": "collateralUsages" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAccountId" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerRiskId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRiskId" }, "delegations": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "delegationAmount" }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationBeginDate" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationEndDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delegationId" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "delegationStatus" } }, "x-aura-field-code": "delegations" } }, "disbursements": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "disbursementAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "disbursementDate": { "type": "string", "format": "date-time", "x-aura-field-code": "disbursementDate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "externalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorAccountId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "disbursementId" }, "internalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorAccountId" }, "isCancel": { "type": "boolean", "x-aura-field-code": "isCancel" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "disbursementStatus" } }, "x-aura-field-code": "disbursements" } }, "earlyPaymentDiscountRate": { "type": "number", "format": "decimal", "x-aura-field-code": "earlyPaymentDiscountRate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" } }, "x-aura-field-code": "expenses" } }, "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "externalTransactionid": { "type": "string", "x-aura-field-code": "externalTransactionid" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "guarantors": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "guarantorId" }, "personId": { "type": "string", "format": "uuid", "x-aura-field-code": "personId" }, "proximity": { "type": "integer", "format": "int32", "x-aura-field-code": "proximity" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "guarantorStatus" } }, "x-aura-field-code": "guarantors" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "insurances": { "type": "array", "items": { "type": "object", "properties": { "chassisNumber": { "type": "string", "x-aura-field-code": "chassisNumber" }, "company": { "type": "string", "x-aura-field-code": "company" }, "coverageAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "coverageAmount" }, "coverageCurrencyNumber": { "type": "string", "x-aura-field-code": "coverageCurrencyNumber" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "insuranceEndDate" }, "engineNumber": { "type": "string", "x-aura-field-code": "engineNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "insuranceId" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "lossPayee": { "type": "string", "x-aura-field-code": "lossPayee" }, "plate": { "type": "string", "x-aura-field-code": "plate" }, "policyHolderFullname": { "type": "string", "x-aura-field-code": "policyHolderFullname" }, "policyHolderNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "policyHolderNumber" }, "policyNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "policyNumber" }, "premiumAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "premiumAmount" }, "premiumCurrencyNumber": { "type": "string", "x-aura-field-code": "premiumCurrencyId" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "insuranceStartDate" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "insuranceType" }, "vehicleBrand": { "type": "string", "x-aura-field-code": "vehicleBrand" }, "vehicleModel": { "type": "string", "x-aura-field-code": "vehicleModel" }, "vehicleType": { "type": "string", "x-aura-field-code": "vehicleType" } }, "x-aura-field-code": "insurances" } }, "latePenaltyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "latePenaltyRate" }, "loanCloseDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanCloseDate" }, "loanCloseType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCloseType" }, "loanDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanDate" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanOrderAmount" }, "billNo": { "type": "string", "x-aura-field-code": "billNo" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "externalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "orderId" }, "internalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorId" }, "orderDate": { "type": "string", "format": "date-time", "x-aura-field-code": "orderDate" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanOrderStatus" } }, "x-aura-field-code": "orders" } }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "parentLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentLoanId" }, "partnerId": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" }, "paybackPlans": { "type": "array", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "compoundInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "compoundInterestRate" }, "effectiveInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "effectiveInterestRate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "calculateInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "calculateInstallmentDate" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentNo" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isManual": { "type": "boolean", "x-aura-field-code": "isManual" }, "principalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "principalAmount" }, "profitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "profitAmount" }, "remainingPrincipalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingPrincipalAmount" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanInstallmentTaxId" }, "taxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "taxAmount" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } } }, "x-aura-field-code": "installments" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "monthlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyRate" }, "paybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "paybackPlanId" }, "totalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmount" }, "totalPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPaymentAmount" }, "xirr": { "type": "number", "format": "decimal", "x-aura-field-code": "xirr" } }, "x-aura-field-code": "paybackPlans" } }, "poolDefinitionRates": { "type": "array", "items": { "type": "object", "properties": { "loanPoolDefinitionRateId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPoolDefinitionRateId" }, "poolDefinitionRateId": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionRateId" } }, "x-aura-field-code": "poolDefinitionRates" } }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanStatus" }, "vendorExternalId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-loan-details-by-id", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/loan/{id}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDetailsDto", "payload": "LoanDetailsDto", "collection": false, "members": [ { "name": "ChannelType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Disbursements", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollateralUsages", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Expenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Orders", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Delegations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Guarantors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ReturnPayments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Insurances", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Merchants", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PoolDefinitionRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/api/pwf-initate-activation": { "post": { "operationId": "mobile-bff-pwf-activation-otp", "tags": [ "pwf-initate-activation" ], "summary": "mobile-bff-pwf-activation-otp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationName": { "type": "string", "x-aura-field-code": "applicationName" }, "password": { "type": "string", "x-aura-field-code": "keycloak_password", "x-aura-encrypted": true }, "userIdentifier": { "type": "string", "x-aura-field-code": "userIdentifier" } }, "required": [ "applicationName", "password", "userIdentifier" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-pwf-activation-otp", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/pwf-initate-activation", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "Password", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicationName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfActivationDto", "payload": "PwfActivationDto", "collection": false, "members": [ { "name": "EncryptedCredentials", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FirstName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Username", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SmsSuccess", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsTempPassword", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomerIdGuid", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURAX_43", "status": 400, "message": null, "message_available": false, "constant_name": "PHONE_NUMBER_NOT_FOUND" }, { "code": "ERR_AURAX_49", "status": 400, "message": null, "message_available": false, "constant_name": "USERNAME_NOT_NUMBER" } ] } } }, "/api/pwf-login": { "post": { "operationId": "mobile-bff-pwf-login", "tags": [ "pwf-login" ], "summary": "mobile-bff-pwf-login", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationNames": { "type": "array", "items": { "type": "string", "x-aura-field-code": "applicationNames" } }, "loginOtp": { "type": "string", "x-aura-field-code": "loginOtp" }, "password": { "type": "string", "x-aura-field-code": "keycloak_password", "x-aura-encrypted": true }, "userIdentifier": { "type": "string", "x-aura-field-code": "userIdentifier" } }, "required": [ "applicationNames", "loginOtp", "password", "userIdentifier" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-pwf-login", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/pwf-login", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "Password", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoginOtp", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfLoginDto", "payload": "PwfLoginDto", "collection": false, "members": [ { "name": "AccessToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpiresIn", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RefreshExpiresIn", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RefreshToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TokenType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SessionState", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Scope", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/pwf-reset-pass": { "post": { "operationId": "mobile-bff-pwf-reset-pass", "tags": [ "pwf-reset-pass" ], "summary": "mobile-bff-pwf-reset-pass", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activationCredential": { "type": "string", "x-aura-field-code": "activationCredential" }, "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" }, "newPassword": { "type": "string", "x-aura-field-code": "newPassword", "x-aura-encrypted": true }, "validityDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDuration" } }, "required": [ "activationCredential", "newPassword", "validityDuration" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-pwf-reset-pass", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/pwf-reset-pass", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ActivationCredential", "declared_type": null, "nullable": false, "collection": false }, { "name": "NewPassword", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDuration", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURAX_50", "status": 400, "message": { "ar": "لا يمكن تكرار نفس الحرف ثلاث مرات (مثل 111023)", "en": "The same character cannot repeat three times (e.g., 111023)", "tr": "Aynı karakter üç kez tekrar edemez (örnek: 111023)" }, "message_available": true, "constant_name": "ACTIVATION_EXPIRED" } ] } } }, "/api/send-sms-otp": { "post": { "operationId": "mobile-bff-service-redirect-send-sms-otp-bpm", "tags": [ "send-sms-otp" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-redirect-send-sms-otp-bpm", "description": "Request and response fields are declared on the routing target `send-sms-otp`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "otpName": { "type": "string", "x-aura-field-code": "otpName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "otpName", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-redirect-send-sms-otp-bpm", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/send-sms-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "OtpName", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SendSmsOtpDto", "payload": "SendSmsOtpDto", "collection": false, "members": [ { "name": "TransactionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/slip-transactions/view-receipt": { "post": { "operationId": "mobile-bff-redirect-view-receipt-by-entityrowid", "tags": [ "slip-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-view-receipt-by-entityrowid", "description": "Request and response fields are declared on the routing target `view-receipt-by-entityrowid`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityRowId": { "type": "string", "format": "uuid", "x-aura-field-code": "entityRowId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "slipId" }, "isPdf": { "type": "boolean", "x-aura-field-code": "isPdf" }, "slipNumber": { "type": "string", "x-aura-field-code": "slipNumber" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "slipTransactionType" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-view-receipt-by-entityrowid", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/slip-transactions/view-receipt", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "EntityRowId", "declared_type": null, "nullable": false, "collection": false, "documentation": { "summary": "Tablonun id bilgisini veya EKB icin BusinessKey bilgisini icerir", "source": "the service's own XML documentation comment, read from its source" } }, { "name": "SlipNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPdf", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false, "documentation": { "summary": "Ekb icin musteri hesap numarasi", "source": "the service's own XML documentation comment, read from its source" } } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `string`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.", "declared_type": "string", "payload": "string" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURAX_34", "status": 400, "message": null, "message_available": false, "constant_name": "REQUEST_MUST_NOT_EMPTY" }, { "code": "ERR_AURAX_35", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_IS_EMPTY" } ] } } }, "/api/template-types/designs/create-document/{templateDesignId}": { "post": { "operationId": "mobile-bff-service-redirect-create-document-with-template-bpmn", "tags": [ "template-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-redirect-create-document-with-template-bpmn", "description": "Request and response fields are declared on the routing target `create-document-with-template-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "designVariables": { "type": "object", "x-aura-field-code": "designVariables" }, "isResponseClear": { "type": "boolean", "x-aura-field-code": "isResponseClear" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "templateDesignContextId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignContextId" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "contextVersion": { "type": "number", "format": "decimal", "x-aura-field-code": "contextVersion" }, "documentContext": { "type": "string", "x-aura-field-code": "documentContext" }, "templateDesignCode": { "type": "string", "x-aura-field-code": "templateDesignCode" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "contextVersion": { "type": "number", "format": "decimal", "x-aura-field-code": "contextVersion" }, "documentContext": { "type": "string", "x-aura-field-code": "documentContext" }, "templateDesignCode": { "type": "string", "x-aura-field-code": "templateDesignCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "contextVersion": { "type": "number", "format": "decimal", "x-aura-field-code": "contextVersion" }, "documentContext": { "type": "string", "x-aura-field-code": "documentContext" }, "templateDesignCode": { "type": "string", "x-aura-field-code": "templateDesignCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-redirect-create-document-with-template-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "api/template-types/designs/create-document/{templateDesignId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DesignVariables", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsResponseClear", "declared_type": null, "nullable": true, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPdf", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/assignments/get-available-limit": { "post": { "operationId": "mobile-bff-redirect-get-available-limit-bpmn", "tags": [ "assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-available-limit-bpmn", "description": "Request and response fields are declared on the routing target `get-available-limit-bpmn-bff`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "transactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionAmount" } }, "required": [ "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-available-limit-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "assignments/get-available-limit", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionAmount", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AvailableLimitDto", "payload": "AvailableLimitDto", "collection": false, "members": [ { "name": "AllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AllotmentAssignmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAssignmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AvailableAllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerProductRisk", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductAllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IsLimitAvailable", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/assignments/get-available-limit-without-product": { "post": { "operationId": "mobile-bff-redirect-get-available-limit-without-product-bpmn", "tags": [ "assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-available-limit-without-product-bpmn", "description": "Read from the caller's token, not from the request: customerId.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-available-limit-without-product-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "assignments/get-available-limit-without-product", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/consent-items/consent-service-maps": { "get": { "operationId": "mobile-bff-get-consent-service-map-list", "tags": [ "consent-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-get-consent-service-map-list", "description": "Request and response fields are declared on the routing target `get-consent-service-map-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "consentItemCode" }, "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "documentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "documentItemId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentServiceMapId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "consentItemName" }, "necessity": { "type": "integer", "format": "int32", "x-aura-field-code": "necessity" }, "processDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "processDefinitionId" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "templateDesignId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-consent-service-map-list", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "consent-items/consent-service-maps", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-consent-service-map-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-loan-collections/by-installment-id/{installmentId}/details": { "get": { "operationId": "mobile-bff-redirect-get-customer-loan-collection-details-by-installment-id", "tags": [ "customer-loan-collections" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-customer-loan-collection-details-by-installment-id", "description": "Request and response fields are declared on the routing target `get-customer-loan-collection-details-by-installment-id`; this entry declares none of its own.", "parameters": [ { "name": "installmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelType": { "type": "integer", "format": "int32", "x-aura-field-code": "cancelType" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionDate": { "type": "string", "format": "date-time", "x-aura-field-code": "collectionDate" }, "collectionDetails": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "collectionDetailType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionDetailType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerLoanCollectionDetailId" } }, "x-aura-field-code": "collectionDetails" } }, "collectionResource": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionResource" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "delayPenalties": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "calculatedMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "calculatedMethod" }, "delayAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "delayAmount" }, "delayDayCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayDayCount" }, "fromAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "fromAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delayPenaltyId" }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delayPenaltyTaxId" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } }, "totalDelayAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalDelayAmount" } }, "x-aura-field-code": "delayPenalties" } }, "discountAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "discountAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerLoanCollectionId" }, "installmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "installmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentType" }, "loanCollectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCollectionId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-customer-loan-collection-details-by-installment-id", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "customer-loan-collections/by-installment-id/{installmentId}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "InstallmentId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerLoanCollectionDetailsDto", "collection": true, "members": [ { "name": "DelayPenalties", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/customers/bnpl-virtual-ibans": { "get": { "operationId": "mobile-bff-get-bnpl-virtual-iban-list", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-get-bnpl-virtual-iban-list", "description": "Request and response fields are declared on the routing target `get-bnpl-virtual-iban-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "fec": { "type": "integer", "format": "int32", "x-aura-field-code": "fec" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "bnplVirtualIbanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-bnpl-virtual-iban-list", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "customers/bnpl-virtual-ibans", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the routing target `get-bnpl-virtual-iban-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/verify": { "post": { "operationId": "mobile-bff-verify-customer-bpm", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-verify-customer-bpm", "description": "Request and response fields are declared on the routing target `verify-customer-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "isPotential": { "type": "boolean", "x-aura-field-code": "isPotential" }, "phone": { "type": "string", "x-aura-field-code": "phone" }, "queryDayNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "queryDayNumber" }, "queryType": { "type": "integer", "format": "int32", "x-aura-field-code": "queryType" }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } }, "required": [ "queryType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressSource": { "type": "integer", "format": "int32", "x-aura-field-code": "addressSource", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "amlVerifyResult": { "type": "boolean", "x-aura-field-code": "amlVerifyResult" }, "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "buildingCode": { "type": "string", "x-aura-field-code": "personAddressBuildingCode" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "string", "x-aura-field-code": "personAddressCityCode" }, "country": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "string", "x-aura-field-code": "personAddressDistrictCode" }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherCitizenid": { "type": "string", "x-aura-field-code": "fatherCitizenid" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "foreignAddress": { "type": "string", "x-aura-field-code": "foreignAddress" }, "foreignPermissionCity": { "type": "string", "x-aura-field-code": "foreignPermissionCity" }, "foreignPermissionEndDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionEndDate" }, "foreignPermissionNumber": { "type": "string", "x-aura-field-code": "foreignPermissionNumber" }, "foreignPermissionStartDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionStartDate" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "isTemporary": { "type": "boolean", "x-aura-field-code": "isTemporary" }, "issueDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoIssueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "identityIssueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "identityIssueReason" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "matchStatusId": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatusId" }, "motherCitizenid": { "type": "string", "x-aura-field-code": "motherCitizenid" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "nationality": { "type": "integer", "format": "int32", "x-aura-field-code": "nationality" }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "neihgbourhoodCode": { "type": "string", "x-aura-field-code": "personNeihgbourhoodCode" }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "referenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "region": { "type": "string", "x-aura-field-code": "region" }, "regionCode": { "type": "string", "x-aura-field-code": "personAddressRegionCode" }, "registerCity": { "type": "string", "x-aura-field-code": "registerCity" }, "registerDistrict": { "type": "string", "x-aura-field-code": "registerDistrict", "x-aura-maskable": true }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "registrationType": { "type": "integer", "format": "int32", "x-aura-field-code": "registrationType" }, "section": { "type": "string", "x-aura-field-code": "section" }, "sectionCode": { "type": "string", "x-aura-field-code": "personAddressSectionCode" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "spouseCitizenid": { "type": "string", "x-aura-field-code": "spouseCitizenid" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "string", "x-aura-field-code": "personAddressStreetCode" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unit": { "type": "string", "x-aura-field-code": "identityUnit" }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" }, "verifyResult": { "type": "boolean", "x-aura-field-code": "verifyResult" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressSource": { "type": "integer", "format": "int32", "x-aura-field-code": "addressSource", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "amlVerifyResult": { "type": "boolean", "x-aura-field-code": "amlVerifyResult" }, "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "buildingCode": { "type": "string", "x-aura-field-code": "personAddressBuildingCode" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "string", "x-aura-field-code": "personAddressCityCode" }, "country": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "string", "x-aura-field-code": "personAddressDistrictCode" }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherCitizenid": { "type": "string", "x-aura-field-code": "fatherCitizenid" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "foreignAddress": { "type": "string", "x-aura-field-code": "foreignAddress" }, "foreignPermissionCity": { "type": "string", "x-aura-field-code": "foreignPermissionCity" }, "foreignPermissionEndDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionEndDate" }, "foreignPermissionNumber": { "type": "string", "x-aura-field-code": "foreignPermissionNumber" }, "foreignPermissionStartDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionStartDate" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "isTemporary": { "type": "boolean", "x-aura-field-code": "isTemporary" }, "issueDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoIssueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "identityIssueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "identityIssueReason" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "matchStatusId": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatusId" }, "motherCitizenid": { "type": "string", "x-aura-field-code": "motherCitizenid" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "nationality": { "type": "integer", "format": "int32", "x-aura-field-code": "nationality" }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "neihgbourhoodCode": { "type": "string", "x-aura-field-code": "personNeihgbourhoodCode" }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "referenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "region": { "type": "string", "x-aura-field-code": "region" }, "regionCode": { "type": "string", "x-aura-field-code": "personAddressRegionCode" }, "registerCity": { "type": "string", "x-aura-field-code": "registerCity" }, "registerDistrict": { "type": "string", "x-aura-field-code": "registerDistrict", "x-aura-maskable": true }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "registrationType": { "type": "integer", "format": "int32", "x-aura-field-code": "registrationType" }, "section": { "type": "string", "x-aura-field-code": "section" }, "sectionCode": { "type": "string", "x-aura-field-code": "personAddressSectionCode" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "spouseCitizenid": { "type": "string", "x-aura-field-code": "spouseCitizenid" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "string", "x-aura-field-code": "personAddressStreetCode" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unit": { "type": "string", "x-aura-field-code": "identityUnit" }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" }, "verifyResult": { "type": "boolean", "x-aura-field-code": "verifyResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressSource": { "type": "integer", "format": "int32", "x-aura-field-code": "addressSource", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "amlVerifyResult": { "type": "boolean", "x-aura-field-code": "amlVerifyResult" }, "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "buildingCode": { "type": "string", "x-aura-field-code": "personAddressBuildingCode" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "string", "x-aura-field-code": "personAddressCityCode" }, "country": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "string", "x-aura-field-code": "personAddressDistrictCode" }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherCitizenid": { "type": "string", "x-aura-field-code": "fatherCitizenid" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "foreignAddress": { "type": "string", "x-aura-field-code": "foreignAddress" }, "foreignPermissionCity": { "type": "string", "x-aura-field-code": "foreignPermissionCity" }, "foreignPermissionEndDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionEndDate" }, "foreignPermissionNumber": { "type": "string", "x-aura-field-code": "foreignPermissionNumber" }, "foreignPermissionStartDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionStartDate" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "isTemporary": { "type": "boolean", "x-aura-field-code": "isTemporary" }, "issueDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoIssueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "identityIssueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "identityIssueReason" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "matchStatusId": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatusId" }, "motherCitizenid": { "type": "string", "x-aura-field-code": "motherCitizenid" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "nationality": { "type": "integer", "format": "int32", "x-aura-field-code": "nationality" }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "neihgbourhoodCode": { "type": "string", "x-aura-field-code": "personNeihgbourhoodCode" }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "referenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "region": { "type": "string", "x-aura-field-code": "region" }, "regionCode": { "type": "string", "x-aura-field-code": "personAddressRegionCode" }, "registerCity": { "type": "string", "x-aura-field-code": "registerCity" }, "registerDistrict": { "type": "string", "x-aura-field-code": "registerDistrict", "x-aura-maskable": true }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "registrationType": { "type": "integer", "format": "int32", "x-aura-field-code": "registrationType" }, "section": { "type": "string", "x-aura-field-code": "section" }, "sectionCode": { "type": "string", "x-aura-field-code": "personAddressSectionCode" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "spouseCitizenid": { "type": "string", "x-aura-field-code": "spouseCitizenid" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "string", "x-aura-field-code": "personAddressStreetCode" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unit": { "type": "string", "x-aura-field-code": "identityUnit" }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" }, "verifyResult": { "type": "boolean", "x-aura-field-code": "verifyResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-verify-customer-bpm", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "customers/verify", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsPotential", "declared_type": null, "nullable": true, "collection": false }, { "name": "Phone", "declared_type": null, "nullable": false, "collection": false }, { "name": "QueryDayNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "QueryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/bnpl-virtual-ibans": { "get": { "operationId": "mobile-bff-get-bnpl-virtual-iban-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-get-bnpl-virtual-iban-by-customer-id", "description": "Request and response fields are declared on the routing target `get-bnpl-virtual-iban-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "properties": { "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "fec": { "type": "integer", "format": "int32", "x-aura-field-code": "fec" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "bnplVirtualIbanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-bnpl-virtual-iban-by-customer-id", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "customers/{id}/bnpl-virtual-ibans", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/generate-pwf-otp": { "post": { "operationId": "mobile-bff-redirect-generate-pwf-otp", "tags": [ "generate-pwf-otp" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-generate-pwf-otp", "description": "Request and response fields are declared on the routing target `generate-pwf-otp`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationName": { "type": "string", "x-aura-field-code": "applicationName" }, "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "password": { "type": "string", "x-aura-field-code": "oldPassword", "x-aura-encrypted": true } }, "required": [ "applicationName", "citizenId", "password" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-generate-pwf-otp", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "generate-pwf-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Password", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicationName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfOtpDto", "payload": "PwfOtpDto", "collection": false, "members": [ { "name": "EncryptedCredentials", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StateToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FirstName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Username", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SmsSuccess", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsTempPassword", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomerIdGuid", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/loan/installment-payment-amount": { "get": { "operationId": "mobile-bff-redirect-calculate-installment-payment-amount-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-calculate-installment-payment-amount-bpmn", "description": "Request and response fields are declared on the routing target `calculate-installment-payment-amount-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "installmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" } }, "required": [ "installmentId" ] } } }, "description": "The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `installmentId`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "installmentId" ] }, "dropped_mandatory_field_names": [ "installmentId" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-calculate-installment-payment-amount-bpmn", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "loan/installment-payment-amount", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types/{id}/fields": { "get": { "operationId": "mobile-bff-get-occupation-type-field-list", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-get-occupation-type-field-list", "description": "Request and response fields are declared on the routing target `get-occupation-type-field-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-occupation-type-field-list", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the routing target `get-occupation-type-field-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/otp-items": { "get": { "operationId": "mobile-bff-get-otp-item-list", "tags": [ "otp-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-get-otp-item-list", "description": "Request and response fields are declared on the routing target `get-otp-item-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "otpItemId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "keyFormatId": { "type": "string", "format": "uuid", "x-aura-field-code": "keyFormatId" }, "name": { "type": "string", "x-aura-field-code": "otpItemName" }, "retryCount": { "type": "integer", "format": "int32", "x-aura-field-code": "retryCount" }, "retryDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "retryDuration" }, "validityDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDuration" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-otp-item-list", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "otp-items", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "caching": true, "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-otp-item-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OtpItemDto", "collection": true, "members": [ { "name": "KeyFormatId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValidityDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RetryDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RetryCount", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/pwf-change-user-password": { "post": { "operationId": "mobile-bff-redirect-pwf-change-user-password", "tags": [ "pwf-change-user-password" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-pwf-change-user-password", "description": "Request and response fields are declared on the routing target `pwf-change-user-password-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newPassword": { "type": "string", "x-aura-field-code": "newPassword", "x-aura-encrypted": true }, "oldPassword": { "type": "string", "x-aura-field-code": "oldPassword", "x-aura-encrypted": true }, "username": { "type": "string", "x-aura-field-code": "keycloakUserName" }, "validityDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDuration" } }, "required": [ "newPassword", "oldPassword", "validityDuration" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-pwf-change-user-password", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "pwf-change-user-password", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/pwf-verify-and-login": { "post": { "operationId": "mobile-bff-redirect-pwf-verify-and-login", "tags": [ "pwf-verify-and-login" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-pwf-verify-and-login", "description": "Request and response fields are declared on the routing target `pwf-login`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationNames": { "type": "array", "items": { "type": "string", "x-aura-field-code": "applicationNames" } }, "citizienId": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "loginOtp": { "type": "string", "x-aura-field-code": "loginOtp" }, "password": { "type": "string", "x-aura-field-code": "keycloak_password", "x-aura-encrypted": true } }, "required": [ "applicationNames", "citizienId", "password" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-pwf-verify-and-login", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "pwf-verify-and-login", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/reset-pwf-otp": { "post": { "operationId": "mobile-bff-redirect-pwf-reset-otp", "tags": [ "reset-pwf-otp" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-pwf-reset-otp", "description": "Request and response fields are declared on the routing target `pwf-reset-password`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "encryptedCredentials": { "type": "string", "x-aura-field-code": "encryptedCredentials" }, "newPassword": { "type": "string", "x-aura-field-code": "newPassword", "x-aura-encrypted": true } }, "required": [ "encryptedCredentials", "newPassword" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-pwf-reset-otp", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "reset-pwf-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "EncryptedCredentials", "declared_type": null, "nullable": false, "collection": false }, { "name": "NewPassword", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResetPasswordDto", "payload": "PwfResetPasswordDto", "collection": false, "members": [ { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/screenshot-logs": { "get": { "operationId": "mobile-bff-get-screenshot-log-list", "tags": [ "screenshot-logs" ], "summary": "mobile-bff-get-screenshot-log-list", "parameters": [ { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "client_log_client_date" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "client_log_client_date" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "urlPath", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "urlPath" } }, { "name": "userCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "userCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 8 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-get-screenshot-log-list", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "screenshot-logs", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "UrlPath", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ScreenshotLogDto", "collection": true, "members": [ { "name": "ClientDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientIp", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientDeviceDetail", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "mobile-bff-create-screenshot-log", "tags": [ "screenshot-logs" ], "summary": "mobile-bff-create-screenshot-log", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientDate": { "type": "string", "format": "date-time", "x-aura-field-code": "client_log_client_date" }, "clientDeviceDetail": { "type": "string", "x-aura-field-code": "clientDeviceDetail" }, "urlPath": { "type": "string", "x-aura-field-code": "urlPath" } }, "required": [ "clientDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-create-screenshot-log", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "screenshot-logs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ClientDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "UrlPath", "declared_type": null, "nullable": false, "collection": false }, { "name": "ClientDeviceDetail", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/user-devices": { "get": { "operationId": "mobile-bff-redirect-get-user-device-list", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-user-device-list", "description": "Request and response fields are declared on the routing target `get-user-device-list`; this entry declares none of its own.", "parameters": [ { "name": "searchCustomerId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "searchCustomerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "deviceModel": { "type": "string", "x-aura-field-code": "deviceModel" }, "deviceOsVersion": { "type": "string", "x-aura-field-code": "deviceOsVersion" }, "deviceStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "deviceStatus" }, "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" }, "isRooted": { "type": "boolean", "x-aura-field-code": "isRooted" }, "lastLoginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lastLoginDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-user-device-list", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "user-devices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-user-device-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SearchCustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "`PwfUserDeviceModel` is not among the C# declarations parsed from this repository. The resolver checks this repository first, then permits a lookup in `aura/framework` or `aura/kernel` only when this repository declares the matching 0.2-line PackageReference. This unresolved verdict means neither licensed lookup produced exactly one parsed declaration. The view does not expose whether that was because no eligible package proof exists or because the entitled platform source does not declare the name, so this page does not guess between them. It is a dependency-boundary gap in what this portal can resolve, not evidence that the service returns no body.", "declared_type": "List", "envelopes": [ "List" ], "payload": "PwfUserDeviceModel" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-devices/by-token": { "delete": { "operationId": "mobile-bff-redirect-delete-device", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-delete-device", "description": "Request and response fields are declared on the routing target `delete-device`; this entry declares none of its own.", "parameters": [ { "name": "deviceToken", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "deviceToken" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-delete-device", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "user-devices/by-token", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResponseDto", "payload": "PwfResponseDto", "collection": false, "members": [ { "name": "VerificationSignature", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecretKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CipherText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Content", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } }, "get": { "operationId": "mobile-bff-redirect-get-user-device-by-token", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-get-user-device-by-token", "description": "Request and response fields are declared on the routing target `get-user-device-info-by-device-token`; this entry declares none of its own.", "parameters": [ { "name": "deviceToken", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "deviceToken" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceModel": { "type": "string", "x-aura-field-code": "deviceModel" }, "deviceOsVersion": { "type": "string", "x-aura-field-code": "deviceOsVersion" }, "deviceStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "deviceStatus" }, "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" }, "isRooted": { "type": "boolean", "x-aura-field-code": "isRooted" }, "lastLoginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lastLoginDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-get-user-device-by-token", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "user-devices/by-token", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfDeviceInfoDto", "payload": "PwfDeviceInfoDto", "collection": false, "members": [ { "name": "LastLoginDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DeviceToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeviceModel", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeviceOsVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsRooted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DeviceStatus", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-devices/lock": { "post": { "operationId": "mobile-bff-redirect-lock-device-by-device-token", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-lock-device-by-device-token", "description": "Request and response fields are declared on the routing target `lock-device-by-device-token`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" } }, "required": [ "deviceToken" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-lock-device-by-device-token", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "user-devices/lock", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResponseDto", "payload": "PwfResponseDto", "collection": false, "members": [ { "name": "VerificationSignature", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecretKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CipherText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Content", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-devices/unlock": { "post": { "operationId": "mobile-bff-redirect-unlock-device-by-device-token", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-redirect-unlock-device-by-device-token", "description": "Request and response fields are declared on the routing target `unlock-device-by-device-token`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" } }, "required": [ "deviceToken" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-redirect-unlock-device-by-device-token", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "user-devices/unlock", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResponseDto", "payload": "PwfResponseDto", "collection": false, "members": [ { "name": "VerificationSignature", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecretKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CipherText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Content", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/users/forget-password": { "post": { "operationId": "mobile-bff-service-redirect-forget-password-send-otp", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-redirect-forget-password-send-otp", "description": "Request and response fields are declared on the routing target `send-otp-forget-password`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userIdentifier": { "type": "string", "x-aura-field-code": "userIdentifier" } }, "required": [ "userIdentifier" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-redirect-forget-password-send-otp", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "users/forget-password", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "SendotpForgetPasswordResponse", "payload": "SendotpForgetPasswordResponse", "collection": false, "members": [ { "name": "Username", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPMCUS_17", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_CORE_161", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/users/forget-password-verify": { "post": { "operationId": "mobile-bff-service-redirect-forget-password-verify", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "mobile-bff-service-redirect-forget-password-verify", "description": "Request and response fields are declared on the routing target `forget-password-verify-otp-and-reset-password`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "oneTimePassword": { "type": "string", "x-aura-field-code": "oneTimePassword", "x-aura-encrypted": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" }, "username": { "type": "string", "x-aura-field-code": "username" } }, "required": [ "oneTimePassword", "transactionId", "username" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "mobile-bff-service-redirect-forget-password-verify", "x-aura-domain": "mobile-bff", "x-aura-raw-url-path": "users/forget-password-verify", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } } }, "components": { "schemas": { "PlatformError": { "type": "object", "title": "PlatformError", "description": "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.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "The platform error code. It is the identifier on the wire; a human-readable message for it is NOT guaranteed. The error catalog carries the codes seeded for this snapshot, with whichever of the published languages each one has text for, and many codes raised by services have no seeded entry at all. Where this portal knows which operations raise a code, they list it under `x-aura-error-codes`, each entry saying whether a message exists for it." }, "message": { "type": "string", "description": "The resolved message for the code, in the language the request asked for." }, "validationErrors": { "type": "array", "description": "Present on a validation failure only: one entry per rule that failed, each carrying its own code.", "items": { "type": "object", "additionalProperties": true } }, "businessErrors": { "type": "array", "description": "Present on a bulk failure only: one code/message pair per failed item.", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "responses": { "Error400": { "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error408": { "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error409": { "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error500": { "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error502": { "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }