Consumer API
90 operations across 33 resources. Choose a resource to see its requests, responses and who may call them.
Base URL: $CONSUMER_API
- InvoicesList invoices for explicitly linked consumer accounts · Get an invoice authorized for the authenticated consumer · List consumer invoice notes · Download one of the caller's invoices as PDF · Dispute an invoice on one of the caller's accounts5 operations
- ReceiptsList consumer receipts · Get a receipt authorized for the authenticated consumer · Printable HTML receipt in Portuguese · Download one of the caller's receipts as PDF4 operations
- ReadingsList readings for an explicitly linked account · Submit a meter reading for an explicitly linked account2 operations
- Reading disputesList consumer reading disputes · Dispute a reading linked to an explicitly authorized account2 operations
- Meter inspection requestsList inspection requests for a linked account · Submit consumer meter inspection request2 operations
- ConsumptionList immutable consumption for an explicitly linked account1 operation
- SearchSearch the authenticated consumer's own resources1 operation
- AccountsList consumer accounts · Get consumer account · Revoke the authenticated consumer's access to an account · List delegates and pending invitations · Invite a delegate with limited permissions …7 operations
- Payment sessionsList payment sessions for linked accounts · Request provider-hosted checkout for a payable invoice · Get payment-session status · Confirm a sandbox session4 operations
- PaymentsList consumer payments1 operation
- Notification preferencesList communication preferences and consent · Update communication preferences and consent2 operations
- ConnectionsList consumer water service connections · Apply for a new water service connection · Get consumer connection3 operations
- Connection applicationsCreate consumer connection application1 operation
- Service requestsList the signed-in person's own service requests · Get one of the signed-in person's own service requests · Withdraw one of the signed-in person's open service requests · List the quotes of one of the signed-in person's requests · List the days the requester can choose for a site visit …6 operations
- Service quotesAccept a quote · Decline a quote2 operations
- CasesList collection cases for consumer · Get a collection case on one of the caller's accounts2 operations
- Payment plansList payment plans for consumer · Get a payment plan authorized for the authenticated consumer2 operations
- TicketsList consumer support tickets · Submit a consumer complaint or service request · Get consumer ticket details · List comments on consumer ticket · Add comment to consumer ticket5 operations
- OnboardingGet consumer onboarding status and requirements · Update profile, notification consent or terms2 operations
- Account linksList linked accounts and pending requests · Create account link · Leave an account or cancel a pending request3 operations
- OverviewGet consumer overview1 operation
- Payment availabilityGet consumer payment availability1 operation
- InterruptionsList consumer interruptions1 operation
- CreditsGet consumer account credit balance and active grants · Redeem a promotional credit code2 operations
- Leak allowancesCheck an invoice against the leak allowance policy · List the consumer's leak allowance applications · Apply with proof of repair · Get an application4 operations
- Payment proofsList the proofs of payment the consumer sent · Send a proof of a payment made outside the app · Download one of the consumer's own proofs3 operations
- PrepaidList the consumer's prepaid meters · List the consumer's purchases · Buy prepaid water by mobile money · Get a purchase, reconciling it if payment has settled · Download the purchase receipt PDF5 operations
- First runRead first-use progress for one journey · Skip or resume one first-use step · Record an explicit exit from a first-use journey3 operations
- Next stepsThe next one to three first-use steps1 operation
- DeveloperAccount permissions the caller can put on a personal API key · List the caller's personal API keys · Create a personal API key · Roll consumer developer api key · Revoke a personal API key immediately5 operations
- InboxList in-app messages addressed to the caller · Mark one of the caller's inbox messages as read · Archive one of the caller's inbox messages3 operations
- RelationshipsList the caller's relationships with utilities · Start a relationship with a utility without an account · End one of the caller's relationships with a utility3 operations
- Payment basketsStart payments for several invoices at once1 operation