契約書 OCR 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" \
  /contract/api

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

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

エンドポイント

POST/contract/api

契約書PDFから支払金額・支払期日・支払方法などの支払情報を抽出し、構造化されたJSON形式で返します

Content-Type

multipart/form-data

最大ファイルサイズ

10MB

対応フォーマット

PDF, JPG, PNG, JPEG

契約書データ抽出

契約書PDFから支払情報を中心に構造化データを抽出し、構造化されたJSONで返します

リクエストパラメータ

filerequired

契約書ファイル(multipart/form-data)
対応形式: PDF, JPG, PNG, JPEG

レスポンス例

成功(200)

{
  "success": true,
  "data": {
    "contract": {
      "contract_title": "業務委託契約書",
      "contract_party_a": "株式会社サ��プル",
      "contract_party_b": "合同会社テスト",
      "contract_date": "2025-04-01",
      "contract_start_date": "2025-04-01",
      "contract_end_date": "2026-03-31",
      "subject": "Webシステムの開発および保守運用業務",
      "notes": null
    },
    "payment": {
      "fee_amount": 500000,
      "tax_amount": 50000,
      "tax_rate": 10,
      "total_amount": 550000,
      "payment_method": "銀行振込",
      "payment_cycle": "月額",
      "closing_day": "月末",
      "payment_due": "翌月末日"
    },
    "bank_transfer": {
      "bank_name": "○○銀行",
      "branch_name": "△△支店",
      "account_type": "普通預金",
      "account_number": "1234567",
      "account_holder_kana": "ゴウドウガイシャテスト"
    },
    "extractedAt": "2025-04-10T15:35:20.123Z",
    "averageConfidence": 0.94
  }
}

エラー

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

フィールド説明

支払情報(payment)
契約書の報酬・委託料・支払条件に関する情報(主要な抽出対象)
fee_amount

number

金額

委��料/報酬の金額(税抜、日本円)

tax_amount

number

消費税額

消費税額(日本円)

tax_rate

number

消費税率

消費税率(数値、例:10)

total_amount

number

税込総額

税込の合計金額(日本円)

payment_method

string

支払方法

支払方法

銀行振込口座振替現金その他
payment_cycle

string

支払サイクル

支払サイクル

月額一括出来高その他
closing_day

string

締日

締日(例:「月末」「毎月末日」)

payment_due

string

支払期日

支払期日(例:「翌月末日」「請求書受領後30日以内」)

契約情報(contract)
契約書の基本情報と契約当事者
contract_title

string

契約書名

契約書のタイトル(例:「業務委託契約書」)

contract_party_a

string

甲(委託者)

甲(委託者/発注者)の名称

contract_party_b

string

乙(受託者)

乙(受託者/受注者)の名称

contract_date

string

契約締結日

YYYY-MM-DD形式の契約締結日

contract_start_date

string

契約開始日

YYYY-MM-DD形式の契約/委託期間の開始日

contract_end_date

string

契約終了日

YYYY-MM-DD形式の契約/委託期間の終了日

subject

string

業務内容

業務内容/委託業務の概要

notes

string

備考

その他支払いに関する特記事項

振込先情報(bank_transfer)
振込先口座の記載がある場合のみ出力(無い場合は null)
bank_name

string

銀行名

振込先銀行名

branch_name

string

支店名

振込先支店名

account_type

string

口座種別

口座種別

普通預金当座預金貯蓄預金その他
account_number

string

口座番号

振込先口座番号

account_holder_kana

string

口座名義人(カタカナ)

振込先口座名義人

エラーコード

INVALID_FILE_FORMAT

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

対応形式: JPG, PNG, JPEG

FILE_TOO_LARGE

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

最大サイズ: 2MB

EXTRACTION_FAILED

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

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

LOW_QUALITY

画像品質が低すぎます

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

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

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