証明書類のカテゴリを選択
本人確認情報に必要な証明書類を準備する際は、返されたカテゴリと主体の種別を使用してください。この一覧はカテゴリを示すものであり、アップロード済みのファイルの一覧ではなく、いずれの証明書類の承認を示すものでもありません。
実際の要件に適合させる
カテゴリが一覧に含まれていても、すべての国、番号の種類、またはお客様の本人確認情報に対する要件を満たすとは限りません。証明書類をアップロードする前に適用される要件を確認し、返されたIDは内部構造や意味を解釈せずに扱ってください。
リクエスト
有効なAPIアカウントの認証情報を使用して、HTTPS経由でアクセスしてください。ベーシック認証と、有効になっているAPIアカウントのベアラートークンがサポートされています。アカウントの制限が適用されます。
ドキュメントに記載されているパラメータを使用する場合はURLパスに含め、GETでリクエストします。
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_proof_types"レスポンス
HTTPステータスに加えて、JSON本文のstatus.codeも確認してください。responseは、id、name、entity_typeを持つオブジェクトの配列です。これらの値は、現在の証明書類カタログから取得されます。IDは内部構造や意味を解釈せずに扱い、自分で組み立てたりハッシュ値を生成したりせず、返された値をコピーしてください。カタログが空でも正常なレスポンスとして返されることがあります。この例から主体の種別の列挙値を網羅していると判断し、ハードコードしないでください。
レスポンスの構造を示す例です。実際のアカウントデータや現在の見積もりではありません。
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"id": "PROOF_TYPE_ID_FROM_RESPONSE",
"name": "Example proof category",
"entity_type": "ENTITY_TYPE_FROM_RESPONSE"
}
]
}エラー
- 認証エラーやサービスエラーについては、status.codeとstatus.msgを確認してください。空のカタログが正常に返されても、書類の承認や登録の免除を意味するものではありません。
利用可否と副作用
- このカタログ・要件の照会では、本人確認情報の作成、証明書類のアップロード、番号の登録、注文の実行はいずれも行われません。
- カタログのレスポンスが正常に返されても、お客様の書類が承認されたことや、選択した番号を有効化できることが確認されたことを意味するものではありません。