結果検証 API | Silent Auth 日本語

概要

APP サーバーはこのインターフェースを呼び出し、Engagelab SDK が返す暗号化データ（payload）を Engagelab サーバーに送信して、電話番号の一致を検証します。

インターフェース情報

項目	説明
リクエストパス	`POST /v1/verify`
プロトコル	HTTPS
認証方式	HTTP Basic Auth
Content-Type	`application/json`

最新ドメイン：authapi.engagelab.com

リクエスト例

curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \ -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \ -H 'Content-Type: application/json' \ -d '{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }'

              
              curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
  -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
  }'

このコードブロックはフローティングウィンドウ内に表示されます

認証方式

HTTP Basic Auth を使用して認証します：

Authorization: Basic base64(appKey:appSecret)

              
              Authorization: Basic base64(appKey:appSecret)

このコードブロックはフローティングウィンドウ内に表示されます

例：

appKey: tn4nm0qx032yx6f17q2tsa8f
appSecret: your_app_secret_here
base64 エンコード: dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

              
              Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

パラメータ名	型	必須	説明
payload	string	はい	Engagelab SDK が返す暗号化データ。APP がそのまま透過的に渡す

リクエストボディ例：

{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }

              
              {
  "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}

このコードブロックはフローティングウィンドウ内に表示されます

レスポンスパラメータ

成功レスポンス（HTTP 200）

パラメータ名	型	説明
code	int	ステータスコード。0 は成功を表す
msg	string	ステータスの説明
data	object	レスポンスデータ
data.message_id	string	メッセージの一意識別子。問題調査に使用できる
data.verified	boolean	電話番号の検証結果。true は一致、false は不一致を表す

成功例（検証通過）：

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": true } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": true
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

成功例（検証不通過）：

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": false } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": false
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

エラーレスポンス（HTTP 4xx/5xx）

パラメータ名	型	説明
code	int	エラーコード
msg	string	エラーの説明

エラー例：

{ "code": 2001, "msg": "auth failed" }

              
              {
  "code": 2001,
  "msg": "auth failed"
}

このコードブロックはフローティングウィンドウ内に表示されます

エラーコードの説明

エラーコード	HTTP ステータスコード	説明	対処の推奨事項
1000	500	サーバー内部エラー	しばらくしてから再試行してください。継続する場合はテクニカルサポートにお問い合わせください
2001	401	認証失敗	appKey と appSecret が正しいか、Authorization の形式が仕様に準拠しているか確認してください
2004	401	appKey が無効	appKey が正しいか確認するか、テクニカルサポートに連絡してサービスが開通済みか確認してください
3001	400	パラメータ形式エラー	リクエストボディが正しい JSON 形式か確認してください
3002	400	パラメータ検証失敗	payload パラメータが存在し、形式が正しいか確認してください
3003	400	appKey が一致しない	payload 内の appKey が認証ヘッダーの appKey と一致しません。正しいキーペアを使用しているか確認してください
3004	400	設定が未有効化	サービス設定がまだ有効化されていません。テクニカルサポートに連絡して開通してください
3005	400	残高不足	アカウント残高が不足しています。チャージ後に再試行してください
4001	400	設定が存在しない	対応するサービス設定が見つかりません。テクニカルサポートにお問い合わせください
5001	400	検証失敗	キャリア認証プロセスで例外が発生しました。msg の具体的な情報に基づいて調査するか、テクニカルサポートにお問い合わせください

注意事項

payload の透過送信：APP は Engagelab SDK が返す payload を受け取ったら、そのまま APP サーバーに送信し、APP サーバーが本インターフェースを呼び出します。payload を一切変更しないでください。
セキュリティの推奨事項：appSecret は適切に保管し、サーバー側でのみ使用してください。APP 内で公開しないでください。
検証結果：verified が false の場合、ユーザーが入力した電話番号が SIM カードの電話番号と一致しないことを意味し、ユーザーのログインを拒否する必要があります。