# Persona (/integrations/persona)





{/* MANUAL-CONTENT-START:intro */}

Use [Persona](https://withpersona.com/) 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.

{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]

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 [#actions]

### Persona Create Inquiry [#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.

<ReferenceDetails>
  #### Input [#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 [#output]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The created inquiry |
</ReferenceDetails>

### Persona Get Inquiry [#persona-get-inquiry]

Retrieve a single identity verification inquiry by ID, including its status, collected fields, and decision timestamps.

<ReferenceDetails>
  #### Input [#input-1]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to retrieve (starts with inq\_) |

  #### Output [#output-1]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The retrieved inquiry |
</ReferenceDetails>

### Persona List Inquiries [#persona-list-inquiries]

List identity verification inquiries, optionally filtered by status, account ID, reference ID, or creation date range. Results are cursor-paginated.

<ReferenceDetails>
  #### Input [#input-2]

  | 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 [#output-2]

  | 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 |
</ReferenceDetails>

### Persona Update Inquiry [#persona-update-inquiry]

Update an inquiry’s note, fields, tags, or redirect URI. Only the provided values are changed.

<ReferenceDetails>
  #### Input [#input-3]

  | 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 [#output-3]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The updated inquiry |
</ReferenceDetails>

### Persona Approve Inquiry [#persona-approve-inquiry]

Approve an identity verification inquiry. Approving prevents further progress on the inquiry and triggers any associated workflows and webhooks.

<ReferenceDetails>
  #### Input [#input-4]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to approve (starts with inq\_) |

  #### Output [#output-4]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The approved inquiry |
</ReferenceDetails>

### Persona Decline Inquiry [#persona-decline-inquiry]

Decline an identity verification inquiry. Declining prevents further progress on the inquiry and triggers any associated workflows and webhooks.

<ReferenceDetails>
  #### Input [#input-5]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to decline (starts with inq\_) |

  #### Output [#output-5]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The declined inquiry |
</ReferenceDetails>

### Persona Mark Inquiry for Review [#persona-mark-inquiry-for-review]

Mark an identity verification inquiry for manual review, moving it to the needs\_review status.

<ReferenceDetails>
  #### Input [#input-6]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to mark for review (starts with inq\_) |

  #### Output [#output-6]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The inquiry marked for review |
</ReferenceDetails>

### Persona Resume Inquiry [#persona-resume-inquiry]

Resume a pending or expired inquiry, creating a new session so the individual can continue verification. Returns a session token.

<ReferenceDetails>
  #### Input [#input-7]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to resume (starts with inq\_) |

  #### Output [#output-7]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The resumed inquiry |
  | `sessionToken` | string | Session token for the new inquiry session, used to continue the flow in embedded SDKs |
</ReferenceDetails>

### Persona Expire Inquiry [#persona-expire-inquiry]

Expire an in-progress inquiry, invalidating its sessions and one-time links so the individual can no longer continue it.

<ReferenceDetails>
  #### Input [#input-8]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to expire (starts with inq\_) |

  #### Output [#output-8]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The expired inquiry |
</ReferenceDetails>

### Persona Generate Inquiry Link [#persona-generate-inquiry-link]

Generate a one-time link for an inquiry that the individual can open to complete their identity verification.

<ReferenceDetails>
  #### Input [#input-9]

  | 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 [#output-9]

  | 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 |
</ReferenceDetails>

### Persona Print Inquiry PDF [#persona-print-inquiry-pdf]

Download a PDF summary of an inquiry, including its collected information and verification results.

<ReferenceDetails>
  #### Input [#input-10]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to print (starts with inq\_) |

  #### Output [#output-10]

  | Parameter | Type | Description |
  | - | - | - |
  | `file` | file | PDF summary of the inquiry, stored in execution files |
</ReferenceDetails>

### Persona Redact Inquiry [#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.

<ReferenceDetails>
  #### Input [#input-11]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `inquiryId` | string | Yes | Inquiry ID to redact (starts with inq\_) |

  #### Output [#output-11]

  | Parameter | Type | Description |
  | - | - | - |
  | `inquiry` | object | The redacted inquiry (PII fields are removed) |
</ReferenceDetails>

### Persona Create Account [#persona-create-account]

Create an account that represents an individual in Persona. Accounts consolidate inquiries, verifications, and reports for the same person.

<ReferenceDetails>
  #### Input [#input-12]

  | 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 [#output-12]

  | Parameter | Type | Description |
  | - | - | - |
  | `account` | object | The created account |
</ReferenceDetails>

### Persona Get Account [#persona-get-account]

Retrieve a single account by ID, including its reference ID, fields, tags, and status.

<ReferenceDetails>
  #### Input [#input-13]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `accountId` | string | Yes | Account ID to retrieve (starts with act\_) |

  #### Output [#output-13]

  | Parameter | Type | Description |
  | - | - | - |
  | `account` | object | The retrieved account |
</ReferenceDetails>

### Persona List Accounts [#persona-list-accounts]

List accounts in your Persona organization, optionally filtered by reference ID. Results are cursor-paginated.

<ReferenceDetails>
  #### Input [#input-14]

  | 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 [#output-14]

  | 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 |
</ReferenceDetails>

### Persona Update Account [#persona-update-account]

Update an account’s reference ID, country code, fields, or tags. Only the provided values are changed.

<ReferenceDetails>
  #### Input [#input-15]

  | 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 [#output-15]

  | Parameter | Type | Description |
  | - | - | - |
  | `account` | object | The updated account |
</ReferenceDetails>

### Persona Import Accounts [#persona-import-accounts]

Bulk-import accounts into Persona from a CSV file. Returns an importer whose status can be polled until processing completes.

<ReferenceDetails>
  #### Input [#input-16]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `file` | file | Yes | CSV file of accounts to import |

  #### Output [#output-16]

  | Parameter | Type | Description |
  | - | - | - |
  | `importer` | object | The created account importer |
</ReferenceDetails>

### Persona Redact Account [#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.

<ReferenceDetails>
  #### Input [#input-17]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `accountId` | string | Yes | Account ID to redact (starts with act\_) |

  #### Output [#output-17]

  | Parameter | Type | Description |
  | - | - | - |
  | `account` | object | The redacted account (PII fields are removed) |
</ReferenceDetails>

### Persona List Cases [#persona-list-cases]

List manual review cases, optionally filtered by status, account ID, or reference ID. Results are cursor-paginated.

<ReferenceDetails>
  #### Input [#input-18]

  | 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 [#output-18]

  | 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 |
</ReferenceDetails>

### Persona Get Case [#persona-get-case]

Retrieve a single manual review case by ID, including its status, resolution, and assignee.

<ReferenceDetails>
  #### Input [#input-19]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `caseId` | string | Yes | Case ID to retrieve (starts with case\_) |

  #### Output [#output-19]

  | Parameter | Type | Description |
  | - | - | - |
  | `case` | object | The retrieved case |
</ReferenceDetails>

### Persona Create Report [#persona-create-report]

Run a screening report (watchlist, adverse media, or politically exposed person) against an individual by name or search term.

<ReferenceDetails>
  #### Input [#input-20]

  | 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 [#output-20]

  | Parameter | Type | Description |
  | - | - | - |
  | `report` | object | The created report. Reports run asynchronously; poll until status is ready. |
</ReferenceDetails>

### Persona Get Report [#persona-get-report]

Retrieve a single screening report by ID, including its status, match results, and full type-specific attributes.

<ReferenceDetails>
  #### Input [#input-21]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `reportId` | string | Yes | Report ID to retrieve (starts with rep\_) |

  #### Output [#output-21]

  | Parameter | Type | Description |
  | - | - | - |
  | `report` | object | The retrieved report |
</ReferenceDetails>

### Persona List Reports [#persona-list-reports]

List screening reports, optionally filtered by account ID or reference ID. Results are cursor-paginated.

<ReferenceDetails>
  #### Input [#input-22]

  | 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 [#output-22]

  | 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 |
</ReferenceDetails>

### Persona Get Verification [#persona-get-verification]

Retrieve a single verification by ID (government ID, selfie, document, database, and more), including its status and the checks that ran.

<ReferenceDetails>
  #### Input [#input-23]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `verificationId` | string | Yes | Verification ID to retrieve (starts with ver\_) |

  #### Output [#output-23]

  | Parameter | Type | Description |
  | - | - | - |
  | `verification` | object | The retrieved verification |
</ReferenceDetails>

### Persona Get Document [#persona-get-document]

Retrieve a single document by ID (government ID, generic document, and more), including its processing status and uploaded files.

<ReferenceDetails>
  #### Input [#input-24]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Persona API key |
  | `documentId` | string | Yes | Document ID to retrieve (starts with doc\_) |

  #### Output [#output-24]

  | Parameter | Type | Description |
  | - | - | - |
  | `document` | object | The retrieved document |
</ReferenceDetails>

### Persona List Inquiry Templates [#persona-list-inquiry-templates]

List the inquiry templates in your Persona organization, to discover template IDs for creating inquiries. Results are cursor-paginated.

<ReferenceDetails>
  #### Input [#input-25]

  | 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 [#output-25]

  | 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 |
</ReferenceDetails>