idp-server コントロールプレーン 身元確認申請管理 API (1.0.0)
Download OpenAPI specification:Download
身元確認申請（Identity Verification Application）の管理API仕様書
組織内身元確認申請一覧取得
指定した組織・テナント内の身元確認申請一覧を取得します。各種フィルタリングおよびページネーションに対応しています。
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
query Parameters
| limit | integer [ 1 .. 1000 ] Default: 20 返すアイテムの最大数 |
| offset | integer >= 0 Default: 0 アイテムを返す開始インデックス |
| id | string <uuid> 申請IDでフィルタリング |
| type | string 検証タイプでフィルタリング |
| client_id | string クライアントIDでフィルタリング |
| status | string Enum: "requested" "applying" "applied" "examination_processing" "approved" "rejected" "expired" "cancelled" 申請ステータスでフィルタリング |
| from | string <date-time> 作成日時の開始（ISO 8601形式） |
| to | string <date-time> 作成日時の終了（ISO 8601形式） |
Responses
Response samples
- 200
- 401
- 403
- 404
Content type
application/json
{- "list": [
- {
- "id": "8a3f2b1c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
- "type": "document_verification",
- "tenant_id": "952f6906-3e95-4ed3-86b2-981f90f785f9",
- "client_id": "my-client",
- "user_id": "3ec055a8-8000-44a2-8677-e70ebff414e2",
- "status": "approved",
- "application_details": { },
- "processes": {
- "property1": {
- "call_count": 3,
- "success_count": 2,
- "failure_count": 1
}, - "property2": {
- "call_count": 3,
- "success_count": 2,
- "failure_count": 1
}
}, - "attributes": { },
- "requested_at": "2026-03-18T10:30:00"
}
], - "total_count": 42,
- "limit": 20,
- "offset": 0
}組織内身元確認申請詳細取得
指定した組織・テナント内の特定の身元確認申請の詳細を取得します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
| application-id required | string <uuid> 身元確認申請の識別子 |
Responses
Response samples
- 200
- 401
- 403
- 404
Content type
application/json
{- "id": "8a3f2b1c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
- "type": "document_verification",
- "tenant_id": "952f6906-3e95-4ed3-86b2-981f90f785f9",
- "client_id": "my-client",
- "user_id": "3ec055a8-8000-44a2-8677-e70ebff414e2",
- "status": "approved",
- "application_details": { },
- "processes": {
- "property1": {
- "call_count": 3,
- "success_count": 2,
- "failure_count": 1
}, - "property2": {
- "call_count": 3,
- "success_count": 2,
- "failure_count": 1
}
}, - "attributes": { },
- "requested_at": "2026-03-18T10:30:00"
}組織内身元確認申請削除
指定した組織・テナント内の特定の身元確認申請を削除します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
| application-id required | string <uuid> 身元確認申請の識別子 |
query Parameters
| dry_run | boolean Default: false trueの場合、リクエストの検証のみで実行はされません |
Responses
Response samples
- 200
- 401
- 403
- 404
Content type
application/json
{- "dry_run": true
}