Flutter
Requirements
Installation of the Authenteq Flow plugin requires Flutter v2.5.0
.
Getting started
Install Authenteq Flow SDK in your project with:
this will change pubspec.yaml
and add authenteq_flow
dependency, e.g.:
Optionally add the modules for Live ID document scanner:
and Live ID document scanner database:
Then install them with the command:
for more information see Flutter official documentation here.
Example to Start an Identification
Import AuthenteqFlow plugin in your dart file:
Start identification:
As alternative to client secret authentication it is possible to provide authentication token:
Token value can be obtained as described in Authentication Token section.
Parameter fields description:
Key name | Type | Description |
| String | Client ID value from Customer Dashboard (required) |
| String | Client Secret value from Customer Daskboard (required unless token is specified) |
| String | In conjunction with Client Secret, Flow ID specify a verification flow defined in customer's dashboard (optional) |
| String | Authentication token (required unless clientSecret is specified) |
| Dictionary | Customized theme settings (optional) |
Android theme keys:
Key name | Type | Description |
| String | Android style name (for definition details see Android customization) |
iOS theme keys:
Key name | Type | Description |
| String (hex value) | Main color of your scheme |
| String (hex value) | Text color |
| String (hex value) | Background color for all screens |
| String (hex value) | Color for some highlighted area in screen background |
| String (hex value) | Color for table view cells separator |
| String (hex value) | Color for selected buttons text |
| String (hex value) | Background color for selected buttons |
| String | Font name for text |
| String | Font name for bold text |
| Image | Custom image for liveness instructions. We recommend using images smaller than 300dp |
| Image | Custom image for passport scan instructions. We recommend using images smaller than 300dp |
| Image | Custom image for driver's license scan instructions. We recommend using images smaller than 300dp |
| Image | Custom image for ID card scan instructions. We recommend using images smaller than 300dp |
| Image | Custom image NFC chip presence verification instructions in the document |
| Image | Custom image NFC document scan instructions |
| Image | Custom image for NFC document inside scan instructions |
| Image | Custom image for proof of address scan instructions. We recommend using images smaller than 300dp |
| Image | Custom icon for ID document. We recommend using images smaller than 250dp |
| Image | Custom icon for proof of address. We recommend using images smaller than 250dp |
Identification result
The class IdentificationResult
will be returned after a successful identification with the following properties:
Property | Type | Description |
| String | Unique reference ID of the completed identification |
| List<DocumentIdentificationResult> | Array with details of the identification documents |
| String | File path to selfie image |
| String | File path to proof of address document |
DocumentIdentificationResult
provide the following properties:
Property | Type | Description |
| enum | Id document type. Possible values:
|
| String | Given names (separated with whitespace) |
| String | Given names in the local language (optional) |
| String | Surnames (separated with whitespace) |
| String | Surnames in the local language (optional) |
| String | Surnames and Given Name(s) (separated with whitespace) - For use when |
| String | Surnames and Given Name(s) in the local language (optional) |
| String | Place of birth |
| String | Place of birth in the local language (optional) |
| DateTime | Date of birth |
| DateTime | Date of expiration of the document |
| DateTime | Date of issue of the document |
| String | Country code of user's nationality in ISO 3166-1 alpha-3 format |
| String | Country code of document's issuing country in ISO 3166-1 alpha-3 format |
| String | Issuing authority name |
| String | Issuing authority name in the local language (optional) |
| String | ID document number |
| String | Personal number of the document owner |
| String | Possible values are:
|
| String | Place of residence |
| String | Area where the document got issued. E.g.: USA State or Canada Province. |
| String | Driver's License Classes |
| Map<String,DriversLicenseClassDetailResult> | Driver's License Class details. Map Key is the Class name (i.e. A, B, B1, C, etc.) and Value is a
|
| bool | Is person's age over 16 years. |
| bool | Is person's age over 18 years. |
| bool | Is person's age over 21 years. |
| String | File path to the image of ID document front page |
| String | File path to the image of ID document back page |
Face Authentication
To perform a face authentication, add the following import:
Start a face authentication:
As alternative to client secret authentication it is possible to provide authentication token:
Token value can be obtained as described in Authentication Token section.
We suggest to use the token authentication in production environment.
With the code obtained it is possible to get the face authentication result using the following API:
Obtain the result of a face authentication
GET
https://api.app.authenteq.com/mobile-sdk/face-authentication-result
This endpoint is authorized with Basic Authorization. You should use your Client ID
and Client Secret
from the Customer Dashboard as the credentials.
Query Parameters
Name | Type | Description |
---|---|---|
code* | string | The code provided at the conclusion of SDK face authentication |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Your client credentials combined with a colon separator, base64-encoded and prefixed with "Basic ". |
When successful the response will contain a single boolean property named success
:
Last updated