ジャンプ先

• リクエスト
• レスポンス
• 例

最終認証ステータスの取得

get

/customercare/v1/{customerId}/status

ユーザーの最終認証ステータスを返します。このメソッドは、30日以上経過したデータをフェッチしません。

リクエスト

パス・パラメータ

• customerId(required): string
  ユーザーのuniqueUserIdです。詳細は、ユーザー・プリファレンスAPIを参照してください。

問合せパラメータ

• requestId(required): string
  ユーザーのセッションのリクエストID(セッションID)。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/xml
• application/json

200レスポンス

成功

本文()

ルート・スキーマ: AuthStatusResponse

型: object

ソースを表示

• authStatus: integer
  ユーザーの最終認証ステータス
• statusResponse: object StatusResponse
  APIコールのステータス情報

{
    "type":"object",
    "properties":{
        "authStatus":{
            "type":"integer",
            "description":"Final authentication status of the user"
        },
        "statusResponse":{
            "$ref":"#/components/schemas/StatusResponse"
        }
    }
}

ネストされたスキーマ: StatusResponse

型: object

APIコールのステータス情報

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• sessionId: string
  認証のセッションID。
• status: boolean
  認証更新リクエスト・ステータス

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        }
    }
}

400レスポンス

無効な入力

404レスポンス

顧客IDが見つかりません

先頭に戻る

例

次の例は、ユーザーの最終認証ステータスを取得するサンプルのリクエストとレスポンスを示しています。

JSON形式で最終認証ステータスを取得するcURLコマンド

curl --location --request GET '<RISKCC>/risk-cc/customercare/v1/{customerId}/status?requestId=9b48bc01-35af-4fe9-9328-518d757b5896' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
  "AuthStatusResponse": {
    "authStatus": "0",
    "statusResponse": {
      "responseCode": "0",
      "responseMessage": "",
      "status": "true"
    }
  }
}

XML形式で最終認証ステータスを取得するcURLコマンド

curl --location --request GET '<RISKCC>/risk-cc/customercare/v1/{customerId}/status?requestId=9b48bc01-35af-4fe9-9328-518d757b5896' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AuthStatusResponse>
    <authStatus>0</authStatus>
    <statusResponse>                                                                
        <responseCode>0</responseCode>
        <responseMessage></responseMessage>
        <status>true</status>
    </statusResponse>
</AuthStatusResponse>

先頭に戻る