開発者

GET/v3/get_encrypted_files

利用可能な登録書類のアップロード一覧を取得する

登録書類を添付する前に、有効期限が切れていない API アップロード参照とメタデータを確認します。

このページの内容
  1. 利用可能なアップロード参照の一覧を取得する
  2. 書類のバイトデータではなくメタデータを確認する
  3. 参照の有効期限が切れる前に添付する
  4. プライバシー

利用可能なアップロード参照の一覧を取得する

このエンドポイントは、登録書類のアップロードの後に、添付にまだ利用できる参照を探す場合に使用します。有効化された MultiTEL API アカウントを使用し、そのアカウントに設定された認証情報と IP 制限に従って HTTPS で接続してください。一覧の対象は、ご利用のアカウントに限定されます。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/get_encrypted_files

リクエスト本文もクエリパラメーターも必要ありません。ハンドラーは、API 経由で作成されたアップロードレコードのうち、期限切れフラグが設定されておらず、有効期限がサーバーの現在時刻より後のものを一覧として返します。ページ分割、検索、並べ替えのパラメーターはありません。アカウント内のすべての本人情報、証明書類、過去の書類を一覧にするものではありません。

書類のバイトデータではなくメタデータを確認する

HTTP の結果と、JSON の status.code を確認してください。成功したレスポンスでは、response に配列が入ります。結果が空の場合は空の配列が返され、アカウントが存在しないことを示すエラーではありません。この例のメタデータと識別子は架空のものです。

{
  "status": {"code": 200, "msg": ""},
  "response": [{
    "id": "0123456789abcdef0123456789abcdef",
    "proof_type": "abcdef0123456789abcdef0123456789",
    "entity_type": "addresses",
    "description": "Example address proof",
    "file_name": "example-document.pdf",
    "date": "2026-10-01 12:00:00"
  }]
}
アップロードのメタデータ項目
項目意味
id外部向けのアップロード参照です。対応する添付リクエストには、この値を正確にコピーして使用してください。識別子を自分で計算したり、本人情報、住所、テンプレートの ID で代用したりしないでください。
proof_type記録された種類の参照が存在する場合は、そのマスクされた値です。存在しない場合は空文字列です。証明書類のアップロードでは証明書類の種類を表し、補足書類のアップロードでは同じキーにテンプレート参照が記録されます。両者の区別には entity_type を確認してください。アップロード ID ではありません。
entity_typeidentities、addresses、supporting_documents など、記録された添付先の区分です。対応する添付ワークフローを選択してください。
description保存されているアップロードの説明です。
file_name元のファイル名です。ダウンロード URL ではありません。
date記録された作成日時です。サーバーによって、タイムゾーンのオフセットを含まない形式に整えられています。

レスポンスには、書類のバイトデータ、保存先 URL、有効期限は含まれません。最初のアップロードレスポンスに含まれる expired_at を保存しておいてください。アップロードを一覧で取得しても、有効期間は延長されず、本人情報への添付も行われません。また、通信事業者が承認したことの証明にもなりません。

参照の有効期限が切れる前に添付する

用途に応じて、証明書類の添付または補足書類の添付のワークフローを使用してください。現在のアップロードワークフローで発行される参照の有効期間は短いため、この一覧に参照が表示されたというだけで添付を先延ばしにしないでください。一覧の取得から添付までの間に、参照の有効期限が切れたり、利用できなくなったりする場合があります。成功したと決めつけず、添付リクエストのレスポンスに応じて処理してください。

一覧が予想に反して空の場合は、アカウントを確認し、アップロードの有効期限が切れていないか、別のワークフローで作成されたものではないかを確認してください。最初のアップロードと添付の結果を確認せずに、同じ書類を自動的に再アップロードしないでください。

プライバシー

ファイルの内容が含まれていなくても、ファイル名や説明から人物や書類を特定できる場合があります。アクセスを制限し、レスポンス全体をログに記録することは避けてください。未使用のローカルアップロード参照を削除する方法は、アップロード参照の削除を参照してください。この操作は、書類を包括的に消去するサービスではありません。