開発者

GET/v3/documents

登録プロフィールの一覧取得

従来の限定的な返却フィールドを使って、アカウントの有効なローカルプロフィールを検索します。

このページの内容
  1. 既存の登録プロフィールを検索する
  2. 一覧取得リクエスト
  3. レスポンスの一覧
  4. 返されるプロフィールのフィールド
  5. 次の手順

既存の登録プロフィールを検索する

API アカウントに関連付けられた、削除されていない有効なローカル登録プロフィールを一覧取得します。プロフィールを開く次の機能を使用する前に、そのプロフィールの UUID を確認するために使用してください: get_document。証明書類や電話番号登録が承認されたかどうかを判断するためのものではありません。

一覧取得リクエスト

有効化された MultiTEL API アカウントと、そのアカウントで許可された IP アドレスを使用して認証してください。例では、環境変数に保存した HTTP Basic 認証情報を使用しています。HTTP レスポンスと、JSON 内の次の値の両方を確認してください: status.code。HTTP 200 レスポンスだけでは成功したとは判断できません。例に示す値はすべて架空のものです。

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

このハンドラーには、リクエストボディ、ページネーション、フィルターパラメーターは実装されていません。該当するアカウントに保存されたプロフィールを返します。特定の順序で返されるとは想定しないでください。大規模なアカウントでは、一覧全体を頻繁にポーリングすることは避けてください。

レスポンスの一覧

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": [
    {
      "id": "11111111111111111111111111111111",
      "first_name": "Example",
      "last_name": "Person",
      "phone_number": "12025550123",
      "id_number": "",
      "birth_date": null,
      "company_name": "",
      "company_reg_number": "",
      "vat_id": "",
      "personal_tax_id": "",
      "description": "Example profile",
      "identity_type": "Personal",
      "postal_code": "00000",
      "city": "Example City",
      "address": "1 Example Street",
      "signature": "BASE64_PNG_SIGNATURE_DATA",
      "date_created": "2026-10-23 16:00:00"
    }
  ]
}

該当する有効なプロフィールがない場合、ハンドラーは API コード 200 と空のレスポンス一覧を返します。response[].id は、作成時に uuid として返されるローカルプロフィールの UUID です。本人情報の ID や住所の ID ではありません。

返されるプロフィールのフィールド

返されるフィールドは id、first_name、last_name、phone_number、id_number、birth_date、company_name、company_reg_number、vat_id、personal_tax_id、description、identity_type、postal_code、city、address、signature、および date_created です。

任意項目の値は、保存されたデータによっては空または null になる場合があります。この従来の返却フィールドには、email、国の選択項目、identity_id、address_id、アップロード済みファイルへの参照、証明書類の一覧、確認状況は含まれません。証明書類の状況や登録の承認を確認するためのエンドポイントではありません。返された本人情報、連絡先、署名のデータは非公開情報として扱ってください。

次の手順

後で添付する際に備え、作成時の create_document レスポンスに含まれるエンティティ ID を保存してください。そのレスポンスを紛失した場合、この一覧からそれらの ID を復元することはできません。プロフィールを確認するには、次のページを開いてください: ポータル。または、サポートにお問い合わせください。重複するプロフィールを自動的に作成することは避けてください。