iFrame Embed

This guide covers embedding Realaml in an iFrame and listening for postMessage events.

Verification / Checks iFrame

iFrame embedding for verification/checks is disabled by default. Contact the Realaml team to enable this for your account.

Embed code

JavaScript events (postMessage)

The iFrame sends these postMessage events to the parent window:

CKYC:started

CKYC:error

CKYC:completed

Each event payload includes:

signatureKey (string)

message (optional string)

Example listener

Recommendation: validate the message origin before trusting the event payload.

Form iFrame

iFrame embedding is enabled by default for all forms.

Get embed code from the dashboard

To copy the embed code:

Open the form page in the Realaml dashboard

Click the dropdown menu on the form card

Select Copy form embed code

Sample embed code

JavaScript events (postMessage)

The embedded form sends these postMessage events to the parent window:

CKYC:form_started

CKYC:form_error

CKYC:form_completed

Each event payload includes:

form_id (optional string)

form_submission_id (optional string)

message (optional string)

Example listener

Recommendation: validate the message origin before using form_id / form_submission_id.

Performance: Optional COOP + COEP headers

Features such as ID scanning, ID capture, and PDF processing use WebAssembly (WASM) internally. WASM can run in multi-threaded mode for better performance, but this requires the parent page to be cross-origin isolated.

This is optional. Without these headers everything still works — WASM simply falls back to single-threaded mode, which may be slightly slower.

To enable multi-threaded WASM, add the following HTTP headers to your parent page (not the iFrame):

Setup	WASM mode	Scanning & PDF
Without COOP + COEP	Single-threaded	✅ Works, slightly slower
With COOP + COEP	Multi-threaded	✅ Works, full performance

Verification / Checks iFrame#

Embed code#

JavaScript events (postMessage)#

Example listener#

Form iFrame#

Get embed code from the dashboard#

Sample embed code#

JavaScript events (postMessage)#

Example listener#

Performance: Optional COOP + COEP headers#

Verification / Checks iFrame

Embed code

JavaScript events (postMessage)

Example listener

Form iFrame

Get embed code from the dashboard

Sample embed code

JavaScript events (postMessage)

Example listener

Performance: Optional COOP + COEP headers