Octet Mobile SDK

Proof of location for iOS and Android apps.

What the SDK does

Your app calls sdk.loc.isWithin(region: …) and gets back an OctetVerdict. Its result is YES (the device is inside the region), NO (the device is outside it), or INDETERMINATE (the SDK cannot answer, and a reason code says why). A YES or NO carries a signed proof that anyone can verify offline.

Starting points

iOS Quick StartInstall with Swift Package Manager and get a first verdict Android Quick StartInstall from Maven and get a first verdict Proof of LocationWhat a proof records and how the SDK produces it What users seeWhat the person sees in your app while the SDK runs On-device VerificationVerify a proof on the device, offline, with Octet.verify API ReferenceOne page per symbol, Swift and Kotlin side by side Upgrading from 2.xChanges from 2.0 to 3.1, breaking changes first Migrating from 1.xChanges from 1.x to 2.0, breaking changes first Troubleshooting & FAQIndexed by what you see in verdict.reason or LicenseError

Access

Create an account and register your app once at sdk.octetproof.com/signup (see Prerequisites). Use of the SDK is governed by the Octet SDK License Agreement. Pricing is at octetproof.com/pricing.

SDK 3.1.2

These docs describe SDK 3.1.2. What's new in 3.1 lists the changes from 3.0. The 3.0 docs stay at /docs/v3.0/, the 2.0 docs at /docs/v2.0/ and the 1.x docs at /docs/v1.2/.