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.

Body Params

request

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.

interactive

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.

providerId

string

required

Provider ID (UUID)

username

string

required

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

See username2

username4

string

length between 0 and 255

See username2

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

See password2

password4

string

length between 0 and 255

See password2

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/hal+json

202Accepted