証明書類テンプレートの一覧を取得

テンプレートのカタログを参照する

サービスが返すテンプレートを一覧表示するには、省略可能なISOパスセグメントを省略します。一覧を絞り込むには、国のISOコードを指定します。フィルターはテンプレートの国の参考情報と照合します。この情報は名前から推定される場合があり、空の場合もあります。

要件に基づいてテンプレートを選ぶ

テンプレートが存在していても、その国のすべての電話番号で必要とされたり、受理されたりするとは限りません。テンプレートIDを、適用される証明書類の要件と照合してください。この一覧は、記入済み書類の生成、署名、アップロード、承認を行うものではありません。

テンプレートが返されない場合

絞り込み後の一覧が空の場合は、一致する国の参考情報が見つからなかった可能性があります。絞り込んでいない一覧が空の場合は、上流のデータを取得できないことが原因の可能性もあります。いずれの結果も、証明書類が不要であることの証拠とは見なさないでください。

ダウンロードしたコピーは使用前に内容を確認する

カタログのダウンロードリンクからは、書式やブランド表示が変更されたコピーが返される場合があります。変更されていない契約書の原本であるとも、ダウンロードすれば登録要件を満たせるとも考えないでください。どの書類も、記入や署名の前に内容を確認してください。

ポータルの機能である書類作成ウィザードで契約書を作成できる場合は、そのプレビューと、明示的に提出操作を行う手順を使用してください。その他の必要な書式については、記入する前に、現在の書式をMultiTELに確認してください。ダウンロードしたテンプレートは、署名済みの添付書類でも、アップロード済みの証明書類でも、電話番号の承認でもありません。

リクエスト

有効化済みのAPIアカウントの認証情報を使用し、HTTPSで接続してください。Basic認証と、有効化済みのAPIアカウントのbearerトークンに対応しています。アカウントの制限が適用されます。

GETを使用し、パラメーターを指定する場合は、文書に記載されたものをURLパスに含めてください。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"

レスポンス

HTTPステータスに加えて、JSON本文のstatus.codeも確認してください。responseは、id、name、permanent、iso、urlを持つオブジェクトの配列です。permanentはboolean型です。isoは空の場合があり、テンプレート名から推定されている場合もあります。国の情報は参考情報として扱い、利用資格の判定とは見なさないでください。カタログが空でも、成功を示す200レスポンスとなります。上流への照会でデータが得られない場合にも、空になることがあります。URLはサービスによって生成されるため、そのホスト名は説明用の例と異なる場合があります。

レスポンス形式を示す例です。実際のアカウントデータや現在の見積もりではありません。

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

エラー

• 認証エラーやサービスエラーについては、status.codeとstatus.msgを確認してください。空のカタログが正常に返されても、書類が承認されたことや、登録が免除されたことを意味しません。

利用可否と副作用

• このカタログ・要件の照会では、本人情報の作成、証明書類のアップロード、電話番号の登録、注文の実行は行われません。
• カタログのレスポンスが成功しても、お客様の書類が承認されたことや、選択した電話番号を有効化できることが確認されたわけではありません。