Submit Multi-factor Authentication Method

put https://api.arcadia.com/plug/credentials/{credentialId}/verificationMethod

Select the multi-factor authentication (MFA) verification method for the specified credential's current job. This endpoint is currently in beta testing. Read more about the MFA workflow here.

Response

Response body

object

correlationId

string | null

required

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

createdAt

date-time

required

A timestamp indicating when the entity was created.

createdBy

string

required

User or system responsible for creating the entity.

string

required

A unique identifier for the entity.

isAccessible

boolean

required

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

isActive

boolean

required

Indicates whether the Credential is active for applicable products.

isCustomerActionRequired

boolean

required

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

isThirdPartyPortal

boolean

required

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

lastModifiedAt

date-time

required

The timestamp indicating when this resource was last modified.

lastModifiedBy

string

required

The user or system that last modified this resource.

nextScheduledAccountRunAt

date-time

required

The scheduled time for the next automated credential job.

provider

object | null

required

The entity providing service and issuing bills (informally known as a utility).

country

string | null

required

The country associated with the billing address.

string

required

A unique identifier for the entity.

isIntervalDataSupported

boolean | null

required

Indicates whether the provider supports interval data

isRealTimeCredentialValidationSupported

boolean

required

Indicates whether the provider supports credential validation

name

string | null

required

The name of the utility service provider.

status

string

required

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

CONNECTION_SUCCESS CONNECTION_IN_PROGRESS CONNECTION_FAILURE

statusDetail

string

required

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

LOGIN_AND_DATA_DISCOVERY_SUCCESS LOGIN_AND_INTERVALS_DISCOVERY_SUCCESS LOGIN_SUCCESS_INTERVALS_DISCOVERY_FAILURE PROVIDER_WEBSITE_INACCESSIBLE 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

totalAccounts

int32

required

The total number of accounts.

username

string

required

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

username2

string | null

required

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

username3

string | null

required

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

username4

string | null

required

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

website

string | null

required

The provider's website that this credential logs into.

Language

Credentials

OAuth2


xxxxxxxxxx
11
1
curl --request PUT \
2
     --url https://api.arcadia.com/plug/credentials/credentialId/verificationMethod \
3
     --header 'Arcadia-Version: 2024-02-21' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "isResubmission": true,
9
  "type": "call"
10
}
11
'


xxxxxxxxxx
28
}
1
{
2
  "correlationId": "string",
3
  "createdAt": "2025-03-27T01:54:33.918Z",
4
  "createdBy": "string",
5
  "id": "string",
6
  "isAccessible": true,
7
  "isActive": true,
8
  "isCustomerActionRequired": true,
9
  "isThirdPartyPortal": true,
10
  "lastModifiedAt": "2025-03-27T01:54:33.918Z",
11
  "lastModifiedBy": "string",
12
  "nextScheduledAccountRunAt": "2025-03-27T01:54:33.918Z",
13
  "provider": {
14
    "country": "string",
15
    "id": "string",
16
    "isIntervalDataSupported": true,
17
    "isRealTimeCredentialValidationSupported": true,
18
    "name": "string"
19
  },
20
  "status": "CONNECTION_SUCCESS",
21
  "statusDetail": "LOGIN_AND_DATA_DISCOVERY_SUCCESS",
22
  "totalAccounts": 0,
23
  "username": "string",
24
  "username2": "string",
25
  "username3": "string",

200OK