HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Update Credential

patch
https://api.urjanet.com/utility/credentials/

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.

Path Params
string
required

Credential ID (UUID)

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
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
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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 8 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
Updated 8 months ago