MultiTEL
開発者

POST/v3/update_document/{uuid}

登録プロフィールを更新する

編集可能なプロフィール情報をすべて送信し、従来の成功レスポンス形式に対応します。

このページの内容
  1. プロフィールの編集可能な情報を置き換える
  2. 更新リクエスト
  3. 詳細設定：アップロード済みの証明書類を追加する
  4. 従来形式の成功・失敗レスポンス
  5. 現在の更新処理の制限と復旧方法

プロフィールの編集可能な情報を置き換える

アカウントが所有する既存の登録プロフィールを更新するには、次のいずれかから取得したローカルUUIDを使用します：create_document または documents。この操作は、アカウントと上流の通信事業者のデータを変更します。保存されているPersonal/Businessの本人区分は変更しません。また、一部のフィールドのみを更新するPATCHではありません。

更新リクエスト

許可されたIPアドレスから、有効なMultiTEL APIアカウントで認証してください。例では、環境変数に格納した認証情報と架空のデータを使用しています。HTTPレスポンスに加えて、JSONのstatus.codeとstatus.msgも確認してください。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"
{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

この例はPersonalプロフィールを示しています。エンドユーザーが意図する情報一式と、使用を許可された署名に置き換えてください。データを保持するために、仮の署名や空の値を送信しないでください。JSON形式とフォームエンコード形式の入力に対応しています。

更新フィールドの要件
フィールド動作
first_name, last_name, city, postal_code, address必須です。各フィールドは64文字以内です。
phone_number八文字以上の数字で指定する必須項目です。国番号を含む国際形式の数字列を使用してください。
signature必須です。ポータルは、データURLの接頭辞を付けずに、Base64でエンコードしたPNGのバイトデータを提供します。
country登録カタログにある、住所の国を表すISOコードを指定してください。ハンドラーはそのコードに対応する国を特定しますが、レビュー対象の住所更新処理では、国との関連付けは変更されません。
nationality既存のPersonalプロフィールでは、国のISOコードが必須です。
company_name, incorporation_country既存のBusinessプロフィールでは必須です。会社名は64文字以内、設立国はISOコードで指定してください。
email省略可能です。指定する場合は254文字以内の有効なメールアドレスを使用してください。保存済みの連絡先メールアドレスを保持するには省略し、ローカルで消去するには空の値を送信してください。
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id現在の値として設定したい値を送信してください。省略した値は既定で空になり、既存の保存値を上書きする場合があります。

国ごとの登録規則によっては、追加の情報や特定の形式が必要になる場合があります。更新情報一式を組み立て直す際に、次の取得元だけに頼らないでください：get_document。このレスポンスには情報が限られており、国の選択項目、email、エンティティIDは含まれません。使用を許可された元データを保持するか、ポータルのドキュメントエディターを使用してください。

詳細設定：アップロード済みの証明書類を追加する

省略可能なidentity_encryptfiles配列とaddress_encryptfiles配列には、次の取得元から得た、アカウントが所有する有効な参照を指定できます：create_encrypt_files。アップロード時のエンティティ区分に合わせ、参照の有効期限が切れる前に送信してください。同じ種類の証明書類が複数ある場合でも、各ファイルは個別の証明リクエストとして添付されます。複数のファイルで本人確認を行う場合は、後続の証明書類の添付ワークフローで、単一の配列を使用してください。

新規作成した住所に対する後続の住所証明が拒否された場合、プロファイル UUID で代用したり、アイデンティティを繰り返し作成し直したりしないでください。作業を中止し、ポータルまたはサポートを通じてプロファイルを確認してください。住所証明の読み取りおよび検索経路は、引き続きレビュー上の制限事項です。

従来形式の成功・失敗レスポンス

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

このエンドポイントの通常の成功コードは、文字列のsuccessであり、数値の200ではありません。上流側またはローカル側での通常の失敗には、文字列のerrorが使用される場合があります。数値の400は無効なフィールドまたは証明処理の失敗、404はプロフィールが存在しない場合またはアップロード済みファイルの参照が無効な場合、500は本文が空の場合または国を特定できない場合を示します。メッセージと、検証項目があればその内容も確認してください。HTTP 200だけで成功と判断しないでください。

現在の更新処理の制限と復旧方法

成功が返されても、上流側のすべてのフィールドが変更されたとは限りません。レビュー対象のコードでは、上流側の住所更新が失敗した後でも、ローカルのプロフィールが保存される場合があります。上流側の本人情報の更新にはemailが含まれません。この処理経路で住所の国の変更や住所の説明の同期が行われることは確認されていません。これらの変更が必要な場合は、上流側の登録情報が更新されたと判断せず、ポータルで結果を確認してサポートにお問い合わせください。

この更新は、全体が一括で成功または失敗する単一のトランザクションではありません。後続の処理が失敗する前に、本人情報の変更や証明書類の添付が実行される場合があります。冪等性キーは公開されていません。結果が不明確なレスポンスを受け取った場合は、再試行する前にプロフィールと添付ファイルを確認してください。証明書類を繰り返し送信すると、重複が発生する場合があります。プロフィールを更新しても、証明書類が承認されたことにはならず、電話番号も有効化されません。