HomeGuidesAPI ReferenceChangelog
Log In
API Reference
Start typing to search…

Create Credential

post https://api.urjanet.com/utility/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.

Log in to see full request history
Body Params

request

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.

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.

string
required

Provider ID (UUID)

string
required
length between 0 and 255

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

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

string
length between 0 and 255

See username2

string
length between 0 and 255

See username2

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.

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.

string
length between 0 and 255

See password2

string
length between 0 and 255

See password2

Response

Response body
object
string | null
required

An ID used to match the utility data pulled for this request back to users in your system. This field is searchable.

string
required
date-time
required

The date-time the credential was registered in Urjanet's system. This field is searchable.

boolean
required

Controls whether data will continue to be extracted behind this credential. This field is searchable.

string
required

Credential ID (UUID)

string
required
date-time
required

This field is searchable.

date-time
required

The time that this credential is next scheduled to be ran in our system. This field is searchable.

provider
object
required
string | null
required

The provider's country

string

The ID of the provider

string
required

The provider's name

boolean | null
required

Whether or not the provider supports credential validation

string
required

This field is searchable.

boolean
required

This field is searchable.

string
required

A high-level status for the credential. See this table for more information. This field is searchable.

OK PENDING ACTION_REQUIRED

string
required

A detailed status for the credential. See this table for more information. This field is searchable.

ACCOUNT_LOCKED E_BILL_REQUIRED LOGIN_FAILURE MULTI_FACTOR_AUTH_FAILURE NAVIGATION_FAILURE NO_ACCOUNTS_FOUND NO_ACTION_REQUIRED SECURITY_QUESTIONS STATEMENT_UNAVAILABLE UNDER_REVIEW UNSUPPORTED_CAPTCHA USER_ACTION_REQUIRED WEBSITE_DOWN ACCOUNT_SETUP_REQUIRED

number
required

The number of accounts that we have seen behind this credential over time. This field is searchable.

string
required

A login input required to access the customer's utility data. This field is searchable.

string | null
required

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

string | null
required

See username2

string | null
required

See username2

_links
object
self
object
accounts
object
consent
object
events
object
passwords
object
provider
object
updateUrl
object

Updated over 1 year ago

Did this page help you?
Language
Credentials

Updated over 1 year ago

Did this page help you?