Skip to content

/

契約書情報を取得

LegalOn API (1.1.0)

API documentation for LegalOn services

Servers

サーバーのURLは `{api_base_url}/rest/v1` です。アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。

https://{api_base_url_without_scheme}/rest/v1

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ワークスペース

ユーザーの閲覧権限によらず、テナント内のすべてのワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

契約書の作成・取得・更新・削除などの操作を提供します。ワークスペースを対象とする操作では、共通の「ワークスペース」（GET /workspaces）で取得した workspace_id を指定してください。

Operations

契約書を作成

Request

契約書ファイルをアップロードして、指定したワークスペース/フォルダに契約書を作成します。AI解析（メタデータ抽出・プレビュー生成）は非同期で実行されます。

Security

OAuth2ClientCredentials

Bodymultipart/form-datarequired

契約書作成リクエスト。document_status_code を未指定にすると契約書ステータスなしで作成する。これは NONE を指定した場合と同義。

workspace_idstring(uuid)required

保存先ワークスペース/フォルダID

contract_file_typestring(contract_file_type)required

アップロードする契約書種別

Enum"PRE_EXECUTION""EXECUTED"

document_status_codestring(document_status_code)

締結前契約書の契約書ステータスコード。NONE は契約書ステータスなしを表す。

Enum"COUNTERPARTY_DRAFT""INTERNAL_DRAFT""COUNTERPARTY_REVISION""INTERNAL_REVISION""APPROVED_VERSION""READY_FOR_SIGNATURE""NONE"

filestring(binary)required

契約書ファイル本体

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/contracts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F workspace_id=00000023-0000-0000-0001-000000000020 \
  -F contract_file_type=PRE_EXECUTION \
  -F document_status_code=INTERNAL_DRAFT \
  -F 'file=<binary file content>'

Responses

正常に契約書を作成

Bodyapplication/json

document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

workspace_idsArray of strings(uuid)required

契約書が所属するワークスペース/フォルダID

document_processing_statusstring(document_processing_status)required

契約書処理ステータス

Enum"PROCESSING""READY""REJECTED""FAILED""SKIPPED"

preview_statusstring(preview_status)required

プレビュー利用可否ステータス

Enum"PROCESSING""READY""NOT_AVAILABLE""FAILED"

Response

application/json

{
  "document_id": "00000016-0000-0000-0001-100000000001",
  "document_version_id": "00000016-0000-0000-0001-100000000101",
  "workspace_ids": [
    "00000023-0000-0000-0001-000000000020"
  ],
  "document_processing_status": "PROCESSING",
  "preview_status": "PROCESSING"
}

契約書情報を取得

Request

指定した契約書情報の詳細を取得します。

Security

OAuth2ClientCredentials

Path

document_idstring(uuid)required

契約書 ID

Query

document_version_idstring(uuid)

取得対象のバージョンID。未指定時は最新バージョンを返す。

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}?document_version_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に契約書情報を取得

Bodyapplication/json

document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

file_namestring[ 1 .. 255 ] charactersrequired

契約書ファイル名

mime_typestring[ 1 .. 255 ] charactersrequired

契約書ファイルのMIMEタイプ

workspace_idsArray of strings(uuid)required

この契約書を含むワークスペース/フォルダ

created_atstring(date-time)required

契約書作成日時

updated_atstring(date-time)required

契約書最終更新日時

document_processing_statusstring(document_processing_status)required

契約書処理ステータス

Enum"PROCESSING""READY""REJECTED""FAILED""SKIPPED"

preview_statusstring(preview_status)required

プレビュー利用可否ステータス

Enum"PROCESSING""READY""NOT_AVAILABLE""FAILED"

metadata_extraction_statusesobject(metadata_extraction_statuses)required

項目単位のメタデータ抽出ステータス。現在の内部データソースで利用できない項目は省略する。

metadata_extraction_statuses.title_statusstring(metadata_extraction_status)

項目単位のメタデータ抽出ステータス

Enum"WAITING""PROCESSING""COMPLETED""FAILED""UNAVAILABLE""SKIPPED"

metadata_extraction_statuses.language_code_statusstring(metadata_extraction_status)

項目単位のメタデータ抽出ステータス

Enum"WAITING""PROCESSING""COMPLETED""FAILED""UNAVAILABLE""SKIPPED"

metadata_extraction_statuses.contract_category_positions_statusstring(metadata_extraction_status)

項目単位のメタデータ抽出ステータス

Enum"WAITING""PROCESSING""COMPLETED""FAILED""UNAVAILABLE""SKIPPED"

metadata_extraction_statuses.own_party_statusstring(metadata_extraction_status)

項目単位のメタデータ抽出ステータス

Enum"WAITING""PROCESSING""COMPLETED""FAILED""UNAVAILABLE""SKIPPED"

metadata_extraction_statuses.counter_party_statusstring(metadata_extraction_status)

項目単位のメタデータ抽出ステータス

Enum"WAITING""PROCESSING""COMPLETED""FAILED""UNAVAILABLE""SKIPPED"

metadataobject(contract_metadata)required

契約書メタデータ

metadata.titlestring[ 1 .. 1000 ] characters

契約書タイトル

metadata.language_codestring[ 2 .. 35 ] characters

契約書の言語コード

metadata.document_status_codestring(contract_document_status_code)

契約書メタデータで返す契約書ステータスコード

Enum"COUNTERPARTY_DRAFT""INTERNAL_DRAFT""COUNTERPARTY_REVISION""INTERNAL_REVISION""APPROVED_VERSION""READY_FOR_SIGNATURE""SIGNED"

metadata.contract_category_positionsArray of objects(contract_category_position)

契約類型・立場の分類

metadata.own_partiesArray of strings(party)

自社名一覧

metadata.counter_partiesArray of strings(party)

取引先名一覧

related_filesArray of objects(related_file)required

契約書に紐付く契約書以外の関連ファイル。関連ファイルの最新バージョン作成日時の降順で最大30件を返す。

related_files[].related_file_idstring(uuid)required

契約書以外の関連ファイル ID

related_files[].file_namestring[ 1 .. 255 ] charactersrequired

契約書以外の関連ファイル名

related_files[].mime_typestring[ 1 .. 255 ] charactersrequired

契約書以外の関連ファイルのMIMEタイプ

previewArray of objects(preview)

契約書プレビュー内の条項

Response

application/json

{
  "document_id": "00000016-0000-0000-0001-100000000001",
  "document_version_id": "00000016-0000-0000-0001-100000000101",
  "file_name": "nda_2026_05_08.pdf",
  "mime_type": "application/pdf",
  "workspace_ids": [
    "00000023-0000-0000-0001-000000000020"
  ],
  "created_at": "2026-05-08T03:12:34Z",
  "updated_at": "2026-05-08T03:13:20Z",
  "document_processing_status": "PROCESSING",
  "preview_status": "READY",
  "metadata_extraction_statuses": {
    "title_status": "COMPLETED",
    "language_code_status": "COMPLETED",
    "contract_category_positions_status": "COMPLETED",
    "own_party_status": "PROCESSING",
    "counter_party_status": "PROCESSING"
  },
  "metadata": {
    "title": "Confidentiality Agreement",
    "language_code": "en",
    "contract_category_positions": [ … ],
    "own_parties": [ … ],
    "counter_parties": [ … ]
  },
  "related_files": [
    { … }
  ],
  "preview": [
    { … }
  ]
}

契約書を削除

Request

指定した契約書を削除します。全バージョンと関連ファイルとの紐付けも削除されます（関連ファイル自体は削除されません）。

Security

OAuth2ClientCredentials

Path

document_idstring(uuid)required

契約書 ID

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に契約書を削除

Response

No content

ワークスペース

共通のワークスペース/フォルダは、契約書などのリソースを格納・整理する単位です。本エンドポイントは、APIを呼び出すユーザーがアクセス権を持つワークスペース/フォルダをツリー構造で返します。契約書APIなどワークスペースを対象とする操作では、ここで取得した workspace_id を指定してください。テナント内全体の管理（作成・権限設定など）は管理者設定のワークスペース操作（/spaces）を参照してください。

Operations