<Verification />
function Verification(props: {
children?: ReactNode
components?: OryFlowComponentOverrides
config: OryClientConfiguration
flow: VerificationFlow
onError?: OryErrorHandler
onSuccess?: OrySuccessHandler
onValidationError?: OryValidationErrorHandler
transientPayload?: OryTransientPayload
}): Element
The Verification component is used to render the verification flow in Ory Elements.
It provides the necessary context and components for the verification flow, allowing you to customize the appearance and behavior of the verification form.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | { children?: ReactNode; components?: OryFlowComponentOverrides; config: OryClientConfiguration; flow: VerificationFlow; onError?: OryErrorHandler; onSuccess?: OrySuccessHandler; onValidationError?: OryValidationErrorHandler; transientPayload?: OryTransientPayload; } | The props for the Verification component. |
props.children? | ReactNode | Optional children to render If not provided, the default OrySelfServiceFlowCard will be rendered. |
props.components? | OryFlowComponentOverrides | Optional components to override the default ones. This allows you to customize the appearance and behavior of the verification flow. |
props.config | OryClientConfiguration | The Ory client configuration object. This object contains the configuration for the Ory client, such as the base URL and other settings. |
props.flow | VerificationFlow | The verification flow object containing the state and data for the verification process. |
props.onError? | OryErrorHandler | Optional callback invoked on flow-level errors. See OryErrorHandler |
props.onSuccess? | OrySuccessHandler | Optional callback invoked on successful flow completion. See OrySuccessHandler |
props.onValidationError? | OryValidationErrorHandler | Optional callback invoked when the flow returns validation errors. See OryValidationErrorHandler |
props.transientPayload? | OryTransientPayload | Optional transient payload to include in flow submissions. Accepts a static object or a function that receives form values at submission time and returns the payload. See OryTransientPayload |
Returns
Element
