本文へ移動

API ドキュメント

v1.0.0

ポートフォリオの照合

POST /api/v1/portfolio/match

スコープ:portfolio:match KvK 番号ごとに 0.1 クレジット

どの KvK 番号が公開された破産に該当するかを確認します。KvK 番号の完全一致のみで、番号は保存されません。

ボディ

ボディ
名前型説明
kvk_numbers 必須

8桁の KvK 番号

string[]8桁の KvK 番号

応答、HTTP 200

応答、HTTP 200

応答、HTTP 200
名前型説明
data 必須 object[]
data[].kvk_number 必須 string
data[].matched 必須 string
data[].cases 必須 string
meta 必須 object
meta.numbers 必須 integer
meta.matched 必須 integer
meta.credits 必須 number

応答、HTTP 422

Validation error

応答、HTTP 422

応答、HTTP 422
名前型説明
error 必須 object
error.code 必須

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message 必須

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

応答のフィールドは openapi.json に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書