Step 5: Validate Credentials

Purpose: Calling this method will validate the utility credentials.

The transactionID from step #4 (start UtilityID Verification) is required.

User-experience: Use this endpoint to submit the end-user provided utility credentials. If the credentials are invalid, the callback status will update and the end-user can retry. The end-user does not need to wait for the Name and Address data to be retrieved once the credentials have been validated. Once the user has been authenticated they can move on to other onboarding tasks.

Sample Request

POST /utilityid/v1/credentials HTTP/1.1
Host: api.globaldatacompany.com
Authorization: Basic <AUTH>
Content-Type: application/json

{
  "TransactionID": "dc401883-8ebe-4357-b380-335ee3d5fb96",
  "Username": "SUCCESS",
  "Password": "mock_password"
}

The response will return 200 and a message informing the credentials were successfully submitted.

📘

Important

An update will be sent to the callback URL (provided in Step 4: start UtilityID verification) indicating if the credentials are valid.

Sample Callback Update

Valid Credentials

{
  "transactionId": "dc401883-8ebe-4357-b380-335ee3d5fb96",
  "transactionRecordId": "",
  "rtsTransactionID": "cd758a6b-6101-42b6-983f-93231be51868",
  "status": "Valid Credentials"
}

Invalid Credentials

{
  "transactionId": "dc401883-8ebe-4357-b380-335ee3d5fb96",
  "transactionRecordId": "",
  "rtsTransactionID": "cd758a6b-6101-42b6-983f-93231be51868",
  "status": "Invalid Credentials"
}

Sample User-Experience