> **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 Persona

The Persona connector lets your AI agent act in each user's Persona account. Each user connects their own Persona access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 57 tools.

**Authentication:** Bearer Token
**Categories:** Customer Support, Developer Tools
**Tools:** 57: 24 read, 31 write, 2 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=PERSONA)

## 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 Persona connection

   In **AgentKit > Connections**, create a Persona 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 = 'persona'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Persona:', 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: 'persona_accounts_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 = "persona"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Persona:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="persona_accounts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Persona 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: 'persona_account_get',
  toolInput: {
    account_id: '<account_id>',
  },
  connector: 'persona',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="persona_account_get",
    tool_input={
        "account_id": "<account_id>",
    },
    connection_name="persona",
    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.

### `persona_account_get`

Get Account · Read-only

Get one account with its fields and related objects.
Returns data (id, attributes, relationships).
Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.

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

Inputs:

- `account_id` (`string`, required): Account ID. Example: act_ABC123def456GHI789jkl012

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

### `persona_accounts_list`

List Accounts · Read-only

List accounts (your end users in Persona), optionally filtered by reference ID.
Returns data (a list of records with id, attributes, relationships).
Use persona_accounts_search for complex queries.

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

Inputs:

- `filter_reference_id` (`string`, optional): Filter accounts by reference ID. Can be a single reference ID or an array of reference IDs. Example: user-1234
- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_accounts_search`

Search Accounts · Read-only

Search accounts with attribute conditions, sorting and paging.
Returns data (a list of records with id, attributes, relationships).
Use persona_accounts_list to filter by reference ID.

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

Inputs:

- `query` (`object`, required): Search query object: an attribute condition such as {"attribute": "status", "operator": "eq", "value": "approved"}, or an and/or group of conditions under "and" or "or". Example: {"attribute": "status", "operator": "eq", "value": "approved"}
- `page` (`object`, optional): Paging: {"size": 1-100, "after": "<id>", "before": "<id>"}. Example: {"size": 25}
- `sort` (`object`, optional): Sort order: {"attribute": "created-at", "direction": "desc"}. Example: {"attribute": "created-at", "direction": "desc"}

Example input: `{"query":{"attribute":"status","operator":"eq","value":"approved"}}`

### `persona_case_get`

Get Case · Read-only

Get one case with its status, assignee and attached objects.
Returns data (type, id, attributes, relationships).
Get case IDs from persona_cases_list or persona_cases_search.

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

Inputs:

- `case_id` (`string`, required): Case ID. Example: case_ABC123def456GHI789jkl012

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

### `persona_cases_list`

List Cases · Read-only

List review cases, filtered by status, template, account, inquiry or report.
Returns data (a list of records with type, id, attributes, relationships).
Use persona_cases_search for complex queries.

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

Inputs:

- `filter_account_id` (`string`, optional): Filter cases by account ID. Example: act_ABC123def456GHI789jkl012
- `filter_case_template_id` (`string`, optional): Filter cases by case template ID. Example: ctmpl_ABC123def456GHI789jkl012
- `filter_inquiry_id` (`string`, optional): Filter cases by inquiry ID. Example: inq_ABC123def456GHI789jkl012
- `filter_reference_id` (`string`, optional): Filter cases by reference ID. Example: user-1234
- `filter_report_id` (`string`, optional): Filter cases by report ID. Example: example
- `filter_status` (`string`, optional): Filter cases by status. Example: open
- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_cases_search`

Search Cases · Read-only

Search cases with attribute conditions, sorting and paging.
Returns data (a list of records with type, id, attributes, relationships).
Use persona_cases_list for simple filters.

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

Inputs:

- `query` (`object`, required): Search query object: an attribute condition such as {"attribute": "status", "operator": "eq", "value": "approved"}, or an and/or group of conditions under "and" or "or". Example: {"attribute": "status", "operator": "eq", "value": "approved"}
- `page` (`object`, optional): Paging: {"size": 1-100, "after": "<id>", "before": "<id>"}. Example: {"size": 25}
- `sort` (`object`, optional): Sort order: {"attribute": "created-at", "direction": "desc"}. Example: {"attribute": "created-at", "direction": "desc"}

Example input: `{"query":{"attribute":"status","operator":"eq","value":"approved"}}`

### `persona_document_get`

Get Document · Read-only

Get one document with its extracted fields and files.
Returns data (type, id, attributes, relationships).
Document IDs appear in an inquiry's relationships (persona_inquiry_get).

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

Inputs:

- `document_id` (`string`, required): Document ID. Example: doc_ABC123def456GHI789jkl012

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

### `persona_event_get`

Get Event · Read-only

Get one event with its payload.
Returns data (id, attributes).
Get event IDs from persona_events_list.

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

Inputs:

- `event_id` (`string`, required): Event ID. Example: evt_ABC123def456GHI789jkl012

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

### `persona_events_list`

List Events · Read-only

List events (such as inquiry.completed) filtered by name or object ID.
Returns data (a list of records with id, attributes).
Use persona_event_get for one event's payload.

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

Inputs:

- `filter_id` (`string`, optional): Comma separated list of event ids. Example: example
- `filter_name` (`string`, optional): Comma separated list of event names. Example: Fraud review
- `filter_object_id` (`string`, optional): Comma separated list of object ids. Example: example
- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_inquiries_list`

List Inquiries · Read-only

List verification inquiries, newest first, filtered by account, reference ID, template or status.
Returns data (a list of records with id, attributes, relationships).
Use persona_inquiries_search for complex queries. Use persona_inquiry_get for one inquiry.

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

Inputs:

- `filter_account_id` (`string`, optional): Comma separated list of account IDs (starting with act_) to filter inquiries by. Example: act_ABC123def456GHI789jkl012
- `filter_created_at_end` (`string`, optional): Filter inquiries by creation date, earlier than or equal to. Example: 2026-01-01T00:00:00Z
- `filter_created_at_start` (`string`, optional): Filter inquiries by creation date, equal to or later than. Example: 2026-01-01T00:00:00Z
- `filter_inquiry_id` (`string`, optional): Comma separated list of inquiry IDs (starting with inq_) to filter inquiries by. Example: inq_ABC123def456GHI789jkl012
- `filter_inquiry_template_id` (`string`, optional): Comma separated list of inquiry template IDs (starting with itmpl_) to filter inquiries by. Example: itmpl_ABC123def456GHI789jkl012
- `filter_note` (`string`, optional): Filter inquiries by note. Must be the only filter. Example: Customer requested re-verification
- `filter_reference_id` (`string`, optional): Filter inquiries by reference ID. Example: user-1234
- `filter_status` (`string`, optional): Comma separated list of statuses to filter inquiries by. Example: open
- `filter_template_id` (`string`, optional): Comma separated list of legacy template IDs (starting with tmpl_) to filter inquiries by. Example: example
- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_inquiries_search`

Search Inquiries · Read-only

Search inquiries with attribute conditions, sorting and paging.
Returns data (a list of records with id, attributes, relationships).
Use persona_inquiries_list for simple filters.

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

Inputs:

- `query` (`object`, required): Search query object: an attribute condition such as {"attribute": "status", "operator": "eq", "value": "approved"}, or an and/or group of conditions under "and" or "or". Example: {"attribute": "status", "operator": "eq", "value": "approved"}
- `page` (`object`, optional): Paging: {"size": 1-100, "after": "<id>", "before": "<id>"}. Example: {"size": 25}
- `sort` (`object`, optional): Sort order: {"attribute": "created-at", "direction": "desc"}. Example: {"attribute": "created-at", "direction": "desc"}

Example input: `{"query":{"attribute":"status","operator":"eq","value":"approved"}}`

### `persona_inquiry_get`

Get Inquiry · Read-only

Get one inquiry with its status, fields and related verifications.
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012

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

### `persona_inquiry_session_get`

Get Inquiry Session · Read-only

Get one inquiry session with its device and network details.
Returns data (id, attributes, relationships).
Get session IDs from persona_inquiry_sessions_list.

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

Inputs:

- `inquiry_session_id` (`string`, required): Inquiry Session ID. Example: iqse_ABC123def456GHI789jkl012

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

### `persona_inquiry_sessions_list`

List Inquiry Sessions · Read-only

List inquiry sessions (device sessions in which a user worked on an inquiry), filtered by inquiry.
Returns data (a list of records with id, attributes, relationships).
Use persona_inquiry_session_expire to end one.

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

Inputs:

- `filter_inquiry_id` (`string`, optional): Filter inquiry sessions by inquiry ID. Example: inq_ABC123def456GHI789jkl012

Example input: `{}`

### `persona_inquiry_template_get`

Get Inquiry Template · Read-only

Get one inquiry template.
Returns data (id, attributes, relationships).
Get template IDs from persona_inquiry_templates_list.

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

Inputs:

- `inquiry_template_id` (`string`, required): Inquiry Template ID. Example: itmpl_ABC123def456GHI789jkl012

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

### `persona_inquiry_templates_list`

List Inquiry Templates · Read-only

List inquiry templates (verification flows) in the organization.
Returns data (a list of records with id, attributes, relationships).
Use the template ID with persona_inquiry_create.

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

Inputs:

- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_list_get`

Get List · Read-only

Get one list with its items.
Returns data (type, id, attributes, relationships).
Get list IDs from persona_lists_list.

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

Inputs:

- `list_id` (`string`, required): ID of the list to retrieve. Example: lst_ABC123def456GHI789jkl012

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

### `persona_lists_list`

List Lists · Read-only

List the allow and block lists (emails, IPs, names, countries and more) in the organization.
Returns data (a list of records with type, id, attributes, relationships).
Use persona_list_get for one list.

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

Inputs:

- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_report_get`

Get Report · Read-only

Get one report with its status and matches.
Returns data (type, id, attributes, relationships).
Get report IDs from persona_reports_list.

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

Inputs:

- `report_id` (`string`, required): Report ID. Example: rep_ABC123def456GHI789jkl012

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

### `persona_reports_list`

List Reports · Read-only

List reports (watchlist, adverse media, lookups) filtered by account or reference ID.
Returns data (a list of records with type, id, attributes, relationships).
Use persona_report_get for results.

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

Inputs:

- `filter_account_id` (`string`, optional): Filter reports by account ID. Example: act_ABC123def456GHI789jkl012
- `filter_reference_id` (`string`, optional): Filter reports by reference ID. Example: user-1234
- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_transaction_get`

Get Transaction · Read-only

Get one transaction with its status and fields.
Returns data (id, attributes, relationships).
Get transaction IDs from persona_transactions_list.

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

Inputs:

- `transaction_id` (`string`, required): ID of the transaction to retrieve. Example: txn_ABC123def456GHI789jkl012

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

### `persona_transactions_list`

List Transactions · Read-only

List transactions, filtered by reference ID or transaction type.
Returns data (a list of records with id, attributes, relationships).
Use persona_transaction_get for one transaction.

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

Inputs:

- `filter_reference_id` (`string`, optional): Filter transactions by reference ID. Example: user-1234
- `filter_transaction_type_id` (`string`, optional): Filter transactions by Transaction Type ID. Example: txntp_ABC123def456GHI789jkl012
- `page_after` (`string`, optional): Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
- `page_before` (`string`, optional): Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
- `page_size` (`integer`, optional): Number of objects per page (1-100, default 10). Example: 25

Example input: `{}`

### `persona_verification_get`

Get Verification · Read-only

Get one verification (government ID, selfie, database and others) with its checks and status.
Returns data (type, id, attributes, relationships).
Verification IDs appear in an inquiry's relationships (persona_inquiry_get).

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

Inputs:

- `verification_id` (`string`, required): Verification ID. Example: ver_ABC123def456GHI789jkl012

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

### `persona_workflow_run_get`

Get Workflow Run · Read-only

Get one workflow run with its status.
Returns data (id, attributes, relationships, meta).
The run ID is returned by persona_workflow_trigger.

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

Inputs:

- `workflow_run_id` (`string`, required): Workflow Run's ID (starts with "wfr_") Example: wfr_ABC123def456GHI789jkl012

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

### `persona_account_create`

Create Account · Write

Create an account for one of your users with identity fields, tags and a reference ID.
Returns data (id, attributes, relationships).
Link inquiries to it with account_id in persona_inquiry_create.

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

Inputs:

- `account_type_id` (`string`, optional): Account Type ID to create the account for. Starts with acttp_. Example: acttp_ABC123def456GHI789jkl012
- `address_city` (`string`, optional): City of residence address. Not all international addresses use this attribute. Example: San Francisco
- `address_postal_code` (`string`, optional): ZIP or postal code of residence address. Not all international addresses use this attribute. Example: 94105
- `address_street_1` (`string`, optional): Street name of residence address. Example: 123 Main St
- `address_street_2` (`string`, optional): Extension of residence address, usually apartment or suite number. Example: example
- `address_subdivision` (`string`, optional): State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. Example: CA
- `birthdate` (`string`, optional): Birthdate, must be in the format "YYYY-MM-DD". Example: 1990-05-17
- `country_code` (`string`, optional): ISO 3166-1 alpha 2 country code. Example: US
- `email_address` (`string`, optional): Email address. Example: jane@example.com
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your Account Type. Example: {"name-first": "Jane", "name-last": "Doe"}
- `name_first` (`string`, optional): Given or first name. Example: Jane
- `name_last` (`string`, optional): Family or last name. Example: Doe
- `name_middle` (`string`, optional): Middle name. Example: Q
- `phone_number` (`string`, optional): Phone number. Example: +15555550100
- `reference_id` (`string`, optional): Reference ID on Account, refers to an entity in your user model. Example: user-1234
- `tags` (`array`, optional): A list of tag names to be associated with the Account. Example: ["vip"]

Example input: `{}`

### `persona_account_tag_add`

Add Tag to Account · Write

Add a tag to an account.
Returns data (id, attributes, relationships).
Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.

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

Inputs:

- `account_id` (`string`, required): Account ID. Example: act_ABC123def456GHI789jkl012
- `tag_name` (`string`, required): Name of the tag. Example: vip

Example input: `{"account_id":"<account_id>","tag_name":"<tag_name>"}`

### `persona_account_tag_remove`

Remove Tag from Account · Write

Remove a tag from an account.
Returns data (id, attributes, relationships).
Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.

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

Inputs:

- `account_id` (`string`, required): Account ID. Example: act_ABC123def456GHI789jkl012
- `tag_name` (`string`, required): Name of the tag. Example: vip

Example input: `{"account_id":"<account_id>","tag_name":"<tag_name>"}`

### `persona_account_update`

Update Account · Write

Update an account's identity fields, tags or reference ID.
Returns data (id, attributes, relationships).
Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.

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

Inputs:

- `account_id` (`string`, required): Account ID. Example: act_ABC123def456GHI789jkl012
- `address_city` (`string`, optional): City of residence address. Not all international addresses use this attribute. Example: San Francisco
- `address_postal_code` (`string`, optional): ZIP or postal code of residence address. Not all international addresses use this attribute. Example: 94105
- `address_street_1` (`string`, optional): Street name of residence address. Example: 123 Main St
- `address_street_2` (`string`, optional): Extension of residence address, usually apartment or suite number. Example: example
- `address_subdivision` (`string`, optional): State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. Example: CA
- `birthdate` (`string`, optional): Birthdate, must be in the format "YYYY-MM-DD". Example: 1990-05-17
- `country_code` (`string`, optional): ISO 3166-1 alpha 2 country code. Example: US
- `email_address` (`string`, optional): Email address. Example: jane@example.com
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your Account Type. Example: {"name-first": "Jane", "name-last": "Doe"}
- `name_first` (`string`, optional): Given or first name. Example: Jane
- `name_last` (`string`, optional): Family or last name. Example: Doe
- `name_middle` (`string`, optional): Middle name. Example: Q
- `phone_number` (`string`, optional): Phone number. Example: +15555550100
- `reference_id` (`string`, optional): Reference ID on Account, refers to an entity in your user model. Example: user-1234
- `tags` (`array`, optional): A list of tag names to be associated with the Account. Example: ["vip"]

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

### `persona_case_assign`

Assign Case · Write

Assign a case to a dashboard user.
Returns data (type, id, attributes, relationships).
Get case IDs from persona_cases_list or persona_cases_search.

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

Inputs:

- `case_id` (`string`, required): ID of the case to update. Example: case_ABC123def456GHI789jkl012
- `user_email_address` (`string`, required): Email address of the Persona user to whom to assign this case. Example: example

Example input: `{"case_id":"<case_id>","user_email_address":"<user_email_address>"}`

### `persona_case_comment_add`

Add Comment to Case · Write

Add a comment to a case's activity feed.
Returns data (type, id, attributes, relationships).
Get case IDs from persona_cases_list or persona_cases_search.

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

Inputs:

- `case_id` (`string`, required): ID of the case to add comment to. Example: case_ABC123def456GHI789jkl012
- `message` (`string`, required): The comment message to add to the Case. Example: Escalating to compliance review

Example input: `{"case_id":"<case_id>","message":"<message>"}`

### `persona_case_create`

Create Case · Write

Create a review case from a case template, optionally attached to an account, inquiry or other objects.
Returns data (type, id, attributes, relationships).
Get case template IDs from the Persona dashboard.

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

Inputs:

- `case_template_id` (`string`, required): ID of the case template for this case. Example: ctmpl_ABC123def456GHI789jkl012
- `case_queue_id` (`string`, optional): ID of the case queue to put this case in. Example: example
- `creator_email_address` (`string`, optional): Email of the user creating this case in the organization. Example: ops@example.com
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your Case Template. Example: {"name-first": "Jane", "name-last": "Doe"}
- `tags` (`array`, optional): Names of tags to add to this case. Tags that don't exist are created. Example: ["vip"]

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

### `persona_case_status_set`

Set Case Status · Write

Set a case's status (and resolution), for example to resolve it.
Returns data (type, id, attributes, relationships).
Get case IDs from persona_cases_list or persona_cases_search.

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

Inputs:

- `case_id` (`string`, required): ID of the case to update status. Example: case_ABC123def456GHI789jkl012
- `status` (`string`, required): Status to update case to. Example: open

Example input: `{"case_id":"<case_id>","status":"<status>"}`

### `persona_case_tag_add`

Add Tag to Case · Write

Add a tag to a case.
Returns data (type, id, attributes, relationships).
Get case IDs from persona_cases_list or persona_cases_search.

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

Inputs:

- `case_id` (`string`, required): ID of the case to update. Example: case_ABC123def456GHI789jkl012
- `tag_name` (`string`, required): Name of the tag. Example: vip

Example input: `{"case_id":"<case_id>","tag_name":"<tag_name>"}`

### `persona_case_update`

Update Case · Write

Update a case's template fields or move it to another case queue.
Returns data (type, id, attributes, relationships).
Get case IDs from persona_cases_list or persona_cases_search.

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

Inputs:

- `case_id` (`string`, required): ID of the case to update. Example: case_ABC123def456GHI789jkl012
- `case_queue_id` (`string`, optional): ID of the case queue to put this case in. Set to null to remove case from case queue. Example: example
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your Case Template. Example: {"name-first": "Jane", "name-last": "Doe"}

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

### `persona_inquiry_approve`

Approve Inquiry · Write

Approve an inquiry, with an optional comment.
Returns data (id, attributes, relationships).
Use persona_inquiry_decline to reject it. Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012
- `comment` (`string`, optional): Unstructured comment for auditing purposes. Example: Documents look valid

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

### `persona_inquiry_create`

Create Inquiry · Write

Create a verification inquiry from an inquiry template, optionally prefilled with fields and linked to an account.
Returns data (id, attributes, relationships).
Share the inquiry with persona_inquiry_one_time_link_generate. Get template IDs from persona_inquiry_templates_list.

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

Inputs:

- `inquiry_template_id` (`string`, required): Template ID for flow requirements (use this attribute if your template ID starts with itmpl_). *You must pass in either template-id OR inquiry-template-id OR inquiry-template-version-id*. Example: itmpl_ABC123def456GHI789jkl012
- `account_id` (`string`, optional): Account ID to associate with this inquiry. Example: act_ABC123def456GHI789jkl012
- `auto_create_account` (`boolean`, optional): If true, automatically create an Account for the user if one does not exist. Default is true. Example: true
- `auto_create_one_time_link` (`boolean`, optional): If true, automatically create a One-Time Link URL for the Inquiry. Example: true
- `expiration_after_create_interval_seconds` (`integer`, optional): Time interval from inquiry creation after which an Inquiry expires and the flow can no longer be accessed. Overrides value set at the template level. Example: 10
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. Example: {"name-first": "Jane", "name-last": "Doe"}
- `note` (`string`, optional): Unstructured field for your custom use. Example: Customer requested re-verification
- `redirect_uri` (`string`, optional): If using the Hosted flow, redirect to this URL after completion. Example: https://example.com/done
- `reference_id` (`string`, optional): Reference ID to refer to an entity in your user model. This attribute is deprecated in favor of meta.auto-create-account-reference-id. Example: user-1234
- `tags` (`array`, optional): A list of tag names to be associated with the Inquiry. Example: ["vip"]
- `theme_set_id` (`string`, optional): Theme Set ID for styling. Only available for Dynamic Flow Inquiries. Example: the_ABC123def456GHI789jkl012

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

### `persona_inquiry_decline`

Decline Inquiry · Write

Decline an inquiry, with an optional comment.
Returns data (id, attributes, relationships).
Use persona_inquiry_approve to approve it. Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012
- `comment` (`string`, optional): Unstructured comment for auditing purposes. Example: Documents look valid

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

### `persona_inquiry_expire`

Expire Inquiry · Write

Expire an inquiry and its sessions so it can no longer be completed.
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012

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

### `persona_inquiry_mark_for_review`

Mark Inquiry for Review · Write

Mark an inquiry for manual review.
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012

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

### `persona_inquiry_one_time_link_generate`

Generate Inquiry One-Time Link · Write

Generate a one-time link the end user opens to complete an inquiry.
Returns data (id, attributes, relationships).
Send the link to the user yourself; Persona does not send it. Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID (starts with "inq_") Example: inq_ABC123def456GHI789jkl012
- `expires_in_seconds` (`integer`, optional): Number of seconds from now to expire the key (must be greater than 0). If not provided, the one-time link expiration setting from the inquiry template version will apply. Default expiry is 24 hours. Example: 3600

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

### `persona_inquiry_resume`

Resume Inquiry · Write

Resume an inquiry and return a session token for the end user to continue it.
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012

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

### `persona_inquiry_session_expire`

Expire Inquiry Session · Write

Expire one inquiry session.
Returns data (id, attributes, relationships).
Get session IDs from persona_inquiry_sessions_list.

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

Inputs:

- `inquiry_session_id` (`string`, required): Inquiry Session ID. Example: iqse_ABC123def456GHI789jkl012

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

### `persona_inquiry_tag_add`

Add Tag to Inquiry · Write

Add a tag to an inquiry (the tag is created if needed).
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012
- `tag_name` (`string`, required): Name of the tag. Example: vip

Example input: `{"inquiry_id":"<inquiry_id>","tag_name":"<tag_name>"}`

### `persona_inquiry_tag_remove`

Remove Tag from Inquiry · Write

Remove a tag from an inquiry.
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012
- `tag_name` (`string`, required): Name of the tag. Example: vip

Example input: `{"inquiry_id":"<inquiry_id>","tag_name":"<tag_name>"}`

### `persona_inquiry_update`

Update Inquiry · Write

Update an inquiry's note, fields or tags.
Returns data (id, attributes, relationships).
Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. Example: {"name-first": "Jane", "name-last": "Doe"}
- `note` (`string`, optional): Unstructured field for your custom use. Example: Customer requested re-verification
- `tags` (`array`, optional): A list of tag names to be associated with the Inquiry. Example: ["vip"]

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

### `persona_list_email_address_add`

Add Email Address to List · Write

Add an email address (or domain pattern) to an email address list.
Returns data (id, type, attributes, relationships).
Get list IDs from persona_lists_list.

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

Inputs:

- `list_id` (`string`, optional): ID of the list to add this item to. List must be an Email Address List. Example: lst_ABC123def456GHI789jkl012
- `match_type` (`string`, optional): Can be either email_address or domain. Example: example
- `note` (`string`, optional): Optional free-text note to attach to the list item. Maximum 255 characters. Example: Customer requested re-verification
- `value` (`string`, optional): Email address to add. Example: fraudster@example.com

Example input: `{}`

### `persona_list_ip_address_add`

Add IP Address to List · Write

Add an IP address to an IP address list.
Returns data (id, type, attributes, relationships).
Get list IDs from persona_lists_list.

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

Inputs:

- `list_id` (`string`, optional): ID of the list to add this item to. List must be an IP Address List. Example: lst_ABC123def456GHI789jkl012
- `note` (`string`, optional): Optional free-text note to attach to the list item. Maximum 255 characters. Example: Customer requested re-verification
- `value` (`string`, optional): IP address to add. IPv4 and IPv6 are supported. Example: fraudster@example.com

Example input: `{}`

### `persona_report_create`

Run Report · Write

Run a new report of a given type, for example a watchlist or adverse media screening, with its query attributes.
Returns data (type, id, attributes, relationships).
Use persona_report_get to read the result. Running a report may be billed.

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

Inputs:

- `attributes` (`object`, required): Report attributes: report-template-id (from the dashboard), optional account-id or reference-id to link the report, and a query object whose fields depend on the type, for example term or name-first, name-last and birthdate for a watchlist report, or email-address for an email report. Example: {"report-template-id": "rptp_ABC123def456GHI789jkl012", "query": {"term": "Jane Doe"}}
- `report_type` (`string`, required): Report type, such as report/watchlist, report/adverse-media, report/politically-exposed-person, report/email-address, report/phone-number or report/business-lookup. Example: report/watchlist

Example input: `{"attributes":{},"report_type":"<report_type>"}`

### `persona_report_monitoring_pause`

Pause Report Monitoring · Write

Pause continuous monitoring for a report.
Returns data (type, id, attributes, relationships).
Get report IDs from persona_reports_list.

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

Inputs:

- `report_id` (`string`, required): Report ID. Example: rep_ABC123def456GHI789jkl012

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

### `persona_report_monitoring_resume`

Resume Report Monitoring · Write

Resume continuous monitoring for a report.
Returns data (type, id, attributes, relationships).
Get report IDs from persona_reports_list.

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

Inputs:

- `report_id` (`string`, required): Report ID. Example: rep_ABC123def456GHI789jkl012

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

### `persona_report_rerun`

Re-run Report · Write

Re-run a report with its original query.
Returns data (type, id, attributes, relationships).
Re-running may be billed. Get report IDs from persona_reports_list.

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

Inputs:

- `report_id` (`string`, required): Report ID. Example: rep_ABC123def456GHI789jkl012

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

### `persona_transaction_create`

Create Transaction · Write

Create a transaction (an event such as a sign-up or payment) of a transaction type, with its fields, for risk evaluation.
Returns data (id, attributes, relationships).
Get transaction type IDs from the Persona dashboard.

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

Inputs:

- `transaction_type_id` (`string`, required): Transaction type ID to create the transaction for. Required. Must be the ID of an existing Transaction Type in your organization, which always begins with txntp_. Example: txntp_ABC123def456GHI789jkl012
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your transaction type. Example: {"name-first": "Jane", "name-last": "Doe"}
- `reference_id` (`string`, optional): Reference ID on Account, refers to an entity in your user model. Example: user-1234
- `tags` (`array`, optional): A list of tag names to be associated with the Transaction. Example: ["vip"]

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

### `persona_transaction_label`

Label Transaction · Write

Label a transaction (for example as fraud or not fraud) to train risk models.
Returns data (id, attributes, relationships).
Get transaction IDs from persona_transactions_list.

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

Inputs:

- `transaction_id` (`string`, required): ID of the transaction to create a label for. Example: txn_ABC123def456GHI789jkl012
- `label` (`string`, optional): Label. Example: fraud
- `model_version` (`string`, optional): Model version. Example: example
- `score` (`string`, optional): Score. Example: example

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

### `persona_transaction_update`

Update Transaction · Write

Update a transaction's fields or status.
Returns data (id, attributes, relationships).
Get transaction IDs from persona_transactions_list.

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

Inputs:

- `transaction_id` (`string`, required): ID of the transaction to update. Example: txn_ABC123def456GHI789jkl012
- `fields` (`object`, optional): JSON key-value pairs of field name to field value. Schema is defined by your transaction type. Example: {"name-first": "Jane", "name-last": "Doe"}
- `label` (`string`, optional): Label. Example: fraud
- `reference_id` (`string`, optional): Reference ID on Account, refers to an entity in your user model. Example: user-1234
- `status` (`string`, optional): The status to move the Transaction to. Valid values are configured on the Transaction Type, not fixed by this API, so they differ between transaction types and between organizations. This API does not expose the configured set; it is visible on the transaction type in the Dashboard. A value outside that set is rejected with Status does not exist. Example: open
- `tags` (`array`, optional): A list of tag names to be associated with the Transaction. Example: ["vip"]

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

### `persona_workflow_trigger`

Trigger Workflow · Write

Start a run of an API-triggered workflow with the given fields.
Returns data (id, attributes, relationships, meta).
Get workflow IDs from the Persona dashboard. Use persona_workflow_run_get to follow the run.

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

Inputs:

- `fields` (`object`, required): JSON key-value pairs of field name to field value. Schema is defined by the trigger payload schema on your Workflow Version. File values must be uploaded as an object with filename and base64-encoded data; references to existing stored files are rejected with a 400. Example: {"name-first": "Jane", "name-last": "Doe"}
- `workflow_id` (`string`, required): Workflow ID. Example: wfl_ABC123def456GHI789jkl012

Example input: `{"fields":{"name-first":"Jane","name-last":"Doe"},"workflow_id":"<workflow_id>"}`

### `persona_account_redact`

Redact Account · Destructive

Permanently redact an account's personal data.
Returns data (id, attributes, relationships).
This cannot be undone. Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.

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

Inputs:

- `account_id` (`string`, required): Account ID. Example: act_ABC123def456GHI789jkl012

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

### `persona_inquiry_redact`

Redact Inquiry · Destructive

Permanently redact an inquiry's personal data (the record remains as a shell).
Returns data (id, attributes, relationships).
This cannot be undone. Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.

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

Inputs:

- `inquiry_id` (`string`, required): Inquiry ID. Example: inq_ABC123def456GHI789jkl012

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

## Related

Other Customer Support connectors ([all 38](/agentkit/connectors/?category=customer-support)):

- [ServiceNow](/agentkit/connectors/servicenow/): Scalekit connector, OAuth, 112 tools
- [Zendesk](/agentkit/connectors/zendeskoauth/): Scalekit connector, OAuth, 137 tools
- [Jira Service Management](/agentkit/connectors/jiraservicemanagement/): Scalekit connector, OAuth, 72 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 |
