Unico IDCloud - DevCenter
HomepageAuthenticationAPIsSDKs
English (United States)
English (United States)
  • Welcome
  • GETTING STARTED
    • Unico IDCloud
    • Capabilities
    • Integration Methods
    • Capabilities and Integration Methods
  • INTEGRATIONS
    • Quickstart
    • Authentication
      • Creating a Service Account
      • Preparing to Make an Authenticated API Request
      • Additional Resources
        • Example in Javascript
        • Authentication Errors
        • Postman Collection
    • Integration by Unico
      • Overview
      • API
        • API Reference
          • CreateProcess
            • CreateProcess separated by flows
          • GetProcess
          • GetSelfie
          • GetEvidenceSet
            • Specification of the evidential set
          • GetDocumentSigned
          • GetEvidenceSign
        • Errors
      • Controlling the experience
        • Redirecting the user
        • SDK
        • QR Code
        • Customizations
      • Additional Resources
        • Postman Collection
        • PoCs available
    • Integration by Client
      • Overview
      • API
        • API Reference
          • Liveness + Identity Verification + Behavior Alert
          • Liveness + Identity Verification + Behavior Alert + Risk Score
          • Liveness + Validation (1:1) + Behavior Alert
          • Document Capture and Reuse
        • Response Scenarios
        • Additional Resources
          • Postman Collection
      • Capture standard (without SDK)
    • Webhook
    • SDK
      • Overview
      • Update Policy
      • SDK Integration
        • Android SDK
          • Installation Guide
          • Usage and Integration Guide
            • Selfie Capture
            • Document Capture
          • Error Handling Guide
          • Android Customization
          • Troubleshooting
          • Release notes
        • iOS SDK
          • Installation Guide
          • Usage and Integration Guide
            • Selfie Capture
            • Document Capture
          • Error Handling Guide
          • iOS Customization
          • Troubleshooting
          • Release notes
        • Flutter SDK
          • Installation Guide
          • Usage and Integration Guide
            • Selfie Capture
            • Document Capture
          • Error Handling Guide
          • Flutter Customization
          • Troubleshooting
          • Release notes
        • Web SDK
          • Installation Guide
          • Usage and Integration Guide
            • Selfie Capture
            • Document Capture
            • Accessibility
          • Error Handling Guide
          • Web Customization
          • Release notes
      • Additional Resources
        • Available PoCs
        • Best Practices for SDK Implementation
  • help & faq
    • Glossary
    • Help Center
Powered by GitBook

Institucional

  • Sobre nós

Copyright © 2024 unico. All rights reserved

On this page
  • Introduction
  • Operational Diagram
  • Requirements Supported by Each Client SDK
  • Versioning of the SDKs

Was this helpful?

Export as PDF
  1. INTEGRATIONS
  2. SDK

Overview

In this section, you will find an overview of how the Unico IDCloud platform SDK operates

PreviousSDKNextUpdate Policy

Last updated 2 months ago

Was this helpful?


Introduction


The SDKs from the Unico IDCloud platform aim to enhance the security of your business and your clients, even allowing you to personalize the user experience by applying your brand's visual identity. The SDKs abstract the complexity of handling the user's device camera and capturing images (Selfie and document), making life easier for developers and reducing the time to deliver the final product. Other advantages:

  • Liveness: The SDKs are used in conjunction with the capability to ensure that the user is alive at the moment of capturing the selfie.

  • Image Capture Accuracy: The SDKs have features that help the user obtain biometrically valid photos, reducing image drop rates compared to captures made by standard device cameras. SmartFrames are added, which are "key elements" that automatically adjust to the user's silhouette and screen proportions, allowing for better image capture.

  • Enhanced Security: Encryption features and protection against image injection, also including functionalities that prevent fraud, adapted to different camera modes. Security layers that work complementarily, both at the application level and in relation to the data transmitted between the SDKs and the backend. The SDK also includes code obfuscation, emulator blocking, and app bundle verification for the app executing it.

The image capture through the SDKs is just the first part of the journey. Therefore, it is extremely important to understand the basic concepts and how the biometric engine APIs work. For more information, see the REST API of the .

SDK Updates

It is important to emphasize that for the proper functioning of our solutions, with maximum security and stability, it is essential that the SDK is properly updated. It is the client's responsibility to monitor and ensure that they are using the latest version of the SDK available on our servers.

Unico is not responsible for issues arising from the lack of SDK updates in the client's operation. [

Operational Diagram


The SDK (Client-side) is responsible for simplifying your integration with the Unico IDCloud platform, handling all the complexity of camera manipulation and image capture.

If the capture is successful, the SDK returns an object that must be sent to the biometric engine API, thus completing the biometric validation, as illustrated in the diagram below:

1

The user accesses their application

2

Through the SDK, your application requests the frame for capture (according to how your application has been configured).

3

Your application renders the capture frame in a pre-established placeholder.

4

The SDK captures the image, generating a JWT token that will be returned to your application.

5

Your application passes the JWT to your server.

6
7

The servers return the response from the biometric engine, which must be sent to your application.

8

Your application provides a response to the user.

Requirements Supported by Each Client SDK


Below are the necessary information and requirements officially supported by each Unico Client SDK:

SDK Android
SDK iOS
SDK Web
  • Plugins: Flutter

  • Linguagens: Java/Kotlin

  • Xcode: >= 15.0

  • Plugins: Flutter

  • Linguagens: swift/objective-c

  • iOS: >= 11

  • Dependency manager: Cocoapods ou Swift Package Manager

  • Frameworks: React JS, Angular, Next JS, Vue JS e JS Vanilla.

  • Versão Javascript: ECMAScript 5 or higher.

Our support is restricted to applications developed directly on the native Android and iOS platforms, using their respective native modules, as well as the Flutter framework (if the implementation uses our plugin). At this time, we do not offer support for applications developed using hybrid frameworks such as React Native, Ionic, or other cross-platform development technologies.

Versioning of the SDKs


The SDKs of the Unico IDCloud platform follow semantic versioning, which means there is a version number in the format "MAJOR.MINOR.PATCH", described as follows:

  • Major Version (MAJOR): When making incompatible changes to the API;

  • Minor Version (MINOR): When adding functionality while maintaining compatibility;

  • Patch Version (PATCH): When fixing bugs while maintaining compatibility.


Your server interacts with the biometric engine APIs to analyze the image (through the REST APIs).

Android: 5.0 (API 21)

Kotlin: 1.6

Still need help?

Didn't find something or still need help? If you're already a client or partner, you can reach out through our .

Liveness
by Client
Learn more about our SDK Update Policy here]
By Client
​
Help Center
​
​