FOR CLIENT USE ONLY.
This version of the documentation focuses specifically on the Wealth Check.
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 cus. The API exposes 2 endpoints secured with apiKey authentication. ## For AI agents Programmatically perform a check., search checks.. Covers 2 operations with apiKey authentication. ## Scope Does not handle payments, communications, or crm - use for analytics only. ## Capabilities - Perform a check. - Search checks. - Integrate beBettor API (Wealth Check) into automated workflows - Query and filter beBettor API (Wealth Check) records by parameters - Monitor beBettor API (Wealth Check) operational status and events ## Use cases ### Analytics Operations Use the beBettor API (Wealth Check) to perform analytics operations programmatically. The API provides 2 endpoints covering core functionality including perform a check., search checks.. Example prompt: Call POST /check to perform a check. ### Data Retrieval and Monitoring Query beBettor API (Wealth Check) resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed. Example prompt: Poll the primary beBettor API (Wealth Check) endpoint, compare response to last known state, and alert if changed ### AI Agent Integration via Jentic AI agents discover and call beBettor API (Wealth Check) 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 | /search | Search checks. | ## Key resources - **Check** — Operations for check - **Search** — Operations for search ## Why Jentic - **Setup:** This beBettor API (Wealth Check) 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 (Wealth Check) from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** This API takes its inputs through the request body and query on /check and /search rather than a resource id in the URL path, so scope by operation: limit the agent to the operations it needs, such as running a wealth check or searching, and leave the rest out unless you add them. - **Credential handling:** Your beBettor API (Wealth Check) 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 'search for a record', and Jentic returns the matching beBettor API (Wealth Check) 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 (Wealth Check) use? The beBettor API (Wealth Check) 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 (Wealth Check)? 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 (Wealth Check)? 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 (Wealth Check) operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the beBettor API (Wealth Check) have? The beBettor API (Wealth Check) exposes 2 endpoints covering check, search operations. ### Can I limit what my agent is allowed to do with the beBettor Wealth Check API? Yes. Because you run Jentic One yourself, you decide which of the beBettor Wealth Check operations your agent may call and which credentials it may use. This API is scoped by operation rather than by resource ID in the URL, so you can allow only POST /check to run an affordability check, only GET /search to look up existing checks, or both, and leave every other operation out. The stored API key is injected at execution time so it never enters the agent's prompt or logs.