canonical: https://jentic.com/apis/liquidhome.tech/liquidhome # Liquidhome Tech Liquid Retail ZW API The Liquid Retail ZW API backs the Liquid Home customer app in Zimbabwe: it signs a customer in, returns their profile with current balance, billing currency, and subscribed services with quota and top-up details, and lists their bills with totals, amounts owing, due and paid dates, and PDF links. It also reports data usage as received, transmitted, and total figures, and serves the app's news articles, promotional banners, and legal documents. ## For AI agents Sign a Liquid Home Zimbabwe customer in, read their balance, services, and bills, and check data usage, news, banners, and legal links. ## Scope Does not take payments, change service plans, or buy top-ups. Use for reading a Liquid Home customer's profile, bills, and data usage only. ## Capabilities - Sign a customer in with username and password to get a bearer token - Read a customer's profile with currentBalance, billingCurrency, and services including quota, quotaUsage, and topUpExpiry - List bills with number, total, owing, dueDate, paidDate, and a pdfUrl for each invoice - Check data usage broken down into received, transmitted, and total - Fetch news articles, promotional banners, and legal document links shown in the app ## Use cases ### Agent-run account check-ins through Jentic A personal assistant agent can answer a Liquid Home customer's account questions: it reads the profile for the current balance and service quotas, lists bills to find what is owing and when it is due, and checks data usage. Through Jentic the agent finds each operation by intent and loads its schema, while the customer's sign-in credentials stay out of its context. Example prompt: Get the profile and report currentBalance with billingCurrency, then list bills and return the number, owing amount, and dueDate of any bill without a paidDate. ### Bill tracking and reminders Each bill carries its number, total, amount owing, currency, bill date, due date, paid date, and a PDF link, so an agent can remind a customer before a due date, confirm when a bill is paid, and fetch the invoice PDF for records. Example prompt: List bills, find the most recent by billDate, and return its total, owing, dueDate, and pdfUrl. ### Data usage monitoring The usage operation reports data received, transmitted, and total, and the profile's services show quota, quotaTotal, quotaUsage, and any top-up with its expiry, so an agent can warn a customer when they are close to their quota. Example prompt: Fetch usage and the profile, then compare quotaUsage with quotaTotal for each service and flag any service that is close to its quotaTotal. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/auth/sign-in` | Sign in | | GET | `/auth/profile` | Get the customer profile | | GET | `/account/bills` | List bills | | GET | `/usage` | Get data usage | | GET | `/news` | List news articles | ## Key resources - **Auth and profile** — Sign-in and the customer profile with balance, billing currency, and services - **Bills** — Customer bills with totals, owing amounts, dates, and PDF links - **Usage** — Data received, transmitted, and total - **Content** — News articles, banners, and legal document links ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 54 / 100 - **Maturity:** Foundational - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 70 / 100 - AI-Readiness & Agent Experience: 29 / 100 - Agent Usability: 94 / 100 - Security: 60 / 100 - AI Discoverability: 50 / 100 - **View full report:** https://jentic.com/apis/liquidhome.tech/liquidhome/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the Liquid Retail ZW API by hand means signing in with a username and password, holding the returned bearer token, and attaching it to each account call. Through Jentic you install once, import it from the API Directory, store the credential once, and your agent calls it. - **Permission scoping:** The Liquid Retail ZW API has no resource ids in its paths: each call reads the signed-in customer's own account, so rules bound which operations your agent may call. You choose the operations it may call, so ones like reading the full profile are not included unless you add them. - **Credential handling:** Your Liquid Home credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'check my internet bill' or 'get data usage', and Jentic returns the matching Liquid Retail ZW operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **MTN Developer API** — Telecom subscriber lookups, SMS, and mobile money - **Flutterwave Payments API** — Card and mobile money payments across Africa - **Airtel Africa API** — Airtel Money payments and status checks ## FAQ ### What authentication does the Liquid Retail ZW API use? Per its OpenAPI spec the Liquid Retail ZW API uses HTTP bearer authentication. The sign-in operation takes a username and password and returns a token, which you then send in the Authorization header. Through Jentic the credentials are stored encrypted by your own Jentic One instance and injected at request time. ### Is there a Liquid Home MCP server? You don't need an MCP server to give your agent the Liquid Retail ZW API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls the profile, bills, and usage operations on demand. ### Can I download my bills with the Liquid Retail ZW API? Yes. The bills operation returns each bill's billKey, number, total, owing, currency, billDate, dueDate, paidDate, and a pdfUrl you can open to get the invoice document. ### What are the rate limits for the Liquid Retail ZW API? The OpenAPI spec does not specify rate limits. Check with Liquid Home at https://liquidhome.tech for current limits. ### Can I limit what my agent is allowed to do with the Liquid Retail ZW API? Yes. For example, allow only the bills and usage operations, so the agent can answer billing and data questions without reading the full profile, which holds the customer's birth date and mobile number. Every call it makes is logged. ### How do I check my Liquid Home data usage through Jentic? Search Jentic for 'check home internet data usage', load the usage operation, and call it; it returns received, transmitted, and total figures. Jentic injects the bearer token at call time. To run it on your own infrastructure, install Jentic One from its GitHub repo.