API Reference
DocumentationChangelogConsoleWebsite
  • API Guides
  • Overview
    • API design
    • Errors
    • Webview
    • Fair usage policy
    • Authentication
  • USER CONNECTIONS
    • Users
    • Connectors
    • Connections
  • PRODUCTS
    • DATA AGGREGATION
      • Bank accounts
      • Bank transactions
      • Transactions attachments
      • Categorization
      • Bank account types
      • Balances
      • Currencies
      • Account Ownerships
      • Identities (obsolete)
      • Categories (obsolete)
      • Invoices
      • Credit notes
      • Advisory (obsolete)
      • Indicators
    • WEALTH AGGREGATION
      • Investments
      • Market orders
      • Pockets
      • Loan amortizations
    • DOCUMENTS AGGREGATION
      • Subscriptions
      • Documents
      • Document types
      • Connection Identity
    • PAYMENTS
      • Payments
      • Payment Links
      • Transfers (obsolete)
  • API SETUP
    • Configuration
    • Client applications
Powered by GitBook
On this page
  • API endpoints
  • List document types
  • Data model
  • DocumentTypesList object
  • DocumentType values

Was this helpful?

  1. PRODUCTS
  2. DOCUMENTS AGGREGATION

Document types

API endpoints

List document types

GET https://{domain}.biapi/pro/2.0/documenttypes

Response body: DocumentTypesList object

Data model

DocumentTypesList object

Property
Type
Description

documenttypes

List of document types.

DocumentType values

Value

bill

RIB

statement

contract

notice

report

income_tax (deprecated)

payslip

identity

kiid

other

Forward compatibility requirement: additional types may be added in the future. When implementing type handling, always fallback to a generic case for unknown values.

PreviousDocumentsNextConnection Identity

Last updated 1 year ago

Was this helpful?

Array of strings

DocumentType