REST API for Customer Care Service in Oracle Advanced Risk Manager

Get final auth status

get

/customercare/v1/{customerId}/status

Return the final authentication status of a user. This method does not fetch data more than 30 days old.

Request

Path Parameters

customerId(required): string

It is the uniqueUserId of the user. Details can be found in the user preferences API.

Query Parameters

requestId(required): string

Request Id (session Id) for the user's session.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success

Root Schema : AuthStatusResponse

Type: object

Show Source

authStatus: integer

Final authentication status of the user
statusResponse: object StatusResponse

Status information for API call

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

Nested Schema : StatusResponse

Type: object

Status information for API call

Show Source

responseCode: string

status code of the request
responseMessage: string

response message related to the response code if needed.
sessionId: string

session id of the authentcation.
status: boolean

authentication update request status

{
    "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 Response

Invalid input

404 Response

Customer ID not found

Examples

The following example shows a sample request and response for obtaining the user's final authentication status.

cURL Command to Obtain Final Authentication Status in JSON Format

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>)>'

Sample Response in JSON Format

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

cURL Command to Obtain Final Authentication Status in XML Format

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>)>'

Sample Response in XML Format

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