FOR PUBLIC USE ONLY.
The beBettor API provides an automated and scalable solution for customer affordability screening. The data we provide helps our clients improve their customer interaction frameworks, develop deeper insights into their customers, design safer online experiences and make more informed business decisions.
To learn more about. The API exposes 3 endpoints secured with apiKey authentication. ## For AI agents Programmatically perform a check., retrieve a detailed report.. Covers 3 operations with apiKey authentication. ## Scope Does not handle payments, communications, or crm - use for analytics only. ## Capabilities - Perform a check. - Retrieve a detailed report. - Search checks. - Query and filter beBettor API records by parameters - Monitor beBettor API operational status and events ## Use cases ### Analytics Operations Use the beBettor API to perform analytics operations programmatically. The API provides 3 endpoints covering core functionality including perform a check., retrieve a detailed report., search checks.. Example prompt: Call POST /check to perform a check. ### Automated Check Management Automate check operations by combining multiple beBettor API endpoints. Agents can retrieve a detailed report. and then search checks. in a single workflow. Example prompt: Call GET /report/{checkId} to retrieve a detailed report., then verify the result ### AI Agent Integration via Jentic AI agents discover and call beBettor API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually. Example prompt: Search Jentic for 'perform a check.', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /check | Perform a check. | | GET | /report/{checkId} | Retrieve a detailed report. | | GET | /search | Search checks. | ## Key resources - **Check** — Operations for check - **Report** — Operations for report - **Search** — Operations for search ## Why Jentic - **Setup:** This beBettor API uses an API-key request header and offers separate production and sandbox hosts, so hand-wiring it means placing the key header on every call, choosing the right host, and handling retries yourself. Through Jentic you install once, import the beBettor API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** This API puts the check id in the URL path (/report/{checkId}), so a rule can pin your agent to reading one check's report. You choose the operations it may call, so you can allow report reads and searches while leaving check creation out unless you add it. - **Credential handling:** Your beBettor API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'run an affordability check' or 'get a check report', and Jentic returns the matching beBettor API operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Mixpanel** — Alternative analytics API - **Amplitude** — Alternative analytics API - **Segment** — Complementary analytics API - **Pendo** — Complementary analytics API ## FAQ ### What authentication does the beBettor API use? The beBettor API uses an API key passed in the `X-Api-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I perform a check. with the beBettor API? Yes. Use the POST /check endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the beBettor API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I perform a check. through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'perform a check.'. Jentic returns the matching beBettor API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the beBettor API have? The beBettor API exposes 3 endpoints covering check, report, search operations. ### Can I limit what my agent is allowed to do with the beBettor API? Yes. Jentic One is self-hosted, so your own rules decide which beBettor API operations and credentials the agent may use. You can allow read-only access to GET /report/{checkId} and GET /search while leaving POST /check out, so the agent can retrieve and search affordability reports without creating new checks. Because the check id sits in the path (/report/{checkId}), you can also pin the agent to reading a single check's report.