添付する前にアップロード
証明書類または補足書類のいずれか一つのカテゴリに属するファイルをアップロードし、返されたファイルIDを次のいずれかで添付します:create_proof または create_supporting_document。アップロードするだけでは、本人情報、住所、証明書類のレコードは作成されず、電話番号の登録も完了しません。まず、最新の要件とカタログIDを確認してください。
指定するセレクターは必ず一つだけにしてください。本人確認・住所証明用には proof_type_id、補足書類用には supporting_template_id を指定します。両方を送信しないでください。該当するMultiTELカタログから返されたIDを使用し、内部構造に意味を見いださない不透明な識別子として扱ってください。
アップロードリクエスト
有効なMultiTEL APIアカウントと、そのアカウントで許可されたIPアドレスを使用してください。例では環境変数から取得したHTTP Basic認証の認証情報を使用しています。お使いのアカウント種別に応じた認証方式に従ってください。リクエストはHTTPSで送信してください。HTTPレスポンスと、JSON内の次の値の両方を確認してください:status.code。HTTP 200でもアプリケーションエラーが返されることがあります。以下の例は架空のものです。
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--form-string "proof_type_id=$PROOF_TYPE_ID" \
--form-string 'description=Identity proof' \
--form 'files[0]=@./identity-proof.pdf' \
https://api.multitel.net/v3/create_encrypt_files| フィールド | 意味 |
|---|---|
files[0] … files[4] | 一つから五つまでのアップロードファイルです。マルチパートフォームデータを使用し、Content-Typeの境界文字列はcurlに生成させてください。これらのフィールドにはファイルのバイト列を含めます。URLやJSON Base64ではありません。 |
proof_type_id | 証明書類のアップロードには必須です。返された次のIDを使用してください:証明種別ID。supporting_template_idは省略してください。 |
supporting_template_id | 補足書類のファイルには、proof_type_idの代わりに必須です。返された次のIDを使用してください:テンプレートID。 |
description | 呼び出し側が任意で指定する説明です。最大100文字です。補足書類のアップロードでは、説明を省略するとテンプレート名が使用される場合があります。 |
ファイルの制限
このハンドラーが受け付けるのは、最大五つのファイル、合計20,000,000バイトまでです。これは十進数でのバイト上限であり、20 MiBではありません。インフラストラクチャやMIME検証によって、さらに制限が適用される場合があります。
許可されている拡張子は pdf、png、jpg、jpeg、gif、tiff、bmp、doc、docx、xls、xlsx、txt、rtf、および csv です。許可された拡張子であっても、そのファイルが選択した登録要件を満たすとは限りません。特に、tif はこの許可リストに含まれていません。
返されたファイルをすべて確認
{
"status": {
"code": 200,
"msg": "Encrypt file has been created successfully"
},
"response": {
"entity_type": "identities",
"document_category": "proof",
"proof_type": "11111111111111111111111111111111",
"ids": [
{
"id": "22222222222222222222222222222222",
"name": "identity-proof.pdf",
"expired_at": "2026-10-23 16:20:00"
}
]
}
}添付リクエストに使用するため、それぞれの response.ids[].id を保存してください。name は、返された元のファイル名を示します。ファイル名はそれぞれ異なるものにし、返されたファイル一式を想定した一式と照合してください。コード200でも、一括処理の一部しか成功していない場合があります。必要なファイルが不足している一式を添付しないでください。
entity_type は、identities または addresses が証明書類の場合の値で、supporting_documents が補足書類のアップロードの場合の値です。document_category の値は proof または supporting です。汎用的な名前の proof_type レスポンスフィールドには、補足書類のアップロードの場合、テンプレートへの参照も格納されます。添付に使用するため、元のsupporting_template_idを保持してください。
速やかに添付
このサービスでは、アップロードしたファイルをローカルに保存した時点から約20分後に有効期限が設定されます。添付時には、ファイルが同じアカウントに属していること、期限切れとしてマークされていないこと、有効期限前であること、エンティティのカテゴリが正しいことを確認します。expired_at には、このレスポンスではタイムゾーンのオフセットが含まれていません。UTCとみなさないでください。有効期限ぎりぎりに処理を予定せず、速やかに添付してください。
アップロード参照の有効期限は、その時点で保存済みの書類のコピーがすべて削除されることを保証するものではありません。このサービスは通信事業者へのアップロード用にファイルを暗号化し、書類ワークフローのために元のバイト列を保持します。クライアント側のみで暗号化するサービスや、データを保持しないサービスとして扱わないでください。ID、ファイル名、レスポンスを公開ログに記録しないでください。
エラーと再試行
現在のハンドラーは、書類ファイルが指定されていない場合にAPIコード404を使用します。説明の検証、セレクターの未指定や競合、無効な証明種別IDやテンプレートID、ファイル数や合計サイズの上限、ストレージの問題、アップロードの失敗にはコード500を使用します。次の値を確認してください:status.msg。無効な入力が常にコード400で示されるわけではありません。
ここではクライアントが指定できる冪等性キーは提供されていません。レスポンスが失われた場合は、アップロードを繰り返す前に書類ワークフローを確認してください。再リクエストによって新しいファイル参照が作成される可能性があります。これらの例は、顧客の本人確認書類を使って実行したものではありません。