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.
- Tools
- 57
- What they doRead · write · destructive
- 24 · 31 · 224 read31 write2 destructive
- Users sign in with
- Access token
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 Persona connection
In AgentKit > Connections, create a Persona 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 = 'persona'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'persona_accounts_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 = "persona"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="persona_accounts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Persona credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpersona_account_getGet one account with its fields and related objects.Read-onlyGet Account
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.
Inputs
account_idstringrequired- Account ID. Example: act_ABC123def456GHI789jkl012
persona_accounts_listList accounts (your end users in Persona), optionally filtered by reference ID.Read-onlyList Accounts
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.
Inputs
filter_reference_idstring- Filter accounts by reference ID. Can be a single reference ID or an array of reference IDs. Example: user-1234
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_accounts_searchSearch accounts with attribute conditions, sorting and paging.Read-onlySearch Accounts
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.
Inputs
queryobjectrequired- 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"}
pageobject- Paging: {"size": 1-100, "after": "<id>", "before": "<id>"}. Example: {"size": 25}
sortobject- Sort order: {"attribute": "created-at", "direction": "desc"}. Example: {"attribute": "created-at", "direction": "desc"}
persona_case_getGet one case with its status, assignee and attached objects.Read-onlyGet Case
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.
Inputs
case_idstringrequired- Case ID. Example: case_ABC123def456GHI789jkl012
persona_cases_listList review cases, filtered by status, template, account, inquiry or report.Read-onlyList Cases
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.
Inputs
filter_account_idstring- Filter cases by account ID. Example: act_ABC123def456GHI789jkl012
filter_case_template_idstring- Filter cases by case template ID. Example: ctmpl_ABC123def456GHI789jkl012
filter_inquiry_idstring- Filter cases by inquiry ID. Example: inq_ABC123def456GHI789jkl012
filter_reference_idstring- Filter cases by reference ID. Example: user-1234
filter_report_idstring- Filter cases by report ID. Example: example
filter_statusstring- Filter cases by status. Example: open
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_cases_searchSearch cases with attribute conditions, sorting and paging.Read-onlySearch Cases
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.
Inputs
queryobjectrequired- 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"}
pageobject- Paging: {"size": 1-100, "after": "<id>", "before": "<id>"}. Example: {"size": 25}
sortobject- Sort order: {"attribute": "created-at", "direction": "desc"}. Example: {"attribute": "created-at", "direction": "desc"}
persona_document_getGet one document with its extracted fields and files.Read-onlyGet Document
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).
Inputs
document_idstringrequired- Document ID. Example: doc_ABC123def456GHI789jkl012
persona_event_getGet one event with its payload.Read-onlyGet Event
Get one event with its payload. Returns data (id, attributes). Get event IDs from persona_events_list.
Inputs
event_idstringrequired- Event ID. Example: evt_ABC123def456GHI789jkl012
persona_events_listList events (such as inquiry.completed) filtered by name or object ID.Read-onlyList Events
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.
Inputs
filter_idstring- Comma separated list of event ids. Example: example
filter_namestring- Comma separated list of event names. Example: Fraud review
filter_object_idstring- Comma separated list of object ids. Example: example
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_inquiries_listList verification inquiries, newest first, filtered by account, reference ID, template or status.Read-onlyList Inquiries
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.
Inputs
filter_account_idstring- Comma separated list of account IDs (starting with act_) to filter inquiries by. Example: act_ABC123def456GHI789jkl012
filter_created_at_endstring- Filter inquiries by creation date, earlier than or equal to. Example: 2026-01-01T00:00:00Z
filter_created_at_startstring- Filter inquiries by creation date, equal to or later than. Example: 2026-01-01T00:00:00Z
filter_inquiry_idstring- Comma separated list of inquiry IDs (starting with inq_) to filter inquiries by. Example: inq_ABC123def456GHI789jkl012
filter_inquiry_template_idstring- Comma separated list of inquiry template IDs (starting with itmpl_) to filter inquiries by. Example: itmpl_ABC123def456GHI789jkl012
filter_notestring- Filter inquiries by note. Must be the only filter. Example: Customer requested re-verification
filter_reference_idstring- Filter inquiries by reference ID. Example: user-1234
filter_statusstring- Comma separated list of statuses to filter inquiries by. Example: open
filter_template_idstring- Comma separated list of legacy template IDs (starting with tmpl_) to filter inquiries by. Example: example
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_inquiries_searchSearch inquiries with attribute conditions, sorting and paging.Read-onlySearch Inquiries
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.
Inputs
queryobjectrequired- 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"}
pageobject- Paging: {"size": 1-100, "after": "<id>", "before": "<id>"}. Example: {"size": 25}
sortobject- Sort order: {"attribute": "created-at", "direction": "desc"}. Example: {"attribute": "created-at", "direction": "desc"}
persona_inquiry_getGet one inquiry with its status, fields and related verifications.Read-onlyGet Inquiry
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.
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
persona_inquiry_session_getGet one inquiry session with its device and network details.Read-onlyGet Inquiry Session
Get one inquiry session with its device and network details. Returns data (id, attributes, relationships). Get session IDs from persona_inquiry_sessions_list.
Inputs
inquiry_session_idstringrequired- Inquiry Session ID. Example: iqse_ABC123def456GHI789jkl012
persona_inquiry_sessions_listList inquiry sessions (device sessions in which a user worked on an inquiry), filtered by inquiry.Read-onlyList Inquiry Sessions
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.
Inputs
filter_inquiry_idstring- Filter inquiry sessions by inquiry ID. Example: inq_ABC123def456GHI789jkl012
persona_inquiry_template_getGet one inquiry template.Read-onlyGet Inquiry Template
Get one inquiry template. Returns data (id, attributes, relationships). Get template IDs from persona_inquiry_templates_list.
Inputs
inquiry_template_idstringrequired- Inquiry Template ID. Example: itmpl_ABC123def456GHI789jkl012
persona_inquiry_templates_listList inquiry templates (verification flows) in the organization.Read-onlyList Inquiry Templates
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.
Inputs
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_list_getGet one list with its items.Read-onlyGet List
Get one list with its items. Returns data (type, id, attributes, relationships). Get list IDs from persona_lists_list.
Inputs
list_idstringrequired- ID of the list to retrieve. Example: lst_ABC123def456GHI789jkl012
persona_lists_listList the allow and block lists (emails, IPs, names, countries and more) in the organization.Read-onlyList Lists
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.
Inputs
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_report_getGet one report with its status and matches.Read-onlyGet Report
Get one report with its status and matches. Returns data (type, id, attributes, relationships). Get report IDs from persona_reports_list.
Inputs
report_idstringrequired- Report ID. Example: rep_ABC123def456GHI789jkl012
persona_reports_listList reports (watchlist, adverse media, lookups) filtered by account or reference ID.Read-onlyList Reports
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.
Inputs
filter_account_idstring- Filter reports by account ID. Example: act_ABC123def456GHI789jkl012
filter_reference_idstring- Filter reports by reference ID. Example: user-1234
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_transaction_getGet one transaction with its status and fields.Read-onlyGet Transaction
Get one transaction with its status and fields. Returns data (id, attributes, relationships). Get transaction IDs from persona_transactions_list.
Inputs
transaction_idstringrequired- ID of the transaction to retrieve. Example: txn_ABC123def456GHI789jkl012
persona_transactions_listList transactions, filtered by reference ID or transaction type.Read-onlyList Transactions
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.
Inputs
filter_reference_idstring- Filter transactions by reference ID. Example: user-1234
filter_transaction_type_idstring- Filter transactions by Transaction Type ID. Example: txntp_ABC123def456GHI789jkl012
page_afterstring- Pagination cursor: return objects after this object ID (the last ID of the previous page). Example: inq_ABC123def456GHI789jkl012
page_beforestring- Pagination cursor: return objects before this object ID. Example: inq_ABC123def456GHI789jkl012
page_sizeinteger- Number of objects per page (1-100, default 10). Example: 25
persona_verification_getGet one verification (government ID, selfie, database and others) with its checks and status.Read-onlyGet Verification
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).
Inputs
verification_idstringrequired- Verification ID. Example: ver_ABC123def456GHI789jkl012
persona_workflow_run_getGet one workflow run with its status.Read-onlyGet Workflow Run
Get one workflow run with its status. Returns data (id, attributes, relationships, meta). The run ID is returned by persona_workflow_trigger.
Inputs
workflow_run_idstringrequired- Workflow Run's ID (starts with "wfr_") Example: wfr_ABC123def456GHI789jkl012
persona_account_createCreate an account for one of your users with identity fields, tags and a reference ID.WriteCreate Account
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.
Inputs
account_type_idstring- Account Type ID to create the account for. Starts with acttp_. Example: acttp_ABC123def456GHI789jkl012
address_citystring- City of residence address. Not all international addresses use this attribute. Example: San Francisco
address_postal_codestring- ZIP or postal code of residence address. Not all international addresses use this attribute. Example: 94105
address_street_1string- Street name of residence address. Example: 123 Main St
address_street_2string- Extension of residence address, usually apartment or suite number. Example: example
address_subdivisionstring- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. Example: CA
birthdatestring- Birthdate, must be in the format "YYYY-MM-DD". Example: 1990-05-17
country_codestring- ISO 3166-1 alpha 2 country code. Example: US
email_addressstring- Email address. Example: jane@example.com
fieldsobject- 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_firststring- Given or first name. Example: Jane
name_laststring- Family or last name. Example: Doe
name_middlestring- Middle name. Example: Q
phone_numberstring- Phone number. Example: +15555550100
reference_idstring- Reference ID on Account, refers to an entity in your user model. Example: user-1234
tagsarray- A list of tag names to be associated with the Account. Example: ["vip"]
persona_account_tag_addAdd a tag to an account.WriteAdd Tag to Account
Add a tag to an account. Returns data (id, attributes, relationships). Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.
- Idempotent
Inputs
account_idstringrequired- Account ID. Example: act_ABC123def456GHI789jkl012
tag_namestringrequired- Name of the tag. Example: vip
persona_account_tag_removeRemove a tag from an account.WriteRemove Tag from Account
Remove a tag from an account. Returns data (id, attributes, relationships). Get account IDs (act_...) from persona_accounts_list or persona_accounts_search.
- Idempotent
Inputs
account_idstringrequired- Account ID. Example: act_ABC123def456GHI789jkl012
tag_namestringrequired- Name of the tag. Example: vip
persona_account_updateUpdate an account's identity fields, tags or reference ID.WriteUpdate Account
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.
Inputs
account_idstringrequired- Account ID. Example: act_ABC123def456GHI789jkl012
address_citystring- City of residence address. Not all international addresses use this attribute. Example: San Francisco
address_postal_codestring- ZIP or postal code of residence address. Not all international addresses use this attribute. Example: 94105
address_street_1string- Street name of residence address. Example: 123 Main St
address_street_2string- Extension of residence address, usually apartment or suite number. Example: example
address_subdivisionstring- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. Example: CA
birthdatestring- Birthdate, must be in the format "YYYY-MM-DD". Example: 1990-05-17
country_codestring- ISO 3166-1 alpha 2 country code. Example: US
email_addressstring- Email address. Example: jane@example.com
fieldsobject- 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_firststring- Given or first name. Example: Jane
name_laststring- Family or last name. Example: Doe
name_middlestring- Middle name. Example: Q
phone_numberstring- Phone number. Example: +15555550100
reference_idstring- Reference ID on Account, refers to an entity in your user model. Example: user-1234
tagsarray- A list of tag names to be associated with the Account. Example: ["vip"]
persona_case_assignAssign a case to a dashboard user.WriteAssign Case
Assign a case to a dashboard user. Returns data (type, id, attributes, relationships). Get case IDs from persona_cases_list or persona_cases_search.
- Idempotent
Inputs
case_idstringrequired- ID of the case to update. Example: case_ABC123def456GHI789jkl012
user_email_addressstringrequired- Email address of the Persona user to whom to assign this case. Example: example
persona_case_comment_addAdd a comment to a case's activity feed.WriteAdd Comment to Case
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.
Inputs
case_idstringrequired- ID of the case to add comment to. Example: case_ABC123def456GHI789jkl012
messagestringrequired- The comment message to add to the Case. Example: Escalating to compliance review
persona_case_createCreate a review case from a case template, optionally attached to an account, inquiry or other objects.WriteCreate Case
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.
Inputs
case_template_idstringrequired- ID of the case template for this case. Example: ctmpl_ABC123def456GHI789jkl012
case_queue_idstring- ID of the case queue to put this case in. Example: example
creator_email_addressstring- Email of the user creating this case in the organization. Example: ops@example.com
fieldsobject- JSON key-value pairs of field name to field value. Schema is defined by your Case Template. Example: {"name-first": "Jane", "name-last": "Doe"}
tagsarray- Names of tags to add to this case. Tags that don't exist are created. Example: ["vip"]
persona_case_status_setSet a case's status (and resolution), for example to resolve it.WriteSet Case Status
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.
- Idempotent
Inputs
case_idstringrequired- ID of the case to update status. Example: case_ABC123def456GHI789jkl012
statusstringrequired- Status to update case to. Example: open
persona_case_tag_addAdd a tag to a case.WriteAdd Tag to Case
Add a tag to a case. Returns data (type, id, attributes, relationships). Get case IDs from persona_cases_list or persona_cases_search.
- Idempotent
Inputs
case_idstringrequired- ID of the case to update. Example: case_ABC123def456GHI789jkl012
tag_namestringrequired- Name of the tag. Example: vip
persona_case_updateUpdate a case's template fields or move it to another case queue.WriteUpdate Case
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.
Inputs
case_idstringrequired- ID of the case to update. Example: case_ABC123def456GHI789jkl012
case_queue_idstring- ID of the case queue to put this case in. Set to null to remove case from case queue. Example: example
fieldsobject- JSON key-value pairs of field name to field value. Schema is defined by your Case Template. Example: {"name-first": "Jane", "name-last": "Doe"}
persona_inquiry_approveApprove an inquiry, with an optional comment.WriteApprove Inquiry
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.
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
commentstring- Unstructured comment for auditing purposes. Example: Documents look valid
persona_inquiry_createCreate a verification inquiry from an inquiry template, optionally prefilled with fields and linked to an account.WriteCreate Inquiry
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.
Inputs
inquiry_template_idstringrequired- 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_idstring- Account ID to associate with this inquiry. Example: act_ABC123def456GHI789jkl012
auto_create_accountboolean- If true, automatically create an Account for the user if one does not exist. Default is true. Example: true
auto_create_one_time_linkboolean- If true, automatically create a One-Time Link URL for the Inquiry. Example: true
expiration_after_create_interval_secondsinteger- 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
fieldsobject- JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. Example: {"name-first": "Jane", "name-last": "Doe"}
notestring- Unstructured field for your custom use. Example: Customer requested re-verification
redirect_uristring- If using the Hosted flow, redirect to this URL after completion. Example: https://example.com/done
reference_idstring- 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
tagsarray- A list of tag names to be associated with the Inquiry. Example: ["vip"]
theme_set_idstring- Theme Set ID for styling. Only available for Dynamic Flow Inquiries. Example: the_ABC123def456GHI789jkl012
persona_inquiry_declineDecline an inquiry, with an optional comment.WriteDecline Inquiry
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.
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
commentstring- Unstructured comment for auditing purposes. Example: Documents look valid
persona_inquiry_expireExpire an inquiry and its sessions so it can no longer be completed.WriteExpire Inquiry
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.
- Idempotent
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
persona_inquiry_mark_for_reviewMark an inquiry for manual review.WriteMark Inquiry for Review
Mark an inquiry for manual review. Returns data (id, attributes, relationships). Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.
- Idempotent
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
persona_inquiry_one_time_link_generateGenerate a one-time link the end user opens to complete an inquiry.WriteGenerate Inquiry One-Time Link
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.
Inputs
inquiry_idstringrequired- Inquiry ID (starts with "inq_") Example: inq_ABC123def456GHI789jkl012
expires_in_secondsinteger- 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
persona_inquiry_resumeResume an inquiry and return a session token for the end user to continue it.WriteResume Inquiry
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.
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
persona_inquiry_session_expireExpire one inquiry session.WriteExpire Inquiry Session
Expire one inquiry session. Returns data (id, attributes, relationships). Get session IDs from persona_inquiry_sessions_list.
- Idempotent
Inputs
inquiry_session_idstringrequired- Inquiry Session ID. Example: iqse_ABC123def456GHI789jkl012
persona_inquiry_tag_addAdd a tag to an inquiry (the tag is created if needed).WriteAdd Tag to Inquiry
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.
- Idempotent
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
tag_namestringrequired- Name of the tag. Example: vip
persona_inquiry_tag_removeRemove a tag from an inquiry.WriteRemove Tag from Inquiry
Remove a tag from an inquiry. Returns data (id, attributes, relationships). Get inquiry IDs (inq_...) from persona_inquiries_list or persona_inquiries_search.
- Idempotent
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
tag_namestringrequired- Name of the tag. Example: vip
persona_inquiry_updateUpdate an inquiry's note, fields or tags.WriteUpdate Inquiry
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.
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
fieldsobject- JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. Example: {"name-first": "Jane", "name-last": "Doe"}
notestring- Unstructured field for your custom use. Example: Customer requested re-verification
tagsarray- A list of tag names to be associated with the Inquiry. Example: ["vip"]
persona_list_email_address_addAdd an email address (or domain pattern) to an email address list.WriteAdd Email Address to List
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.
Inputs
list_idstring- ID of the list to add this item to. List must be an Email Address List. Example: lst_ABC123def456GHI789jkl012
match_typestring- Can be either email_address or domain. Example: example
notestring- Optional free-text note to attach to the list item. Maximum 255 characters. Example: Customer requested re-verification
valuestring- Email address to add. Example: fraudster@example.com
persona_list_ip_address_addAdd an IP address to an IP address list.WriteAdd IP Address to List
Add an IP address to an IP address list. Returns data (id, type, attributes, relationships). Get list IDs from persona_lists_list.
Inputs
list_idstring- ID of the list to add this item to. List must be an IP Address List. Example: lst_ABC123def456GHI789jkl012
notestring- Optional free-text note to attach to the list item. Maximum 255 characters. Example: Customer requested re-verification
valuestring- IP address to add. IPv4 and IPv6 are supported. Example: fraudster@example.com
persona_report_createRun a new report of a given type, for example a watchlist or adverse media screening, with its query attributes.WriteRun Report
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.
Inputs
attributesobjectrequired- 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_typestringrequired- 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
persona_report_monitoring_pausePause continuous monitoring for a report.WritePause Report Monitoring
Pause continuous monitoring for a report. Returns data (type, id, attributes, relationships). Get report IDs from persona_reports_list.
- Idempotent
Inputs
report_idstringrequired- Report ID. Example: rep_ABC123def456GHI789jkl012
persona_report_monitoring_resumeResume continuous monitoring for a report.WriteResume Report Monitoring
Resume continuous monitoring for a report. Returns data (type, id, attributes, relationships). Get report IDs from persona_reports_list.
- Idempotent
Inputs
report_idstringrequired- Report ID. Example: rep_ABC123def456GHI789jkl012
persona_report_rerunRe-run a report with its original query.WriteRe-run Report
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.
Inputs
report_idstringrequired- Report ID. Example: rep_ABC123def456GHI789jkl012
persona_transaction_createCreate a transaction (an event such as a sign-up or payment) of a transaction type, with its fields, for risk evaluation.WriteCreate Transaction
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.
Inputs
transaction_type_idstringrequired- 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
fieldsobject- 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_idstring- Reference ID on Account, refers to an entity in your user model. Example: user-1234
tagsarray- A list of tag names to be associated with the Transaction. Example: ["vip"]
persona_transaction_labelLabel a transaction (for example as fraud or not fraud) to train risk models.WriteLabel Transaction
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.
Inputs
transaction_idstringrequired- ID of the transaction to create a label for. Example: txn_ABC123def456GHI789jkl012
labelstring- Label. Example: fraud
model_versionstring- Model version. Example: example
scorestring- Score. Example: example
persona_transaction_updateUpdate a transaction's fields or status.WriteUpdate Transaction
Update a transaction's fields or status. Returns data (id, attributes, relationships). Get transaction IDs from persona_transactions_list.
Inputs
transaction_idstringrequired- ID of the transaction to update. Example: txn_ABC123def456GHI789jkl012
fieldsobject- JSON key-value pairs of field name to field value. Schema is defined by your transaction type. Example: {"name-first": "Jane", "name-last": "Doe"}
labelstring- Label. Example: fraud
reference_idstring- Reference ID on Account, refers to an entity in your user model. Example: user-1234
statusstring- 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
tagsarray- A list of tag names to be associated with the Transaction. Example: ["vip"]
persona_workflow_triggerStart a run of an API-triggered workflow with the given fields.WriteTrigger Workflow
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.
Inputs
fieldsobjectrequired- 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_idstringrequired- Workflow ID. Example: wfl_ABC123def456GHI789jkl012
persona_account_redactPermanently redact an account's personal data.DestructiveRedact Account
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.
- Idempotent
Inputs
account_idstringrequired- Account ID. Example: act_ABC123def456GHI789jkl012
persona_inquiry_redactPermanently redact an inquiry's personal data (the record remains as a shell).DestructiveRedact Inquiry
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.
- Idempotent
Inputs
inquiry_idstringrequired- Inquiry ID. Example: inq_ABC123def456GHI789jkl012
No tools match.