シンプルな統合
1つのエンドポイント。構造化された JSON。
PDF を POST するだけ。クリーンで構造化された取引データが返ってきます。すべてのレスポンスには銀行名、明細期間、そして正規化された日付・説明・出金・入金・残高フィールドを含む完全な取引配列が含まれます。
- ✓すべての銀行で一貫したフィールド名
- ✓欠落した出金/入金には null 値(曖昧さなし)
- ✓ISO 日付形式の出力
- ✓銀行名と期間を自動検出
- ✓利用状況追跡のためのページ数を含む
POST /api/v1/convert
Authorization: Bearer {API_KEY}
Content-Type: multipart/form-data
# Response: 200 OK
{
"bankName": "HSBC",
"accountNumber": "1234 5678",
"period": "Jan 2025, Mar 2025",
"pageCount": 3,
"transactionCount": 2,
"reconciliation": {
"verified": true,
"status": "ok",
"opening": 2384.21,
"closing": 6841.22,
"expectedClosing": 6841.22,
"difference": 0,
"totalIn": 4500.00,
"totalOut": 42.99
},
"transactions": [
{
"date": "2025-01-03",
"description": "AMAZON.CO.UK",
"debit": 42.99,
"credit": null,
"balance": 2341.22
},
{
"date": "2025-01-07",
"description": "SALARY - ACME LTD",
"debit": null,
"credit": 4500.00,
"balance": 6841.22
}
]
}呼び出し方
Pro を契約する
API の利用には有効な Pro 契約が必要です。ほかのアカウントの鍵はエンドポイントが拒否します。
API キーを作る
アカウントページで発行します。表示は一度きりで、保存されるのはハッシュだけです。
PDF を POST する
Authorization: Bearer ヘッダーを付けて /api/v1/convert に PDF を送ります。"file" フィールドの multipart form-data でも、application/pdf のボディでも構いません。上限は 15 MB です。
JSON を読む
200 応答は bankName、accountNumber、period、pageCount、transactionCount、reconciliation オブジェクト、そして date・description・debit・credit・balance を持つ transactions 配列を返します。
API の利用者
会計ソフトウェア統合
クライアントの PDF を自社システムに送信し、Xero、QuickBooks、Sage の元帳に直接転記できる構造化された JSON を受け取ります, 手動での再入力は不要。
フィンテック・融資
ローン申請の支払い能力分析を自動化。申請者の3〜12か月分の明細を数秒で解析し、収入、定期的な支払い義務、残高の推移を抽出します。
エンタープライズ自動化
銀行明細書の解析を社内ワークフローに統合, コンプライアンスチェック、経費処理、監査サポート、カスタム財務ダッシュボードなど。
料金モデル
明細書ごとの支払い
利用条件
Pro に含まれます
対応銀行
1000以上
The API is a Pro feature
Upgrade to Pro to create API keys and convert statements programmatically.
Upgrade to ProAPI の使い方
認証はどうしますか。
キーをベアラートークンとして送ってください。Authorization: Bearer pvb_live_... キーはこのページで発行・失効できます。エンドポイントには有効な Pro のご契約が必要で、Pro でないアカウントの有効なキーは 403 で拒否されます。
PDF はどう送りますか。
multipart/form-data の "file" という名前のフィールドに入れるか、Content-Type: application/pdf で生のリクエストボディとして送ります。同じエンドポイントがどちらも受け付けます。上限は 15 MB で、ボディを読む前に宣言された長さで判定するため、大きすぎるファイルは転送されずに 413 で拒否されます。
何が返ってきますか。
ひとつの JSON オブジェクトです。明細から検出した bankName、accountNumber、period、pageCount に加えて、transactionCount と transactions 配列が入ります。各取引には日付、摘要と debit、credit、balance のフィールドがあり、列が本当に存在しない場合はゼロではなく null になります。
スキャンした明細も読めますか。
読めません。API がウェブアプリより狭いのはここだけです。ブラウザはスキャンに OCR をかけますが、API はテキストレイヤーのみを解析し、使えるテキストがない明細は 422 を返してデジタルの PDF を求めます。入力にスキャンが含まれる場合は、それだけブラウザで変換するか、ご相談ください。
エラーコードの意味を教えてください。
401 はキーが無い、無効、または失効。403 は有効なキーだがアカウントが Pro でない。400 はボディが読める PDF ではない。413 は 15 MB 超過。422 は PDF は解析できたが使えるテキストが得られなかった場合で、実際にはスキャンを意味します。
利用量はどう数えますか。
成功した呼び出しごとに1件の変換として、ページ数とともにアカウントに記録されます。ブラウザでの変換と同じ扱いです。エラーになった呼び出しは数えません。
大量利用・エンタープライズ
大量に変換されますか。
API はすでに提供中で、Pro のご契約に含まれています。上でキーを作成すれば、そのまま明細を送信できます。順番待ちはありません。
大量に変換される場合、個別の料金が必要な場合、あるいは実装前に連携について相談したい場合は、ご連絡ください。
