CrossmintIdentityVerification

Class Renders Crossmint’s hosted identity verification step in a WebView.

class CrossmintIdentityVerification extends StatefulWidget

Read-only: the hosted page reports lifecycle events and nothing is sent back to it. Open it when the order first carries credentials and, while it is open, keep passing the latest non-null credentials so a rotated secret reaches it. Close it on onComplete or onCancel and keep it closed for that order. With session credentials the order leaves requires-kyc as soon as the buyer submits, before the result screen shows, so the controller’s identityVerificationCredentials turns null while the flow is still on screen.

CrossmintIdentityVerificationCredentials? _credentials;
String? _closedOrderId;

// Listener on checkoutController:
void _onOrderChanged() {
  final latest = checkoutController.identityVerificationCredentials;
  final orderId = checkoutController.order?['orderId'];
  if (latest != null && orderId != _closedOrderId) {
    setState(() => _credentials = latest);
  }
}

void _closeVerification() => setState(() {
  _credentials = null;
  _closedOrderId = checkoutController.order?['orderId'] as String?;
});

// In build:
if (_credentials != null)
  CrossmintIdentityVerification(
    apiKey: 'YOUR_API_KEY',
    credentials: _credentials!,
    onComplete: (_) => _closeVerification(),
    onCancel: _closeVerification,
  ),

Constructors

CrossmintIdentityVerification

const CrossmintIdentityVerification({
  super.key,
  required this.apiKey,
  required this.credentials,
  this.locale,
  this.onReady,
  this.onComplete,
  this.onCancel,
  this.onError,
  this.loadingBuilder,
  this.defaultHeight = 300,
})

Properties

apiKey

final String apiKey

Crossmint API key. Resolves staging versus production and is forwarded to the hosted page, matching the React Native SDK and the other Crossmint widgets in this package.

credentials

final CrossmintIdentityVerificationCredentials credentials

Credentials for the verification session.

locale

final String? locale

Optional locale tag. Must be one the hosted page recognises, for example en-US, es-ES, pt-PT. An unrecognised tag is not ignored: the page rejects it and reports a non-retriable invalidConfiguration error, which leaves the buyer with a dead screen.

onReady

final void Function()? onReady

Called when the verification UI is ready.

onComplete

final void Function(CrossmintIdentityVerificationStatus status)? onComplete

Called with the outcome when verification finishes.

onCancel

final void Function()? onCancel

Called when the buyer abandons verification.

onError

final void Function(CrossmintIdentityVerificationError error)? onError

Called when verification cannot run or continue.

loadingBuilder

final CrossmintIdentityVerificationLoadingBuilder? loadingBuilder

Optional builder for the loading overlay. Falls back to a themed Material spinner, matching CrossmintPaymentMethodManagement.

defaultHeight

final double defaultHeight

Initial height before the hosted page reports its actual height.

Methods

createState

State<CrossmintIdentityVerification> createState()

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

CrossmintIdentityVerification

Constructors

CrossmintIdentityVerification

Properties

apiKey

credentials

locale

onReady

onComplete

onCancel

onError

loadingBuilder

defaultHeight

Methods

createState

​Constructors

​CrossmintIdentityVerification

​Properties

​apiKey

​credentials

​locale

​onReady

​onComplete

​onCancel

​onError

​loadingBuilder

​defaultHeight

​Methods

​createState

Constructors

CrossmintIdentityVerification

Properties

apiKey

credentials

locale

onReady

onComplete

onCancel

onError

loadingBuilder

defaultHeight

Methods

createState