Persona

Persona is an identity verification platform that helps businesses verify who their users are. Persona handles the full identity lifecycle — collecting government IDs, selfies, and documents through hosted verification flows, screening individuals against global watchlists and sanctions lists, and routing edge cases to human review.

With Persona, you can:

  • Verify identities end to end: Create inquiries from your verification templates, send customers one-time verification links, and read back collected fields and decision results
  • Automate KYC and compliance decisions: Approve or decline inquiries programmatically, run watchlist, adverse media, and politically-exposed-person screening reports, and monitor cases that need manual review
  • Manage your verified user base: Create and look up accounts, bulk-import existing users from CSV, and keep your user model in sync with Persona via reference IDs
  • Keep an audit trail: Download inquiry summary PDFs and retrieve the underlying verifications and documents behind every decision

In Sim, the Persona block lets your agents drive identity verification as part of real workflows. Trigger verification when a customer signs up, route on approval status, screen names against watchlists before activating accounts, post pending reviews to Slack, or archive verification PDFs to cloud storage — all using your Persona API key and templates.

Usage Instructions

Integrate Persona identity verification into the workflow. 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryTemplateIdstringYesInquiry template ID (starts with itmpl_), inquiry template version ID (starts with itmplv_), or legacy template ID (starts with tmpl_)
accountIdstringNoAccount ID (starts with act_) to associate with this inquiry
referenceIdstringNoReference ID that refers to an entity in your user model. An account is auto-created for it if one does not exist.
fieldsjsonNoJSON object of field name to field value pairs to pre-fill, as defined by the inquiry template (e.g. {"name-first": "Jane"})
notestringNoFree-form note to attach to the inquiry
redirectUristringNoURI to redirect the individual to after completing the inquiry flow

Output

ParameterTypeDescription
inquiryobjectThe created inquiry

persona_get_inquiry

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to retrieve (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe retrieved inquiry

persona_list_inquiries

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
statusstringNoFilter by inquiry status (created, pending, completed, failed, expired, needs_review, approved, declined)
accountIdstringNoFilter by account ID (starts with act_); comma-separate multiple IDs
referenceIdstringNoFilter by reference ID
createdAtStartstringNoFilter to inquiries created at or after this ISO 8601 timestamp
createdAtEndstringNoFilter to inquiries created at or before this ISO 8601 timestamp
pageSizenumberNoNumber of inquiries to return per page (1-100, default 10)
pageAfterstringNoPagination cursor: return inquiries after this inquiry ID

Output

ParameterTypeDescription
inquiriesarrayInquiries matching the filters
nextCursorstringCursor 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to update (starts with inq_)
notestringNoFree-form note to set on the inquiry
fieldsjsonNoJSON object of field name to field value pairs to set, as defined by the inquiry template (e.g. {"name-first": "Jane"})
tagsarrayNoJSON array of tag names to set on the inquiry (e.g. ["vip"])
redirectUristringNoURI to redirect the individual to after completing the inquiry flow

Output

ParameterTypeDescription
inquiryobjectThe updated inquiry

persona_approve_inquiry

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to approve (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe approved inquiry

persona_decline_inquiry

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to decline (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe declined inquiry

persona_mark_inquiry_for_review

Mark an identity verification inquiry for manual review, moving it to the needs_review status.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to mark for review (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe inquiry marked for review

persona_resume_inquiry

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to resume (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe resumed inquiry
sessionTokenstringSession token for the new inquiry session, used to continue the flow in embedded SDKs

persona_expire_inquiry

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to expire (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe expired inquiry

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to generate a one-time link for (starts with inq_)
expiresInSecondsnumberNoNumber of seconds from now until the link expires (must be greater than 0; defaults to the inquiry template setting, typically 24 hours)

Output

ParameterTypeDescription
inquiryobjectThe inquiry the link was generated for
oneTimeLinkstringOne-time link the individual can open to complete the inquiry
oneTimeLinkShortstringShortened version of the one-time link

persona_print_inquiry_pdf

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to print (starts with inq_)

Output

ParameterTypeDescription
filefilePDF summary of the inquiry, stored in execution files

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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
inquiryIdstringYesInquiry ID to redact (starts with inq_)

Output

ParameterTypeDescription
inquiryobjectThe redacted inquiry (PII fields are removed)

persona_create_account

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
accountTypeIdstringNoAccount type ID to create the account for (starts with acttp_); defaults to your organization default
referenceIdstringNoReference ID that refers to an entity in your user model
countryCodestringNoISO 3166-1 alpha-2 country code (e.g. US)
fieldsjsonNoJSON object of field name to field value pairs, as defined by the account type (e.g. {"name-first": "Jane"})
tagsarrayNoJSON array of tag names to associate with the account (e.g. ["vip"])

Output

ParameterTypeDescription
accountobjectThe created account

persona_get_account

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
accountIdstringYesAccount ID to retrieve (starts with act_)

Output

ParameterTypeDescription
accountobjectThe retrieved account

persona_list_accounts

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
referenceIdstringNoFilter by reference ID
pageSizenumberNoNumber of accounts to return per page (1-100, default 10)
pageAfterstringNoPagination cursor: return accounts after this account ID

Output

ParameterTypeDescription
accountsarrayAccounts matching the filters
nextCursorstringCursor 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
accountIdstringYesAccount ID to update (starts with act_)
referenceIdstringNoReference ID that refers to an entity in your user model
countryCodestringNoISO 3166-1 alpha-2 country code (e.g. US)
fieldsjsonNoJSON object of field name to field value pairs to set, as defined by the account type (e.g. {"name-first": "Jane"})
tagsarrayNoJSON array of tag names to set on the account (e.g. ["vip"])

Output

ParameterTypeDescription
accountobjectThe 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
filefileYesCSV file of accounts to import

Output

ParameterTypeDescription
importerobjectThe created account importer

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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
accountIdstringYesAccount ID to redact (starts with act_)

Output

ParameterTypeDescription
accountobjectThe redacted account (PII fields are removed)

persona_list_cases

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
statusstringNoFilter by case status (e.g. Open, Resolved)
accountIdstringNoFilter by account ID (starts with act_)
referenceIdstringNoFilter by reference ID
pageSizenumberNoNumber of cases to return per page (1-100, default 10)
pageAfterstringNoPagination cursor: return cases after this case ID

Output

ParameterTypeDescription
casesarrayCases matching the filters
nextCursorstringCursor 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
caseIdstringYesCase ID to retrieve (starts with case_)

Output

ParameterTypeDescription
caseobjectThe retrieved case

persona_create_report

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
reportTypestringYesType of report to run: watchlist, adverse-media, or politically-exposed-person
reportTemplateIdstringYesReport template ID to run (starts with rptp_)
termstringNoFull-name search term (e.g. "Jane Q Doe"). Provide this or the separate name parts.
nameFirststringNoFirst name of the individual to search
nameMiddlestringNoMiddle name of the individual to search
nameLaststringNoLast name of the individual to search
birthdatestringNoBirthdate of the individual, formatted as YYYY-MM-DD
countryCodestringNoISO 3166-1 alpha-2 country code (e.g. US)
accountIdstringNoAccount ID (starts with act_) to associate with this report

Output

ParameterTypeDescription
reportobjectThe 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
reportIdstringYesReport ID to retrieve (starts with rep_)

Output

ParameterTypeDescription
reportobjectThe retrieved report

persona_list_reports

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
accountIdstringNoFilter by account ID (starts with act_)
referenceIdstringNoFilter by reference ID
pageSizenumberNoNumber of reports to return per page (1-100, default 10)
pageAfterstringNoPagination cursor: return reports after this report ID

Output

ParameterTypeDescription
reportsarrayReports matching the filters
nextCursorstringCursor 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.

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
verificationIdstringYesVerification ID to retrieve (starts with ver_)

Output

ParameterTypeDescription
verificationobjectThe retrieved verification

persona_get_document

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
documentIdstringYesDocument ID to retrieve (starts with doc_)

Output

ParameterTypeDescription
documentobjectThe retrieved document

persona_list_inquiry_templates

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

Input

ParameterTypeRequiredDescription
apiKeystringYesPersona API key
pageSizenumberNoNumber of templates to return per page (1-100, default 10)
pageAfterstringNoPagination cursor: return templates after this template ID

Output

ParameterTypeDescription
inquiryTemplatesarrayInquiry templates in the organization
nextCursorstringCursor for the next page (pass as pageAfter), or null on the last page

On this page