補足書類を添付する

テンプレートに基づく補足書類を添付する

次の取得元からテンプレートを選んで使用してください：get_supporting_document_templates。あわせて、ご利用のアカウントがすでに所有している本人情報を使用します。書類のファイルは、次の機能でアップロードしてください：create_encrypt_files。その際、supporting_template_idを指定します。通常の本人確認書類や住所証明書類のアップロードは別のカテゴリに属するため、代わりに使用することはできません。

補足書類を作成する

有効な MultiTEL API アカウントと、そのアカウントで許可されている IP アドレスを使用してください。以下の例では、環境変数から取得した認証情報を HTTP Basic 認証に使用しています。ご利用のアカウント種別に応じた認証方法に従ってください。リクエストは HTTPS 経由で送信してください。HTTP レスポンスと、JSON 内の次の値の両方を確認してください：status.code。HTTP 200 が返されても、アプリケーションエラーが含まれる場合があります。以下の例は架空のものです。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

リクエストのフィールド
フィールド	意味
`identity_id`	必須項目です。ご利用のアカウントに関連付けられた本人情報の ID を指定します。このリクエストは本人情報に書類を添付するものであり、住所や電話番号に直接添付するものではありません。
`template_id`	必須項目です。補足書類のテンプレート ID を指定します。補足書類のアップロード時に選択したものと同じテンプレートを使用してください。添付時のフィールドは template_id、アップロード時のフィールドは supporting_template_id です。
`encrypted_file_ids`	必須項目です。アップロード時に返された ID を、空でない JSON 配列で指定します。各アップロードは現在のアカウントに属し、有効期限内で、カテゴリが supporting_documents である必要があります。

フォームデータでは、encrypted_file_ids[]フィールドを繰り返し指定する形式も受け付けます。この添付用エンドポイントにファイルのバイトデータを送信しないでください。

作成された補足書類

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

この応答は補足書類の作成を確認するものであり、規制上の承認や電話番号の有効化を示すものではありません。上流のリソースで使われている「永続的」という用語は、保存期間や削除方針についてお客様に保証するものではありません。

エラーと再試行

API コード 500 は、入力項目の不足、通信事業者側のエラー、または通信事業者からの無効な応答を表します。コード 404 は、本人情報がアカウントに関連付けられていない、テンプレートが無効である、アップロードが存在しない・期限切れである・カテゴリが異なる、または使用可能なファイルがないことを表します。次の値を確認してください：status.msg。HTTP 200 だけでは成功を判断できません。

返されたファイル参照の有効期間内にアップロードと添付を行ってください。処理結果が不明な応答を受け取った場合は、再試行する前に、ポータルで該当する本人情報の補足書類を確認してください。このハンドラーには、利用できる冪等性キーがありません。