Introduction¶
IMPORTANT NOTE
This iOS Swift product is not a new major version of the Objective-C SDK, but the product redesigned in Swift. It introduces significant changes and new capabilities compared to the previous implementation, but it does not maintain backward compatibility. To ensure a smooth transition, follow the dedicated migration guide and thoroughly test in development environments to validate integration and functionality.
Key Features and Improvements of iOS SDKs
- Accessible and user-friendly UI, with full customization options.
- Enhanced and more structured configuration management.
The Document SDK is a Swift library focused on identity document capture for iOS. It guides the user through the document flow, captures the required sides, and returns structured results and events for integration. The SDK supports various document types, including ID cards, driving licenses, residence permits, and passports.
Flow¶
The Document SDK guides the user through a clear capture flow:
- Show the obverse (front side) of the document: The user must present the front side of the document inside the capture area.
- Show the reverse (back side) of the document (if applicable): If the selected document type requires it, the SDK requests the reverse side.
- Review and completion: The SDK confirms capture and returns final callbacks and results to the host app.
Document type¶
The SDK supports the capture of a wide range of documents from around the world. You can find the complete list here: Documents. Depending on the document type, the SDK will prompt the user to capture either just the front side (obverse) or both sides (obverse and reverse) of the document.