Ghana Card scanner and data extractor SDK for iOS — reads both sides, extracts MRZ data and passport photo.
# GhanaCardSDK
Ghana National ID Card scanner for iOS — automatic, on-device, MRZ + photo extraction.
---
## What It Does
GhanaCardSDK gives your iOS app a fully automatic Ghana Card scanning screen. The user points the camera at the front of their Ghana National ID Card, then the back. The SDK detects the card automatically, captures both sides, and returns all extracted fields including the MRZ data and the passport photo — no manual capture button needed.
**What gets extracted:**
- Full name
- Personal ID number
- Document number
- Date of birth
- Expiry date
- Sex
- Nationality
- Passport photo (base64 JPEG)
- Processing time
---
## Requirements
- iOS 15.0+
- Xcode 15+
- A CodeLytical API key (see below)
---
## Step 1 — Get Your API Key
1. Go to **
codelyticalhub.com**
2. Create an account or sign in
3. Navigate to **Dashboard → API Keys**
4. Click **Generate Key**
5. Copy your key
Keep your key private. Do not commit it to a public repository.
---
## Step 2 — Installation
### CocoaPods
Add this to your `Podfile`:
```ruby
pod 'GhanaCardSDK', '~> 1.0.0'
```
Then run:
```bash
pod install
```
Open your project using the `.xcworkspace` file from now on.
---
### Swift Package Manager
In Xcode:
1. Go to **File → Add Package Dependencies**
2. Paste this URL:
```
github.com
```
3. Select **Up to Next Major Version** → `1.0.0`
4. Click **Add Package**
---
## Step 3 — Camera Permission
Add this to your `Info.plist`:
```xml
NSCameraUsageDescription
This app uses the camera to scan your Ghana Card.
```
Without this the app will crash when the SDK tries to access the camera.
---
## Step 4 — Integration
### Import the SDK
```swift
import GhanaCardSDK
```
---
### Register (call once at app start)
Call this in your `App` struct or `SceneDelegate` — it is a no-op on iOS but required for consistency:
```swift
GhanaCardClient.register()
```
---
### Initialize (validate your API key …