Create Credential

post

https://api.arcadia.com/plug/credentials

The credential endpoint allows you to create a new credential in the system. In order to create a new credential, you must submit the required provider ID, username, and password as defined by the providers endpoint.

This endpoint supports Sandbox Mode.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

correlationId

string

length between 0 and 255

An ID used to match the utility data pulled for this request back to users in your system. Correlation ID does not have to be unique.

isInteractive

boolean

For a provider that supports real time credential validation, you can create a credential with interactive set as true to receive feedback if the credential is valid or invalid.

password

string

length between 0 and 255

A sensitive input required to access the customer's utility data. This will not be returned in any GET calls for the request object.

password2

string

length between 0 and 255

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.

password3

string

length between 0 and 255

password4

string

length between 0 and 255

privacyPolicyUrl

string

length between 0 and 500

The URL to access the privacy policy you would like to use.

providerId

string

required

The unique identifier of the utility service provider.

termsOfServiceUrl

string

length between 0 and 500

The URL for the terms of service you want to use.

username

string

length between 0 and 255

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

username2

string

length between 0 and 255

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

username3

string

length between 0 and 255

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

username4

string

length between 0 and 255

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

website

string

The provider's website that this credential logs into.

Headers

Arcadia-Version

string

required

Defaults to 2024-02-21

The Arcadia-Version for the request

Response

200OK