Skip to main content
POST
Create or refresh an enhanced verification session

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Response

Interactive enhanced verification session details retrieved just in time for the authenticated user.

Interactive enhanced verification session details retrieved just in time for the authenticated user.

sessionId
string
required

Provider-issued identifier for the current verification session.

Example:

"inq_2Q3x7k9m1n"

provider
enum<string>
required
Available options:
persona,
plaid
sessionToken
string | null
required

Provider-issued token for an embedded flow: a Persona session token when provider is persona, or a Plaid Link token when provider is plaid. Null when the provider supplies only a hosted URL or no usable flow.

verificationUrl
string<uri> | null
required

Provider-hosted URL to start or continue verification. It is the hosted fallback for either provider and must not be constructed by the client. Null when only an embedded token is available or no usable flow was returned.

Example:

"https://withpersona.com/verify?inquiry-id=inq_2Q3x7k9m1n"

verificationUrlExpiresAt
string<date-time> | null
required

Expiration time for verificationUrl when the provider returns an expiring link.