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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryTemplateId`	string	是	Inquiry template ID (starts with itmpl_), inquiry template version ID (starts with itmplv_), or legacy template ID (starts with tmpl_)
`accountId`	string	否	Account ID (starts with act_) to associate with this inquiry
`referenceId`	string	否	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	否	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	否	Free-form note to attach to the inquiry
`redirectUri`	string	否	URI to redirect the individual to after completing the inquiry flow

输出

参数	类型	描述
`inquiry`	object	The created inquiry

`persona_get_inquiry`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to retrieve (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`status`	string	否	Filter by inquiry status (created, pending, completed, failed, expired, needs_review, approved, declined)
`accountId`	string	否	Filter by account ID (starts with act_); comma-separate multiple IDs
`referenceId`	string	否	Filter by reference ID
`createdAtStart`	string	否	Filter to inquiries created at or after this ISO 8601 timestamp
`createdAtEnd`	string	否	Filter to inquiries created at or before this ISO 8601 timestamp
`pageSize`	number	否	Number of inquiries to return per page (1-100, default 10)
`pageAfter`	string	否	Pagination cursor: return inquiries after this inquiry ID

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to update (starts with inq_)
`note`	string	否	Free-form note to set on the inquiry
`fields`	json	否	JSON object of field name to field value pairs to set, as defined by the inquiry template (e.g. {"name-first": "Jane"})
`tags`	array	否	JSON array of tag names to set on the inquiry (e.g. ["vip"])
`redirectUri`	string	否	URI to redirect the individual to after completing the inquiry flow

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to approve (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The approved inquiry

`persona_decline_inquiry`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to decline (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The declined inquiry

`persona_mark_inquiry_for_review`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to mark for review (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to resume (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The resumed inquiry
`sessionToken`	string	Session 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to expire (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The expired inquiry

`persona_generate_inquiry_link`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to generate a one-time link for (starts with inq_)
`expiresInSeconds`	number	否	Number of seconds from now until the link expires (must be greater than 0; defaults to the inquiry template setting, typically 24 hours)

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to print (starts with inq_)

输出

参数	类型	描述
`file`	file	PDF 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`inquiryId`	string	是	Inquiry ID to redact (starts with inq_)

输出

参数	类型	描述
`inquiry`	object	The 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`accountTypeId`	string	否	Account type ID to create the account for (starts with acttp_); defaults to your organization default
`referenceId`	string	否	Reference ID that refers to an entity in your user model
`countryCode`	string	否	ISO 3166-1 alpha-2 country code (e.g. US)
`fields`	json	否	JSON object of field name to field value pairs, as defined by the account type (e.g. {"name-first": "Jane"})
`tags`	array	否	JSON array of tag names to associate with the account (e.g. ["vip"])

输出

参数	类型	描述
`account`	object	The created account

`persona_get_account`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`accountId`	string	是	Account ID to retrieve (starts with act_)

输出

参数	类型	描述
`account`	object	The retrieved account

`persona_list_accounts`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`referenceId`	string	否	Filter by reference ID
`pageSize`	number	否	Number of accounts to return per page (1-100, default 10)
`pageAfter`	string	否	Pagination cursor: return accounts after this account ID

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`accountId`	string	是	Account ID to update (starts with act_)
`referenceId`	string	否	Reference ID that refers to an entity in your user model
`countryCode`	string	否	ISO 3166-1 alpha-2 country code (e.g. US)
`fields`	json	否	JSON object of field name to field value pairs to set, as defined by the account type (e.g. {"name-first": "Jane"})
`tags`	array	否	JSON array of tag names to set on the account (e.g. ["vip"])

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`file`	file	是	CSV file of accounts to import

输出

参数	类型	描述
`importer`	object	The 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`accountId`	string	是	Account ID to redact (starts with act_)

输出

参数	类型	描述
`account`	object	The 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`status`	string	否	Filter by case status (e.g. Open, Resolved)
`accountId`	string	否	Filter by account ID (starts with act_)
`referenceId`	string	否	Filter by reference ID
`pageSize`	number	否	Number of cases to return per page (1-100, default 10)
`pageAfter`	string	否	Pagination cursor: return cases after this case ID

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`caseId`	string	是	Case ID to retrieve (starts with case_)

输出

参数	类型	描述
`case`	object	The retrieved case

`persona_create_report`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`reportType`	string	是	Type of report to run: watchlist, adverse-media, or politically-exposed-person
`reportTemplateId`	string	是	Report template ID to run (starts with rptp_)
`term`	string	否	Full-name search term (e.g. "Jane Q Doe"). Provide this or the separate name parts.
`nameFirst`	string	否	First name of the individual to search
`nameMiddle`	string	否	Middle name of the individual to search
`nameLast`	string	否	Last name of the individual to search
`birthdate`	string	否	Birthdate of the individual, formatted as YYYY-MM-DD
`countryCode`	string	否	ISO 3166-1 alpha-2 country code (e.g. US)
`accountId`	string	否	Account ID (starts with act_) to associate with this report

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`reportId`	string	是	Report ID to retrieve (starts with rep_)

输出

参数	类型	描述
`report`	object	The retrieved report

`persona_list_reports`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`accountId`	string	否	Filter by account ID (starts with act_)
`referenceId`	string	否	Filter by reference ID
`pageSize`	number	否	Number of reports to return per page (1-100, default 10)
`pageAfter`	string	否	Pagination cursor: return reports after this report ID

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`verificationId`	string	是	Verification ID to retrieve (starts with ver_)

输出

参数	类型	描述
`verification`	object	The retrieved verification

`persona_get_document`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`documentId`	string	是	Document ID to retrieve (starts with doc_)

输出

参数	类型	描述
`document`	object	The 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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Persona API key
`pageSize`	number	否	Number of templates to return per page (1-100, default 10)
`pageAfter`	string	否	Pagination cursor: return templates after this template ID

输出

参数	类型	描述
`inquiryTemplates`	array	Inquiry templates in the organization
`nextCursor`	string	Cursor for the next page (pass as pageAfter), or null on the last page

Persona

On this page