Know of an official OpenAPI document? Contribute it →
For Agents
Programmatically this endpoint will be used by edge to retrieve a list of available packages, this endpoint will be used by edge to initiate a background check. Covers 2 operations with basic authentication.
Use for: I need to this endpoint will be used by edge to retrieve a list of available packages, I want to this endpoint will be used by edge to initiate a background check, Get the current status of Edge Background Check Connector resources, List all records from Edge Background Check Connector
Not supported: Does not handle payments, communications, or crm - use for developer tools only.
Edge Custom Background Check API Template. Use this template to help generate your API contracts so that you can connect with CSOD and become a custom background check provider. Detailed in this API are endpoints that should be implemented so that the contract can adhere to Edge Custom Background Check Provier standards. The API exposes 2 endpoints secured with basic authentication.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Edge Background Check Connector, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswaggerhub.csodedge%2Fedge-background-check-connector" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswaggerhub.csodedge%2Fedge-background-check-connector" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Edge Background Check Connector API.
This endpoint will be used by Edge to retrieve a list of available packages
Manage developer tools data programmatically
Integrate Edge Background Check Connector into automated workflows
Query and filter Edge Background Check Connector records by parameters
Monitor Edge Background Check Connector operational status and events
Patterns agents use Edge Background Check Connector API for, with concrete tasks.
★ Developer Tools Operations
Use the Edge Background Check Connector to perform developer tools operations programmatically. The API provides 2 endpoints covering core functionality including this endpoint will be used by edge to retrieve a list of available packages, this endpoint will be used by edge to initiate a background check.
Call GET /api/Packages to this endpoint will be used by edge to retrieve a list of available packages
Data Retrieval and Monitoring
Query Edge Background Check Connector 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.
Poll the primary Edge Background Check Connector endpoint, compare response to last known state, and alert if changed
AI Agent Integration via Jentic
AI agents discover and call Edge Background Check Connector 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 basic tokens manually.
Search Jentic for 'this endpoint will be used by edge to retrieve a list of available packages', load the operation schema, and execute with Jentic-managed credentials
2 endpoints — edge custom background check api template.
METHOD
PATH
DESCRIPTION
/api/Packages
This endpoint will be used by Edge to retrieve a list of available packages
/api/InitiateBackgroundCheck
This endpoint will be used by Edge to initiate a background check
/api/Packages
This endpoint will be used by Edge to retrieve a list of available packages
/api/InitiateBackgroundCheck
This endpoint will be used by Edge to initiate a background check
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Edge Background Check Connector by hand means setting up its HTTP basic auth, encoding the credentials on each call, and matching the packages and background-check request formats yourself. Through Jentic you install once, import the Edge Background Check Connector from the API Directory, store the basic-auth credential once, and your agent calls it.
Permission scoping
This connector takes its background-check details in the request body rather than a URL path, so limit the agent to the operations it needs, such as retrieving available packages. You choose which operations are allowed, so a write like initiating a background check is only included if you add it.
Credential isolation
Your Edge Background Check Connector basic-auth credential 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.
Intent-based discovery
Agents search Jentic by intent such as 'list available packages' or 'initiate a background check', and Jentic returns the matching Edge Background Check Connector operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Github
Alternative developer tools API
Choose Github when you need a different approach to developer tools operations
Specific to using Edge Background Check Connector API through Jentic.
What authentication does the Edge Background Check Connector use?
The Edge Background Check Connector uses HTTP Basic authentication with username and password. 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 this endpoint will be used by edge to retrieve a list of available packages with the Edge Background Check Connector?
Yes. Use the GET /api/Packages endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Edge Background Check Connector?
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 this endpoint will be used by edge to retrieve a list of available packages through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'this endpoint will be used by edge to retrieve a list of available packages'. Jentic returns the matching Edge Background Check Connector operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Edge Background Check Connector have?
The Edge Background Check Connector exposes 2 endpoints covering initiatebackgroundcheck, packages operations.
Can I limit what my agent is allowed to do with the Edge Background Check Connector?
Yes. Because Jentic One is self-hosted, you decide which of the connector's operations and which basic-auth credential your agent may use. You can allow only the read operation, GET /api/Packages, so the agent lists available packages without being able to start a check, and you include the write operation, POST /api/InitiateBackgroundCheck, only if you explicitly add it. Your own rules govern every call the agent can make.
GET STARTED