Step 4: Start UtilityID Verification

Purpose: Calling this method will start the UtilityID verification process and return the login schema for the selected utility provider. Each provider has its own set of required fields for the login schema.

The transactionID returned in the response will be needed to validate utility provider credentials.

📘

Important

The CallbackURL is required in the request as UtilityID works asynchronously.

User-experience: Call this endpoint to receive the login schema for the utility provider, after the end-user has selected their utility provider. The response will contain the required login schema fields which will need to be filled out by your end-user.

Sample Request

POST /utilityid/v1/verify HTTP/1.1
Host: api.globaldatacompany.com
Authorization: Basic 
Content-Type: application/json

{
    "AcceptTruliooTermsAndConditions": true,
    "ConfigurationName": "Identity Verification",
    "CountryCode": "CA",
    "CallBackUrl": "https://webhook.site/75295e44-42d9-4372-905e-7f22c2c49446?",
    "ProviderName": "BC Hydro",
    "DataFields": {
        "PersonInfo": {
            "FirstGivenName": "Test",
            "FirstSurName": "User"
        },
        "Location": {
            "City": "Vancouver",
            "StateProvinceCode": "BC",
            "PostalCode": "V6E 2E9",
            "AdditionalFields": {
                "Address1": "1055 W Hastings St"
            }
        }
    }
}

📘

Important

The TransactionID returned will be needed for all subsequent requests. The schema returns the login schema that must be collected from end-users.

Sample Response

{
    "TransactionID": "dc401883-8ebe-4357-b380-335ee3d5fb96",
    "Schema": {
        "requiredFields": [
            "password",
            "email"
        ],
        "requiredFieldMetadata": [
            {
                "fieldName": "password",
                "fieldLabel": "Password",
                "fieldNumber": 2,
                "fieldPart": 1
            },
            {
                "fieldName": "email",
                "fieldLabel": "Email",
                "fieldNumber": 1,
                "fieldPart": 1
            }
        ]
    },
 
    "Errors": []
}

Sample User-Experience


Did this page help you?