Persona types

Inquiry and verification results

Exports inquiry statuses and the results of Persona inquiry creation and verification.

Usage

import type * as  from 'mppx/extensions/identity/persona'
 
declare const : .
.(.)
inq_example

InquiryStatus

Persona.InquiryStatus is the union below. Only approved is accepted by default; completed means the flow completed, not that a workflow or reviewer approved it.

type InquiryStatus =
  | 'approved'
  | 'completed'
  | 'created'
  | 'declined'
  | 'expired'
  | 'failed'
  | 'needs_review'
  | 'pending'

StartedInquiry

Persona.StartedInquiry, returned by startInquiry as a frozen object:

Property	Type	Meaning
`inquiryId`	`string`	Persona inquiry ID (`inq_…`)
`url`	`string`	One-time link to the hosted KYC flow

VerifiedInquiry

Persona.VerifiedInquiry, returned by successful paymentCheck and verifier lookups as a frozen object:

Property	Type	Meaning
`inquiryId`	`string`	Accepted Persona inquiry ID
`referenceId`	`string`	Exact reference ID matched by the check
`status`	`Persona.InquiryStatus`	Accepted inquiry status
`verifiedAt` (optional)	`Date`	`decisioned-at`, falling back to `completed-at`; absent if unparseable or missing

Server types

Export	Reference
`Persona.Server.LookupOptions`	Shared cache, freshness, status, and onboarding options
`Persona.Server.Persona`	Client returned by `create`
`Persona.Server.create.Config`	Client configuration
`Persona.Server.create.PaymentParameters`	Payment check callback input
`Persona.Server.verifyWallet.Parameters`	Wallet signature verification input
`Persona.did.Parameters`	Wallet DID input

Suggest changes to this page