メインコンテンツへスキップ
GET
curl
ファイルのエクスポートで開始したエクスポートを取得します。
  • PENDINGとPROCESSING:ZIPを準備中です。数秒後にもう一度エクスポートを取得してください。
  • READY:download_urlはZIPへの署名付きリンクで、短時間だけ有効です。expires_atまでは、エクスポートを再度取得すると新しいリンクを取得できます。
  • FAILED:ZIPを準備できませんでした。新しいエクスポートを開始してください。
  • EXPIRED:ZIPは削除されました。新しいエクスポートを開始してください。
ダウンロードリンクを返す取得は、すべてセッションの監査ログに記録されます。削除されたセッションのエクスポートは404を返します。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

sessionId
string<uuid>
必須

検証セッションのUUID(POST /v3/session/が返すsession_id)。ユーザー認証(KYC)と法人確認(KYB)の両方のセッションIDを受け付けます。削除されたセッションは404を返します。

例:

"11111111-2222-3333-4444-555555555555"

exportId
string<uuid>
必須

POST /v3/session/{sessionId}/files-export/が返したexport_idです。

例:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

レスポンス

エクスポートです。

セッションのすべてのファイルを元の品質のまま収めた1つのZIPファイル。

export_id
string<uuid>
必須

エクスポートのID。GET /v3/session/{sessionId}/files-export/{exportId}/に渡します。

session_id
string<uuid>
必須

ファイルの取得元のセッション。

status
enum<string>
必須

ZIPの準備中はPENDINGおよびPROCESSING、ダウンロード可能になるとREADY、準備できなかった場合はFAILED(新しいエクスポートをリクエストしてください)、ZIPが削除されるとEXPIREDです。

利用可能なオプション:
PENDING,
PROCESSING,
READY,
FAILED,
EXPIRED
file_count
integer | null
必須

ZIP内のファイル。statusがREADYの間のみ設定されます。

size_bytes
integer<int64> | null
必須

ZIPのサイズ(バイト単位)。statusがREADYの間のみ設定されます。

download_url
string<uri> | null
必須

ZIPの署名付きURLで、有効期間は短時間です。statusがREADYの間のみ設定されます。新しいURLを取得するには、エクスポートを再度読み取ってください。

expires_at
string<date-time> | null
必須

ZIPが削除される日時で、準備完了から24時間後です。statusがREADYの間のみ設定されます。

error
string | null
必須

statusがFAILEDの場合に、エクスポートが失敗した理由。

created_at
string<date-time>
必須

エクスポートがリクエストされた日時。

completed_at
string<date-time> | null
必須

ZIPの準備が完了した日時、またはエクスポートが失敗した日時。

最終更新日 2026年11月1日