Basic Realaml workflow

This guide covers the standard end-to-end flow to create a verification, have an end user complete it, and retrieve the final result.

1) Create a verification

Initiate a verification by calling:

POST /verifications/

The request/response parameters are documented in the API Reference

2) Choose how the end user starts the verification

Option A: Realaml sends the link (SMS or email)

If you include a phone number or email address in POST /verifications/, Realaml will send the end user an SMS or email containing a link to complete the verification.

Option B: You embed the flow (iFrame or Mobile SDK)

If you want to use the iFrame and/or mobile SDKs and you don’t want Realaml to send an SMS/email, let us know so we can enable that for your account.

When iFrame and/or mobile SDKs are enabled, the POST /verifications/ response includes:

url — use this as the iFrame src

signature_key — use this in the mobile SDKs

Related guides:

iFrame documentation

Android SDK documentation

iOS SDK documentation

3) Receive verification updates (webhooks)

To receive updates when a verification changes state, provide callback_url in POST /verifications/.

Details on how and when callback_url is called is in API Reference.

4) Fetch verification details

After you receive a callback, fetch the verification details using:

GET /verification/{signature_key}/

The response fields and possible statuses are documented API Reference.

About report links (PDFs/images)

The GET response can include temporary links to PDFs and images. These links expire after 15 minutes, so download/copy them promptly if you need to retain them.

5) Determine when the verification is complete

Use these key response fields from GET /verification/{signature_key}/:

is_completed — indicates whether all verification steps have finished

result — combined outcome across all checks

You can also access individual check results and additional metadata as described in the API docs.

6) Finalize

When is_completed is true, you can treat the verification as complete and use result as the combined verification outcome.

Basic Realaml workflow

1) Create a verification#

2) Choose how the end user starts the verification#

Option A: Realaml sends the link (SMS or email)#

Option B: You embed the flow (iFrame or Mobile SDK)#

3) Receive verification updates (webhooks)#

4) Fetch verification details#

About report links (PDFs/images)#

5) Determine when the verification is complete#

6) Finalize#