{ "openapi": "3.0.1", "info": { "title": "Bank Frick VBAN API", "version": "0.11.0" }, "servers": [ { "url": "https://api.bankfrick.li/vban" }, { "url": "https://api-test.bankfrick.li/vban" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/end-customers": { "get": { "operationId": "getEndCustomers", "parameters": [ { "description": "Filter by end customer type", "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "NATURAL_PERSON", "LEGAL_ENTITY" ] }, "uniqueItems": true } }, { "description": "Filter by end customer state", "in": "query", "name": "state", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PREPARED", "ACTIVE" ] }, "uniqueItems": true } }, { "description": "Filter by the caller\u0027s own identifier", "example": "customer-4711", "in": "query", "name": "externalReference", "required": false, "schema": { "type": "string" } }, { "description": "Return only end customers whose lastModifiedAt is strictly after this ISO 8601 timestamp", "example": "2026-05-20T08:00:00Z", "in": "query", "name": "lastModifiedAfter", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "Page size, default 100, maximum 1000", "example": "10", "in": "query", "name": "pageSize", "required": false, "schema": { "type": "string" } }, { "description": "Page index, default 0", "example": "2", "in": "query", "name": "pageIndex", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndCustomersDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "summary": "Get end customers", "tags": [ "End Customers Controller" ] } }, "/end-customers/approvals": { "put": { "operationId": "approveEndCustomer", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveEndCustomerDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndCustomerDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Approve a prepared end customer", "tags": [ "End Customers Controller" ] } }, "/end-customers/legal-entities": { "post": { "operationId": "createLegalEntityEndCustomer", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLegalEntityEndCustomerDto" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntityEndCustomerDto" } } }, "description": "CREATED", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Register a legal entity as an end customer", "tags": [ "End Customers Controller" ] } }, "/end-customers/natural-persons": { "post": { "operationId": "createNaturalPersonEndCustomer", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNaturalPersonEndCustomerDto" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NaturalPersonEndCustomerDto" } } }, "description": "CREATED", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Register a natural person as an end customer", "tags": [ "End Customers Controller" ] } }, "/end-customers/{endCustomerId}": { "get": { "operationId": "getEndCustomer", "parameters": [ { "in": "path", "name": "endCustomerId", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndCustomerDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Read an end customer", "tags": [ "End Customers Controller" ] } }, "/named-virtual-ibans": { "get": { "operationId": "getNamedVirtualIbans", "parameters": [ { "description": "Filter by list of reference accounts", "example": [ "LI4408811MAINACCOUNT1" ], "in": "query", "name": "account", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, { "description": "Filter by list of Virtual IBAN states. When omitted, every state except DEACTIVATED is returned.", "example": [ "ACTIVE" ], "in": "query", "name": "state", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PREPARED", "ACTIVE", "DEACTIVATION_REQUESTED", "DEACTIVATED" ] }, "uniqueItems": true } }, { "description": "Return only VBANs whose lastModifiedAt is strictly after this ISO 8601 timestamp", "example": "2026-05-20T08:00:00Z", "in": "query", "name": "lastModifiedAfter", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "Page size, default 100, maximum 1000", "example": "10", "in": "query", "name": "pageSize", "required": false, "schema": { "type": "string" } }, { "description": "Page index, default 0", "example": "2", "in": "query", "name": "pageIndex", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedVirtualIbansDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "summary": "Get Named VBANs", "tags": [ "Named Virtual Ibans Controller" ] }, "post": { "operationId": "createNamedVirtualIban", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNamedVirtualIbanDto" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedVirtualIbanDto" } } }, "description": "CREATED", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create a Named VBAN for an approved end customer", "tags": [ "Named Virtual Ibans Controller" ] } }, "/named-virtual-ibans/activations/approvals": { "put": { "operationId": "approveNamedVirtualIbanActivation", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveNamedVirtualIbanActivationDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedVirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Approve a prepared Named VBAN together with its end customer", "tags": [ "Named Virtual Ibans Controller" ] } }, "/named-virtual-ibans/deactivations": { "put": { "operationId": "deactivateNamedVirtualIban", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateNamedVirtualIbanDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedVirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Request deactivation of a Named VBAN", "tags": [ "Named Virtual Ibans Controller" ] } }, "/named-virtual-ibans/deactivations/approvals": { "put": { "operationId": "approveNamedVirtualIbanDeactivation", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveNamedVirtualIbanDeactivationDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedVirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Approve the deactivation of a Named VBAN", "tags": [ "Named Virtual Ibans Controller" ] } }, "/named-virtual-ibans/upgrades": { "post": { "operationId": "upgradeVirtualIban", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeVirtualIbanDto" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanUpgradeDto" } } }, "description": "CREATED", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Request the upgrade of a VBAN to a Named VBAN", "tags": [ "Named Virtual Ibans Controller" ] } }, "/named-virtual-ibans/upgrades/approvals": { "put": { "operationId": "approveVirtualIbanUpgrade", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveVirtualIbanUpgradeDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanUpgradeDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Approve a pending upgrade of a VBAN to a Named VBAN", "tags": [ "Named Virtual Ibans Controller" ] } }, "/named-virtual-ibans/{vban}": { "get": { "operationId": "getNamedVirtualIban", "parameters": [ { "in": "path", "name": "vban", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedVirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Read a Named VBAN", "tags": [ "Named Virtual Ibans Controller" ] } }, "/virtual-ibans": { "get": { "operationId": "getVirtualIbans", "parameters": [ { "description": "Filter by list of reference accounts", "example": [ "LI4408811MAINACCOUNT1" ], "in": "query", "name": "account", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, { "description": "Filter by list of Virtual IBAN states. When omitted, every state except DEACTIVATED is returned.", "example": [ "ACTIVE" ], "in": "query", "name": "state", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PREPARED", "ACTIVE", "DEACTIVATION_REQUESTED", "DEACTIVATED" ] }, "uniqueItems": true } }, { "description": "Return only VBANs whose lastModifiedAt is strictly after this ISO 8601 timestamp", "example": "2026-05-20T08:00:00Z", "in": "query", "name": "lastModifiedAfter", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "Page size, default 100, maximum 1000", "example": "10", "in": "query", "name": "pageSize", "required": false, "schema": { "type": "string" } }, { "description": "Page index, default 0", "example": "2", "in": "query", "name": "pageIndex", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbansDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "summary": "Get virtual IBANs", "tags": [ "Virtual Ibans Controller" ] }, "post": { "operationId": "createVirtualIban", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVirtualIbanDto" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanDto" } } }, "description": "CREATED", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create virtual IBAN", "tags": [ "Virtual Ibans Controller" ] } }, "/virtual-ibans/activations/approvals": { "put": { "operationId": "approveVirtualIbanActivation", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveVirtualIbanActivationDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Approve prepared virtual IBAN", "tags": [ "Virtual Ibans Controller" ] } }, "/virtual-ibans/deactivations": { "put": { "operationId": "deactivateVirtualIban", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateVirtualIbanDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Deactivate virtual IBAN", "tags": [ "Virtual Ibans Controller" ] } }, "/virtual-ibans/deactivations/approvals": { "put": { "operationId": "approveVirtualIbanDeactivation", "parameters": [ { "description": "Cryptographic fingerprint of request body. Provide used algorithm in \u003calgorithm\u003e header.", "in": "header", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "Algorithm used for signing the request. Supported algorithms: rsa-sha512, rsa-sha384, rsa-sha256. If not provided, the server assumes rsa-sha512.", "in": "header", "name": "algorithm", "required": false, "schema": { "type": "string", "default": "rsa-sha512", "enum": [ "rsa-sha512", "rsa-sha384", "rsa-sha256" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveVirtualIbanDeactivationDto" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Approve deactivation of virtual IBAN", "tags": [ "Virtual Ibans Controller" ] } }, "/virtual-ibans/{vban}": { "get": { "operationId": "getVirtualIban", "parameters": [ { "in": "path", "name": "vban", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualIbanDto" } } }, "description": "OK", "headers": { "algorithm": { "description": "Algorithm used for signing the response. Default: rsa-sha512", "required": true, "schema": { "type": "string" } }, "signature": { "description": "Cryptographic fingerprint of response body. For calculation method, see \u003calgorithm\u003e header.", "required": true, "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Read virtual IBAN", "tags": [ "Virtual Ibans Controller" ] } } }, "components": { "responses": { "BadRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } }, "description": "A parameter or the payload failed validation, or the provided signature was invalid." }, "Conflict": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } }, "description": "The record was modified concurrently. Retry the request." }, "Forbidden": { "description": "The caller\u0027s IP address is outside the range the access token is restricted to. The request is rejected at the API gateway, which answers in its own error format." }, "NotFound": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } }, "description": "The requested record does not exist, or is not visible to the caller." }, "Unauthorized": { "description": "The access token is missing, expired or invalid. The request is rejected at the API gateway, which answers in its own error format." } }, "schemas": { "AddressType3Choice": { "type": "object" }, "AddressType3ChoiceCd": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AddressType3Choice" }, { "type": "object", "properties": { "Cd": { "type": "string", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ] } } } ] }, "AddressType3ChoicePrtry": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AddressType3Choice" }, { "type": "object", "properties": { "Prtry": { "$ref": "#/components/schemas/GenericIdentification30" } } } ] }, "ApprovalDto": { "type": "object", "properties": { "contactNumber": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "signatureGroup": { "type": "integer", "format": "int32" }, "signatureType": { "type": "string", "enum": [ "INDIVIDUAL", "COLLECTIVE_TWO", "COLLECTIVE_THREE", "COLLECTIVE_FOUR" ] } }, "required": [ "contactNumber", "createdAt", "createdBy", "signatureGroup", "signatureType" ] }, "ApproveEndCustomerDto": { "type": "object", "properties": { "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 } }, "required": [ "endCustomerId" ] }, "ApproveNamedVirtualIbanActivationDto": { "type": "object", "properties": { "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 }, "vban": { "type": "string", "minLength": 1 } }, "required": [ "endCustomerId", "vban" ] }, "ApproveNamedVirtualIbanDeactivationDto": { "type": "object", "properties": { "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 }, "vban": { "type": "string", "minLength": 1 } }, "required": [ "endCustomerId", "vban" ] }, "ApproveVirtualIbanActivationDto": { "type": "object", "properties": { "vban": { "type": "string" } }, "required": [ "vban" ] }, "ApproveVirtualIbanDeactivationDto": { "type": "object", "properties": { "vban": { "type": "string" } }, "required": [ "vban" ] }, "ApproveVirtualIbanUpgradeDto": { "type": "object", "properties": { "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 }, "vban": { "type": "string", "minLength": 1 } }, "required": [ "endCustomerId", "vban" ] }, "CommercialRegisterEntryDto": { "type": "object", "description": "Place and date of the commercial register entry, where applicable", "properties": { "date": { "type": "string", "format": "date" }, "place": { "type": "string" } }, "required": [ "date", "place" ] }, "CreateCommercialRegisterEntryDto": { "type": "object", "description": "Place and date of the commercial register entry, where applicable", "properties": { "date": { "type": "string", "format": "date" }, "place": { "type": "string", "maxLength": 255, "minLength": 1 } }, "required": [ "date", "place" ] }, "CreateLegalEntityEndCustomerDto": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/PostalAddress27" }, "commercialRegisterEntry": { "$ref": "#/components/schemas/CreateCommercialRegisterEntryDto" }, "companyName": { "type": "string", "maxLength": 255, "minLength": 1 }, "customerNumber": { "type": "string", "description": "The Bank Frick customer to register under", "maxLength": 7, "minLength": 1 }, "externalReference": { "type": "string", "description": "The caller\u0027s own identifier; stored and echoed back, never editable", "maxLength": 255, "minLength": 1 }, "incorporationCountry": { "type": "string", "description": "Country in which the business was incorporated, if different from the registered address, as ISO 3166-1 alpha-2 country code; required if available", "pattern": "^[A-Z]{2}$" }, "incorporationDate": { "type": "string", "format": "date" }, "legalEntityIdentifier": { "type": "string", "description": "Legal Entity Identifier (LEI) or any available equivalent official identifier; required if available", "maxLength": 50, "minLength": 1 }, "legalForm": { "type": "string", "maxLength": 255, "minLength": 1 }, "legalRepresentatives": { "type": "array", "description": "The legal representatives (management body), each a natural person or a legal entity", "items": { "$ref": "#/components/schemas/CreatePartyDto" }, "maxItems": 50, "minItems": 0 }, "nomineeDirectors": { "type": "array", "description": "Individuals or entities acting as nominee directors; required if available", "items": { "$ref": "#/components/schemas/CreatePartyDto" }, "maxItems": 50, "minItems": 0 }, "nomineeShareholders": { "type": "array", "description": "Individuals or entities acting as nominee shareholders; required if available", "items": { "$ref": "#/components/schemas/CreatePartyDto" }, "maxItems": 50, "minItems": 0 }, "principalPlaceOfBusiness": { "type": "string", "description": "Primary location where the entity conducts its business activities, if different from the registered address; required if available", "maxLength": 255, "minLength": 1 }, "registrationNumber": { "type": "string", "description": "Official number assigned to the entity by the relevant register; required if available", "maxLength": 50, "minLength": 1 }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number assigned to the legal entity; required if available", "maxLength": 50, "minLength": 1 }, "tradeName": { "type": "string", "description": "Name under which the legal entity conducts business, if different from the company name; required if available", "maxLength": 255, "minLength": 1 } }, "required": [ "address", "companyName", "customerNumber", "incorporationDate", "legalForm", "legalRepresentatives" ] }, "CreateLegalEntityPartyDto": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreatePartyDto" }, { "type": "object", "properties": { "companyName": { "type": "string", "maxLength": 255, "minLength": 1 } } } ], "required": [ "companyName", "type" ] }, "CreateNamedVirtualIbanDto": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 1000, "minLength": 1 }, "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 }, "referenceAccountIban": { "type": "string", "minLength": 1 } }, "required": [ "endCustomerId", "referenceAccountIban" ] }, "CreateNaturalPersonEndCustomerDto": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/PostalAddress27" }, "countryOfBirth": { "type": "string", "description": "Country where the individual was born, as ISO 3166-1 alpha-2 country code", "minLength": 1, "pattern": "^[A-Z]{2}$" }, "customerNumber": { "type": "string", "description": "The Bank Frick customer to register under", "maxLength": 7, "minLength": 1 }, "dateOfBirth": { "type": "string", "format": "date" }, "externalReference": { "type": "string", "description": "The caller\u0027s own identifier; stored and echoed back, never editable", "maxLength": 255, "minLength": 1 }, "firstName": { "type": "string", "maxLength": 255, "minLength": 1 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 1 }, "middleNames": { "type": "string", "description": "Middle name(s) of the individual, separated by spaces; required if available", "maxLength": 255, "minLength": 1 }, "nationalities": { "type": "array", "description": "All nationalities of the individual, as ISO 3166-1 alpha-2 country codes", "items": { "type": "string", "description": "All nationalities of the individual, as ISO 3166-1 alpha-2 country codes", "minLength": 1, "pattern": "^[A-Z]{2}$" }, "maxItems": 10, "minItems": 0 }, "placeOfBirth": { "type": "string", "description": "City, town, municipality, county, or other available information specifying the individual\u0027s place of birth; required if available", "maxLength": 255, "minLength": 1 }, "preferredName": { "type": "string", "description": "Preferred or commonly used name or alias; required if available", "maxLength": 255, "minLength": 1 }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number assigned to the individual; required if available", "maxLength": 50, "minLength": 1 } }, "required": [ "address", "countryOfBirth", "customerNumber", "dateOfBirth", "firstName", "lastName", "nationalities" ] }, "CreateNaturalPersonPartyDto": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreatePartyDto" }, { "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 255, "minLength": 1 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 1 }, "middleNames": { "type": "string", "description": "Middle name(s) of the individual, separated by spaces; required if available", "maxLength": 255, "minLength": 1 } } } ], "required": [ "firstName", "lastName", "type" ] }, "CreatePartyDto": { "type": "object", "description": "A party named on the legal entity: a natural person or a legal entity, told apart by its type", "discriminator": { "mapping": { "LEGAL_ENTITY": "#/components/schemas/CreateLegalEntityPartyDto", "NATURAL_PERSON": "#/components/schemas/CreateNaturalPersonPartyDto" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CreateNaturalPersonPartyDto" }, { "$ref": "#/components/schemas/CreateLegalEntityPartyDto" } ], "properties": { "type": { "type": "string", "enum": [ "NATURAL_PERSON", "LEGAL_ENTITY" ] } }, "required": [ "type" ] }, "CreateVirtualIbanAddressDto": { "type": "object", "properties": { "city": { "type": "string", "maxLength": 255, "minLength": 0 }, "country": { "type": "string", "maxLength": 255, "minLength": 0 }, "number": { "type": "string", "maxLength": 15, "minLength": 0 }, "postalCode": { "type": "string", "maxLength": 15, "minLength": 0 }, "street": { "type": "string", "maxLength": 255, "minLength": 0 } }, "required": [ "city", "country", "number", "postalCode", "street" ] }, "CreateVirtualIbanDto": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/CreateVirtualIbanAddressDto" }, "description": { "type": "string", "maxLength": 1000, "minLength": 0 }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "referenceAccountIban": { "type": "string" } }, "required": [ "referenceAccountIban" ] }, "DeactivateNamedVirtualIbanDto": { "type": "object", "properties": { "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 }, "vban": { "type": "string", "minLength": 1 } }, "required": [ "endCustomerId", "vban" ] }, "DeactivateVirtualIbanDto": { "type": "object", "properties": { "vban": { "type": "string" } }, "required": [ "vban" ] }, "EndCustomerDto": { "type": "object", "discriminator": { "mapping": { "LEGAL_ENTITY": "#/components/schemas/LegalEntityEndCustomerDto", "NATURAL_PERSON": "#/components/schemas/NaturalPersonEndCustomerDto" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NaturalPersonEndCustomerDto" }, { "$ref": "#/components/schemas/LegalEntityEndCustomerDto" } ], "properties": { "activationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "address": { "$ref": "#/components/schemas/PostalAddress27" }, "customerNumber": { "type": "string", "description": "The Bank Frick customer owning the record" }, "externalReference": { "type": "string" }, "id": { "type": "string" }, "matchingName": { "type": "string", "description": "Name used for Verification of Payee" }, "state": { "type": "string", "enum": [ "PREPARED", "ACTIVE" ] }, "type": { "type": "string", "enum": [ "NATURAL_PERSON", "LEGAL_ENTITY" ] } }, "required": [ "activationApprovals", "address", "customerNumber", "id", "matchingName", "state", "type" ] }, "EndCustomerSummaryDto": { "type": "object", "properties": { "id": { "type": "string" }, "matchingName": { "type": "string" }, "type": { "type": "string", "enum": [ "NATURAL_PERSON", "LEGAL_ENTITY" ] } }, "required": [ "id", "matchingName", "type" ] }, "EndCustomersDto": { "type": "object", "properties": { "endCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/EndCustomerDto" } }, "pagination": { "$ref": "#/components/schemas/PaginationDto" } }, "required": [ "endCustomers", "pagination" ] }, "ErrorResponseDto": { "type": "object", "properties": { "reason": { "type": "string" }, "status": { "type": "integer", "format": "int32" } }, "required": [ "reason", "status" ] }, "GenericIdentification30": { "type": "object", "properties": { "Id": { "type": "string", "pattern": "^(?:[a-zA-Z0-9]{4})$" }, "Issr": { "type": "string", "maxLength": 35, "minLength": 1 }, "SchmeNm": { "type": "string", "maxLength": 35, "minLength": 1 } } }, "LegalEntityEndCustomerDto": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EndCustomerDto" }, { "type": "object", "properties": { "commercialRegisterEntry": { "$ref": "#/components/schemas/CommercialRegisterEntryDto" }, "companyName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "incorporationCountry": { "type": "string", "description": "Country in which the business was incorporated, if different from the registered address, as ISO 3166-1 alpha-2 country code" }, "incorporationDate": { "type": "string", "format": "date" }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "lastModifiedBy": { "type": "string" }, "legalEntityIdentifier": { "type": "string", "description": "Legal Entity Identifier (LEI) or any available equivalent official identifier" }, "legalForm": { "type": "string" }, "legalRepresentatives": { "type": "array", "description": "The legal representatives (management body), each a natural person or a legal entity", "items": { "$ref": "#/components/schemas/PartyDto" } }, "nomineeDirectors": { "type": "array", "description": "Individuals or entities acting as nominee directors; empty when none were named", "items": { "$ref": "#/components/schemas/PartyDto" } }, "nomineeShareholders": { "type": "array", "description": "Individuals or entities acting as nominee shareholders; empty when none were named", "items": { "$ref": "#/components/schemas/PartyDto" } }, "principalPlaceOfBusiness": { "type": "string", "description": "Primary location where the entity conducts its business activities, if different from the registered address" }, "registrationNumber": { "type": "string", "description": "Official number assigned to the entity by the relevant register" }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number assigned to the legal entity" }, "tradeName": { "type": "string", "description": "Name under which the legal entity conducts business, if different from the company name" } } } ], "required": [ "activationApprovals", "address", "companyName", "createdAt", "createdBy", "customerNumber", "id", "incorporationDate", "lastModifiedAt", "lastModifiedBy", "legalForm", "legalRepresentatives", "matchingName", "nomineeDirectors", "nomineeShareholders", "state", "type" ] }, "LegalEntityPartyDto": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PartyDto" }, { "type": "object", "properties": { "companyName": { "type": "string" } } } ], "required": [ "companyName", "type" ] }, "NamedVirtualIbanDto": { "type": "object", "properties": { "activationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "customerNumber": { "type": "string" }, "deactivationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "description": { "type": "string" }, "endCustomer": { "$ref": "#/components/schemas/EndCustomerDto" }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "lastModifiedBy": { "type": "string" }, "referenceAccountIban": { "type": "string" }, "state": { "type": "string", "enum": [ "PREPARED", "ACTIVE", "DEACTIVATION_REQUESTED", "DEACTIVATED" ] }, "upgradeApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "vban": { "type": "string" } }, "required": [ "activationApprovals", "createdAt", "createdBy", "customerNumber", "deactivationApprovals", "endCustomer", "lastModifiedAt", "lastModifiedBy", "referenceAccountIban", "state", "vban" ] }, "NamedVirtualIbanListEntryDto": { "type": "object", "properties": { "activationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "customerNumber": { "type": "string" }, "deactivationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "description": { "type": "string" }, "endCustomer": { "$ref": "#/components/schemas/EndCustomerSummaryDto" }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "lastModifiedBy": { "type": "string" }, "referenceAccountIban": { "type": "string" }, "state": { "type": "string", "enum": [ "PREPARED", "ACTIVE", "DEACTIVATION_REQUESTED", "DEACTIVATED" ] }, "upgradeApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "vban": { "type": "string" } }, "required": [ "activationApprovals", "createdAt", "createdBy", "customerNumber", "deactivationApprovals", "endCustomer", "lastModifiedAt", "lastModifiedBy", "referenceAccountIban", "state", "vban" ] }, "NamedVirtualIbansDto": { "type": "object", "properties": { "namedVirtualIbans": { "type": "array", "items": { "$ref": "#/components/schemas/NamedVirtualIbanListEntryDto" } }, "pagination": { "$ref": "#/components/schemas/PaginationDto" } }, "required": [ "namedVirtualIbans", "pagination" ] }, "NaturalPersonEndCustomerDto": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EndCustomerDto" }, { "type": "object", "properties": { "countryOfBirth": { "type": "string", "description": "Country where the individual was born, as ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date" }, "firstName": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "lastModifiedBy": { "type": "string" }, "lastName": { "type": "string" }, "middleNames": { "type": "string", "description": "Middle name(s) of the individual, separated by spaces" }, "nationalities": { "type": "array", "description": "All nationalities of the individual, as ISO 3166-1 alpha-2 country codes", "items": { "type": "string", "description": "All nationalities of the individual, as ISO 3166-1 alpha-2 country codes" } }, "placeOfBirth": { "type": "string", "description": "City, town, municipality, county, or other available information specifying the individual\u0027s place of birth" }, "preferredName": { "type": "string", "description": "Preferred or commonly used name or alias" }, "taxIdentificationNumber": { "type": "string", "description": "Tax identification number assigned to the individual" } } } ], "required": [ "activationApprovals", "address", "countryOfBirth", "createdAt", "createdBy", "customerNumber", "dateOfBirth", "firstName", "id", "lastModifiedAt", "lastModifiedBy", "lastName", "matchingName", "nationalities", "state", "type" ] }, "NaturalPersonPartyDto": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PartyDto" }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleNames": { "type": "string", "description": "Middle name(s) of the individual, separated by spaces" } } } ], "required": [ "firstName", "lastName", "type" ] }, "PaginationDto": { "type": "object", "properties": { "hasMore": { "type": "boolean" }, "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" } }, "required": [ "hasMore", "pageIndex", "pageSize", "totalCount" ] }, "PartyDto": { "type": "object", "description": "A party named on the legal entity: a natural person or a legal entity, told apart by its type", "discriminator": { "mapping": { "LEGAL_ENTITY": "#/components/schemas/LegalEntityPartyDto", "NATURAL_PERSON": "#/components/schemas/NaturalPersonPartyDto" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NaturalPersonPartyDto" }, { "$ref": "#/components/schemas/LegalEntityPartyDto" } ], "properties": { "type": { "type": "string", "enum": [ "NATURAL_PERSON", "LEGAL_ENTITY" ] } }, "required": [ "type" ] }, "PostalAddress27": { "type": "object", "properties": { "AdrLine": { "type": "array", "items": { "type": "string" }, "maxItems": 7, "minItems": 0 }, "AdrTp": { "oneOf": [ { "$ref": "#/components/schemas/AddressType3ChoiceCd" }, { "$ref": "#/components/schemas/AddressType3ChoicePrtry" } ] }, "BldgNb": { "type": "string", "maxLength": 16, "minLength": 1 }, "BldgNm": { "type": "string", "maxLength": 140, "minLength": 1 }, "CareOf": { "type": "string", "maxLength": 140, "minLength": 1 }, "Ctry": { "type": "string", "pattern": "^(?:[A-Z]{2,2})$" }, "CtrySubDvsn": { "type": "string", "maxLength": 35, "minLength": 1 }, "Dept": { "type": "string", "maxLength": 70, "minLength": 1 }, "DstrctNm": { "type": "string", "maxLength": 140, "minLength": 1 }, "Flr": { "type": "string", "maxLength": 70, "minLength": 1 }, "PstBx": { "type": "string", "maxLength": 16, "minLength": 1 }, "PstCd": { "type": "string", "maxLength": 16, "minLength": 1 }, "Room": { "type": "string", "maxLength": 70, "minLength": 1 }, "StrtNm": { "type": "string", "maxLength": 140, "minLength": 1 }, "SubDept": { "type": "string", "maxLength": 70, "minLength": 1 }, "TwnLctnNm": { "type": "string", "maxLength": 140, "minLength": 1 }, "TwnNm": { "type": "string", "maxLength": 140, "minLength": 1 }, "UnitNb": { "type": "string", "maxLength": 16, "minLength": 1 } } }, "UpgradeVirtualIbanDto": { "type": "object", "properties": { "endCustomerId": { "type": "string", "maxLength": 36, "minLength": 1 }, "vban": { "type": "string", "minLength": 1 } }, "required": [ "endCustomerId", "vban" ] }, "VirtualIbanAddressDto": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "number": { "type": "string" }, "postalCode": { "type": "string" }, "street": { "type": "string" } }, "required": [ "city", "country", "number", "postalCode", "street" ] }, "VirtualIbanDto": { "type": "object", "properties": { "activationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "address": { "$ref": "#/components/schemas/VirtualIbanAddressDto" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "customerNumber": { "type": "string" }, "deactivationApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "description": { "type": "string" }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "lastModifiedBy": { "type": "string" }, "name": { "type": "string" }, "pendingUpgrade": { "$ref": "#/components/schemas/VirtualIbanUpgradeDto" }, "referenceAccountIban": { "type": "string" }, "state": { "type": "string", "enum": [ "PREPARED", "ACTIVE", "DEACTIVATION_REQUESTED", "DEACTIVATED" ] }, "vban": { "type": "string" } }, "required": [ "activationApprovals", "createdAt", "createdBy", "customerNumber", "deactivationApprovals", "lastModifiedAt", "lastModifiedBy", "referenceAccountIban", "state", "vban" ] }, "VirtualIbanUpgradeDto": { "type": "object", "properties": { "approvals": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalDto" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "createdBy": { "type": "string" }, "endCustomer": { "$ref": "#/components/schemas/EndCustomerSummaryDto" }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format", "example": "2021-10-24T13:24:13.541Z" }, "lastModifiedBy": { "type": "string" }, "state": { "type": "string", "enum": [ "PENDING", "COMPLETED" ] }, "vban": { "type": "string" } }, "required": [ "approvals", "createdAt", "createdBy", "endCustomer", "lastModifiedAt", "lastModifiedBy", "state", "vban" ] }, "VirtualIbansDto": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationDto" }, "virtualIbans": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualIbanDto" } } }, "required": [ "pagination", "virtualIbans" ] } }, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "description": "JWT token from Online Banking WebAPI", "scheme": "bearer", "type": "http" } } } }