generated: '2026-10-14'
method: derived
generator: derive-data-model.py
source:
- openapi/inscribe-core-resources-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 66
  entities_in_spec: 66
  relationships: 63
entities:
- name: Address
  fields: 6
  description: The structured address. Any or all of these fields can be empty
- name: AdvancedCollectSession
  fields: 1
- name: AdvancedDocumentRequest
  fields: 1
- name: BankAccount
  fields: 2
  description: A bank account object which contains information about the bank account.
- name: BankAccountCreditAnalysis
  fields: 4
- name: BankAccountCreditAnalysisCashflowInsights
  fields: 0
- name: BankAccountCreditSummaryStatistics
  fields: 17
  description: Summary statistics that contain inferred creditworthiness and income information (based on the submitted
    customer documents and transactions).
- name: BankAccountData
  fields: 8
  description: The bank account data
- name: BaseCollectSession
  fields: 10
- name: BasicBankAccountCreditAnalysisCashflowInsights
  fields: 20
  description: Insights about cashflow and balances specific to the listed bank account.
- name: BusinessComplianceAnalyst
  fields: 6
  description: AI-powered Business Compliance Analyst results that perform deep KYB due diligence on the company
    and its associated individuals.
- name: BusinessComplianceAnalystBaseCheck
  fields: 0
- name: BusinessComplianceAnalystBeneficialOwnerCheck
  fields: 2
- name: BusinessComplianceAnalystCanonicalProfile
  fields: 13
- name: BusinessComplianceAnalystCompanyCheck
  fields: 0
- name: BusinessComplianceAnalystOutput
  fields: 5
- name: CanonicalAddress
  fields: 6
  description: A canonical address derived for a customer, along with the kind of source it was extracted from.
- name: CanonicalItem
  fields: 2
  description: A single canonical value extracted for a customer, along with the kind of source it was derived from.
- name: CanonicalProfile
  fields: 2
  description: Structured profile information aggregated from documents and verification sources for this customer.
    Each value carries the kind of source it was derived from.
- name: CollectSession
  fields: 1
- name: CollectSessionCreateRequest
  fields: 5
- name: CollectSessions
  fields: 2
- name: Company
  fields: 7
  description: The company associated with the customer record
- name: CreateDocumentRequest
  fields: 5
- name: CreditAnalysisExpenditureInsights
  fields: 6
- name: CreditAnalysisIncomeInsights
  fields: 4
- name: CreditAnalysisLoanInsights
  fields: 7
- name: CreditAnalysisRiskInsights
  fields: 17
  description: Insights about risk specific to the listed customer or bank account.
- name: CreditSummaryStatistics
  fields: 16
  description: Summary statistics that contain inferred creditworthiness and income information (based on the submitted
    customer documents and transactions).
- name: Customer
  fields: 18
- name: CustomerCreateRequest
  fields: 7
- name: CustomerCreditAnalysis
  fields: 5
- name: CustomerCreditAnalysisCashflowInsights
  fields: 20
  description: Insights about cashflow and balances (aggregated at both the customer and bank account levels).
- name: CustomerInsight
  fields: 9
  description: A customer-level insight derived from a customer fraud signal or a verification.
- name: CustomerRiskAssessment
  fields: 7
  description: Contains customer risk assessment data, including risk indicators and related insights.
- name: CustomerUpdateRequest
  fields: 6
- name: CustomerWithoutVerifications
  fields: 17
- name: Customers
  fields: 2
- name: Document
  fields: 0
- name: DocumentCompact
  fields: 19
- name: DocumentRequest
  fields: 5
- name: DocumentUpdateRequest
  fields: 4
- name: Error
  fields: 1
- name: Health
  fields: 2
  description: Response for the reachability check endpoint
- name: InscribeOpenBankingDataUploadRequest
  fields: 3
- name: ListBankAccounts
  fields: 3
- name: ListDocuments
  fields: 2
- name: ListOpenBankingData
  fields: 2
- name: ListTransactions
  fields: 3
- name: MXAggregatedDataUploadRequest
  fields: 2
- name: OpenBankingData
  fields: 4
- name: ParsedAmount
  fields: 3
- name: Person
  fields: 7
  description: Person associated with the customer record
- name: PlaidAssetsUploadRequest
  fields: 3
- name: Review
  fields: 3
  description: Represents a manual review decision.
- name: Tag
  fields: 2
- name: Transaction
  fields: 11
  description: A transaction object which contains information about the transaction.
- name: TransactionCategories
  fields: 1
- name: UploadDocuments
  fields: 1
- name: UploadTag
  fields: 1
- name: VerificationRequestPluralizedFormsOnly
  fields: 7
  description: Optional information to be verified against a document.
- name: VerificationsRequest
  fields: 11
  description: Optional information to be verified against a document. If supplied there must be exactly one entry
    for each document, an entry can be blank if no information is to be verified.
- name: VerifyEntityRequest
  fields: 1
  description: Entities that are requested to be verified.
- name: VerifyEntityResponse
  fields: 1
  description: Entities that have been requested to be verified.
- name: metadata_insights
  fields: 5
  description: Additional data which provides context about Inscribe's Credit Insights response.
- name: metadata_transactions_accounts
  fields: 4
  description: Additional data which provides context about Inscribe's Credit Insights response.
relationships:
- from: ListBankAccounts
  to: BankAccountData
  type: has_many
  via: data
- from: ListBankAccounts
  to: metadata_transactions_accounts
  type: has_one
  via: metadata
- from: BankAccount
  to: BankAccountData
  type: has_one
  via: data
- from: BankAccount
  to: metadata_transactions_accounts
  type: has_one
  via: metadata
- from: BaseCollectSession
  to: Customer
  type: belongs_to
  via: customer_id
- from: DocumentRequest
  to: Tag
  type: has_many
  via: tags
- from: CollectSession
  to: DocumentRequest
  type: has_many
  via: document_requests
- from: CreateDocumentRequest
  to: UploadTag
  type: has_many
  via: tags
- from: CreateDocumentRequest
  to: VerificationsRequest
  type: has_one
  via: verify
- from: CollectSessionCreateRequest
  to: CreateDocumentRequest
  type: has_many
  via: document_requests
- from: CollectSessions
  to: CollectSession
  type: has_many
  via: data
- from: DocumentCompact
  to: Customer
  type: belongs_to
  via: customer_id
- from: DocumentCompact
  to: Review
  type: has_one
  via: review
- from: Document
  to: Tag
  type: has_many
  via: tags
- from: AdvancedDocumentRequest
  to: Document
  type: has_many
  via: documents
- from: AdvancedCollectSession
  to: AdvancedDocumentRequest
  type: has_many
  via: document_requests
- from: CustomerCreditAnalysis
  to: CreditSummaryStatistics
  type: has_one
  via: summary_statistics
- from: CustomerCreditAnalysis
  to: metadata_insights
  type: has_one
  via: metadata
- from: BankAccountCreditAnalysis
  to: BankAccountCreditSummaryStatistics
  type: has_one
  via: summary_statistics
- from: BankAccountCreditAnalysis
  to: metadata_insights
  type: has_one
  via: metadata
- from: CustomerCreditAnalysisCashflowInsights
  to: metadata_insights
  type: has_one
  via: metadata
- from: BankAccountCreditAnalysisCashflowInsights
  to: metadata_insights
  type: has_one
  via: metadata
- from: CreditAnalysisExpenditureInsights
  to: metadata_insights
  type: has_one
  via: metadata
- from: CreditAnalysisIncomeInsights
  to: metadata_insights
  type: has_one
  via: metadata
- from: CreditAnalysisLoanInsights
  to: metadata_insights
  type: has_one
  via: metadata
- from: CreditAnalysisRiskInsights
  to: metadata_insights
  type: has_one
  via: metadata
- from: CustomerRiskAssessment
  to: CustomerInsight
  type: has_many
  via: insights
- from: Person
  to: Address
  type: has_one
  via: address
- from: Company
  to: Address
  type: has_one
  via: address
- from: BusinessComplianceAnalystCompanyCheck
  to: BusinessComplianceAnalystBaseCheck
  type: has_many
  via: sub_checks
- from: BusinessComplianceAnalystBeneficialOwnerCheck
  to: BusinessComplianceAnalystBaseCheck
  type: has_many
  via: checks
- from: BusinessComplianceAnalystOutput
  to: BusinessComplianceAnalystCanonicalProfile
  type: has_one
  via: canonical_profile
- from: BusinessComplianceAnalystOutput
  to: BusinessComplianceAnalystCompanyCheck
  type: has_many
  via: company_checks
- from: BusinessComplianceAnalystOutput
  to: BusinessComplianceAnalystBeneficialOwnerCheck
  type: has_many
  via: beneficial_owner_checks
- from: BusinessComplianceAnalyst
  to: Customer
  type: belongs_to
  via: customer_id
- from: BusinessComplianceAnalyst
  to: BusinessComplianceAnalystOutput
  type: has_one
  via: output
- from: CustomerCreateRequest
  to: Review
  type: has_one
  via: review
- from: CustomerCreateRequest
  to: Person
  type: has_many
  via: persons
- from: CustomerCreateRequest
  to: Company
  type: has_one
  via: company
- from: CustomerCreateRequest
  to: VerifyEntityRequest
  type: has_one
  via: verify_entity
- from: Customer
  to: Review
  type: has_one
  via: review
- from: Customer
  to: CustomerRiskAssessment
  type: has_one
  via: risk_assessment
- from: Customer
  to: Company
  type: has_one
  via: company
- from: Customer
  to: VerifyEntityResponse
  type: has_one
  via: verify_entity
- from: Customer
  to: CanonicalProfile
  type: has_one
  via: canonical_profile
- from: Customer
  to: BusinessComplianceAnalyst
  type: has_one
  via: business_compliance_agent_v1
- from: CustomerWithoutVerifications
  to: Review
  type: has_one
  via: review
- from: CustomerWithoutVerifications
  to: CustomerRiskAssessment
  type: has_one
  via: risk_assessment
- from: CustomerWithoutVerifications
  to: Company
  type: has_one
  via: company
- from: CustomerWithoutVerifications
  to: CanonicalProfile
  type: has_one
  via: canonical_profile
- from: CustomerWithoutVerifications
  to: BusinessComplianceAnalyst
  type: has_one
  via: business_compliance_agent_v1
- from: Customers
  to: CustomerWithoutVerifications
  type: has_many
  via: data
- from: CustomerUpdateRequest
  to: Review
  type: has_one
  via: review
- from: CustomerUpdateRequest
  to: VerifyEntityRequest
  type: has_one
  via: verify_entity
- from: CustomerUpdateRequest
  to: Company
  type: has_one
  via: company
- from: UploadDocuments
  to: DocumentCompact
  type: has_many
  via: data
- from: ListDocuments
  to: Document
  type: has_many
  via: data
- from: DocumentUpdateRequest
  to: UploadTag
  type: has_many
  via: tags
- from: DocumentUpdateRequest
  to: Review
  type: has_one
  via: review
- from: DocumentUpdateRequest
  to: VerificationRequestPluralizedFormsOnly
  type: has_one
  via: verify_entity
- from: ListOpenBankingData
  to: OpenBankingData
  type: has_many
  via: data
- from: ListTransactions
  to: Transaction
  type: has_many
  via: data
- from: ListTransactions
  to: metadata_transactions_accounts
  type: has_one
  via: metadata