generated: '2026-10-09'
method: derived
generator: derive-data-model.py
source:
- openapi/spliceforms-auth-services-openapi.yml
- openapi/spliceforms-capture-services-openapi.yml
- openapi/spliceforms-data-services-openapi.yml
- openapi/spliceforms-inquiry-services-openapi.yml
- openapi/spliceforms-processing-service-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 89
  entities_in_spec: 89
  relationships: 73
entities:
- name: AccessToken
  fields: 2
  description: The access tokem
- name: AccountOpeningResult
  fields: 1
  description: Account opening result
- name: AmountWithCurrency
  fields: 2
  description: Amount with currency code
- name: Application
  fields: 1
  description: Common/base model for application with common attributes. Concrete models for specific channel application
    forms should extend this (using allOff construct)
- name: Application92828
  fields: 4
  description: Represents the Application object for application form 92828
- name: ApplicationInitiationRequest
  fields: 2
- name: ApplicationInitiationResponse
  fields: 1
- name: ApplicationStatus92828
  fields: 2
  description: Processing status for application
- name: Bank
  fields: 2
  description: The bank
- name: BankAccountOwnershipCheckRequest
  fields: 5
- name: BankAccountOwnershipCheckResponse
  fields: 1
- name: BankUse
  fields: 6
  description: Specifies internal processing details and configurations used by the bank to handle the application.
- name: Branch
  fields: 6
- name: BranchAddress
  fields: 12
  description: Specifies the complete address details of branch
- name: BranchCity
  fields: 2
  description: It specifies the details of City where bank branch is available
- name: BranchDistrict
  fields: 2
  description: It specifies the details of District where bank branch is available
- name: BranchState
  fields: 2
  description: Specifies the details of state where bank branch is available
- name: Cheque
  fields: 1
  description: Contains details of the cheque instrument.
- name: City
  fields: 6
  description: Specifies the details of city, state and country.
- name: Code
  fields: 2
  description: Code against active Codeset
- name: Codeset
  fields: 2
  description: It represents a standardized collection of related codes used within the system
- name: CombinedFunding
  fields: 2
  description: Funds are sourced from both internal and external accounts.
- name: CombinedFundingPreference
  fields: 0
  description: Funds are sourced from both internal and external accounts.
- name: ConsentDefinition
  fields: 4
  description: It represents the structure of customer consent
- name: ConvertToFD
  fields: 1
  description: Indicates the customer's choice for converting the amount to a Fixed Deposit for a tenure of 1 year
    and 1 day.
- name: DA1Nomination
  fields: 1
  description: This form allows the account holder to specify a nominee.
- name: Declaration
  fields: 3
  description: A declaration may include consent for compliance, acknowledgment of policies, and confirmation of
    provided details.
- name: Device
  fields: 3
  description: It captures details about the device initiating the request
- name: ETBFDApplicationForm
  fields: 3
  description: Represents the application form to open FD account for ETB customers
- name: ETBFDApplicationStatus
  fields: 2
  description: Processing status for ETB FD application
- name: ETBIndividualApplicant
  fields: 2
  description: It includes essential information of an individual
- name: ExistingNomination
  fields: 1
  description: Indicates if existing nomination is to be copied
- name: ExternalBankAccount
  fields: 3
  description: Contains details of the NEFT instrument.
- name: ExternalFunding
  fields: 3
  description: Funds sourced from an external bank account.
- name: ExternalFundingPreference
  fields: 2
  description: Funds sourced from an external bank account.
- name: ExternalFundingRequest
  fields: 2
  description: Funds sourced from an external bank account.
- name: FDAccount
  fields: 7
  description: Represents the preferences for FD account
- name: FDAccountOpeningResult
  fields: 3
- name: FDAccountWithOptionalPayout
  fields: 7
  description: Represents the preferences for FD account. Optionally payout preferences also can be provided
- name: FDApplication
  fields: 0
  description: Contains the common fields for FD applications
- name: FDInternalPayout
  fields: 2
- name: FDMaturity
  fields: 4
  description: Information related to a Fixed Deposit (FD) at the time of maturity, including the maturity amount,
    interest earned, start date and maturity date.
- name: FDMaturityCalculationRequest
  fields: 8
- name: FDPayout
  fields: 2
  description: Specifies the methods to payout FD interest and/or principal on maturity
- name: FDTenure
  fields: 3
  description: This indicates the duration for which the Fixed Deposit (FD) is held, expressed in days, months and
    years.
- name: Form92828
  fields: 3
  description: FIXED DEPOSIT / RECURRING DEPOSIT PAYIN SLIP (FD/RD) APPLICABLE FOR RESIDENT AND NON RESIDENT CUSTOMERS
- name: GeoLocation
  fields: 2
  description: Represents the geographical location
- name: Guardian
  fields: 4
  description: It refers to the information related to the person who will act as a legal guardian for the nominee
    in case the nominee is a minor or unable to manage their own affairs.
- name: GuardianAddress
  fields: 5
  description: Specifies the complete address details of the guardian.
- name: IDToken
  fields: 2
  description: The ID token
- name: IndividualNameWithPrefix
  fields: 2
  description: Individual full name with prefix
- name: Initiation
  fields: 5
  description: Captures metadata and submission details such as the form id, form's version, application id, issuance
    date, and the channel id through which the application was initiated.
- name: InternalBankAccount
  fields: 1
  description: Specifies the internal bank account details
- name: InternalFunding
  fields: 2
  description: Funds drawn from an account within the bank.
- name: InternalFundingPreference
  fields: 2
  description: Funds drawn from an account within the bank.
- name: MobileAndDob
  fields: 2
- name: MobileAndPan
  fields: 2
- name: Netbanking
  fields: 2
  description: Contains details of the netbanking instrument.
- name: NetbankingPaymentRequest
  fields: 1
  description: Contains details of the netbanking payment request.
- name: Nominee
  fields: 6
  description: Specifies the personal information of the nominee designated by the account holder.
- name: NomineeAddress
  fields: 5
  description: Specifies the complete address details of the nominee.
- name: NomineeInquiryRequest
  fields: 1
  description: Account number
- name: OTPAuthResponse
  fields: 2
- name: OTPChallengeAnswer
  fields: 2
- name: OTPChallengeRequest
  fields: 2
- name: OTPChallengeResponse
  fields: 3
- name: OTPResendRequest
  fields: 1
  description: Request for resending OTP
- name: OtherBankBranch
  fields: 4
  description: Branch of other bank
- name: PaginatedResponse
  fields: 4
- name: Payin
  fields: 2
  description: Contains the funding details, including the amount and payment method.
- name: PayinInitiationResponse
  fields: 3
  description: Response for the payin request
- name: PayinRequest
  fields: 4
  description: Payin request
- name: PayinSourcePreference
  fields: 2
  description: Payment source preference for the application
- name: PayinStatusResponse
  fields: 1
- name: PaymentLink
  fields: 3
  description: Payment Link information
- name: PaymentStatusRequest
  fields: 1
- name: ProblemJson
  fields: 5
  description: Problem Error Json
- name: RDAccount
  fields: 6
  description: Represents the preferences for RD account
- name: RDPayout
  fields: 2
  description: Specifies the method for disbursing the RD maturity proceeds, including both the principal and accrued
    interest.
- name: Staff
  fields: 3
  description: It captures key details of a bank staff involved in processing an application
- name: State
  fields: 4
  description: Specifies the details of state and country
- name: TDS
  fields: 2
  description: Captures tds information such as to deduct tds yes/no and if no then attach relevant document.
- name: UPI
  fields: 3
  description: Contains details of the UPI instrument.
- name: Upi
  fields: 3
  description: Contains details of the UPI instrument.
- name: UpiPaymentRequest
  fields: 2
  description: Contains details of the UPI payment request
- name: VPAOwnershipCheckRequest
  fields: 2
- name: VPAOwnershipCheckResponse
  fields: 1
- name: ValidationError
  fields: 3
  description: Validation Error
- name: Witness
  fields: 4
  description: Specifies the information of the witness required to validate and authenticate the application.
relationships:
- from: OTPChallengeRequest
  to: MobileAndDob
  type: has_one
  via: identity
- from: OTPChallengeRequest
  to: MobileAndPan
  type: has_one
  via: identity
- from: OTPAuthResponse
  to: AccessToken
  type: has_one
  via: accessToken
- from: OTPAuthResponse
  to: IDToken
  type: has_one
  via: idToken
- from: ProblemJson
  to: ValidationError
  type: has_many
  via: validationErrors
- from: FDAccountWithOptionalPayout
  to: FDTenure
  type: has_one
  via: tenure
- from: FDAccountWithOptionalPayout
  to: FDPayout
  type: has_one
  via: payout
- from: FDPayout
  to: InternalBankAccount
  type: has_one
  via: instrument
- from: FDPayout
  to: ExternalBankAccount
  type: has_one
  via: instrument
- from: PayinSourcePreference
  to: InternalFundingPreference
  type: has_one
  via: source
- from: PayinSourcePreference
  to: ExternalFundingPreference
  type: has_one
  via: source
- from: PayinSourcePreference
  to: CombinedFundingPreference
  type: has_one
  via: source
- from: InternalFundingPreference
  to: InternalBankAccount
  type: has_one
  via: account
- from: ExternalFundingPreference
  to: ExternalBankAccount
  type: has_one
  via: account
- from: Payin
  to: InternalFunding
  type: has_one
  via: source
- from: Payin
  to: ExternalFunding
  type: has_one
  via: source
- from: Payin
  to: CombinedFunding
  type: has_one
  via: source
- from: InternalFunding
  to: InternalBankAccount
  type: has_one
  via: instrument
- from: ExternalFunding
  to: Upi
  type: has_one
  via: instrument
- from: ExternalFunding
  to: Netbanking
  type: has_one
  via: instrument
- from: Upi
  to: ExternalBankAccount
  type: has_one
  via: account
- from: Netbanking
  to: ExternalBankAccount
  type: has_one
  via: account
- from: CombinedFunding
  to: InternalFunding
  type: has_one
  via: internal
- from: CombinedFunding
  to: ExternalFunding
  type: has_one
  via: external
- from: PayinRequest
  to: ExternalFundingRequest
  type: has_one
  via: source
- from: PayinRequest
  to: Device
  type: has_one
  via: device
- from: ExternalFundingRequest
  to: UpiPaymentRequest
  type: has_one
  via: instrument
- from: ExternalFundingRequest
  to: NetbankingPaymentRequest
  type: has_one
  via: instrument
- from: UpiPaymentRequest
  to: ExternalBankAccount
  type: has_one
  via: account
- from: NetbankingPaymentRequest
  to: ExternalBankAccount
  type: has_one
  via: account
- from: PayinInitiationResponse
  to: PaymentLink
  type: has_one
  via: link
- from: ETBFDApplicationForm
  to: FDApplication
  type: has_one
  via: application
- from: ETBFDApplicationForm
  to: ETBIndividualApplicant
  type: has_one
  via: applicant
- from: ETBFDApplicationForm
  to: FDAccount
  type: has_one
  via: account
- from: FDApplication
  to: Declaration
  type: has_one
  via: declaration
- from: FDApplication
  to: Payin
  type: has_one
  via: payin
- from: Declaration
  to: Nominee
  type: has_one
  via: da1Nomination
- from: FDAccount
  to: FDTenure
  type: has_one
  via: tenure
- from: FDAccount
  to: FDPayout
  type: has_one
  via: payout
- from: ETBFDApplicationStatus
  to: AccountOpeningResult
  type: has_one
  via: accountOpeningResult
- from: AccountOpeningResult
  to: FDAccountOpeningResult
  type: has_many
  via: accounts
- from: ApplicationInitiationRequest
  to: ETBIndividualApplicant
  type: has_one
  via: applicant
- from: ApplicationInitiationRequest
  to: Staff
  type: has_one
  via: staff
- from: ApplicationInitiationResponse
  to: Application
  type: belongs_to
  via: applicationId
- from: Nominee
  to: NomineeAddress
  type: has_one
  via: address
- from: Nominee
  to: Guardian
  type: has_one
  via: guardian
- from: Guardian
  to: GuardianAddress
  type: has_one
  via: address
- from: Application
  to: Staff
  type: has_one
  via: staff
- from: Branch
  to: GeoLocation
  type: has_one
  via: geoLocation
- from: Branch
  to: BranchAddress
  type: has_one
  via: address
- from: Codeset
  to: Code
  type: has_many
  via: codes
- from: OtherBankBranch
  to: BranchAddress
  type: has_one
  via: address
- from: FDMaturityCalculationRequest
  to: AmountWithCurrency
  type: has_one
  via: amount
- from: FDMaturityCalculationRequest
  to: FDTenure
  type: has_one
  via: tenure
- from: Form92828
  to: Application92828
  type: has_one
  via: application
- from: Form92828
  to: ETBIndividualApplicant
  type: has_one
  via: applicant
- from: Form92828
  to: FDAccount
  type: has_one
  via: account
- from: Form92828
  to: RDAccount
  type: has_one
  via: account
- from: Application92828
  to: Initiation
  type: has_one
  via: initiation
- from: Application92828
  to: Payin
  type: has_one
  via: payin
- from: Application92828
  to: Declaration
  type: has_one
  via: declaration
- from: Application92828
  to: BankUse
  type: has_one
  via: bankUse
- from: ApplicationStatus92828
  to: FDAccountOpeningResult
  type: has_one
  via: accountOpeningResult
- from: FDInternalPayout
  to: InternalBankAccount
  type: has_one
  via: interestPayoutAccountNo
- from: FDInternalPayout
  to: InternalBankAccount
  type: has_one
  via: principalPayoutAccountNo
- from: RDAccount
  to: TDS
  type: has_one
  via: tds
- from: RDAccount
  to: RDPayout
  type: has_one
  via: payout
- from: RDPayout
  to: InternalBankAccount
  type: has_one
  via: instrument
- from: RDPayout
  to: ExternalBankAccount
  type: has_one
  via: instrument
- from: RDPayout
  to: ConvertToFD
  type: has_one
  via: instrument
- from: Initiation
  to: Application
  type: belongs_to
  via: applicationId
- from: UPI
  to: ExternalBankAccount
  type: has_one
  via: account
- from: DA1Nomination
  to: Nominee
  type: has_one
  via: nominee