Credential Authentication

Get authentication result

Changed on

Obtain the final result of credential authentication operation.

get/authentications/{ticket}

Request

  • Base URL
    //basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header Authorization

Path parameters

ticketstring required

Universal unique identifier associated with this authentication. It is provided as part of the URL in the Location header when the authentication operation is first submitted.

Response

Ok

authenticationStatusErrorCodeinteger

Status code from the authentication operation; 1006 indicates success

authenticationStatusInfostring

Status info from the authentication operation (populated only if an error occurrd)

authenticationStatusInfoTypestring

Type of status information from the latest authentication attempt

credentialIdinteger required

Account Credential ID associated with this authentication

lastAuthenticationAttemptstring date-time

Date of the last authentication attempt

oauthExpirationTimestring date-time
statusstring required

Account Credential ID associated with this authentication

statusTimestampstring date-time required

Status timestamp

userInputExpirationTimestring date-time

User Input Expiration Time is the time after which ISAC will timeout regardless of whether it has been kept alive with keep alive requests. Only valued if status is 'Waiting for User Input'

userInputTimeoutIntervalinteger

User Input Timeout Interval is the interval of time in seconds in which a keep alive request or the user input result should be submitted. Only valued if status is 'Waiting for User Input'

Example response

{
  "authenticationStatusErrorCode": 1007,
  "authenticationStatusInfo": "WebPortfolio could not determine an answer for the security question: 'In what city did you meet your spouse for the first time?'  Please provide the answer to this question and try again.",
  "authenticationStatusInfoType": "cannotConnectMissingLoginPW",
  "credentialId": 5566,
  "sqa": [
    {
      "id": 5487894,
      "question": "In what city did you meet your spouse for the first time?",
      "answer": "Boston"
    }
  ],
  "status": "In Progress",
  "userInput": [
    {
      "inputRadio": [
        {
          "identifier": 1,
          "instructionText": "Use the code 'ABC123', otherwise a 1007 error will be returned.",
          "label": "xxbar@xxxxxxfoobar.com"
        }
      ],
      "inputType": "inputCheckbox",
      "instructionText": "Use the code 'ABC123', otherwise a 1007 error will be returned.",
      "identifier": 1,
      "label": "xxbar@xxxxxxfoobar.com"
    }
  ]
}

Changes