銀行通帳データ抽出 API

銀行通帳の画像・スキャン・PDFから取引明細データを抽出し、構造化されたJSON形式で返します

概要

Base URL: https://ai.transmit.work/v1
認証方式: Bearer Token
レスポンス形式: JSON

認証

APIキーを使用した認証

すべてのリクエストには認証ヘッダーが必須です（以下のいずれか）

方法1: Authorization ヘッダー（推奨）

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.jpg" \
  /passbook/api

方法2: X-API-Key ヘッダー

curl -X POST \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.jpg" \
  /passbook/api

エンドポイント

POST/passbook/api

銀行通帳の画像・スキャン・PDFから取引明細データを抽出し、構造化されたJSON形式で返します

Content-Type

multipart/form-data

最大ファイルサイズ

10MB

対応フォーマット

JPG, PNG, JPEG, PDF

通帳データ抽出

銀行通帳の画像・スキャン・PDFから構造化データを抽出し、構造化されたJSONで返します

リクエストパラメータ

filerequired

画像またはPDFファイル（multipart/form-data）
対応形式: JPG, PNG, JPEG, PDF

レスポンス例

成功（200）

{
  "success": true,
  "data": {
    "account": {
      "bank_name": "三菱UFJ銀行",
      "bank_code": "0005",
      "branch_name": "渋谷支店",
      "branch_code": "150",
      "account_type": "普通",
      "account_number": "1234567",
      "account_holder": "山田 太郎",
      "account_holder_kana": "ヤマダ タロウ"
    },
    "period": {
      "start_date": "2025-01-05",
      "end_date": "2025-02-28",
      "opening_balance": 1250000,
      "closing_balance": 1485000
    },
    "transactions": [
      {
        "date": "2025-01-10",
        "description": "給与 カ）サンプルカイシャ",
        "deposit": 350000,
        "withdrawal": null,
        "balance": 1600000,
        "branch_name": null,
        "transaction_type": "振込"
      },
      {
        "date": "2025-01-15",
        "description": "家賃 ヤマダフドウサン",
        "deposit": null,
        "withdrawal": 120000,
        "balance": 1480000,
        "branch_name": null,
        "transaction_type": "振替"
      },
      {
        "date": "2025-01-25",
        "description": "電気代 トウキョウデンリョク",
        "deposit": null,
        "withdrawal": 8500,
        "balance": 1471500,
        "branch_name": null,
        "transaction_type": "引落"
      }
    ],
    "summary": {
      "total_deposits": 350000,
      "total_withdrawals": 128500,
      "transaction_count": 3,
      "net_change": 221500
    },
    "fieldConfidence": {
      "account.bank_name": 0.95,
      "account.branch_name": 0.92,
      "account.account_number": 0.94,
      "transactions": 0.88,
      "summary.total_deposits": 0.9
    },
    "metadata": {
      "fileName": "passbook_scan.jpg",
      "fileSize": 524288,
      "processingTimeMs": 4200,
      "extractedAt": "2025-02-10T15:35:20.123Z",
      "pageCount": null
    }
  }
}

エラー

{
  "success": false,
  "error": {
    "code": "EXTRACTION_FAILED",
    "message": "データ抽出に失敗しました",
    "details": "通帳画像の処理中にエラーが発生しました",
    "level": "error"
  }
}

フィールド説明

口座情報

銀行口座の基本情報

account.bank_name

string

銀行名

通帳に記載された銀行名

account.bank_code

string

銀行コード

銀行の識別コード（4桁）

account.branch_name

string

支店名

口座の支店名

account.branch_code

string

支店コード

支店の識別コード（3桁）

account.account_type

string

口座種別

普通、当座、貯蓄等

account.account_number

string

口座番号

口座の識別番号

account.account_holder

string

口座名義人

口座の名義人名

account.account_holder_kana

string

口座名義人（カナ）

口座名義人のカタカナ表記

記帳期間

通帳の記帳期間に関する情報

period.start_date

string

開始日

記帳期間の開始日（YYYY-MM-DD形式）

period.end_date

string

終了日

記帳期間の終了日（YYYY-MM-DD形式）

period.opening_balance

number

期首残高

記帳期間開始時点の残高

period.closing_balance

number

期末残高

記帳期間終了時点の残高

取引明細

各取引の詳細情報

transactions[].date

string

取引日

取引が行われた日付（YYYY-MM-DD形式）

transactions[].description

string

摘要

取引内容・相手先名

transactions[].deposit

number

入金額

お預り金額（入金の場合）

transactions[].withdrawal

number

出金額

お支払金額（出金の場合）

transactions[].balance

number

残高

取引後の差引残高

transactions[].transaction_type

string

取引種別

振込、振替、引落、入金、出金、利息等

集計情報

取引の集計データ

summary.total_deposits

number

入金合計

期間内の入金総額

summary.total_withdrawals

number

出金合計

期間内の出金総額

summary.transaction_count

number

取引件数

期間内の取引総数

summary.net_change

number

純増減額

入金合計 - 出金合計

品質指標とメタデータ

抽出精度とファイル処理情報

fieldConfidence

object

フィールド信頼度

各フィールドの抽出信頼度（0-1のスコア）

metadata.extractedAt

string

抽出日時

ISO 8601形式のタイムスタンプ

metadata.fileName

string

ファイル名

アップロードされたファイル名

metadata.fileSize

number

ファイルサイズ

ファイルサイズ（バイト単位）

metadata.processingTimeMs

number

処理時間

処理にかかった時間（ミリ秒単位）

metadata.pageCount

number

ページ数

PDFの場合のページ数

エラーコード

INVALID_FILE_FORMAT

ファイル形式がサポートされていません

対応形式: JPG, PNG, JPEG

FILE_TOO_LARGE

ファイルサイズが大きすぎます

最大サイズ: 2MB

EXTRACTION_FAILED

データ抽出に失敗しました

PDFの処理中にエラーが発生しました

LOW_QUALITY

画像品質が低すぎます

より鮮明な画像を提供してください

APIキーの発行をご希望の方

まずはご登録でお試しいただけます

デモを試すお問い合わせ