iOS SDK · by IDX Studios

Scan an ID.
Check the person.
All on the phone.

The EKAI Document Capture SDK scans licences, ID cards and passports, reads the barcode and the machine-readable lines, checks liveness and matches the selfie to the ID photo. It makes no network calls. It ships with a guide written for your coding agent.

iOS 15 or later (face match: iOS 16). Swift. Needs a physical iPhone to scan.

What it does

Three checks, one at a time

  1. Scan the document

    A driver's licence, ID card or passport. The SDK finds the card, waits until it is steady and sharp, then captures it. It reads the barcode on the back of a licence and the two machine-readable lines on a passport, and crops the portrait.

  2. Check there is a person

    A selfie with a blink and a head turn, in random order. It stops a photo held up to the camera and simple replays.

  3. Match the face to the ID

    The selfie is compared with the portrait on the document, on the phone. You get match, uncertain or no match, plus a score.

You can use only the first step, or the first two. They are separate parts of the SDK.

Before you integrate

Ten decisions that are yours, not your agent's

A coding agent can wire the SDK in without you. It cannot decide what your product promises or what the law allows. The guide tells the agent to ask you these, and to use the safe default and say so if you are not there.

1. Which checks do you need?

Scan only, scan plus liveness, or scan plus liveness plus face match. Each adds screens and privacy duties. Start with the smallest.

2. Lowest iOS version

The SDK runs on iOS 15. Face match needs iOS 16. Do not raise your minimum without meaning to.

3. Is it going in an App Clip?

A clip has a hard size limit (10 MB on iOS 15, 15 MB on iOS 16 and later) for everything in it. The SDK is about 8.4 MB, most of it the face model.

4. Legal sign-off for face match

The face model was trained on public research datasets. Have counsel confirm their terms allow your commercial use before face match goes to production.

5. How much to trust a match

The thresholds are provisional. Treat “uncertain” as a case for a person to review, and do not approve anyone on “match” alone.

6. What liveness is, and is not

Basic liveness. It does not stop a video replay or a mask, and it is not a certified presentation-attack test. Do not describe it as anti-spoofing.

7. The camera message

Apple shows your wording to users and reviews it. Write it yourself.

8. Where the ID data goes

The SDK sends nothing anywhere. Your app decides what to keep. Government ID data is regulated personal data: keep it in memory unless you have a reason and a plan.

9. Commercial terms

Agree these with IDX Studios before you ship to production.

10. Which documents must work

US and Canadian licence barcodes and passport or ID-card MRZ lines are read. Other layouts may scan without returning parsed fields. Name the documents and test each on a phone.

For your coding agent

Download, unzip, hand it one instruction

  1. 1Download the zip below and unzip it next to your project.
  2. 2Give your agent the instruction on the right. It reads INTEGRATION.md first.
  3. 3Answer its questions about the ten decisions.
  4. 4Test on a physical iPhone. The agent will not be able to, and will say so.
Paste this to your agent
Integrate the EKAI Document Capture SDK into this iOS app.
Read INTEGRATION.md from the SDK folder completely before editing anything.
Ask me the questions in its section 0; do not guess. Then follow it in order and
finish by ticking every line of its "Definition of done", telling me which
lines you could not verify.

The guide is also plain Markdown at idxstudioz.com/ekai-sdk/integration.md, so an agent can read it before you download.

In the zip

Everything needed, nothing to sign up for

The framework

EkaiDocumentCapture.xcframework for device and simulator, plus a Package.swift so Xcode adds it as a local package.

INTEGRATION.md

The guide your coding agent reads first. Setup, code, a definition of done, and the decisions that are yours to make.

A reference app

A small SwiftUI flow: scan, back of ID, selfie, result. Copy its structure rather than starting blank.

Changelog and notices

What changed in each version, and the third-party licences that must be acknowledged.

Plainly

What it does not do yet

  • Scanning needs a physical iPhone. The camera and Apple's document and face models do not run in the simulator.
  • Auto-capture timing, the liveness turn direction and passport detection have not yet been verified on a physical device or with a wide set of real passports. Test on your own phones before you rely on them.
  • An open passport may be outlined as both pages; the SDK keeps the page with the machine-readable lines.
  • The look of the scanner is the SDK's own (purple and white). The result and selfie screens in the reference app are examples, not a design system.
Get the SDK

Enter your email, get the link

Download the EKAI SDK

  • iOS 15+
  • xcframework + guide + demo
  • 15.6 MB zip

Latest version1.2.0, October 2026

Before you download
  • A Mac with Xcode 26 or later.
  • An iOS app (or App Clip) target, iOS 15 or later.
  • A physical iPhone to test scanning.
  • A coding agent, or an hour with the guide.
Questions

Before you try it

Does anything leave the phone?
Not from the SDK. It makes no network calls: scanning, parsing, liveness and face match all run on the device. What your app does with the result is up to you.
Which coding agents does it work with?
Any agent that can read a Markdown file and edit an Xcode project. INTEGRATION.md is plain Markdown and is also served at the link below, so an agent can read it before you download anything.
What is the licence?
Commercial terms are agreed with IDX Studios before you ship to production. Reply to the email with your download link and we will sort it out.
How are updates delivered?
Each release is a new zip with a changelog that lists behaviour changes. The guide has an upgrade section, so an agent can do it for you. This page always shows the latest version.
Why ask for my email?
The link is single-use and expires after 48 hours, so it is emailed to you rather than posted here.
Who makes it?
IDX Studios, in Vancouver.

Looking for a ready-made check rather than an SDK? See FastpassX.