Skip to main content

Fetch customer information from an electricity provider

GET /v2/bill/electricity/lookup

Use this endpoint to confirm a customer’s details before you vend electricity. It returns the customer’s name and address as held by the electricity provider.
GET /v1/bill/electricity/lookup is deprecated and will be removed in a future release. It returns only the customer’s name as a string. Move to GET /v2/bill/electricity/lookup, where data is an object containing name and address.

Query parameters

string
required
The code name of the electricity provider as gotten when the list of discos is fetched e.g. phed
string
required
The unique identifier of the customer on the provider’s platform, such as the meter number

Response body

string
required
Response code
string
required
Response description
object
required
The customer’s details
string
required
Response message