{ "swagger": "2.0", "info": { "version": "2.0.0", "title": "Customer Offer", "description": "This service domain orchestrates the processing of a product offer for a new/established customer." }, "host": "virtserver.swaggerhub.com", "schemes": [ "https" ], "paths": { "/customer-offer/activation": { "post": { "tags": [ "activate" ], "summary": "Activate a SDCustomerOffer servicing session", "description": "Activate a SDCustomerOffer servicing session", "operationId": "activateSDCustomerOffer", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "SDCustomerOffer Request Payload", "required": true, "schema": { "type": "object", "properties": { "serviceDomainActivationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activation service call consolidated processing record\n", "properties": {} }, "serviceDomainCenterReference": { "type": "string", "example": "SCR793499", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the service center/operational unit\n" }, "serviceDomainServiceReference": { "type": "string", "example": "CPASSR703914", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "700761", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of service configuration parameter\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } } } } } } } ], "responses": { "201": { "description": "Successful Service Activation", "schema": { "type": "object", "properties": { "serviceDomainActivationActionTaskReference": { "type": "string", "example": "SAATR758836", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service activation service call\n" }, "serviceDomainActivationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activation service call consolidated processing record\n", "properties": {} }, "serviceDomainServicingSessionReference": { "type": "string", "example": "SSSR783215", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "serviceDomainServicingSessionRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Consolidated information record for the servicing session\n", "properties": {} }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "700761", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the configuration parameter, allowed values and processing impact\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "769192", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "791202", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "767210", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "serviceDomainServiceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the offered service (e.g. active, suspended, idle)\n" } } }, "serviceDomainServicingSessionStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The current operating status of the overall servicing session\n" } } } } } } }, "/customer-offer/{sd-reference-id}/configuration": { "put": { "tags": [ "configure" ], "summary": "Update an active SDCustomerOffer session configuration", "description": "Update an active SDCustomerOffer session configuration", "operationId": "configureSDCustomerOffer", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "SDCustomerOffer Servicing Session Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "SDCustomerOffer Configure Request Payload", "required": true, "schema": { "type": "object", "properties": { "serviceDomainConfigurationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The configuration service call consolidated processing record\n", "properties": {} }, "serviceDomainServicingSessionReference": { "type": "string", "example": "SSSR764367", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "serviceDomainServiceReference": { "type": "string", "example": "CPASSR744740", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "710630", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of service configuration parameter\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } } } } } } } ], "responses": { "200": { "description": "Successful Service Configuration", "schema": { "type": "object", "properties": { "serviceDomainConfigurationActionTaskReference": { "type": "string", "example": "SCATR765419", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service configuration service call\n" }, "serviceDomainConfigurationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The configuration service call consolidated processing record\n", "properties": {} }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the configuration parameter, allowed values and processing impact\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "serviceDomainServiceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the offered service (e.g. active, suspended, idle)\n" } } }, "serviceDomainServicingSessionStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The current operating status of the overall servicing session\n" } } } } } } }, "/customer-offer/{sd-reference-id}/feedback": { "put": { "tags": [ "feedback" ], "summary": "Capturing feedback against the SDCustomerOffer service that can target different levels of detail: SD/CR/BQ", "description": "Capturing feedback against the SDCustomerOffer service that can target different levels of detail: SD/CR/BQ", "operationId": "feedbackSDCustomerOffer", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "SDCustomerOffer Servicing Session Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "SDCustomerOffer Feedback Request Payload", "required": true, "schema": { "type": "object", "properties": { "serviceDomainFeedbackActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The feedback service call consolidated processing record\n", "properties": {} }, "serviceDomainFeedbackActionRecord": { "properties": { "serviceDomainServicingSessionReference": { "type": "string", "example": "796678", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "controlRecordInstanceReference": { "type": "string", "example": "724385", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance if appropriate\n" }, "behaviorQualifierInstanceReference": { "type": "string", "example": "789747", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the behavior qualifier instance if appropriate\n" }, "feedbackRecordType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The layout/type of the feedback provided\n" }, "feedbackRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The content of the feedback in any suitable format and media\n", "properties": {} } } } } } } ], "responses": { "200": { "description": "Successful Service Feedback", "schema": { "type": "object", "properties": { "serviceDomainFeedbackActionTaskReference": { "type": "string", "example": "SFATR765157", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a feedback service call\n" }, "serviceDomainFeedbackActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The feedback service call consolidated processing record\n", "properties": {} }, "serviceDomainFeedbackActionRecord": { "properties": { "feedbackRecordDateTime": { "type": "string", "example": "09-22-2018", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::DateTime\n general-info: The date/time the feedback submitted for consideration\n" }, "feedbackRecordStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of processing the feedback e.g. received, considered, responded to\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "769031", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to business unit/employee responsible for handling feedback\n" } } } } } } } } }, "/customer-offer/{sd-reference-id}": { "get": { "tags": [ "retrieve" ], "summary": "Analytical views maintained by the SDCustomerOffer service center for management reporting and analysis purposes", "description": "Analytical views maintained by the SDCustomerOffer service center for management reporting and analysis purposes", "operationId": "retrieveSDCustomerOffer", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "SDCustomerOffer Servicing Session Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/SDCustomerOfferRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful Service Retrieve", "schema": { "type": "object", "properties": { "serviceDomainRetrieveActionTaskReference": { "type": "string", "example": "SRATR795161", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a retrieve service call\n" }, "serviceDomainRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "serviceDomainRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "serviceDomainRetrieveActionRecord": { "properties": { "serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" }, "activityAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the activity analysis that can be on-going, periodic and actual and projected\n" }, "activityAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of activity analysis report available\n" }, "activityAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activity analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" }, "performanceAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the performance analysis that can be on-going or periodic\n" }, "performanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of performance analysis report available\n" }, "performanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The performance analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" }, "controlRecordPortfolioAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the portfolio analysis that can be on-going, periodic and actual and projected (can be unstructured data)\n" }, "controlRecordPortfolioAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external portfolio analysis report available\n" }, "controlRecordAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "serviceDomainOfferedService": { "properties": { "serviceDomainServiceReference": { "type": "string", "example": "776158", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceRecord": { "properties": { "serviceDomainServiceType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Refers to the different types of services offered\n" }, "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" }, "serviceDomainServiceDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the offered service \n" }, "serviceDomainServicePoliciesandGuidelines": { "properties": { "serviceDomainServiceEligibility": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Policies and rules governing access to the offered service, includes eligibility and qualifications\n" }, "serviceDomainServiceIntendedUses": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines covering allowed, intended use of the service\n" }, "serviceDomainServicePricingandTerms": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms, prices, penalties associated with use of the service\n" } } }, "serviceDomainServiceSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Schedule defining when the accessed service is available\n" } } } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/initiation": { "post": { "tags": [ "initiate" ], "summary": "Details of a new CustomerOfferProcedure instance", "description": "Initiate the offer procedure", "operationId": "initiateCustomerOfferProcedure", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "CustomerOfferProcedure Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR738028", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInitiateActionRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The Initiate service call input and output record\n", "properties": {} }, "customerOfferProcedureInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Customer Offer Procedure instance (e.g. initialised, pending, active)\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "720996", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "733369", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "752248", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "productInstanceRecord": { "properties": { "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "733949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "755683", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "736195", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } } } } } ], "responses": { "201": { "description": "Successful initiation of new CustomerOfferProcedure instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR769333", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInitiateActionReference": { "type": "string", "example": "COPIAR731552", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an Initiate service call\n" }, "customerOfferProcedureInitiateActionRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The Initiate service call input and output record\n", "properties": {} }, "customerOfferProcedureInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Customer Offer Procedure instance (e.g. initialised, pending, active)\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" } } }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "717235", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "744472", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "733949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "755683", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "736195", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the CustomerOfferProcedure instance", "description": "Update details of an offer procedure", "operationId": "updateCustomerOfferProcedure", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Customer Offer Procedure Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR743736", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR719518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753477", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "784212", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "726864", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Customer Offer Procedure Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753477", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "784212", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "726864", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureUpdateActionTaskReference": { "type": "string", "example": "COPUATR762977", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "customerOfferProcedureUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/control": { "put": { "tags": [ "control" ], "summary": "Request specific processing (e.g. suspend, skip, terminate)", "description": "Control the processing of an offer (e.g. terminate)", "operationId": "controlCustomerOfferProcedureUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Customer Offer Procedure Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR700741", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR744807", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureControlActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The processing control service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureControlActionRequest": { "properties": { "controlActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of processing action requested (e.g. suspend, skip, terminate)\n" } } } } } } ], "responses": { "200": { "description": "Successful control of Customer Offer Procedure Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureControlActionTaskReference": { "type": "string", "example": "COPCATR736217", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance control processing service call\n" }, "customerOfferProcedureControlActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The processing control service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureControlActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the control action service response\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/exchange": { "put": { "tags": [ "exchange" ], "summary": "Handle an external exchange (e.g. accept, reject, verify)", "description": "Accept, reject, verify, etc an offer procedure", "operationId": "exchangeCustomerOfferProcedureUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Customer Offer Procedure Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR704797", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR789127", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } } } ], "responses": { "200": { "description": "Successful exchange of Customer Offer Procedure Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureExchangeActionTaskReference": { "type": "string", "example": "COPEATR713254", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance exchange service call\n" }, "customerOfferProcedureExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/execution": { "put": { "tags": [ "execute" ], "summary": "Invoke an automated execute action against the CustomerOfferProcedure instance", "description": "Execute an automated task against an offer (e.g. submit data)", "operationId": "executeCustomerOfferProcedureUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Customer Offer Procedure Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR780445", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR751868", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "722189", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "785314", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "735490", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "customerOfferProcedureExecuteActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The execute service call consolidated processing record\n", "properties": {} }, "executeRecordType": { "properties": { "executeInputRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Execute transaction/record (e.g. deposit, withdrawal, fee/penalty, interest)\n", "properties": {} } } } } } } ], "responses": { "200": { "description": "Successful execution of Customer Offer Procedure Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureExecuteActionTaskReference": { "type": "string", "example": "COPEATR712059", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance execute service call\n" }, "customerOfferProcedureExecuteActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The execute service call consolidated processing record\n", "properties": {} }, "executeRecordReference": { "type": "string", "example": "ERR758817", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the execute transaction/record\n" }, "executeResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the execute action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/requisition": { "put": { "tags": [ "request" ], "summary": "Invoke a service request action against the CustomerOfferProcedure instance", "description": "Request manual intervention in an offer (e.g. request specialist support)", "operationId": "requestCustomerOfferProcedureUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Customer Offer Procedure Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR728693", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR745870", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "772666", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "752917", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "753970", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "customerOfferProcedureRequestActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The request service call consolidated processing record\n", "properties": {} }, "requestRecordType": { "properties": { "requestInputRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Request service record (e.g. rework function, refresh record, process workstep)\n", "properties": {} } } } } } } ], "responses": { "200": { "description": "Successful requisition of Customer Offer Procedure Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureRequestActionTaskReference": { "type": "string", "example": "COPRATR734822", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance request service call\n" }, "customerOfferProcedureRequestActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The request service call consolidated processing record\n", "properties": {} }, "requestRecordReference": { "type": "string", "example": "RRR736011", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the service request record\n" }, "requestResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the request action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Customer Offer Procedure instance related report", "description": "Retrieve details about a customer offer", "operationId": "retrieveCustomerOffer", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/CRCustomerOfferProcedureRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Customer Offer Procedure Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "774480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "704310", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "705910", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureRetrieveActionTaskReference": { "type": "string", "example": "COPRATR785437", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance retrieve service call\n" }, "customerOfferProcedureRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "customerOfferProcedureInstanceReportRecord": { "properties": { "customerOfferProcedureInstanceReportData": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n" }, "customerOfferProcedureInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "customerOfferProcedureInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "customerOfferProcedureInstanceAnalysis": { "properties": { "customerOfferProcedureInstanceAnalysisData": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n" }, "customerOfferProcedureInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "customerOfferProcedureInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/product/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Product instance", "description": "Update product options and pricing terms", "operationId": "updateCustomerOfferProcedureProduct", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Product Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Product Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR772148", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "productInstanceReference": { "type": "string", "example": "COPIR772148", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Product instance\n" }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "productUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "productUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Product Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "productUpdateActionTaskReference": { "type": "string", "example": "COPUATR740346", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "productUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/product/{bq-reference-id}/exchange": { "put": { "tags": [ "exchange" ], "summary": "Handle an external exchange (e.g. accept, reject, verify)", "description": "Accept, reject etc product options and pricing terms", "operationId": "exchangeCustomerOfferProcedureProductUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Product Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Product request payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR785200", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "productInstanceReference": { "type": "string", "example": "COPIR785200", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Product instance\n" }, "productExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "productExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } } } ], "responses": { "200": { "description": "Successful exchange of Product Instance Record", "schema": { "type": "object", "properties": { "productExchangeActionTaskReference": { "type": "string", "example": "COPEATR702960", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Product instance exchange service call\n" }, "productExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "productExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "productInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Product instance (e.g. accepted, rejected, verified)\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/product/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Product instance related report.", "description": "Retrieve details about product options and pricing terms .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureProduct", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Product Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQProductRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Product Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "731146", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "710811", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "productRetrieveActionTaskReference": { "type": "string", "example": "COPRATR747428", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Product instance retrieve service call\n" }, "productRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "productRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "productInstanceReport": { "properties": { "productInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "productInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "productInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "productInstanceAnalysis": { "properties": { "productInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "productInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "productInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/disclosures/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Disclosures instance", "description": "Update disclosure submission", "operationId": "updateCustomerOfferProcedureDisclosures", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Disclosures Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Disclosures Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "750376", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR703181", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "disclosuresInstanceReference": { "type": "string", "example": "DIR774723", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Disclosures instance\n" }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "787732", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "disclosuresUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "disclosuresUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Disclosures Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "750376", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "787732", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "disclosuresUpdateActionTaskReference": { "type": "string", "example": "DUATR721912", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "disclosuresUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/disclosures/{bq-reference-id}/exchange": { "put": { "tags": [ "exchange" ], "summary": "Handle an external exchange (e.g. accept, reject, verify)", "description": "Accept, reject etc. disclosures", "operationId": "exchangeCustomerOfferProcedureDisclosuresUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Disclosures Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Disclosures request payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR747491", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "disclosuresInstanceReference": { "type": "string", "example": "DIR777695", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Disclosures instance\n" }, "disclosuresExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "disclosuresExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } } } ], "responses": { "200": { "description": "Successful exchange of Disclosures Instance Record", "schema": { "type": "object", "properties": { "disclosuresExchangeActionTaskReference": { "type": "string", "example": "DEATR754071", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Disclosures instance exchange service call\n" }, "disclosuresExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "disclosuresExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "disclosuresInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Disclosures instance (e.g. accepted, rejected, verified)\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/disclosures/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Disclosures instance related report.", "description": "Retrieve details about disclosure submissions .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureDisclosures", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Disclosures Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQDisclosuresRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Disclosures Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "758232", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "731415", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "724284", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "718187", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "disclosuresRetrieveActionTaskReference": { "type": "string", "example": "DRATR735013", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Disclosures instance retrieve service call\n" }, "disclosuresRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "disclosuresRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "disclosuresInstanceReport": { "properties": { "disclosuresInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "disclosuresInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "disclosuresInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "disclosuresInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "disclosuresInstanceAnalysis": { "properties": { "disclosuresInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "disclosuresInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "disclosuresInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "disclosuresInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/credit/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Credit instance", "description": "Update credit submission details", "operationId": "updateCustomerOfferProcedureCredit", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Credit Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Credit Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "717579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR762563", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "creditInstanceReference": { "type": "string", "example": "CIR792446", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Credit instance\n" }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753252", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "creditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "creditUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Credit Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "717579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753252", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "creditUpdateActionTaskReference": { "type": "string", "example": "CUATR722573", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "creditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/credit/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Credit instance related report.", "description": "Retrieve details about the credit submission .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureCredit", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Credit Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQCreditRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Credit Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "735889", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "713711", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793043", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753377", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "creditRetrieveActionTaskReference": { "type": "string", "example": "CRATR777458", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Credit instance retrieve service call\n" }, "creditRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "creditRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "creditInstanceReport": { "properties": { "creditInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "creditInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "creditInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "creditInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "creditInstanceAnalysis": { "properties": { "creditInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "creditInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "creditInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "creditInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/underwriting/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Underwriting instance", "description": "Update submitted materials for the underwriting decision", "operationId": "updateCustomerOfferProcedureUnderwriting", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Underwriting Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Underwriting Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "701909", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR764167", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "underwritingInstanceReference": { "type": "string", "example": "UIR711787", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Underwriting instance\n" }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "702751", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "underwritingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "underwritingUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Underwriting Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "701909", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "702751", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "underwritingUpdateActionTaskReference": { "type": "string", "example": "UUATR762410", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "underwritingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/underwriting/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Underwriting instance related report.", "description": "Retrieve details about the underwriting decision .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureUnderwriting", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Underwriting Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQUnderwritingRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Underwriting Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "798524", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "782588", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "733171", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "743102", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "underwritingRetrieveActionTaskReference": { "type": "string", "example": "URATR735691", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Underwriting instance retrieve service call\n" }, "underwritingRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "underwritingRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "underwritingInstanceReport": { "properties": { "underwritingInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "underwritingInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "underwritingInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "underwritingInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "underwritingInstanceAnalysis": { "properties": { "underwritingInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "underwritingInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "underwritingInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "underwritingInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/compliance/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Compliance instance", "description": "Update details submitted for compliance checks", "operationId": "updateCustomerOfferProcedureCompliance", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Compliance Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Compliance Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "787582", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR714236", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "complianceInstanceReference": { "type": "string", "example": "CIR784347", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Compliance instance\n" }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "complianceUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "complianceUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Compliance Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "787582", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "complianceUpdateActionTaskReference": { "type": "string", "example": "CUATR739424", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "complianceUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/compliance/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Compliance instance related report.", "description": "Retrieve details of the regulatory compliance assessment .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureCompliance", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Compliance Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQComplianceRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Compliance Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "768555", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "716204", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "756506", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "complianceRetrieveActionTaskReference": { "type": "string", "example": "CRATR701585", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Compliance instance retrieve service call\n" }, "complianceRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "complianceRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "complianceInstanceReport": { "properties": { "complianceInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "complianceInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "complianceInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "complianceInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "complianceInstanceAnalysis": { "properties": { "complianceInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "complianceInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "complianceInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "complianceInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/audit/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Audit instance", "description": "Update details of submitted materials for audit checks", "operationId": "updateCustomerOfferProcedureAudit", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Audit Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Audit Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "786768", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR796411", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "auditInstanceReference": { "type": "string", "example": "AIR799393", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Audit instance\n" }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "auditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "auditUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Audit Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "786768", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "auditUpdateActionTaskReference": { "type": "string", "example": "AUATR794764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "auditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/audit/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Audit instance related report.", "description": "Retrieve details of the compliance assessment .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureAudit", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Audit Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQAuditRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Audit Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753821", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "793767", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725215", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "auditRetrieveActionTaskReference": { "type": "string", "example": "ARATR750423", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Audit instance retrieve service call\n" }, "auditRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "auditRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "auditInstanceReport": { "properties": { "auditInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "auditInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "auditInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "auditInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "auditInstanceAnalysis": { "properties": { "auditInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "auditInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "auditInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "auditInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/collateral/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Collateral instance", "description": "Update details of the collateral allocation", "operationId": "updateCustomerOfferProcedureCollateral", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Collateral Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Collateral Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "737819", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR739427", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "collateralInstanceReference": { "type": "string", "example": "CIR793143", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Collateral instance\n" }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "767541", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "796658", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "collateralUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "collateralUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Collateral Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "737819", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "767541", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "796658", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "collateralUpdateActionTaskReference": { "type": "string", "example": "CUATR766676", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "collateralUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/collateral/{bq-reference-id}/exchange": { "put": { "tags": [ "exchange" ], "summary": "Handle an external exchange (e.g. accept, reject, verify)", "description": "Accept, reject etc. the collateral allocation", "operationId": "exchangeCustomerOfferProcedureCollateralUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Collateral Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Collateral request payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR787534", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "collateralInstanceReference": { "type": "string", "example": "CIR717731", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Collateral instance\n" }, "collateralExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "collateralExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } } } ], "responses": { "200": { "description": "Successful exchange of Collateral Instance Record", "schema": { "type": "object", "properties": { "collateralExchangeActionTaskReference": { "type": "string", "example": "CEATR722980", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Collateral instance exchange service call\n" }, "collateralExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "collateralExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "collateralInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Collateral instance (e.g. accepted, rejected, verified)\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/collateral/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Collateral instance related report.", "description": "Retrieve details about the collateral allocation .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureCollateral", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Collateral Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQCollateralRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Collateral Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "771026", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "796305", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "783804", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "719765", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "717572", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "collateralRetrieveActionTaskReference": { "type": "string", "example": "CRATR777265", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Collateral instance retrieve service call\n" }, "collateralRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "collateralRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "collateralInstanceReport": { "properties": { "collateralInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "collateralInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "collateralInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "collateralInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "collateralInstanceAnalysis": { "properties": { "collateralInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "collateralInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "collateralInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "collateralInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/booking/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Booking instance", "description": "Update details of the offer asset and liability booking", "operationId": "updateCustomerOfferProcedureBooking", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Booking Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Booking Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "784510", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR751074", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "bookingInstanceReference": { "type": "string", "example": "BIR748644", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Booking instance\n" }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "757280", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "bookingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "bookingUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Booking Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "784510", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "757280", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "bookingUpdateActionTaskReference": { "type": "string", "example": "BUATR753898", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "bookingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/booking/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Booking instance related report.", "description": "Retrieve details about the booking .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureBooking", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Booking Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQBookingRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Booking Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "751473", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "773008", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732274", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "779818", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "bookingRetrieveActionTaskReference": { "type": "string", "example": "BRATR723427", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Booking instance retrieve service call\n" }, "bookingRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "bookingRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "bookingInstanceReport": { "properties": { "bookingInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "bookingInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "bookingInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "bookingInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "bookingInstanceAnalysis": { "properties": { "bookingInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "bookingInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "bookingInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "bookingInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/correspondenceanddocuments/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the CorrespondenceandDocuments instance", "description": "Update details about the correspondence and documents accessed and created by the offer", "operationId": "updateCustomerOfferProcedureCorrespondenceandDocuments", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "CorrespondenceandDocuments Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "CorrespondenceandDocuments Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725429", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR780577", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "correspondenceandDocumentsInstanceReference": { "type": "string", "example": "CADIR736347", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Correspondence and Documents instance\n" }, "correspondenceandDocumentsInstanceRecord": { "properties": { "correspondenceInstanceReference": { "type": "string", "example": "764564", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "755966", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "correspondenceandDocumentsUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated CorrespondenceandDocuments Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725429", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" }, "correspondenceInstanceReference": { "type": "string", "example": "764564", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "755966", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "correspondenceandDocumentsUpdateActionTaskReference": { "type": "string", "example": "CADUATR791014", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "correspondenceandDocumentsUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/correspondenceanddocuments/{bq-reference-id}/exchange": { "put": { "tags": [ "exchange" ], "summary": "Handle an external exchange (e.g. accept, reject, verify)", "description": "Accept, verify, etc. correspondence and documents", "operationId": "exchangeCustomerOfferProcedureCorrespondenceandDocumentsUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "CorrespondenceandDocuments Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "CorrespondenceandDocuments request payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR709918", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "correspondenceandDocumentsInstanceReference": { "type": "string", "example": "CADIR751617", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Correspondence and Documents instance\n" }, "correspondenceandDocumentsExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } } } ], "responses": { "200": { "description": "Successful exchange of CorrespondenceandDocuments Instance Record", "schema": { "type": "object", "properties": { "correspondenceandDocumentsExchangeActionTaskReference": { "type": "string", "example": "CADEATR789579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Correspondence and Documents instance exchange service call\n" }, "correspondenceandDocumentsExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "correspondenceandDocumentsInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Correspondence and Documents instance (e.g. accepted, rejected, verified)\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/correspondenceanddocuments/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a CorrespondenceandDocuments instance related report.", "description": "Retrieve details about correspondence and documents from the customer offer procedure .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureCorrespondenceandDocuments", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "CorrespondenceandDocuments Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQCorrespondenceandDocumentsRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved CorrespondenceandDocuments Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "782616", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "759645", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785837", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" }, "correspondenceInstanceReference": { "type": "string", "example": "736630", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "700162", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "correspondenceandDocumentsRetrieveActionTaskReference": { "type": "string", "example": "CADRATR745080", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Correspondence and Documents instance retrieve service call\n" }, "correspondenceandDocumentsRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "correspondenceandDocumentsInstanceReport": { "properties": { "correspondenceandDocumentsInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "correspondenceandDocumentsInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "correspondenceandDocumentsInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "correspondenceandDocumentsInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "correspondenceandDocumentsInstanceAnalysis": { "properties": { "correspondenceandDocumentsInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "correspondenceandDocumentsInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "correspondenceandDocumentsInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "correspondenceandDocumentsInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/agreement/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the Agreement instance", "description": "Update details of the customer agreement", "operationId": "updateCustomerOfferProcedureAgreement", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Agreement Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Agreement Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "768218", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR784807", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "agreementInstanceReference": { "type": "string", "example": "AIR758103", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Agreement instance\n" }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "732372", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "767742", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "agreementUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "agreementUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated Agreement Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "768218", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "732372", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "767742", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "agreementUpdateActionTaskReference": { "type": "string", "example": "AUATR724260", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "agreementUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/agreement/{bq-reference-id}/exchange": { "put": { "tags": [ "exchange" ], "summary": "Handle an external exchange (e.g. accept, reject, verify)", "description": "Accept, verify, etc. actions against the customer and product agreements", "operationId": "exchangeCustomerOfferProcedureAgreementUpdate", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Agreement Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Agreement request payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR727691", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "agreementInstanceReference": { "type": "string", "example": "AIR726778", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Agreement instance\n" }, "agreementExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "agreementExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } } } ], "responses": { "200": { "description": "Successful exchange of Agreement Instance Record", "schema": { "type": "object", "properties": { "agreementExchangeActionTaskReference": { "type": "string", "example": "AEATR770257", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Agreement instance exchange service call\n" }, "agreementExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "agreementExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "agreementInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Agreement instance (e.g. accepted, rejected, verified)\n" } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/agreement/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a Agreement instance related report.", "description": "Retrieve details about the agreements impacted and created as part of the offer .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureAgreement", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "Agreement Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQAgreementRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved Agreement Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "725269", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "735177", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "718943", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "749826", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "743608", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "agreementRetrieveActionTaskReference": { "type": "string", "example": "ARATR711293", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Agreement instance retrieve service call\n" }, "agreementRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "agreementRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "agreementInstanceReport": { "properties": { "agreementInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "agreementInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "agreementInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "agreementInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "agreementInstanceAnalysis": { "properties": { "agreementInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "agreementInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "agreementInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "agreementInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/productinitialization/{bq-reference-id}/update": { "put": { "tags": [ "update" ], "summary": "Update to any amendable fields of the ProductInitialization instance", "description": "Update details of the product initiation request", "operationId": "updateCustomerOfferProcedureProductInitialization", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "ProductInitialization Instance Reference", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "ProductInitialization Request Payload", "required": true, "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785117", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR749649", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "productInitializationInstanceReference": { "type": "string", "example": "PIIR723627", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Product Initialization instance\n" }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "705158", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "productInitializationUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "productInitializationUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } } } ], "responses": { "200": { "description": "Successfully Updated ProductInitialization Instance", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785117", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "705158", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "productInitializationUpdateActionTaskReference": { "type": "string", "example": "PIUATR766983", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "productInitializationUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/productinitialization/{bq-reference-id}/": { "get": { "tags": [ "retrieve" ], "summary": "Invoke a reporting action to obtain a ProductInitialization instance related report.", "description": "Retrieve details about the product initiation request .The retrieve operation can have sub qualifiers beyond BQ level, please reffer to the model heriarchy to extend beyond BQ level into APIs retrieving sub-qualifier level information.", "operationId": "retrieveCustomerOfferProcedureProductInitialization", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "bq-reference-id", "in": "path", "description": "ProductInitialization Instance Reference", "required": true, "type": "string" }, { "name": "queryparams", "in": "query", "description": "Query params from schema '#/definitions/BQProductInitializationRetrieveInputModel'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successfully Retrieved ProductInitialization Instance Record", "schema": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "709459", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "728005", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "792591", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "productInitializationRetrieveActionTaskReference": { "type": "string", "example": "PIRATR716347", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Product Initialization instance retrieve service call\n" }, "productInitializationRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "productInitializationRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "productInitializationInstanceReport": { "properties": { "productInitializationInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInitializationInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "productInitializationInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "productInitializationInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "productInitializationInstanceAnalysis": { "properties": { "productInitializationInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInitializationInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "productInitializationInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "productInitializationInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure": { "get": { "tags": [ "retrieve" ], "summary": "Retrieve CR Ids", "operationId": "RetrieveCustomerOfferReferenceIds", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "collection-filter", "in": "query", "description": "Filter to refine the result set. ex- CustomerOffer Instance Status='active'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful", "schema": { "type": "array", "items": { "type": "string" }, "example": [ "ID726464", "ID7264642" ] } } } } }, "/customer-offer/customer-offer-procedure/behavior-qualifiers/": { "get": { "tags": [ "retrieve" ], "summary": "Retrieve BQ names", "operationId": "RetrieveCustomerOfferBehaviorQualifiers", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful", "schema": { "type": "array", "items": { "type": "string" }, "example": [ "Product", "Disclosures", "Credit", "Underwriting", "Compliance", "Audit", "Collateral", "Booking", "CorrespondenceAndDocuments", "Agreement", "ProductInitialization" ] } } } } }, "/customer-offer/{sd-reference-id}/customer-offer-procedure/{cr-reference-id}/{behavior-qualifier}/": { "get": { "tags": [ "retrieve" ], "summary": "Retrieve Behavior Qualifier Reference Ids", "operationId": "RetrieveCustomerOfferBehaviorQualifierReferenceIds", "produces": [ "application/json" ], "parameters": [ { "name": "sd-reference-id", "in": "path", "description": "Customer Offer Servicing Session Reference", "required": true, "type": "string" }, { "name": "cr-reference-id", "in": "path", "description": "Customer Offer Procedure Instance Reference", "required": true, "type": "string" }, { "name": "behavior-qualifier", "in": "path", "description": "Behavior Qualifier Name. ex- ProductInitialization", "required": true, "type": "string" }, { "name": "collection-filter", "in": "query", "description": "Filter to refine the result set. ex- ProductInitialization Instance Status = 'pending'", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful", "schema": { "type": "array", "items": { "type": "string" }, "example": [ "ProductInitializationID1", "ProductInitializationID2" ] } } } } } }, "definitions": { "SDCustomerOfferActivateInputModel": { "type": "object", "properties": { "serviceDomainActivationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activation service call consolidated processing record\n", "properties": {} }, "serviceDomainCenterReference": { "type": "string", "example": "SCR793499", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the service center/operational unit\n" }, "serviceDomainServiceReference": { "type": "string", "example": "CPASSR703914", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "700761", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of service configuration parameter\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } } } } } }, "SDCustomerOfferActivateOutputModel": { "type": "object", "properties": { "serviceDomainActivationActionTaskReference": { "type": "string", "example": "SAATR758836", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service activation service call\n" }, "serviceDomainActivationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activation service call consolidated processing record\n", "properties": {} }, "serviceDomainServicingSessionReference": { "type": "string", "example": "SSSR783215", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "serviceDomainServicingSessionRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Consolidated information record for the servicing session\n", "properties": {} }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "700761", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the configuration parameter, allowed values and processing impact\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "769192", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "791202", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "767210", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "serviceDomainServiceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the offered service (e.g. active, suspended, idle)\n" } } }, "serviceDomainServicingSessionStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The current operating status of the overall servicing session\n" } } }, "SDCustomerOfferConfigureInputModel": { "type": "object", "properties": { "serviceDomainConfigurationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The configuration service call consolidated processing record\n", "properties": {} }, "serviceDomainServicingSessionReference": { "type": "string", "example": "SSSR764367", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "serviceDomainServiceReference": { "type": "string", "example": "CPASSR744740", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "710630", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of service configuration parameter\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } } } } } }, "SDCustomerOfferConfigureOutputModel": { "type": "object", "properties": { "serviceDomainConfigurationActionTaskReference": { "type": "string", "example": "SCATR765419", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service configuration service call\n" }, "serviceDomainConfigurationActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The configuration service call consolidated processing record\n", "properties": {} }, "serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the configuration parameter, allowed values and processing impact\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "serviceDomainServiceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the offered service (e.g. active, suspended, idle)\n" } } }, "serviceDomainServicingSessionStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The current operating status of the overall servicing session\n" } } }, "SDCustomerOfferFeedbackInputModel": { "type": "object", "properties": { "serviceDomainFeedbackActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The feedback service call consolidated processing record\n", "properties": {} }, "serviceDomainFeedbackActionRecord": { "properties": { "serviceDomainServicingSessionReference": { "type": "string", "example": "796678", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "controlRecordInstanceReference": { "type": "string", "example": "724385", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance if appropriate\n" }, "behaviorQualifierInstanceReference": { "type": "string", "example": "789747", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the behavior qualifier instance if appropriate\n" }, "feedbackRecordType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The layout/type of the feedback provided\n" }, "feedbackRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The content of the feedback in any suitable format and media\n", "properties": {} } } } } }, "SDCustomerOfferFeedbackOutputModel": { "type": "object", "properties": { "serviceDomainFeedbackActionTaskReference": { "type": "string", "example": "SFATR765157", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a feedback service call\n" }, "serviceDomainFeedbackActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The feedback service call consolidated processing record\n", "properties": {} }, "serviceDomainFeedbackActionRecord": { "properties": { "feedbackRecordDateTime": { "type": "string", "example": "09-22-2018", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::DateTime\n general-info: The date/time the feedback submitted for consideration\n" }, "feedbackRecordStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of processing the feedback e.g. received, considered, responded to\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "769031", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to business unit/employee responsible for handling feedback\n" } } } } }, "SDCustomerOfferRetrieveInputModel": { "type": "object", "properties": { "serviceDomainRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "serviceDomainRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "serviceDomainRetrieveActionRecord": { "properties": { "serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" } } }, "serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" } } }, "controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" } } } } }, "serviceDomainOfferedService": { "properties": { "serviceDomainServiceReference": { "type": "string", "example": "776158", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceRecord": { "properties": { "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" } } } } } } }, "SDCustomerOfferRetrieveOutputModel": { "type": "object", "properties": { "serviceDomainRetrieveActionTaskReference": { "type": "string", "example": "SRATR795161", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a retrieve service call\n" }, "serviceDomainRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "serviceDomainRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "serviceDomainRetrieveActionRecord": { "properties": { "serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" }, "activityAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the activity analysis that can be on-going, periodic and actual and projected\n" }, "activityAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of activity analysis report available\n" }, "activityAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activity analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" }, "performanceAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the performance analysis that can be on-going or periodic\n" }, "performanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of performance analysis report available\n" }, "performanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The performance analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" }, "controlRecordPortfolioAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the portfolio analysis that can be on-going, periodic and actual and projected (can be unstructured data)\n" }, "controlRecordPortfolioAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external portfolio analysis report available\n" }, "controlRecordAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "serviceDomainOfferedService": { "properties": { "serviceDomainServiceReference": { "type": "string", "example": "776158", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceRecord": { "properties": { "serviceDomainServiceType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Refers to the different types of services offered\n" }, "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" }, "serviceDomainServiceDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the offered service \n" }, "serviceDomainServicePoliciesandGuidelines": { "properties": { "serviceDomainServiceEligibility": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Policies and rules governing access to the offered service, includes eligibility and qualifications\n" }, "serviceDomainServiceIntendedUses": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines covering allowed, intended use of the service\n" }, "serviceDomainServicePricingandTerms": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms, prices, penalties associated with use of the service\n" } } }, "serviceDomainServiceSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Schedule defining when the accessed service is available\n" } } } } } } }, "CRCustomerOfferProcedureInitiateInputModel": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR738028", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInitiateActionRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The Initiate service call input and output record\n", "properties": {} }, "customerOfferProcedureInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Customer Offer Procedure instance (e.g. initialised, pending, active)\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "720996", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "733369", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "752248", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "productInstanceRecord": { "properties": { "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "733949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "755683", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "736195", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } } } }, "CRCustomerOfferProcedureInitiateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR769333", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInitiateActionReference": { "type": "string", "example": "COPIAR731552", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an Initiate service call\n" }, "customerOfferProcedureInitiateActionRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The Initiate service call input and output record\n", "properties": {} }, "customerOfferProcedureInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Customer Offer Procedure instance (e.g. initialised, pending, active)\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" } } }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "717235", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "744472", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "733949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "755683", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "736195", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } } } }, "CRCustomerOfferProcedureUpdateInputModel": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR743736", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR719518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753477", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "784212", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "726864", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "CRCustomerOfferProcedureUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753477", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "784212", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "726864", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureUpdateActionTaskReference": { "type": "string", "example": "COPUATR762977", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "customerOfferProcedureUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "CRCustomerOfferProcedureControlInputModel": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR700741", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR744807", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureControlActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The processing control service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureControlActionRequest": { "properties": { "controlActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of processing action requested (e.g. suspend, skip, terminate)\n" } } } } }, "CRCustomerOfferProcedureControlOutputModel": { "type": "object", "properties": { "customerOfferProcedureControlActionTaskReference": { "type": "string", "example": "COPCATR736217", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance control processing service call\n" }, "customerOfferProcedureControlActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The processing control service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureControlActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the control action service response\n" } } }, "CRCustomerOfferProcedureExchangeInputModel": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR704797", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR789127", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } }, "CRCustomerOfferProcedureExchangeOutputModel": { "type": "object", "properties": { "customerOfferProcedureExchangeActionTaskReference": { "type": "string", "example": "COPEATR713254", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance exchange service call\n" }, "customerOfferProcedureExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" } } }, "CRCustomerOfferProcedureExecuteInputModel": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR780445", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR751868", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "722189", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "785314", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "735490", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "customerOfferProcedureExecuteActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The execute service call consolidated processing record\n", "properties": {} }, "executeRecordType": { "properties": { "executeInputRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Execute transaction/record (e.g. deposit, withdrawal, fee/penalty, interest)\n", "properties": {} } } } } }, "CRCustomerOfferProcedureExecuteOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureExecuteActionTaskReference": { "type": "string", "example": "COPEATR712059", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance execute service call\n" }, "customerOfferProcedureExecuteActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The execute service call consolidated processing record\n", "properties": {} }, "executeRecordReference": { "type": "string", "example": "ERR758817", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the execute transaction/record\n" }, "executeResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the execute action service response\n", "properties": {} } } }, "CRCustomerOfferProcedureRequestInputModel": { "type": "object", "properties": { "customerOfferServicingSessionReference": { "type": "string", "example": "COSSR728693", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR745870", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Customer Offer Procedure instance\n" }, "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "772666", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "752917", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "753970", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "customerOfferProcedureRequestActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The request service call consolidated processing record\n", "properties": {} }, "requestRecordType": { "properties": { "requestInputRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Request service record (e.g. rework function, refresh record, process workstep)\n", "properties": {} } } } } }, "CRCustomerOfferProcedureRequestOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureRequestActionTaskReference": { "type": "string", "example": "COPRATR734822", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance request service call\n" }, "customerOfferProcedureRequestActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The request service call consolidated processing record\n", "properties": {} }, "requestRecordReference": { "type": "string", "example": "RRR736011", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the service request record\n" }, "requestResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the request action service response\n", "properties": {} } } }, "CRCustomerOfferProcedureRetrieveInputModel": { "type": "object", "properties": { "customerOfferProcedureRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "customerOfferProcedureInstanceReportRecord": { "properties": { "customerOfferProcedureInstanceReportReference": { "type": "string", "example": "752538", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" }, "customerOfferProcedureInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "customerOfferProcedureInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" } } }, "customerOfferProcedureInstanceAnalysis": { "properties": { "customerOfferProcedureInstanceAnalysisReference": { "type": "string", "example": "792167", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" }, "customerOfferProcedureInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "customerOfferProcedureInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" } } } } }, "CRCustomerOfferProcedureRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "774480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "704310", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "705910", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureRetrieveActionTaskReference": { "type": "string", "example": "COPRATR785437", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Customer Offer Procedure instance retrieve service call\n" }, "customerOfferProcedureRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "customerOfferProcedureRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "customerOfferProcedureInstanceReportRecord": { "properties": { "customerOfferProcedureInstanceReportData": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n" }, "customerOfferProcedureInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "customerOfferProcedureInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "customerOfferProcedureInstanceAnalysis": { "properties": { "customerOfferProcedureInstanceAnalysisData": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n" }, "customerOfferProcedureInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "customerOfferProcedureInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQProductUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR772148", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "productInstanceReference": { "type": "string", "example": "COPIR772148", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Product instance\n" }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "productUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "productUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQProductUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "productUpdateActionTaskReference": { "type": "string", "example": "COPUATR740346", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "productUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQProductExchangeInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR785200", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "productInstanceReference": { "type": "string", "example": "COPIR785200", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Product instance\n" }, "productExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "productExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } }, "BQProductExchangeOutputModel": { "type": "object", "properties": { "productExchangeActionTaskReference": { "type": "string", "example": "COPEATR702960", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Product instance exchange service call\n" }, "productExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "productExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "productInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Product instance (e.g. accepted, rejected, verified)\n" } } }, "BQProductRetrieveInputModel": { "type": "object", "properties": { "productRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "productRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "productInstanceReport": { "properties": { "productInstanceReportReference": { "type": "string", "example": "705387", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "productInstanceAnalysis": { "properties": { "productInstanceAnalysisReference": { "type": "string", "example": "774067", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQProductRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "731146", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "710811", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "productRetrieveActionTaskReference": { "type": "string", "example": "COPRATR747428", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Product instance retrieve service call\n" }, "productRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "productRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "productInstanceReport": { "properties": { "productInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "productInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "productInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "productInstanceAnalysis": { "properties": { "productInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "productInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "productInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQDisclosuresUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "750376", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR703181", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "disclosuresInstanceReference": { "type": "string", "example": "DIR774723", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Disclosures instance\n" }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "787732", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "disclosuresUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "disclosuresUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQDisclosuresUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "750376", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "787732", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "disclosuresUpdateActionTaskReference": { "type": "string", "example": "DUATR721912", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "disclosuresUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQDisclosuresExchangeInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR747491", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "disclosuresInstanceReference": { "type": "string", "example": "DIR777695", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Disclosures instance\n" }, "disclosuresExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "disclosuresExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } }, "BQDisclosuresExchangeOutputModel": { "type": "object", "properties": { "disclosuresExchangeActionTaskReference": { "type": "string", "example": "DEATR754071", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Disclosures instance exchange service call\n" }, "disclosuresExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "disclosuresExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "disclosuresInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Disclosures instance (e.g. accepted, rejected, verified)\n" } } }, "BQDisclosuresRetrieveInputModel": { "type": "object", "properties": { "disclosuresRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "disclosuresRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "disclosuresInstanceReport": { "properties": { "disclosuresInstanceReportReference": { "type": "string", "example": "762553", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "disclosuresInstanceAnalysis": { "properties": { "disclosuresInstanceAnalysisReference": { "type": "string", "example": "719944", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQDisclosuresRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "758232", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "731415", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "724284", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "718187", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "disclosuresRetrieveActionTaskReference": { "type": "string", "example": "DRATR735013", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Disclosures instance retrieve service call\n" }, "disclosuresRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "disclosuresRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "disclosuresInstanceReport": { "properties": { "disclosuresInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "disclosuresInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "disclosuresInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "disclosuresInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "disclosuresInstanceAnalysis": { "properties": { "disclosuresInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "disclosuresInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "disclosuresInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "disclosuresInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQCreditUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "717579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR762563", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "creditInstanceReference": { "type": "string", "example": "CIR792446", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Credit instance\n" }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753252", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "creditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "creditUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQCreditUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "717579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753252", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "creditUpdateActionTaskReference": { "type": "string", "example": "CUATR722573", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "creditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQCreditRetrieveInputModel": { "type": "object", "properties": { "creditRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "creditRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "creditInstanceReport": { "properties": { "creditInstanceReportReference": { "type": "string", "example": "790862", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "creditInstanceAnalysis": { "properties": { "creditInstanceAnalysisReference": { "type": "string", "example": "785949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQCreditRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "735889", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "713711", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793043", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753377", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "creditRetrieveActionTaskReference": { "type": "string", "example": "CRATR777458", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Credit instance retrieve service call\n" }, "creditRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "creditRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "creditInstanceReport": { "properties": { "creditInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "creditInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "creditInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "creditInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "creditInstanceAnalysis": { "properties": { "creditInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "creditInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "creditInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "creditInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQUnderwritingUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "701909", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR764167", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "underwritingInstanceReference": { "type": "string", "example": "UIR711787", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Underwriting instance\n" }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "702751", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "underwritingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "underwritingUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQUnderwritingUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "701909", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "702751", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "underwritingUpdateActionTaskReference": { "type": "string", "example": "UUATR762410", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "underwritingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQUnderwritingRetrieveInputModel": { "type": "object", "properties": { "underwritingRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "underwritingRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "underwritingInstanceReport": { "properties": { "underwritingInstanceReportReference": { "type": "string", "example": "717724", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "underwritingInstanceAnalysis": { "properties": { "underwritingInstanceAnalysisReference": { "type": "string", "example": "746157", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQUnderwritingRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "798524", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "782588", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "733171", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "743102", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "underwritingRetrieveActionTaskReference": { "type": "string", "example": "URATR735691", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Underwriting instance retrieve service call\n" }, "underwritingRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "underwritingRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "underwritingInstanceReport": { "properties": { "underwritingInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "underwritingInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "underwritingInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "underwritingInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "underwritingInstanceAnalysis": { "properties": { "underwritingInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "underwritingInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "underwritingInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "underwritingInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQComplianceUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "787582", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR714236", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "complianceInstanceReference": { "type": "string", "example": "CIR784347", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Compliance instance\n" }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "complianceUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "complianceUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQComplianceUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "787582", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "complianceUpdateActionTaskReference": { "type": "string", "example": "CUATR739424", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "complianceUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQComplianceRetrieveInputModel": { "type": "object", "properties": { "complianceRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "complianceRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "complianceInstanceReport": { "properties": { "complianceInstanceReportReference": { "type": "string", "example": "776133", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "complianceInstanceAnalysis": { "properties": { "complianceInstanceAnalysisReference": { "type": "string", "example": "722418", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQComplianceRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "768555", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "716204", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "756506", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "complianceRetrieveActionTaskReference": { "type": "string", "example": "CRATR701585", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Compliance instance retrieve service call\n" }, "complianceRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "complianceRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "complianceInstanceReport": { "properties": { "complianceInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "complianceInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "complianceInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "complianceInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "complianceInstanceAnalysis": { "properties": { "complianceInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "complianceInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "complianceInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "complianceInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQAuditUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "786768", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR796411", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "auditInstanceReference": { "type": "string", "example": "AIR799393", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Audit instance\n" }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "auditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "auditUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQAuditUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "786768", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "auditUpdateActionTaskReference": { "type": "string", "example": "AUATR794764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "auditUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQAuditRetrieveInputModel": { "type": "object", "properties": { "auditRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "auditRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "auditInstanceReport": { "properties": { "auditInstanceReportReference": { "type": "string", "example": "730762", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "auditInstanceAnalysis": { "properties": { "auditInstanceAnalysisReference": { "type": "string", "example": "714906", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQAuditRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753821", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "793767", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725215", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "auditRetrieveActionTaskReference": { "type": "string", "example": "ARATR750423", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Audit instance retrieve service call\n" }, "auditRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "auditRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "auditInstanceReport": { "properties": { "auditInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "auditInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "auditInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "auditInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "auditInstanceAnalysis": { "properties": { "auditInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "auditInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "auditInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "auditInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQCollateralUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "737819", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR739427", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "collateralInstanceReference": { "type": "string", "example": "CIR793143", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Collateral instance\n" }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "767541", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "796658", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "collateralUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "collateralUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQCollateralUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "737819", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "767541", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "796658", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "collateralUpdateActionTaskReference": { "type": "string", "example": "CUATR766676", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "collateralUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQCollateralExchangeInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR787534", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "collateralInstanceReference": { "type": "string", "example": "CIR717731", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Collateral instance\n" }, "collateralExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "collateralExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } }, "BQCollateralExchangeOutputModel": { "type": "object", "properties": { "collateralExchangeActionTaskReference": { "type": "string", "example": "CEATR722980", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Collateral instance exchange service call\n" }, "collateralExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "collateralExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "collateralInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Collateral instance (e.g. accepted, rejected, verified)\n" } } }, "BQCollateralRetrieveInputModel": { "type": "object", "properties": { "collateralRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "collateralRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "collateralInstanceReport": { "properties": { "collateralInstanceReportReference": { "type": "string", "example": "729687", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "collateralInstanceAnalysis": { "properties": { "collateralInstanceAnalysisReference": { "type": "string", "example": "730826", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQCollateralRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "771026", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "796305", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "783804", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "719765", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "717572", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "collateralRetrieveActionTaskReference": { "type": "string", "example": "CRATR777265", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Collateral instance retrieve service call\n" }, "collateralRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "collateralRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "collateralInstanceReport": { "properties": { "collateralInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "collateralInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "collateralInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "collateralInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "collateralInstanceAnalysis": { "properties": { "collateralInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "collateralInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "collateralInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "collateralInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQBookingUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "784510", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR751074", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "bookingInstanceReference": { "type": "string", "example": "BIR748644", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Booking instance\n" }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "757280", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "bookingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "bookingUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQBookingUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "784510", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "757280", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "bookingUpdateActionTaskReference": { "type": "string", "example": "BUATR753898", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "bookingUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQBookingRetrieveInputModel": { "type": "object", "properties": { "bookingRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "bookingRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "bookingInstanceReport": { "properties": { "bookingInstanceReportReference": { "type": "string", "example": "716461", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "bookingInstanceAnalysis": { "properties": { "bookingInstanceAnalysisReference": { "type": "string", "example": "782656", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQBookingRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "751473", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "773008", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732274", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "779818", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "bookingRetrieveActionTaskReference": { "type": "string", "example": "BRATR723427", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Booking instance retrieve service call\n" }, "bookingRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "bookingRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "bookingInstanceReport": { "properties": { "bookingInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "bookingInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "bookingInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "bookingInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "bookingInstanceAnalysis": { "properties": { "bookingInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "bookingInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "bookingInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "bookingInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQCorrespondenceandDocumentsUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725429", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR780577", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "correspondenceandDocumentsInstanceReference": { "type": "string", "example": "CADIR736347", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Correspondence and Documents instance\n" }, "correspondenceandDocumentsInstanceRecord": { "properties": { "correspondenceInstanceReference": { "type": "string", "example": "764564", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "755966", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "correspondenceandDocumentsUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQCorrespondenceandDocumentsUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725429", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" }, "correspondenceInstanceReference": { "type": "string", "example": "764564", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "755966", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "correspondenceandDocumentsUpdateActionTaskReference": { "type": "string", "example": "CADUATR791014", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "correspondenceandDocumentsUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQCorrespondenceandDocumentsExchangeInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR709918", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "correspondenceandDocumentsInstanceReference": { "type": "string", "example": "CADIR751617", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Correspondence and Documents instance\n" }, "correspondenceandDocumentsExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } }, "BQCorrespondenceandDocumentsExchangeOutputModel": { "type": "object", "properties": { "correspondenceandDocumentsExchangeActionTaskReference": { "type": "string", "example": "CADEATR789579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Correspondence and Documents instance exchange service call\n" }, "correspondenceandDocumentsExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "correspondenceandDocumentsInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Correspondence and Documents instance (e.g. accepted, rejected, verified)\n" } } }, "BQCorrespondenceandDocumentsRetrieveInputModel": { "type": "object", "properties": { "correspondenceandDocumentsRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "correspondenceandDocumentsInstanceReport": { "properties": { "correspondenceandDocumentsInstanceReportReference": { "type": "string", "example": "776762", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "correspondenceandDocumentsInstanceAnalysis": { "properties": { "correspondenceandDocumentsInstanceAnalysisReference": { "type": "string", "example": "743908", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQCorrespondenceandDocumentsRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "782616", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "759645", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785837", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" }, "correspondenceInstanceReference": { "type": "string", "example": "736630", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "700162", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "correspondenceandDocumentsRetrieveActionTaskReference": { "type": "string", "example": "CADRATR745080", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Correspondence and Documents instance retrieve service call\n" }, "correspondenceandDocumentsRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "correspondenceandDocumentsRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "correspondenceandDocumentsInstanceReport": { "properties": { "correspondenceandDocumentsInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "correspondenceandDocumentsInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "correspondenceandDocumentsInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "correspondenceandDocumentsInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "correspondenceandDocumentsInstanceAnalysis": { "properties": { "correspondenceandDocumentsInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "correspondenceandDocumentsInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "correspondenceandDocumentsInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "correspondenceandDocumentsInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQAgreementUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "768218", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR784807", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "agreementInstanceReference": { "type": "string", "example": "AIR758103", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Agreement instance\n" }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "732372", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "767742", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "agreementUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "agreementUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQAgreementUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "768218", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "732372", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "767742", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "agreementUpdateActionTaskReference": { "type": "string", "example": "AUATR724260", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "agreementUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQAgreementExchangeInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR727691", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "agreementInstanceReference": { "type": "string", "example": "AIR726778", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Agreement instance\n" }, "agreementExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "agreementExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } } } }, "BQAgreementExchangeOutputModel": { "type": "object", "properties": { "agreementExchangeActionTaskReference": { "type": "string", "example": "AEATR770257", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Agreement instance exchange service call\n" }, "agreementExchangeActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The exchange service call consolidated processing record\n", "properties": {} }, "agreementExchangeActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the exchange action service response\n" }, "agreementInstanceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the Agreement instance (e.g. accepted, rejected, verified)\n" } } }, "BQAgreementRetrieveInputModel": { "type": "object", "properties": { "agreementRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "agreementRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "agreementInstanceReport": { "properties": { "agreementInstanceReportReference": { "type": "string", "example": "788627", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "agreementInstanceAnalysis": { "properties": { "agreementInstanceAnalysisReference": { "type": "string", "example": "72.0.0", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQAgreementRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "725269", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "735177", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "718943", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "749826", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "743608", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "agreementRetrieveActionTaskReference": { "type": "string", "example": "ARATR711293", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Agreement instance retrieve service call\n" }, "agreementRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "agreementRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "agreementInstanceReport": { "properties": { "agreementInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "agreementInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "agreementInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "agreementInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "agreementInstanceAnalysis": { "properties": { "agreementInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "agreementInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "agreementInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "agreementInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "BQProductInitializationUpdateInputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785117", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "customerOfferProcedureInstanceReference": { "type": "string", "example": "COPIR749649", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the parent Customer Offer Procedure instance\n" }, "productInitializationInstanceReference": { "type": "string", "example": "PIIR723627", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the Product Initialization instance\n" }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "705158", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "productInitializationUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "productInitializationUpdateActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the update action service request\n" } } }, "BQProductInitializationUpdateOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785117", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "705158", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "productInitializationUpdateActionTaskReference": { "type": "string", "example": "PIUATR766983", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to an update service call\n" }, "productInitializationUpdateActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The update service call consolidated processing record\n", "properties": {} }, "updateResponseRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Details of the Update action service response\n", "properties": {} } } }, "BQProductInitializationRetrieveInputModel": { "type": "object", "properties": { "productInitializationRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "productInitializationRetrieveActionRequest": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service request (lists requested reports)\n" }, "productInitializationInstanceReport": { "properties": { "productInitializationInstanceReportReference": { "type": "string", "example": "706859", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "productInitializationInstanceAnalysis": { "properties": { "productInitializationInstanceAnalysisReference": { "type": "string", "example": "707040", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } } } }, "BQProductInitializationRetrieveOutputModel": { "type": "object", "properties": { "customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "709459", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "728005", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "792591", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "productInitializationRetrieveActionTaskReference": { "type": "string", "example": "PIRATR716347", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a Product Initialization instance retrieve service call\n" }, "productInitializationRetrieveActionTaskRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The retrieve service call consolidated processing record\n", "properties": {} }, "productInitializationRetrieveActionResponse": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Details of the retrieve action service response (lists returned reports)\n" }, "productInitializationInstanceReport": { "properties": { "productInitializationInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInitializationInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "productInitializationInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "productInitializationInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "productInitializationInstanceAnalysis": { "properties": { "productInitializationInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInitializationInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "productInitializationInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "productInitializationInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "SDCustomerOfferActivateInputModel_serviceDomainServiceConfigurationRecord_serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } }, "SDCustomerOfferActivateInputModel_serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "700761", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of service configuration parameter\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } } } }, "SDCustomerOfferActivateOutputModel_serviceDomainServiceConfigurationRecord_serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "769192", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "SDCustomerOfferActivateOutputModel_serviceDomainServiceConfigurationRecord_serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "791202", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "767210", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "SDCustomerOfferActivateOutputModel_serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "700761", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the configuration parameter, allowed values and processing impact\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The default activation setting for the offered service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "769192", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "791202", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "767210", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "serviceDomainServiceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the offered service (e.g. active, suspended, idle)\n" } } }, "SDCustomerOfferConfigureInputModel_serviceDomainServiceConfigurationRecord_serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "SDCustomerOfferConfigureInputModel_serviceDomainServiceConfigurationRecord_serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "SDCustomerOfferConfigureInputModel_serviceDomainServiceConfigurationRecord_serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "SDCustomerOfferConfigureInputModel_serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingReference": { "type": "string", "example": "710630", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Refers to the service configuration parameter for the service\n" }, "serviceDomainServiceConfigurationSettingType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of service configuration parameter\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } } } }, "SDCustomerOfferConfigureOutputModel_serviceDomainServiceConfigurationRecord": { "properties": { "serviceDomainServiceConfigurationSettingDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the configuration parameter, allowed values and processing impact\n" }, "serviceDomainServiceConfigurationSetup": { "properties": { "serviceDomainServiceConfigurationParameter": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The requested and current activation values for the service configuration parameter \n" } } }, "serviceDomainServiceSubscription": { "properties": { "serviceDomainServiceSubscriberReference": { "type": "string", "example": "756221", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Maintains reference to allowed users or subscribers to the service which can be any known party\n" }, "serviceDomainServiceSubscriberAccessProfile": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The allowed service access for a user or subscriber to the service which can be any known party\n" } } }, "serviceDomainServiceAgreement": { "properties": { "serviceDomainServiceAgreementReference": { "type": "string", "example": "721156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the offered service agreement\n" }, "serviceDomainServiceUserReference": { "type": "string", "example": "733696", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the user covered by the contract\n" }, "serviceDomainServiceAgreementTermsandConditions": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms and conditions covering the service agreement\n" } } }, "serviceDomainServiceStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of the offered service (e.g. active, suspended, idle)\n" } } }, "SDCustomerOfferFeedbackInputModel_serviceDomainFeedbackActionRecord": { "properties": { "serviceDomainServicingSessionReference": { "type": "string", "example": "796678", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the active servicing session\n" }, "controlRecordInstanceReference": { "type": "string", "example": "724385", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance if appropriate\n" }, "behaviorQualifierInstanceReference": { "type": "string", "example": "789747", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the behavior qualifier instance if appropriate\n" }, "feedbackRecordType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The layout/type of the feedback provided\n" }, "feedbackRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The content of the feedback in any suitable format and media\n", "properties": {} } } }, "SDCustomerOfferFeedbackOutputModel_serviceDomainFeedbackActionRecord": { "properties": { "feedbackRecordDateTime": { "type": "string", "example": "09-22-2018", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::DateTime\n general-info: The date/time the feedback submitted for consideration\n" }, "feedbackRecordStatus": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The status of processing the feedback e.g. received, considered, responded to\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "769031", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to business unit/employee responsible for handling feedback\n" } } }, "SDCustomerOfferRetrieveInputModel_serviceDomainRetrieveActionRecord_serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" } } }, "SDCustomerOfferRetrieveInputModel_serviceDomainRetrieveActionRecord_serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" } } }, "SDCustomerOfferRetrieveInputModel_serviceDomainRetrieveActionRecord_controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" } } }, "SDCustomerOfferRetrieveInputModel_serviceDomainRetrieveActionRecord": { "properties": { "serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" } } }, "serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" } } }, "controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" } } } } }, "SDCustomerOfferRetrieveInputModel_serviceDomainOfferedService_serviceDomainServiceRecord": { "properties": { "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" } } }, "SDCustomerOfferRetrieveInputModel_serviceDomainOfferedService": { "properties": { "serviceDomainServiceReference": { "type": "string", "example": "776158", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceRecord": { "properties": { "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" } } } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainRetrieveActionRecord_serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" }, "activityAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the activity analysis that can be on-going, periodic and actual and projected\n" }, "activityAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of activity analysis report available\n" }, "activityAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activity analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainRetrieveActionRecord_serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" }, "performanceAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the performance analysis that can be on-going or periodic\n" }, "performanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of performance analysis report available\n" }, "performanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The performance analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainRetrieveActionRecord_controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" }, "controlRecordPortfolioAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the portfolio analysis that can be on-going, periodic and actual and projected (can be unstructured data)\n" }, "controlRecordPortfolioAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external portfolio analysis report available\n" }, "controlRecordAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainRetrieveActionRecord": { "properties": { "serviceDomainActivityAnalysis": { "properties": { "activityAnalysisReference": { "type": "string", "example": "730230", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal activity analysis view maintained by the service center\n" }, "activityAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the activity analysis that can be on-going, periodic and actual and projected\n" }, "activityAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of activity analysis report available\n" }, "activityAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The activity analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "serviceDomainPerformanceAnalysis": { "properties": { "performanceAnalysisReference": { "type": "string", "example": "761670", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the internal performance analysis view maintained by the service center\n" }, "performanceAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the performance analysis that can be on-going or periodic\n" }, "performanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of performance analysis report available\n" }, "performanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The performance analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "controlRecordPortfolioAnalysis": { "properties": { "controlRecordPortfolioAnalysisReference": { "type": "string", "example": "739764", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record portfolio analysis view maintained by the service center\n" }, "controlRecordPortfolioAnalysisResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The results of the portfolio analysis that can be on-going, periodic and actual and projected (can be unstructured data)\n" }, "controlRecordPortfolioAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external portfolio analysis report available\n" }, "controlRecordAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainOfferedService_serviceDomainServiceRecord_serviceDomainServicePoliciesandGuidelines": { "properties": { "serviceDomainServiceEligibility": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Policies and rules governing access to the offered service, includes eligibility and qualifications\n" }, "serviceDomainServiceIntendedUses": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines covering allowed, intended use of the service\n" }, "serviceDomainServicePricingandTerms": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms, prices, penalties associated with use of the service\n" } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainOfferedService_serviceDomainServiceRecord": { "properties": { "serviceDomainServiceType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Refers to the different types of services offered\n" }, "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" }, "serviceDomainServiceDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the offered service \n" }, "serviceDomainServicePoliciesandGuidelines": { "properties": { "serviceDomainServiceEligibility": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Policies and rules governing access to the offered service, includes eligibility and qualifications\n" }, "serviceDomainServiceIntendedUses": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines covering allowed, intended use of the service\n" }, "serviceDomainServicePricingandTerms": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms, prices, penalties associated with use of the service\n" } } }, "serviceDomainServiceSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Schedule defining when the accessed service is available\n" } } }, "SDCustomerOfferRetrieveOutputModel_serviceDomainOfferedService": { "properties": { "serviceDomainServiceReference": { "type": "string", "example": "776158", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to a service offered by the service center\n" }, "serviceDomainServiceRecord": { "properties": { "serviceDomainServiceType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Refers to the different types of services offered\n" }, "serviceDomainServiceVersion": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The version details of the service when appropriate\n" }, "serviceDomainServiceDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the offered service \n" }, "serviceDomainServicePoliciesandGuidelines": { "properties": { "serviceDomainServiceEligibility": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Policies and rules governing access to the offered service, includes eligibility and qualifications\n" }, "serviceDomainServiceIntendedUses": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines covering allowed, intended use of the service\n" }, "serviceDomainServicePricingandTerms": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Terms, prices, penalties associated with use of the service\n" } } }, "serviceDomainServiceSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Schedule defining when the accessed service is available\n" } } } } }, "CRCustomerOfferProcedureInitiateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "752248", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "720996", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "733369", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "752248", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "CRCustomerOfferProcedureInitiateInputModel_productInstanceRecord": { "properties": { "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "733949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "755683", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" } } }, "CRCustomerOfferProcedureInitiateInputModel_productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "736195", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "CRCustomerOfferProcedureInitiateOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "CRCustomerOfferProcedureInitiateOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "CRCustomerOfferProcedureInitiateOutputModel_productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" } } }, "CRCustomerOfferProcedureInitiateOutputModel_disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" } } }, "CRCustomerOfferProcedureInitiateOutputModel_collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "717235", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "744472", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "CRCustomerOfferProcedureUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "726864", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "CRCustomerOfferProcedureUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753477", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "784212", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "726864", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "CRCustomerOfferProcedureControlInputModel_customerOfferProcedureControlActionRequest": { "properties": { "controlActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of processing action requested (e.g. suspend, skip, terminate)\n" } } }, "CRCustomerOfferProcedureExchangeInputModel_customerOfferProcedureExchangeActionRequest": { "properties": { "exchangeActionType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of exchange (e.g. accept, reject, verify)\n" } } }, "CRCustomerOfferProcedureExecuteInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "735490", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } }, "CRCustomerOfferProcedureExecuteInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "722189", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "785314", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "735490", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "CRCustomerOfferProcedureExecuteInputModel_executeRecordType": { "properties": { "executeInputRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Execute transaction/record (e.g. deposit, withdrawal, fee/penalty, interest)\n", "properties": {} } } }, "CRCustomerOfferProcedureRequestInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "753970", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } }, "CRCustomerOfferProcedureRequestInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "772666", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "752917", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "753970", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" } } } } }, "CRCustomerOfferProcedureRequestInputModel_requestRecordType": { "properties": { "requestInputRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: Request service record (e.g. rework function, refresh record, process workstep)\n", "properties": {} } } }, "CRCustomerOfferProcedureRetrieveInputModel_customerOfferProcedureInstanceReportRecord": { "properties": { "customerOfferProcedureInstanceReportReference": { "type": "string", "example": "752538", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" }, "customerOfferProcedureInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "customerOfferProcedureInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" } } }, "CRCustomerOfferProcedureRetrieveInputModel_customerOfferProcedureInstanceAnalysis": { "properties": { "customerOfferProcedureInstanceAnalysisReference": { "type": "string", "example": "792167", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" }, "customerOfferProcedureInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "customerOfferProcedureInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" } } }, "CRCustomerOfferProcedureRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "705910", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "CRCustomerOfferProcedureRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "774480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "704310", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "705910", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "CRCustomerOfferProcedureRetrieveOutputModel_customerOfferProcedureInstanceReportRecord": { "properties": { "customerOfferProcedureInstanceReportData": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n" }, "customerOfferProcedureInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "customerOfferProcedureInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "CRCustomerOfferProcedureRetrieveOutputModel_customerOfferProcedureInstanceAnalysis": { "properties": { "customerOfferProcedureInstanceAnalysisData": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n" }, "customerOfferProcedureInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "customerOfferProcedureInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQProductUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQProductUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793518", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQProductUpdateInputModel_productInstanceRecord": { "properties": { "productOption": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Product feature that can be configured for the customer\n" }, "productOptionDescription": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the feature provided for review\n" }, "productOptionSelection": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The option setting as agreed/defined with the customer\n" }, "productPricing": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304/elements/_FY_P8MTGEeChad0JzLk7QA_-1890335916\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).BankingProduct.BankingProductFeature (as PricingFeature)\n general-info: The allowed pricing includes ranges by customer measures e.g. credit grade\n" }, "negotiationGuidelinesRules": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Guidelines for the allowed situation-based pricing adjustments (to maximize margins)\n" }, "agreedPricing": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The agreed pricing (covers all negotiable prices/fees/penalties as necessary)\n" }, "pricingAdjustments": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: \n" } } }, "BQProductRetrieveInputModel_productInstanceReport": { "properties": { "productInstanceReportReference": { "type": "string", "example": "705387", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQProductRetrieveInputModel_productInstanceAnalysis": { "properties": { "productInstanceAnalysisReference": { "type": "string", "example": "774067", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQProductRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQProductRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "731146", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "710811", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785480", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQProductRetrieveOutputModel_productInstanceReport": { "properties": { "productInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "productInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "productInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQProductRetrieveOutputModel_productInstanceAnalysis": { "properties": { "productInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "productInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "productInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQDisclosuresUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "750376", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQDisclosuresUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "750376", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQDisclosuresUpdateInputModel_disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "787732", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "BQDisclosuresRetrieveInputModel_disclosuresInstanceReport": { "properties": { "disclosuresInstanceReportReference": { "type": "string", "example": "762553", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQDisclosuresRetrieveInputModel_disclosuresInstanceAnalysis": { "properties": { "disclosuresInstanceAnalysisReference": { "type": "string", "example": "719944", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQDisclosuresRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "724284", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQDisclosuresRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "758232", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "731415", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "724284", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQDisclosuresRetrieveOutputModel_disclosuresInstanceRecord": { "properties": { "disclosureType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0HltEeG7BsjMvd1mEw_-611051048\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureType\n general-info: The type of disclosure (e.g. verbal, requiring signature)\n" }, "disclosureTextDescription": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m0XltEeG7BsjMvd1mEw_369279782\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.DisclosureDescription\n general-info: The presented disclosure for customer review in any suitable format\n" }, "customerAcceptanceIndicator": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9j4m03ltEeG7BsjMvd1mEw_-1318630222\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.ConfirmationIndicator\n general-info: An indicator that the disclosure has been accepted (indicates signature obtained as necessary)\n" }, "documentReference": { "type": "string", "example": "718187", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9ju10HltEeG7BsjMvd1mEw_-739610260/elements/_9kx-tHltEeG7BsjMvd1mEw_2137767733\n bian-reference: CustomerOffer.OfferedAgreement(as Agreement).Disclosure.SpecifiedDocument\n general-info: \n" } } }, "BQDisclosuresRetrieveOutputModel_disclosuresInstanceReport": { "properties": { "disclosuresInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "disclosuresInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "disclosuresInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "disclosuresInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQDisclosuresRetrieveOutputModel_disclosuresInstanceAnalysis": { "properties": { "disclosuresInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "disclosuresInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "disclosuresInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "disclosuresInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQCreditUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "717579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQCreditUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "717579", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQCreditUpdateInputModel_creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753252", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "BQCreditRetrieveInputModel_creditInstanceReport": { "properties": { "creditInstanceReportReference": { "type": "string", "example": "790862", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQCreditRetrieveInputModel_creditInstanceAnalysis": { "properties": { "creditInstanceAnalysisReference": { "type": "string", "example": "785949", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQCreditRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793043", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQCreditRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "735889", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "713711", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "793043", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQCreditRetrieveOutputModel_creditInstanceRecord": { "properties": { "customerCreditRating": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FQCvV8TGEeChad0JzLk7QA_1351565206\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating)\n general-info: The customer's current credit rating\n" }, "creditAuthorizationDecisionReference": { "type": "string", "example": "753377", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n general-info: Reference to the authorization if an aspect of the offer procedure\n" }, "creditAuthorizationDecision": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg\n bian-reference: CustomerOffer.TagetCustomer.CustomerRating (as CustomerCreditRating).CustomerCreditRatingAssessment\n`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The credit decision (indicates credit position is adequate for the offer)\n" } } }, "BQCreditRetrieveOutputModel_creditInstanceReport": { "properties": { "creditInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "creditInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "creditInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "creditInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQCreditRetrieveOutputModel_creditInstanceAnalysis": { "properties": { "creditInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "creditInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "creditInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "creditInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQUnderwritingUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "701909", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQUnderwritingUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "701909", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQUnderwritingUpdateInputModel_underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "702751", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "BQUnderwritingRetrieveInputModel_underwritingInstanceReport": { "properties": { "underwritingInstanceReportReference": { "type": "string", "example": "717724", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQUnderwritingRetrieveInputModel_underwritingInstanceAnalysis": { "properties": { "underwritingInstanceAnalysisReference": { "type": "string", "example": "746157", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQUnderwritingRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "733171", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQUnderwritingRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "798524", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "782588", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "733171", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQUnderwritingRetrieveOutputModel_underwritingInstanceRecord": { "properties": { "customerIncomeStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: A statement of income over a required duration in a suitable format\n" }, "customerDebtStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided debt statements may combine bank and non-bank managed debt details\n" }, "customerAssetStatement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The provided asset statement may combine bank and known non-bank managed assets\n" }, "underwritingAssessmentReference": { "type": "string", "example": "743102", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The outcome of the underwriting assessment\n" } } }, "BQUnderwritingRetrieveOutputModel_underwritingInstanceReport": { "properties": { "underwritingInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "underwritingInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "underwritingInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "underwritingInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQUnderwritingRetrieveOutputModel_underwritingInstanceAnalysis": { "properties": { "underwritingInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "underwritingInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "underwritingInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "underwritingInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQComplianceUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "787582", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQComplianceUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "787582", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQComplianceUpdateInputModel_complianceInstanceRecord": { "properties": { "regulatoryComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: RegulatoryComplianceCheck (as Assessmet).Type\n general-info: The required check\n" }, "regulatoryComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "regulatoryComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "regulatoryComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "regulatoryComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "BQComplianceRetrieveInputModel_complianceInstanceReport": { "properties": { "complianceInstanceReportReference": { "type": "string", "example": "776133", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQComplianceRetrieveInputModel_complianceInstanceAnalysis": { "properties": { "complianceInstanceAnalysisReference": { "type": "string", "example": "722418", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQComplianceRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "756506", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQComplianceRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "768555", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "716204", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "756506", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQComplianceRetrieveOutputModel_complianceInstanceReport": { "properties": { "complianceInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "complianceInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "complianceInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "complianceInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQComplianceRetrieveOutputModel_complianceInstanceAnalysis": { "properties": { "complianceInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "complianceInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "complianceInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "complianceInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQAuditUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "786768", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQAuditUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "786768", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQAuditUpdateInputModel_auditInstanceRecord": { "properties": { "guidelineComplianceCheckType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_K1lxwG7NEeO82qXU9yOWsg/elements/_ddIbAG7VEeO82qXU9yOWsg\n bian-reference: Audit.GuidelineComplianceCheck (as Assessmet).Type\n general-info: The required compliance check\n" }, "guidelineComplianceCheckRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Description of the compliance requirements\n" }, "guidelineComplianceCheckSubmission": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The submitted offer related materials\n" }, "guidelineComplianceAdjustmentRequirement": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Any required changes to the offer needed to comply\n" }, "guidelineComplianceCheckAssessment": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The result of the compliance assessment\n" } } }, "BQAuditRetrieveInputModel_auditInstanceReport": { "properties": { "auditInstanceReportReference": { "type": "string", "example": "730762", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQAuditRetrieveInputModel_auditInstanceAnalysis": { "properties": { "auditInstanceAnalysisReference": { "type": "string", "example": "714906", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQAuditRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725215", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQAuditRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "753821", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "793767", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725215", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQAuditRetrieveOutputModel_auditInstanceReport": { "properties": { "auditInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "auditInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "auditInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "auditInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQAuditRetrieveOutputModel_auditInstanceAnalysis": { "properties": { "auditInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "auditInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "auditInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "auditInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQCollateralUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "737819", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQCollateralUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "737819", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQCollateralUpdateInputModel_collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "767541", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "796658", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "BQCollateralRetrieveInputModel_collateralInstanceReport": { "properties": { "collateralInstanceReportReference": { "type": "string", "example": "729687", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQCollateralRetrieveInputModel_collateralInstanceAnalysis": { "properties": { "collateralInstanceAnalysisReference": { "type": "string", "example": "730826", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQCollateralRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "783804", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQCollateralRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "771026", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "796305", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "783804", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQCollateralRetrieveOutputModel_collateralInstanceRecord": { "properties": { "collateralRequirement": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_FLlGE8TGEeChad0JzLk7QA_-1191802314\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAmount\n general-info: The required collateral amount for the offer\n" }, "collateralEarmarkReference": { "type": "string", "example": "719765", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344\n bian-reference: CollateralAgreement.CollateralArrangement.PaymentWarrantyArrangement\n general-info: Reference to earmarked collateral during the offer procedure\n" }, "collateralAssetAllocationInstanceRecord": { "type": "object", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831345\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset. CollateralAssetAllocation\n general-info: Reference to the allocated collateral\n", "properties": {} }, "collateralAssetReference": { "type": "string", "example": "717572", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FLlGEcTGEeChad0JzLk7QA_1826831344/elements/_2rpAYbbpEeG8PZlPAY1QrA_1766124127\n bian-reference: CollateralAgreement.CollateralArrangement.CollateralAsset\n general-info: Reference to the related collateral asset (e.g. property)\n" } } }, "BQCollateralRetrieveOutputModel_collateralInstanceReport": { "properties": { "collateralInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "collateralInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "collateralInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "collateralInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQCollateralRetrieveOutputModel_collateralInstanceAnalysis": { "properties": { "collateralInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "collateralInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "collateralInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "collateralInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQBookingUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "784510", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQBookingUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "784510", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQBookingUpdateInputModel_bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "757280", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "BQBookingRetrieveInputModel_bookingInstanceReport": { "properties": { "bookingInstanceReportReference": { "type": "string", "example": "716461", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQBookingRetrieveInputModel_bookingInstanceAnalysis": { "properties": { "bookingInstanceAnalysisReference": { "type": "string", "example": "782656", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQBookingRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732274", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQBookingRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "751473", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "773008", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732274", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQBookingRetrieveOutputModel_bookingInstanceRecord": { "properties": { "businessUnitReference": { "type": "string", "example": "779818", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Defines the booking entity\n" }, "assetLiabilityType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines the booking rules (e.g. booking value ratios)\n" }, "amount": { "type": "string", "example": "USD 250", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Amount\n general-info: The principle amount for booking\n" } } }, "BQBookingRetrieveOutputModel_bookingInstanceReport": { "properties": { "bookingInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "bookingInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "bookingInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "bookingInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQBookingRetrieveOutputModel_bookingInstanceAnalysis": { "properties": { "bookingInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "bookingInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "bookingInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "bookingInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQCorrespondenceandDocumentsUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725429", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQCorrespondenceandDocumentsUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "725429", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQCorrespondenceandDocumentsUpdateInputModel_correspondenceandDocumentsInstanceRecord": { "properties": { "correspondenceInstanceReference": { "type": "string", "example": "764564", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "755966", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "BQCorrespondenceandDocumentsUpdateOutputModel_correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" }, "correspondenceInstanceReference": { "type": "string", "example": "764564", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "755966", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "BQCorrespondenceandDocumentsRetrieveInputModel_correspondenceandDocumentsInstanceReport": { "properties": { "correspondenceandDocumentsInstanceReportReference": { "type": "string", "example": "776762", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQCorrespondenceandDocumentsRetrieveInputModel_correspondenceandDocumentsInstanceAnalysis": { "properties": { "correspondenceandDocumentsInstanceAnalysisReference": { "type": "string", "example": "743908", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQCorrespondenceandDocumentsRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785837", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQCorrespondenceandDocumentsRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "782616", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "759645", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785837", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQCorrespondenceandDocumentsRetrieveOutputModel_correspondenceandDocumentsInstanceRecord": { "properties": { "customerOfferRequiredDocuments": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Description of the required documents and time limits on receipt where appropriate\n" }, "correspondenceInstanceReference": { "type": "string", "example": "736630", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Reference to the correspondence generated and received\n" }, "correspondenceContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_9lOqonltEeG7BsjMvd1mEw_-1685162102\n bian-reference: Document.Correspondence\n general-info: Correspondence content - messages sent to and received from involved parties\n" }, "documentDirectoryEntryInstanceReference": { "type": "string", "example": "700162", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: The document reference for associated documents\n" }, "documentContent": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNET28TGEeChad0JzLk7QA_1924783636\n bian-reference: Document\n general-info: Document copy/content - legal or significant documents created & referenced\n" } } }, "BQCorrespondenceandDocumentsRetrieveOutputModel_correspondenceandDocumentsInstanceReport": { "properties": { "correspondenceandDocumentsInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "correspondenceandDocumentsInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "correspondenceandDocumentsInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "correspondenceandDocumentsInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQCorrespondenceandDocumentsRetrieveOutputModel_correspondenceandDocumentsInstanceAnalysis": { "properties": { "correspondenceandDocumentsInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "correspondenceandDocumentsInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "correspondenceandDocumentsInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "correspondenceandDocumentsInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQAgreementUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "768218", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQAgreementUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "768218", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQAgreementUpdateInputModel_agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "732372", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "767742", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "BQAgreementRetrieveInputModel_agreementInstanceReport": { "properties": { "agreementInstanceReportReference": { "type": "string", "example": "788627", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQAgreementRetrieveInputModel_agreementInstanceAnalysis": { "properties": { "agreementInstanceAnalysisReference": { "type": "string", "example": "72.0.0", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQAgreementRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "718943", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQAgreementRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "725269", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "735177", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "718943", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQAgreementRetrieveOutputModel_agreementInstanceRecord": { "properties": { "customerAgreementInstanceReference": { "type": "string", "example": "749826", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FYsVBcTGEeChad0JzLk7QA_-1076024413\n bian-reference: CustomerAgreement\n general-info: Reference to the associated master agreement that is accessed during the offer procedure\n" }, "salesProductAgreementInstanceReference": { "type": "string", "example": "743608", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_E2tpUMTGEeChad0JzLk7QA_1799405832\n bian-reference: ProductSalesAgreement\n general-info: Reference to the product specific agreement that is set-up as a result of the offer procedure (when successful)\n" } } }, "BQAgreementRetrieveOutputModel_agreementInstanceReport": { "properties": { "agreementInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "agreementInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "agreementInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "agreementInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQAgreementRetrieveOutputModel_agreementInstanceAnalysis": { "properties": { "agreementInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "agreementInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "agreementInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "agreementInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQProductInitializationUpdateInputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785117", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQProductInitializationUpdateInputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "785117", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQProductInitializationUpdateInputModel_productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "705158", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "BQProductInitializationRetrieveInputModel_productInitializationInstanceReport": { "properties": { "productInitializationInstanceReportReference": { "type": "string", "example": "706859", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance report\n" } } }, "BQProductInitializationRetrieveInputModel_productInitializationInstanceAnalysis": { "properties": { "productInitializationInstanceAnalysisReference": { "type": "string", "example": "707040", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the control record instance analysis view\n" } } }, "BQProductInitializationRetrieveOutputModel_customerOfferProcedureInstanceRecord_customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } }, "BQProductInitializationRetrieveOutputModel_customerOfferProcedureInstanceRecord": { "properties": { "customerReference": { "type": "string", "example": "709459", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Reference to the associated customer (can currently be a person or a company)\n" }, "partyReference": { "type": "string", "example": "728005", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FNqJt8TGEeChad0JzLk7QA_-1317971633\n bian-reference: Party\n general-info: Reference to the legal entity (typically the customer)\n" }, "productServiceType": { "type": "string", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: BankingProduct\n general-info: The type of product or service that is being offered\n" }, "customerOfferProcessingSchedule": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Defines scheduled update/review tasks covering all tracked properties\n" }, "customerOfferProcessingTask": { "properties": { "customerOfferProcessingTaskType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The type of task performed (each BQ constitutes an optional task instance)\n" }, "employeeBusinessUnitReference": { "type": "string", "example": "732156", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::ISO20022andUNCEFACT::Identifier\n general-info: Employees involved in completing the offer task\n" }, "customerOfferProcessingTaskWorkProducts": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: Work documentation, forms and schedules produced and referenced during the analysis\n" }, "customerOfferProcessingTaskResult": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The outcome of the task (will be used to update the Customer Offer Procedure Instance Record)\n" } } } } }, "BQProductInitializationRetrieveOutputModel_productInitializationInstanceRecord": { "properties": { "productInstanceReference": { "type": "string", "example": "792591", "description": "`status: Registered`\n iso-link: https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/bc/_FY1e9cTGEeChad0JzLk7QA_-1288627304\n bian-reference: CustomerOffer.OfferedAgreement (as Agreement).BankingProduct\n general-info: Reference to a specific product instance if the offer is accepted and the product set-up initiated\n" } } }, "BQProductInitializationRetrieveOutputModel_productInitializationInstanceReport": { "properties": { "productInitializationInstanceReportRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The input information used to assemble the report that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInitializationInstanceReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external report available\n" }, "productInitializationInstanceReportParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the report (e.g. period, content type)\n" }, "productInitializationInstanceReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external report in any suitable form including selection filters where appropriate\n", "properties": {} } } }, "BQProductInitializationRetrieveOutputModel_productInitializationInstanceAnalysis": { "properties": { "productInitializationInstanceAnalysisRecord": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The inputs and results of the instance analysis that can be on-going, periodic and actual and projected\n", "properties": {} }, "productInitializationInstanceAnalysisReportType": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Code\n general-info: The type of external performance analysis report available\n" }, "productInitializationInstanceAnalysisParameters": { "type": "string", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Text\n general-info: The selection parameters for the analysis (e.g. period, algorithm type)\n" }, "productInitializationInstanceAnalysisReport": { "type": "object", "description": "`status: Not Mapped`\n core-data-type-reference: BIAN::DataTypesLibrary::CoreDataTypes::UNCEFACT::Binary\n general-info: The external analysis report in any suitable form including selection filters where appropriate\n", "properties": {} } } } } }