generated: '2026-10-14' method: derived generator: derive-vocabulary.py source: openapi/inscribe-core-resources-openapi.yml vocabulary: name: Inscribe Domain Vocabulary description: 'Terms declared by Inscribe''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-14' terms: - term: Bank Accounts definition: Bank account objects are created to store bank account data. These objects describe characteristics of bank accounts, such as the account name, number, and type. You can get and list bank accounts using these endpoints. Bank accounts are identified by an id. tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: Collect Sessions definition: Collect sessions allow you to automate each step of your document collection process, from customer contact to fraud checks and verification. Sessions are identified by an id. tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: Credit Insights definition: Credit Insights provides inferred creditworthiness datapoints relating to a specific customer or bank account. tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: Customers definition: Customer objects are created to easily track and store documents. You can create, get, update, delete, and list your customers. Customers are identified by an id. tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: Documents definition: Document objects are created to store a document. You can create, get, delete, and list your documents against a customer. Documents are identified by an id. tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: Open Banking definition: 'This endpoint allows you to associate open banking data with an Inscribe customer. There are 2 types of open banking data supported: Plaid and MX. Credit insights for this customer are then generated from this data.' tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: Transactions definition: Transaction objects are created to store transaction data. These objects describe characteristics of transactions, such as the date, amount, description, and category. You can list all of your transactions using these endpoints. Transactions are identified by an id. tags: - Resource Group source: openapi/inscribe-core-resources-openapi.yml - term: BankAccountData definition: The bank account data tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BankAccountData - term: metadata_transactions_accounts definition: Additional data which provides context about Inscribe's Credit Insights response. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/metadata_transactions_accounts - term: ListBankAccounts definition: 'Object declared by the contract with fields: data, pagination, metadata.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/ListBankAccounts - term: Error definition: 'Object declared by the contract with fields: message.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Error - term: BankAccount definition: A bank account object which contains information about the bank account. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BankAccount - term: BaseCollectSession definition: 'Object declared by the contract with fields: id, url, customer_id, created_at, completed_at, success_url, cancel_url, logo_url, display_name, expired.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BaseCollectSession - term: Tag definition: 'Object declared by the contract with fields: id, value.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Tag - term: DocumentRequest definition: 'Object declared by the contract with fields: id, label, max_documents, verify, tags.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/DocumentRequest - term: CollectSession definition: 'Object declared by the contract with fields: document_requests.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CollectSession - term: UploadTag definition: 'Object declared by the contract with fields: text.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/UploadTag - term: VerificationsRequest definition: 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. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/VerificationsRequest - term: CreateDocumentRequest definition: 'Object declared by the contract with fields: label, description, max_documents, tags, verify.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CreateDocumentRequest - term: CollectSessionCreateRequest definition: 'Object declared by the contract with fields: customer, document_requests, success_url, cancel_url, send_email.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CollectSessionCreateRequest - term: CollectSessions definition: 'Object declared by the contract with fields: data, metadata.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CollectSessions - term: Review definition: Represents a manual review decision. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Review - term: DocumentCompact definition: 'Object declared by the contract with fields: uuid, id, name, created_at, customer_id, customer_name, state, total_pages, document_type, subtypes, file_type, language. (7 more)' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/DocumentCompact - term: Address definition: The structured address. Any or all of these fields can be empty tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Address - term: ParsedAmount definition: 'Object declared by the contract with fields: raw, normalized, confidence.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/ParsedAmount - term: ProfitAndLoss definition: A list of financial statements found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/ProfitAndLoss - term: Taxform1040 definition: A list of U.S. Form 1040 (Individual Income Tax Return) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1040 - term: Taxform1065 definition: A list of U.S. Form 1065 (Partnership Return) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1065 - term: Taxform1120 definition: A list of U.S. Form 1120 (Corporation Income Tax Return) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1120 - term: TaxformW2 definition: A list of U.S. Form W-2, Wage and Tax statements found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/TaxformW2 - term: TaxformW9 definition: A list of U.S. Form W-9 (Request for Taxpayer Identification Number and Certification) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/TaxformW9 - term: Taxform1040ScheduleC definition: A list of U.S. Form 1040 Schedule C (Profit or Loss from Business) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1040ScheduleC - term: Taxform1120s definition: A list of U.S. Form 1120-S (Income Tax Return for an S Corporation) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1120s - term: Taxform1099Misc definition: A list of U.S. Form 1099-MISC (Miscellaneous Income) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1099Misc - term: Taxform1099NEC definition: A list of U.S. Form 1099-NEC (Non-Employee Compensation) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Taxform1099NEC - term: TaxformCP575 definition: A list of U.S. Letter CP-575 (EIN Confirmation Letter) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/TaxformCP575 - term: TaxformLTR147C definition: A list of U.S. Letter 147C (EIN Verification Letter) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/TaxformLTR147C - term: TaxformSS4 definition: A list of U.S. Form SS-4 (Application for Employer Identification Number) found in the document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/TaxformSS4 - term: Invoices definition: An array of invoices found in the document. Currently, only the first invoice present in a document is returned. If the document isn't of type `INVOICE`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire abo tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Invoices - term: BusinessFilings definition: An array of business filings found in the document. Currently, only the first business filing present in a document is returned. If the document isn't of type `BUSINESS_FILING` and of one of the subtypes `CERTIFICATE_OF_INCORPORATION`, `ARTICLES_OF_INCORPORATION`, `CERTIFICATE_OF_FORMATION`, `ARTICLES_OF_ORGANIZATION`, `CERTIFICATE_OF_ORGANIZATION`, `PARTNERSHIP_AGREEMENT`, `CERTIFICATE_OF_GOOD_ST tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BusinessFilings - term: UtilityBills definition: An array of utility bills found in the document. Currently, only the first utility bill present in a document is returned. If the document isn't of type `UTILITY_BILL`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/UtilityBills - term: BenefitsStatements definition: An array of income amounts parsed from a benefits statement. Currently, only the first set of amounts present in a document is returned. If the document isn't of type `BENEFITS_STATEMENT`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact I tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BenefitsStatements - term: AdvancedDocumentRequest definition: 'Object declared by the contract with fields: documents.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/AdvancedDocumentRequest - term: AdvancedCollectSession definition: 'Object declared by the contract with fields: document_requests.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/AdvancedCollectSession - term: CreditSummaryStatistics definition: Summary statistics that contain inferred creditworthiness and income information (based on the submitted customer documents and transactions). tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CreditSummaryStatistics - term: metadata_insights definition: Additional data which provides context about Inscribe's Credit Insights response. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/metadata_insights - term: CustomerCreditAnalysis definition: 'Object declared by the contract with fields: summary_statistics, bank_accounts, metadata, confidence_score, customer_contains_low_trust_documents.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerCreditAnalysis - term: BankAccountCreditSummaryStatistics definition: Summary statistics that contain inferred creditworthiness and income information (based on the submitted customer documents and transactions). tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BankAccountCreditSummaryStatistics - term: BankAccountCreditAnalysis definition: 'Object declared by the contract with fields: summary_statistics, metadata, confidence_score, customer_contains_low_trust_documents.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BankAccountCreditAnalysis - term: BasicBankAccountCreditAnalysisCashflowInsights definition: Insights about cashflow and balances specific to the listed bank account. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BasicBankAccountCreditAnalysisCashflowInsights - term: CustomerCreditAnalysisCashflowInsights definition: Insights about cashflow and balances (aggregated at both the customer and bank account levels). tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerCreditAnalysisCashflowInsights - term: CreditAnalysisExpenditureInsights definition: 'Object declared by the contract with fields: total_spend, spend_by_vendor, spend_by_payment_processor, spend_by_category, metadata, confidence_score.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CreditAnalysisExpenditureInsights - term: CreditAnalysisIncomeInsights definition: 'Object declared by the contract with fields: personal_income, revenue, metadata, confidence_score.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CreditAnalysisIncomeInsights - term: CreditAnalysisLoanInsights definition: 'Object declared by the contract with fields: count_loan_repayments, total_loan_repayments, count_loan_disbursements, total_loan_disbursements, loans, metadata, confidence_score.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CreditAnalysisLoanInsights - term: CreditAnalysisRiskInsights definition: Insights about risk specific to the listed customer or bank account. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CreditAnalysisRiskInsights - term: CustomerInsight definition: A customer-level insight derived from a customer fraud signal or a verification. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerInsight - term: CustomerRiskAssessment definition: Contains customer risk assessment data, including risk indicators and related insights. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerRiskAssessment - term: Person definition: Person associated with the customer record tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Person - term: Persons definition: List of persons associated with the customer record tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Persons - term: Company definition: The company associated with the customer record tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Company - term: CustomerFraudRating definition: The fraud rating of the customer. This field can be either 'HIGH_RISK', 'LOW_RISK', 'UNCERTAIN_RISK', or null. More information can be found at https://help.inscribe.ai/en/articles/8631969-fraud-rating tags: - Enumeration source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerFraudRating - term: CanonicalItem definition: A single canonical value extracted for a customer, along with the kind of source it was derived from. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CanonicalItem - term: CanonicalAddress definition: A canonical address derived for a customer, along with the kind of source it was extracted from. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CanonicalAddress - term: CanonicalProfile definition: Structured profile information aggregated from documents and verification sources for this customer. Each value carries the kind of source it was derived from. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CanonicalProfile - term: BusinessComplianceAnalystCanonicalProfile definition: 'Object declared by the contract with fields: legal_name, address, address_city, address_state, address_country, phone_number, company_structure, business_type, business_description, ownership_structure, beneficial_owners, source_of_funds_claim. (1 more)' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BusinessComplianceAnalystCanonicalProfile - term: BusinessComplianceAnalystBeneficialOwnerCheck definition: 'Object declared by the contract with fields: beneficial_owner_full_name, checks.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BusinessComplianceAnalystBeneficialOwnerCheck - term: BusinessComplianceAnalystOutput definition: 'Object declared by the contract with fields: result, analysis, canonical_profile, company_checks, beneficial_owner_checks.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BusinessComplianceAnalystOutput - term: BusinessComplianceAnalyst definition: 'AI-powered Business Compliance Analyst results that perform deep KYB due diligence on the company and its associated individuals. NOTE: This feature requires explicit access. Please contact your Customer Success Manager or sales@inscribe.ai to enable this feature.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/BusinessComplianceAnalyst - term: VerifyEntityRequest definition: Entities that are requested to be verified. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/VerifyEntityRequest - term: CustomerCreateRequest definition: 'Object declared by the contract with fields: name, approved, review, notes, persons, company, verify_entity.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerCreateRequest - term: VerifyEntityResponse definition: Entities that have been requested to be verified. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/VerifyEntityResponse - term: Customer definition: 'Object declared by the contract with fields: id, name, created_at, approved, review, notes, no_of_documents, no_of_fraudulent_documents, urls, creator, organisation, risk_assessment. (6 more)' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/Customer - term: CustomerWithoutVerifications definition: 'Object declared by the contract with fields: id, name, created_at, approved, review, notes, no_of_documents, no_of_fraudulent_documents, urls, creator, organisation, risk_assessment. (5 more)' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerWithoutVerifications - term: CustomerUpdateRequest definition: 'Object declared by the contract with fields: name, approved, review, notes, verify_entity, company.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/CustomerUpdateRequest - term: UploadDocuments definition: 'Object declared by the contract with fields: data.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/UploadDocuments - term: ListDocuments definition: 'Object declared by the contract with fields: data, metadata.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/ListDocuments - term: VerificationRequestPluralizedFormsOnly definition: Optional information to be verified against a document. tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/VerificationRequestPluralizedFormsOnly - term: DocumentUpdateRequest definition: 'Object declared by the contract with fields: tags, review_status, review, verify_entity.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/DocumentUpdateRequest - term: InscribeOpenBankingDataUploadRequest definition: 'Object declared by the contract with fields: start_date, end_datetime, accounts.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/InscribeOpenBankingDataUploadRequest - term: OpenBankingData definition: 'Object declared by the contract with fields: id, created_at, state, no_of_bank_accounts.' tags: - Object source: openapi/inscribe-core-resources-openapi.yml#/components/schemas/OpenBankingData