Use Persona to create inquiries from verification templates, generate one-time links, inspect verification results, and update inquiry decisions or lifecycle state. The actions also retrieve summary PDFs and documents, manage accounts and CSV imports, run screening reports, and inspect cases.
Provide your Persona API key and the template or resource identifiers required by the action. Keep a human review step where your process requires one before approving or declining an inquiry.
Use the block
Manage the full inquiry lifecycle (create, update, approve, decline, review, resume, expire, redact), generate one-time verification links and PDF summaries, manage accounts including CSV bulk import, run watchlist and adverse media reports, review cases, retrieve verifications and documents, and discover inquiry templates.
Actions
Persona Create Inquiry
Create a new identity verification inquiry from an inquiry template. Returns the created inquiry, which can then be completed by the individual via a one-time link.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
inquiryTemplateId | string | Yes | Inquiry template ID (starts with itmpl_), inquiry template version ID (starts with itmplv_), or legacy template ID (starts with tmpl_) |
accountId | string | No | Account ID (starts with act_) to associate with this inquiry |
referenceId | string | No | Reference ID that refers to an entity in your user model. An account is auto-created for it if one does not exist. |
fields | json | No | JSON object of field name to field value pairs to pre-fill, as defined by the inquiry template (e.g. {"name-first": "Jane"}) |
note | string | No | Free-form note to attach to the inquiry |
redirectUri | string | No | URI to redirect the individual to after completing the inquiry flow |
Output
| Parameter | Type | Description |
|---|---|---|
inquiry | object | The created inquiry |
Persona Get Inquiry
Retrieve a single identity verification inquiry by ID, including its status, collected fields, and decision timestamps.
Inputs and outputs
Persona List Inquiries
List identity verification inquiries, optionally filtered by status, account ID, reference ID, or creation date range. Results are cursor-paginated.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
status | string | No | Filter by inquiry status (created, pending, completed, failed, expired, needs_review, approved, declined) |
accountId | string | No | Filter by account ID (starts with act_); comma-separate multiple IDs |
referenceId | string | No | Filter by reference ID |
createdAtStart | string | No | Filter to inquiries created at or after this ISO 8601 timestamp |
createdAtEnd | string | No | Filter to inquiries created at or before this ISO 8601 timestamp |
pageSize | number | No | Number of inquiries to return per page (1-100, default 10) |
pageAfter | string | No | Pagination cursor: return inquiries after this inquiry ID |
Output
| Parameter | Type | Description |
|---|---|---|
inquiries | array | Inquiries matching the filters |
nextCursor | string | Cursor for the next page (pass as pageAfter), or null on the last page |
Persona Update Inquiry
Update an inquiry’s note, fields, tags, or redirect URI. Only the provided values are changed.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
inquiryId | string | Yes | Inquiry ID to update (starts with inq_) |
note | string | No | Free-form note to set on the inquiry |
fields | json | No | JSON object of field name to field value pairs to set, as defined by the inquiry template (e.g. {"name-first": "Jane"}) |
tags | array | No | JSON array of tag names to set on the inquiry (e.g. ["vip"]) |
redirectUri | string | No | URI to redirect the individual to after completing the inquiry flow |
Output
| Parameter | Type | Description |
|---|---|---|
inquiry | object | The updated inquiry |
Persona Approve Inquiry
Approve an identity verification inquiry. Approving prevents further progress on the inquiry and triggers any associated workflows and webhooks.
Inputs and outputs
Persona Decline Inquiry
Decline an identity verification inquiry. Declining prevents further progress on the inquiry and triggers any associated workflows and webhooks.
Inputs and outputs
Persona Mark Inquiry for Review
Mark an identity verification inquiry for manual review, moving it to the needs_review status.
Inputs and outputs
Persona Resume Inquiry
Resume a pending or expired inquiry, creating a new session so the individual can continue verification. Returns a session token.
Inputs and outputs
Persona Expire Inquiry
Expire an in-progress inquiry, invalidating its sessions and one-time links so the individual can no longer continue it.
Inputs and outputs
Persona Generate Inquiry Link
Generate a one-time link for an inquiry that the individual can open to complete their identity verification.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
inquiryId | string | Yes | Inquiry ID to generate a one-time link for (starts with inq_) |
expiresInSeconds | number | No | Number of seconds from now until the link expires (must be greater than 0; defaults to the inquiry template setting, typically 24 hours) |
Output
| Parameter | Type | Description |
|---|---|---|
inquiry | object | The inquiry the link was generated for |
oneTimeLink | string | One-time link the individual can open to complete the inquiry |
oneTimeLinkShort | string | Shortened version of the one-time link |
Persona Print Inquiry PDF
Download a PDF summary of an inquiry, including its collected information and verification results.
Inputs and outputs
Persona Redact Inquiry
Permanently delete all personally identifiable information collected by an inquiry, for example to honor a data deletion request. This cannot be undone.
Inputs and outputs
Persona Create Account
Create an account that represents an individual in Persona. Accounts consolidate inquiries, verifications, and reports for the same person.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
accountTypeId | string | No | Account type ID to create the account for (starts with acttp_); defaults to your organization default |
referenceId | string | No | Reference ID that refers to an entity in your user model |
countryCode | string | No | ISO 3166-1 alpha-2 country code (e.g. US) |
fields | json | No | JSON object of field name to field value pairs, as defined by the account type (e.g. {"name-first": "Jane"}) |
tags | array | No | JSON array of tag names to associate with the account (e.g. ["vip"]) |
Output
| Parameter | Type | Description |
|---|---|---|
account | object | The created account |
Persona Get Account
Retrieve a single account by ID, including its reference ID, fields, tags, and status.
Inputs and outputs
Persona List Accounts
List accounts in your Persona organization, optionally filtered by reference ID. Results are cursor-paginated.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
referenceId | string | No | Filter by reference ID |
pageSize | number | No | Number of accounts to return per page (1-100, default 10) |
pageAfter | string | No | Pagination cursor: return accounts after this account ID |
Output
| Parameter | Type | Description |
|---|---|---|
accounts | array | Accounts matching the filters |
nextCursor | string | Cursor for the next page (pass as pageAfter), or null on the last page |
Persona Update Account
Update an account’s reference ID, country code, fields, or tags. Only the provided values are changed.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
accountId | string | Yes | Account ID to update (starts with act_) |
referenceId | string | No | Reference ID that refers to an entity in your user model |
countryCode | string | No | ISO 3166-1 alpha-2 country code (e.g. US) |
fields | json | No | JSON object of field name to field value pairs to set, as defined by the account type (e.g. {"name-first": "Jane"}) |
tags | array | No | JSON array of tag names to set on the account (e.g. ["vip"]) |
Output
| Parameter | Type | Description |
|---|---|---|
account | object | The updated account |
Persona Import Accounts
Bulk-import accounts into Persona from a CSV file. Returns an importer whose status can be polled until processing completes.
Inputs and outputs
Persona Redact Account
Permanently delete all personally identifiable information stored on an account, for example to honor a data deletion request. This cannot be undone.
Inputs and outputs
Persona List Cases
List manual review cases, optionally filtered by status, account ID, or reference ID. Results are cursor-paginated.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
status | string | No | Filter by case status (e.g. Open, Resolved) |
accountId | string | No | Filter by account ID (starts with act_) |
referenceId | string | No | Filter by reference ID |
pageSize | number | No | Number of cases to return per page (1-100, default 10) |
pageAfter | string | No | Pagination cursor: return cases after this case ID |
Output
| Parameter | Type | Description |
|---|---|---|
cases | array | Cases matching the filters |
nextCursor | string | Cursor for the next page (pass as pageAfter), or null on the last page |
Persona Get Case
Retrieve a single manual review case by ID, including its status, resolution, and assignee.
Inputs and outputs
Persona Create Report
Run a screening report (watchlist, adverse media, or politically exposed person) against an individual by name or search term.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
reportType | string | Yes | Type of report to run: watchlist, adverse-media, or politically-exposed-person |
reportTemplateId | string | Yes | Report template ID to run (starts with rptp_) |
term | string | No | Full-name search term (e.g. "Jane Q Doe"). Provide this or the separate name parts. |
nameFirst | string | No | First name of the individual to search |
nameMiddle | string | No | Middle name of the individual to search |
nameLast | string | No | Last name of the individual to search |
birthdate | string | No | Birthdate of the individual, formatted as YYYY-MM-DD |
countryCode | string | No | ISO 3166-1 alpha-2 country code (e.g. US) |
accountId | string | No | Account ID (starts with act_) to associate with this report |
Output
| Parameter | Type | Description |
|---|---|---|
report | object | The created report. Reports run asynchronously; poll until status is ready. |
Persona Get Report
Retrieve a single screening report by ID, including its status, match results, and full type-specific attributes.
Inputs and outputs
Persona List Reports
List screening reports, optionally filtered by account ID or reference ID. Results are cursor-paginated.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
accountId | string | No | Filter by account ID (starts with act_) |
referenceId | string | No | Filter by reference ID |
pageSize | number | No | Number of reports to return per page (1-100, default 10) |
pageAfter | string | No | Pagination cursor: return reports after this report ID |
Output
| Parameter | Type | Description |
|---|---|---|
reports | array | Reports matching the filters |
nextCursor | string | Cursor for the next page (pass as pageAfter), or null on the last page |
Persona Get Verification
Retrieve a single verification by ID (government ID, selfie, document, database, and more), including its status and the checks that ran.
Inputs and outputs
Persona Get Document
Retrieve a single document by ID (government ID, generic document, and more), including its processing status and uploaded files.
Inputs and outputs
Persona List Inquiry Templates
List the inquiry templates in your Persona organization, to discover template IDs for creating inquiries. Results are cursor-paginated.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Persona API key |
pageSize | number | No | Number of templates to return per page (1-100, default 10) |
pageAfter | string | No | Pagination cursor: return templates after this template ID |
Output
| Parameter | Type | Description |
|---|---|---|
inquiryTemplates | array | Inquiry templates in the organization |
nextCursor | string | Cursor for the next page (pass as pageAfter), or null on the last page |