Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Credentials

Update Credential

To make updates to a credential, make a PATCH call to the credentials endpoint with a specific credentialId. For a list of fields that can be updated look below. None of these fields are required, but at least one field must be passed in the body to update a credential.

This endpoint supports Sandbox Mode.

patch/plug/credentials/{credentialId}

Path parameters

credentialIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

correlationIdstring

A string value you can set to help you reconcile with your internal systems.

isActiveboolean

Indicates whether the Credential is active for applicable products.

isInteractiveboolean

Indicates whether the account supports interactive features or functionalities.

passwordstring

The password associated with the account

password2string

Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.

password3string

Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.

password4string

Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.

usernamestring

The username associated with the account.

username2string

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider

username3string

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider

username4string

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider

Response

OK

connectionHealth'CONNECTION_SUCCESS' | 'CONNECTION_IN_PROGRESS' | 'CONNECTION_FAILURE' | 'CONNECTION_DEACTIVATED' required

A high-level connection health status that reflects the best outcome across the credential and all configured alternate access methods.

correlationIdstring nullable required

A string value you can set to help you reconcile with your internal systems.

createdAtstring date-time required

A timestamp indicating when the entity was created.

createdBystring required

User or system responsible for creating the entity.

customerGivenWebsitestring nullable required

The website provided by the customer when creating this credential.

idstring required

A unique identifier for the entity.

isAccessibleboolean required

Indicates whether Arcadia is potentially able to successfully log into the Credential.

isActiveboolean required

Indicates whether the Credential is active for applicable products.

isCustomerActionRequiredboolean required

Indicates whether any action is required from you regarding this resource.

isThirdPartyPortalboolean required

Indicates whether the account requires to be accessed through a third-party portal or platform.

lastModifiedAtstring date-time required

The timestamp indicating when this resource was last modified.

lastModifiedBystring required

The user or system that last modified this resource.

lastSuccessfulMultiFactorAuthenticationOptOutAtstring date-time nullable required

The timestamp indicating when this Credential was last successfully opted out of Multi Factor Authentication.

multiFactorAuthenticationOptOutStatus'SUCCESS' | 'FAILURE' | 'IN_PROGRESS' nullable required

The status of Multi Factor Authentication Opt Out for the Credential.

nextScheduledAccountRunAtstring date-time required

The scheduled time for the next automated credential job.

status'CONNECTION_SUCCESS' | 'CONNECTION_IN_PROGRESS' | 'CONNECTION_FAILURE' | 'CONNECTION_DEACTIVATED' | 'ALTERNATE_ACCESS' required

A high-level status for this credential. See this table for more information.

statusDetail'LOGIN_AND_DATA_DISCOVERY_SUCCESS' | 'LOGIN_AND_INTERVALS_DISCOVERY_SUCCESS' | 'LOGIN_SUCCESS_INTERVALS_DISCOVERY_FAILURE' | 'PROVIDER_WEBSITE_INACCESSIBLE' | 'ACCOUNT_TEMPORARILY_LOCKED' | 'ISSUE_UNDER_REVIEW' | 'PROVIDER_WEBSITE_NAVIGATION_FAILURE' | 'UNSUPPORTED_CAPTCHA' | 'INVALID_CREDENTIALS' | 'MULTI_FACTOR_AUTHENTICATION_FAILURE' | 'UNSUPPORTED_MULTI_FACTOR_AUTHENTICATION' | 'MULTI_FACTOR_AUTHENTICATION_TIMEOUT' | 'MULTI_FACTOR_AUTHENTICATION_REFRESH_REQUIRED' | 'OTHER_ACCESS_LIMITATION' | 'DATA_EXTRACTION_IN_PROGRESS' | 'REQUIRES_ENROLLMENT' | 'EMAIL_APPROVAL' | 'UNSUCCESSFUL_EMAIL_APPROVAL' | 'USER_REVOKED_ACCESS' | 'PROVIDER_REGISTRATION_INCOMPLETE' | 'GUEST_ACCESS_SYNC_INCOMPLETE' | 'GUEST_ACCESS_CONFIGURATION_IN_PROGRESS' | 'GUEST_ACCESS_CONFIGURATION_FAILURE' | 'GUEST_ACCESS_NOT_SUPPORTED' | 'GUEST_ACCESS_REMOVED' | 'DATA_EXTRACTION_NOT_REQUESTED' required

A detailed status for this credential. See this table for more information.

totalAccountsinteger required

The total number of accounts.

usernamestring required

A login input required to access the customer's utility data

username2string nullable required

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider

username3string nullable required

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider

username4string nullable required

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider

websitestring nullable required

The provider's website that this credential logs into.