Persona

使用方法

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.

ツール

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.

入力

出力

persona_get_inquiry

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

入力

出力

persona_list_inquiries

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

入力

出力

persona_update_inquiry

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

入力

出力

persona_approve_inquiry

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

入力

出力

persona_decline_inquiry

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

入力

出力

persona_mark_inquiry_for_review

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

入力

出力

persona_resume_inquiry

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

入力

出力

persona_expire_inquiry

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

入力

出力

persona_generate_inquiry_link

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

入力

出力

persona_print_inquiry_pdf

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

入力

出力

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.

入力

出力

persona_create_account

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

入力

出力

persona_get_account

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

入力

出力

persona_list_accounts

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

入力

出力

persona_update_account

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

入力

出力

persona_import_accounts

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

入力

出力

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.

入力

出力

persona_list_cases

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

入力

出力

persona_get_case

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

入力

出力

persona_create_report

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

入力

出力

persona_get_report

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

入力

出力

persona_list_reports

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

入力

出力

persona_get_verification

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

入力

出力

persona_get_document

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

入力

出力

persona_list_inquiry_templates

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

入力

出力