The ApexVerify connector lets your AI agent act in each user's ApexVerify account. Each user connects their own ApexVerify API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 10 tools.
- Tools
- 10
- What they doRead · write · destructive
- 5 · 4 · 15 read4 write1 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ApexVerify connection
In AgentKit > Connections, create an ApexVerify connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'apexverify'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize ApexVerify:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'apexverify_batches_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "apexverify"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize ApexVerify:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="apexverify_batches_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ApexVerify credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolapexverify_batch_details_getGet a batch's full details.Read-onlyGet Batch Details
Get a batch's full details. Returns its UUID, status, name, description, verification parameters, uploaded content and metadata. Use apexverify_batch_get for a lighter status check.
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
apexverify_batch_exportExport a finished batch's results as JSON.Read-onlyExport Batch Results
Export a finished batch's results as JSON. Returns the data rows with their verification results, plus optional statistics and details sections. Use this after apexverify_batch_get shows the batch is complete.
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
include_detailsboolean- Include the details section. Defaults to true. Example: true.
include_statisticsboolean- Include the statistics section. Defaults to true. Example: true.
apexverify_batch_getGet a batch's current status.Read-onlyGet Batch Status
Get a batch's current status. Returns the status and, once available, execution costs, result counts and refunds. Use this to poll a batch after launching it. Use apexverify_batch_details_get for its parameters and content, and apexverify_batch_export for per-row results.
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
apexverify_batches_listList the account's batch files, newest first.Read-onlyList Batches
List the account's batch files, newest first. Returns each batch's UUID, name, status and creation date. Use this to find a batch UUID. Use apexverify_batch_get for one batch's status and results.
Inputs
from_datestring- Only batches created on or after this date (YYYY-MM-DD). Example: 2026-01-01.
limitinteger- Maximum number of batches to return. Defaults to 100. Example: 50.
offsetinteger- Number of batches to skip, for paging. Defaults to 0. Example: 0.
to_datestring- Only batches created on or before this date (YYYY-MM-DD). Example: 2026-01-31.
apexverify_credits_getGet the ApexVerify account's remaining verification credits.Read-onlyGet Credits
Get the ApexVerify account's remaining verification credits. Returns the email and phone credit balances. Use this before large verifications, or to confirm the connection works.
Inputs
This tool takes no inputs.
apexverify_batch_launchStart verifying a prepared batch.WriteLaunch Batch Verification
Start verifying a prepared batch. Uses credits for every row. Returns the batch's new status. The batch must be ready_for_verification (see apexverify_batch_prepare). Poll apexverify_batch_get until it finishes.
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
apexverify_batch_prepareParse and prepare an uploaded batch for verification with its current parameters.WritePrepare Batch
Parse and prepare an uploaded batch for verification with its current parameters. Can be run again after changing parameters. Returns the batch's preparation status. Run this before apexverify_batch_launch; the batch must reach ready_for_verification.
- Idempotent
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
apexverify_batch_updateChange a batch's verification parameters (type, country, audience, cache and cleanup options) before it is launched.WriteUpdate Batch Parameters
Change a batch's verification parameters (type, country, audience, cache and cleanup options) before it is launched. Returns the updated batch. Run apexverify_batch_prepare afterwards so the content is reprocessed with the new parameters.
- Idempotent
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
target_countrystringrequired- ISO 3166-1 alpha-2 country the data is verified against (used for phone formats and scoring), for example US, GB or SG. Example: US.
typestringrequired- Kind of data to verify: email or phone. Example: email.one of
emailphone max_account_cache_backoffinteger- How many days back (1 to 180) to look for account cache matches. Defaults to 30. Example: 30.
max_global_cache_backoffinteger- How many days back (1 to 180) to look for global cache matches. Defaults to 30. Example: 30.
remove_duplicateboolean- Remove duplicate rows when preparing the batch. Defaults to true. Example: true.
remove_wrong_email_formatboolean- Remove rows that are not valid email addresses when preparing the batch. Defaults to true. Example: true.
remove_wrong_phone_formatboolean- Remove rows that are not valid phone numbers when preparing the batch. Defaults to true. Example: true.
target_audienceinteger- Target audience code, used to tune scoring: 1 Agency/Consultants, 2 Creators & Influencers, 3 Customer Support & Success, 4 Developers & Technical Leads, 5 E-commerce & Retail Managers, 6 Enterprise Decision-Makers, 7 Finance & Operations, 8 Founders & C-Level, 9 Freelancers & Solopreneurs, 10 Government & Public Sector, 11 HR & Talent Acquisition, 12 Healthcare Professionals, 13 Hobbyists & Enthusiasts, 14 Investors & VCs, 15 Job Seekers, 16 Legal Professionals, 17 Marketing & Sales, 18 Non-Profit, 19 Parents & Families, 20 Product & Project Managers, 21 Real Estate, 22 SMB Owners, 23 Students & Educators. Example: 17.
target_market_industryinteger- Target industry code from 1 to 115 (NAICS-style list in the ApexVerify API reference, for example 29 Finance and Insurance). Example: 29.
target_objectiveinteger- Campaign objective code: 1 App Installs, 2 Audience Building, 3 Brand Awareness, 4 Customer Acquisition/Sales, 5 Free Trial Signups, 6 Lead Generation, 7 Loyalty & Referral, 8 Market Research, 9 New Market Entry, 10 Partner Recruitment, 11 Product Engagement, 12 Sales-Ready Leads, 13 Upsell/Cross-sell, 14 Retention, 15 Waitlist/Pre-order, 16 Website/App Traffic. Example: 6.
use_account_cacheboolean- Reuse your own earlier results for the same data, refunding 50% of those credits. Defaults to true. Example: true.
use_global_cacheboolean- Reuse anonymously shared results from all accounts, refunding 50% of those credits; your results are shared in turn. Defaults to true. Example: true.
apexverify_unit_verifyVerify one email address or phone number in real time (up to about 5 seconds).WriteVerify Email or Phone
Verify one email address or phone number in real time (up to about 5 seconds). Uses one credit unless a cache match refunds part of it. Returns the verification status and result details for the value. Use this for a single value. For a list, upload a batch in the ApexVerify dashboard and use apexverify_batch_launch.
Inputs
target_countrystringrequired- ISO 3166-1 alpha-2 country the data is verified against (used for phone formats and scoring), for example US, GB or SG. Example: US.
typestringrequired- Kind of data to verify: email or phone. Example: email.one of
emailphone unitstringrequired- The email address or phone number to verify. Example: jane.doe@example.com.
max_account_cache_backoffinteger- How many days back (1 to 180) to look for account cache matches. Defaults to 30. Example: 30.
max_global_cache_backoffinteger- How many days back (1 to 180) to look for global cache matches. Defaults to 30. Example: 30.
target_audienceinteger- Target audience code, used to tune scoring: 1 Agency/Consultants, 2 Creators & Influencers, 3 Customer Support & Success, 4 Developers & Technical Leads, 5 E-commerce & Retail Managers, 6 Enterprise Decision-Makers, 7 Finance & Operations, 8 Founders & C-Level, 9 Freelancers & Solopreneurs, 10 Government & Public Sector, 11 HR & Talent Acquisition, 12 Healthcare Professionals, 13 Hobbyists & Enthusiasts, 14 Investors & VCs, 15 Job Seekers, 16 Legal Professionals, 17 Marketing & Sales, 18 Non-Profit, 19 Parents & Families, 20 Product & Project Managers, 21 Real Estate, 22 SMB Owners, 23 Students & Educators. Example: 17.
target_market_industryinteger- Target industry code from 1 to 115 (NAICS-style list in the ApexVerify API reference, for example 29 Finance and Insurance). Example: 29.
target_objectiveinteger- Campaign objective code: 1 App Installs, 2 Audience Building, 3 Brand Awareness, 4 Customer Acquisition/Sales, 5 Free Trial Signups, 6 Lead Generation, 7 Loyalty & Referral, 8 Market Research, 9 New Market Entry, 10 Partner Recruitment, 11 Product Engagement, 12 Sales-Ready Leads, 13 Upsell/Cross-sell, 14 Retention, 15 Waitlist/Pre-order, 16 Website/App Traffic. Example: 6.
use_account_cacheboolean- Reuse your own earlier results for the same data, refunding 50% of those credits. Defaults to true. Example: true.
use_global_cacheboolean- Reuse anonymously shared results from all accounts, refunding 50% of those credits; your results are shared in turn. Defaults to true. Example: true.
apexverify_batch_deleteDelete a batch and its results, before or after verification but not while it is processing.DestructiveDelete Batch
Delete a batch and its results, before or after verification but not while it is processing. Returns a confirmation. This cannot be undone.
- Idempotent
Inputs
batch_uuidstringrequired- UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
No tools match.