> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ApexVerify

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.

**Authentication:** API Key
**Categories:** Marketing, Analytics
**Tools:** 10: 5 read, 4 write, 1 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=APEXVERIFY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ApexVerify connection

   In **AgentKit > Connections**, create an ApexVerify connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'apexverify'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'apexverify_batches_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "apexverify"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="apexverify_batches_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ApexVerify credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'apexverify_batch_details_get',
  toolInput: {
    batch_uuid: '<batch_uuid>',
  },
  connector: 'apexverify',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="apexverify_batch_details_get",
    tool_input={
        "batch_uuid": "<batch_uuid>",
    },
    connection_name="apexverify",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `apexverify_batch_details_get`

Get Batch Details · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.

Example input: `{"batch_uuid":"<batch_uuid>"}`

### `apexverify_batch_export`

Export Batch Results · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
- `include_details` (`boolean`, optional): Include the details section. Defaults to true. Example: true.
- `include_statistics` (`boolean`, optional): Include the statistics section. Defaults to true. Example: true.

Example input: `{"batch_uuid":"<batch_uuid>"}`

### `apexverify_batch_get`

Get Batch Status · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.

Example input: `{"batch_uuid":"<batch_uuid>"}`

### `apexverify_batches_list`

List Batches · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_date` (`string`, optional): Only batches created on or after this date (YYYY-MM-DD). Example: 2026-01-01.
- `limit` (`integer`, optional): Maximum number of batches to return. Defaults to 100. Example: 50.
- `offset` (`integer`, optional): Number of batches to skip, for paging. Defaults to 0. Example: 0.
- `to_date` (`string`, optional): Only batches created on or before this date (YYYY-MM-DD). Example: 2026-01-31.

Example input: `{}`

### `apexverify_credits_get`

Get Credits · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `apexverify_batch_launch`

Launch Batch Verification · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.

Example input: `{"batch_uuid":"<batch_uuid>"}`

### `apexverify_batch_prepare`

Prepare Batch · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.

Example input: `{"batch_uuid":"<batch_uuid>"}`

### `apexverify_batch_update`

Update Batch Parameters · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.
- `target_country` (`string`, required): 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.
- `type` (`string`, required): Kind of data to verify: email or phone. Example: email. One of: `email`, `phone`.
- `max_account_cache_backoff` (`integer`, optional): How many days back (1 to 180) to look for account cache matches. Defaults to 30. Example: 30.
- `max_global_cache_backoff` (`integer`, optional): How many days back (1 to 180) to look for global cache matches. Defaults to 30. Example: 30.
- `remove_duplicate` (`boolean`, optional): Remove duplicate rows when preparing the batch. Defaults to true. Example: true.
- `remove_wrong_email_format` (`boolean`, optional): Remove rows that are not valid email addresses when preparing the batch. Defaults to true. Example: true.
- `remove_wrong_phone_format` (`boolean`, optional): Remove rows that are not valid phone numbers when preparing the batch. Defaults to true. Example: true.
- `target_audience` (`integer`, optional): 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_industry` (`integer`, optional): Target industry code from 1 to 115 (NAICS-style list in the ApexVerify API reference, for example 29 Finance and Insurance). Example: 29.
- `target_objective` (`integer`, optional): 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_cache` (`boolean`, optional): Reuse your own earlier results for the same data, refunding 50% of those credits. Defaults to true. Example: true.
- `use_global_cache` (`boolean`, optional): Reuse anonymously shared results from all accounts, refunding 50% of those credits; your results are shared in turn. Defaults to true. Example: true.

Example input: `{"batch_uuid":"<batch_uuid>","target_country":"<target_country>","type":"email"}`

### `apexverify_unit_verify`

Verify Email or Phone · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `target_country` (`string`, required): 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.
- `type` (`string`, required): Kind of data to verify: email or phone. Example: email. One of: `email`, `phone`.
- `unit` (`string`, required): The email address or phone number to verify. Example: jane.doe@example.com.
- `max_account_cache_backoff` (`integer`, optional): How many days back (1 to 180) to look for account cache matches. Defaults to 30. Example: 30.
- `max_global_cache_backoff` (`integer`, optional): How many days back (1 to 180) to look for global cache matches. Defaults to 30. Example: 30.
- `target_audience` (`integer`, optional): 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_industry` (`integer`, optional): Target industry code from 1 to 115 (NAICS-style list in the ApexVerify API reference, for example 29 Finance and Insurance). Example: 29.
- `target_objective` (`integer`, optional): 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_cache` (`boolean`, optional): Reuse your own earlier results for the same data, refunding 50% of those credits. Defaults to true. Example: true.
- `use_global_cache` (`boolean`, optional): Reuse anonymously shared results from all accounts, refunding 50% of those credits; your results are shared in turn. Defaults to true. Example: true.

Example input: `{"target_country":"<target_country>","type":"email","unit":"<unit>"}`

### `apexverify_batch_delete`

Delete Batch · Destructive

Delete a batch and its results, before or after verification but not while it is processing.
Returns a confirmation.
This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `batch_uuid` (`string`, required): UUID of the batch, from apexverify_batches_list. Example: 3f1c9a52-7d4e-4b8a-9c2f-1e6d5a7b8c90.

Example input: `{"batch_uuid":"<batch_uuid>"}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
