開発者

GET/v3/get_document/{uuid}

登録プロフィールを取得する

ローカルのドキュメントUUIDを指定して、アカウントに属する有効なプロフィールを取得します。

このページの内容
  1. 保存済みのプロフィールを取得する
  2. プロフィールのリクエスト
  3. プロフィールのレスポンス
  4. 返されるプロフィールのフィールド
  5. 見つからない場合と再試行

保存済みのプロフィールを取得する

アカウント内の有効なローカル登録プロフィールをUUIDで指定して取得します。返されるプロフィールのフィールドは、次のエンドポイントと同じ限定された項目です:documents。通信事業者による確認の更新や、添付された証明書類の取得は行いません。

プロフィールのリクエスト

有効化された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/get_document/$DOCUMENT_UUID"

DOCUMENT_UUIDにはresponse.uuidを設定します。その取得元は create_document です。または、documentsから取得したresponse[].idを設定します。ここではidentity_id、address_id、証明書類のID、電話番号を使用しないでください。リクエストボディは不要です。

プロフィールのレスポンス

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "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"
  }
}

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

このフィールドの抽出結果には、次の項目が含まれます: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、アップロード済みファイルへの参照、証明書類の一覧、確認状況は含まれません。これは証明書類の状況を確認したり、登録を承認したりするためのエンドポイントではありません。返された本人情報、連絡先情報、署名データは非公開情報として扱ってください。

見つからない場合と再試行

APIコード404と次のメッセージ:Failed, Not found が返された場合、そのアカウントとUUIDに一致する有効なプロフィールが見つからなかったことを意味します。アカウント、識別子、プロフィールが削除されていないかを確認してください。この検索によって別のアカウントのプロフィールが開示されることはありません。

取得に成功しても、証明書類が受理されたことや電話番号が有効化されたことは確認できません。作成または添付リクエストの結果が不明で、その後の対応を行う場合は、状態を変更するリクエストを再度送信する前に、ポータル上のドキュメントを確認してください。