Credentials

Get an account credential by ID

Changed on
get/credentials/{id}

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

idinteger required

The ID of the account credential requested

Query parameters

includeMaskedAccountNumbersboolean

true if masked account numbers delivered in response.

Response

Ok

idinteger required

ID of the Account Credential

profileIdinteger required

Financial profile ID of the credential owner

namestring required

Name of the Account Credential

fiIdinteger

ID of the Financial Institution. Either the fiId field or the fiRequestName field was must be provided (and not both).

firequestNamestring

The name of the requested FI. Either the fiId field or the fiRequestName field was must be provided (and not both)

firequestURLstring

The URL of the requested FI. May only be provided when the fiRequestName is provided (and the fiId field is not provided).

accountLoginstring

Account Login

accountLogin2string

Account Login 2

accountPinPresentboolean

Account Pin Present = true or false

accountSecondPinPresentboolean

Account Second Pin Present = true or false

authTypestring required

Indicates whether Oauth authentication is supported at this Financial Institution

oauthTokenIdstring required

Indicates whether Oauth authentication is supported at this Financial Institution

isCredentialCompleteboolean required

Credential complete = true or false

lastAuthenticationAttemptstring date-time

Date of the last authentication attempt

authenticationStatusErrorCodeinteger

Error code from the latest authentication attempt

authenticationStatusInfoTypestring

Type of status information from the latest authentication attempt

authenticationStatusInfostring

Status information from the latest authentication attempt (simplified)

hasAccountsboolean required

Indicates whether this account credential has any associated accounts

incompleteISACboolean required

Indicates whether the ISAC process is complete

creationDatestring date-time required

Credential creation date

maskedAccountNumbersstring

Comma separated list of masked account numbers associated with the requested Financial Institution

Example response

{
  "id": 778899,
  "profileId": 5566,
  "name": "DataConnect Account Credential Test FI 001 - No SQA 151",
  "fiId": 12484,
  "firequestName": "DataConnect Account Credential Test FI 001 - (requested fi)",
  "firequestURL": "http://AccountCredentialTestFI001@dataconnect.com",
  "accountLogin": "username",
  "accountLogin2": "username",
  "accountPinPresent": true,
  "accountSecondPinPresent": true,
  "authType": "Oauth",
  "oauthTokenId": "Oauth",
  "isCredentialComplete": true,
  "authenticationStatusErrorCode": 1006,
  "authenticationStatusInfoType": "cannotConnectMissingLoginPW",
  "authenticationStatusInfo": "Cannot connect. Missing Login or Password.",
  "hasAccounts": true,
  "incompleteISAC": true,
  "maskedAccountNumbers": "x-1234,x-5678"
}

Changes