How to use the API keys page in Credibled
The API Keys page lets you connect your own application or ATS to Credibled, set up a sandbox environment for safe testing, configure webhooks, and access the full API documentation. This guide walks you through every section.
Who this is for: Account admins and developers. Regular user accounts do not have access to the API Keys page.
In this article 1. How to access the API Keys page 3. Setting up your sandbox environment |
1. How to access the API Keys page
The API Keys page is only accessible from the admin portal. If you have not accessed the admin portal before, see our article: How to access the admin portal in Credibled.
1 | Open the account menu Click your name in the top-right corner of the screen (shown as Hi, [Your Name]). A dropdown appears with three options: Profile, Admin portal, and Log out. |
2 | Click "Admin portal" Select Admin portal from the dropdown. This opens the admin area with an expanded left navigation, including Billing, Settings, and API Keys. |
3 | Click "API Keys" in the left menu In the left sidebar, select API Keys. This is where you manage everything related to your API integration. |
2. Overview of each section
The API Keys page is divided into four main sections.
| Section | What it does |
| API Documentation | Opens the full API reference in a new tab, including all endpoints, request formats, and authentication details. |
| Your API Keys | Create and manage API keys for your sandbox or production environment. You can hold up to 10 keys per account. |
| Webhook Configuration | Configure a URL to receive real-time push notifications when a check is completed. Optional for basic API setups. |
| Sandbox Environment | A safe testing space that returns dummy results. No checks run here are billed. |
| Rate limit: The API supports up to 500 requests per second per API key. |
3. Setting up your sandbox environment
The sandbox lets you test your integration fully without affecting your live account or incurring any charges.
| Important: All check results returned in the sandbox are dummy data. Criminal record results, credit checks, and all other check types return randomised test values. None of these results are real. |
| Checks run through the sandbox are never billed. You can run as many test checks as you need at no cost. |
1 | Create the sandbox Scroll to the Sandbox Environment section at the bottom of the page. Click + Create Sandbox. This creates an isolated test environment linked to your account. |
2 | Sync your settings Once the sandbox is created, click Sync Settings. This copies your production configuration (branding, logo, address, domain, and country settings) into the sandbox so your test environment matches your live setup. We strongly recommend doing this before running any tests. |
3 | Confirm the sandbox is active After creation, the sandbox status shows Active. You will also see a usage counter showing how many test applications have been run this hour (limit: 100 per hour). A yellow banner at the top of the screen confirms: "You're testing in a sandbox. Changes you make here don't affect your live account." |
4 | Create your sandbox API key You are now ready to create an API key for the sandbox. See Section 4 below for instructions. |
4. Creating your API key
You need an API key to authenticate every request sent to the Credibled API. Keys are environment-specific: create one in the sandbox for testing, and a separate one in production when you go live.
1 | Click "Create API Key" Click the + Create API Key button at the top right of the API Keys page. Give your key a clear, descriptive name such as "Sandbox test" or "Production integration". |
2 | Copy and store your key securely Your API key is shown only once at the time of creation. Copy it immediately and store it securely in your environment variables or a secret manager. Do not hardcode it directly in your application code. |
3 | Include the key in your requests Pass your API key in the curl -X GET "https://api.credibled.com/auth/endpoint" \ -H "X-API-Key: YOUR_API_KEY_HERE" \ -H "Content-Type: application/json" |
5. Accessing the API documentation
The full API reference covers all available endpoints, request and response formats, authentication details, and example calls.
1 | Click "API Documentation" At the top of the API Keys page, click the API Documentation button. This opens the full reference in a new tab. The documentation is available from both the sandbox and the production view at any time, even before you create a key. |
6. Configuring webhooks
Webhooks allow Credibled to automatically notify your application when a check is completed, so your system can react in real time rather than polling the API.
| Webhooks are optional. If you only need to pull results by calling the API directly, you do not need to configure a webhook. |
1 | Locate the Webhook Configuration section On the API Keys page, scroll down to the Webhook Configuration section. The toggle will show as Disabled by default. |
2 | Enter your webhook URL In the Webhook URL field, paste the endpoint URL from your application. This is the URL Credibled will send a POST request to whenever a check is completed. |
3 | Enable the webhook Toggle the Webhook Active switch to enable it. Once active, Credibled will start sending notifications to your URL when checks are completed. |
| Make sure your endpoint is publicly accessible and returns a 200 OK response promptly. If your server takes too long to respond or returns an error, Credibled may retry the delivery. Configure webhook notifications in your sandbox environment first to test your integration before going live. |
7. Moving to production
Once your integration is tested and working in the sandbox, follow these steps to switch to your live environment.
1 | Switch to the production environment Click the Switch to Production button in the top-right corner of the screen. This exits the sandbox view and returns you to your live account. |
2 | Create a production API key On the production API Keys page, click + Create API Key to generate your live key. This is a separate key from your sandbox key. |
3 | Update your application Replace the sandbox API key in your integration with your new production key. All checks run with the production key are real, and standard billing applies. |
| Never use your sandbox key in a production environment. Sandbox results are dummy data and will not reflect real background check outcomes. |
Still need help? Contact our support team at support@credibled.com or reach out through the chat widget inside your account. |
Related Articles
How to Access the Admin Portal in Credibled
How to Access the Admin Portal in Credibled The Admin Portal allows authorized users to manage organization-wide settings in Credibled, including users, departments, billing, questionnaires, and API keys. This article explains who can access the ...How to Access Your Invoices and Usage Base Reports
As an admin user on Credibled, you can easily view, download, and track all your invoices and the associated usage reports directly from the admin dashboard. This ensures full transparency and lets you audit all background checks tied to each billing ...Best Practices for Fast, Complete Criminal Background Checks with Credibled
Before Sending the Background Check Request 1. Set Expectations Early Inform candidates early in the process that a criminal background check is required. Explain why it's necessary and when it will be initiated. 2. Explain the Process Clearly Share ...How to Add a New User in Credibled
Adding a new user to your organization’s Credibled account is quick and easy. Just make sure you're logged in through the Admin portal, as only admin users can manage other users. ✅ Step-by-Step: Adding a New User 1. Log in as Admin Go to ...Incomplete and Discrepancy results for US SSN Verification Scans
Occasionally, the SSN (Social Security Number) Verification Scan portion of a US criminal record check can return as “Incomplete” or “Discrepancy.” In this article, you’ll learn what this result means and what you can do next. This article is ...