React Native

Requirements
Installation of the Authenteq Flow npm requires React Native v0.61.5.
Getting started
$ npm install react-native-authenteq-flow --save
or
$ yarn add react-native-authenteq-flow
​
For iOS setup check here. For Android setup check here.
Usage in JavaScript
Import AuthenteqFlow in JS file before usage:
import AuthenteqFlow from 'react-native-authenteq-flow';
Start identification:
AuthenteqFlow
  .identification("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", [['PP','DL','NID']])
  .then((res) => {
    console.log(res);
  }).catch((error) => {
    console.error(error);
  })
To use a token identification or specify a custom theme use identificationWithParameters specifying a dictionary:
AuthenteqFlow
  .identificationWithParameters({
     clientId: "YOUR_CLIENT_ID", 
     clientSecret: "YOUR_CLIENT_SECRET", 
     documents: [['PP','DL','NID']],
     theme: {
        // iOS or Android custom theme 
     }
  })
  .then((res) => {
    console.log(res);
  }).catch((error) => {
    console.error(error);
  })
Parameters description:
Key name
Type
Description
clientId
String
Client ID value from Customer Dashboard (required)
clientSecret
String
Client Secret value from Customer Daskboard  (required unless token is specified)
token
String
Background color for all screens  (required unless clientSecret is specified)
documents
Array of Array of String
Color for some highlighted area in screen background (required)
theme
Dictionary
Customized theme settings  (optional)
 Android theme property:
Key name
Type
Description
AndroidStyle
String
Android style name (for definition details see Android customization)
iOS theme properties:
Property name
Type
Description
primaryColor
String (hex value)
Main color of your scheme
textColor
String (hex value)
Text color
screenBackgroundColor
String (hex value)
Background color for all screens
viewBackgroundHighlightColor
String (hex value)
Color for some highlighted area in screen background
separatorColor
String (hex value)
Color for table view cells separator 
selectedButtonTextColor
String (hex value)
Color for selected buttons text
selectedButtonBackgroundColor
String (hex value)
Background color for selected buttons
font
String
Font name for text
boldFont
String
Font name for bold text

identificationInstructionImageForSelfie
Image
Custom image for Selfie Authentication instructions. We recommend using images smaller than 300dp
identificationInstructionImageForPassport
Image
Custom image for passport scan instructions. We recommend using images smaller than 300dp
identificationInstructionImageForDriverLicense
Image
Custom image for driver's license scan instructions. We recommend using images smaller than 300dp
identificationInstructionImageForIdCard
Image
Custom image for ID card scan instructions. We recommend using images smaller than 300dp
identificationNfcSymbolCheck
Image
Custom image NFC chip presence verification instructions in the document
identificationNfcInstruction
Image
Custom image NFC document scan instructions
identificationNfcScanInside
Image
Custom image for NFC document inside scan instructions
react-native-sample.zip
react-native-sample.zip - 748KB
Example of JSON output for single document (driver's license)
{
    "verificationId": "3EF7784D-CBBB-4737-98F9-322E895EC667",
    "selfieImageFilePath": "path/to/jpeg_file",
    "documents": [
        {
            "dateOfBirth": "1987-01-12",
            "dateOfExpiry": "2045-05-22",
            "dateOfIssue": "2015-05-22",
            "documentFrontImageFilePath": "path/to/jpeg_file",
            "documentBackImageFilePath": "path/to/jpeg_file",
            "documentNumber": "DXY191672",
            "documentType": "DL",
            "givenNames": "ANNA MARIA",
            "surname": "SCHMIDT",
            "surnameAndGivenNames": "SCHMIDT ANNA MARIA",
            "isEighteenPlus": true,
            "isSixteenPlus": true,
            "issuingCountry": "DEU",
            "isTwentyOnePlus": true,
            "licenseClass": "A1 A B1 B",
            "licenseClassDetails": {
                "A": {
                    "from": "2015-05-22"
                },
                "A1": {
                    "from": "2015-05-22"
                },
                "B": {
                    "from": "2004-08-27"
                },
                "B1": {
                    "from": "2004-08-27"
                }
            }
        }
    ]
}
Example of JSON output for multiple documents (passport and driver's license)
{
    "verificationId": "3EF7784D-CBBB-4737-98F9-322E895EC667",
    "selfieImageFilePath": "path/to/jpeg_file",
    "documents": [
        {
            "dateOfBirth": "1987-01-12",
            "dateOfExpiry": "2027-01-30",
            "documentFrontImageFilePath": "path/to/jpg_file",
            "documentNumber": "8136431812",
            "documentType": "PP",
            "givenNames": "ANNA MARIA",
            "surname": "SCHMIDT",
            "surnameAndGivenNames": "SCHMIDT ANNA MARIA",
            "isEighteenPlus": true,
            "isSixteenPlus": true,
            "issuingCountry": "DEU",
            "isTwentyOnePlus": true,
            "nationality": "DEU",
            "sex": "F"
        },
        {
            "dateOfBirth": "1987-01-12",
            "dateOfExpiry": "2045-05-22",
            "dateOfIssue": "2015-05-22",
            "documentFrontImageFilePath": "path/to/jpeg_file",
            "documentBackImageFilePath": "path/to/jpeg_file",
            "documentNumber": "DXY191672",
            "documentType": "DL",
            "givenNames": "ANNA MARIA",
            "surname": "SCHMIDT",
            "surnameAndGivenNames": "SCHMIDT ANNA MARIA",
            "isEighteenPlus": true,
            "isSixteenPlus": true,
            "issuingCountry": "DEU",
            "isTwentyOnePlus": true,
            "licenseClass": "A1 A B1 B",
            "licenseClassDetails": {
                "A": {
                    "from": "2015-05-22"
                },
                "A1": {
                    "from": "2015-05-22"
                },
                "B": {
                    "from": "2004-08-27"
                },
                "B1": {
                    "from": "2004-08-27"
                }
            }
        }
    ]
}
Deprecated fields
selfieImageFile  is deprecated and is now available as selfieImageFilePath
documentFrontFile  is deprecated and is now available as documentFrontImageFilePath
documentBackFile  is deprecated and is now available as documentBackImageFilePath

Customization

iOS

Last updated 1 month ago

Key name	Type	Description
`clientId`	String	Client ID value from Customer Dashboard (required)
`clientSecret`	String	Client Secret value from Customer Daskboard (required unless token is specified)
`token`	String	Background color for all screens (required unless clientSecret is specified)
`documents`	Array of Array of String	Color for some highlighted area in screen background (required)
`theme`	Dictionary	Customized theme settings (optional)

Property name	Type	Description
`primaryColor`	String (hex value)	Main color of your scheme
`textColor`	String (hex value)	Text color
`screenBackgroundColor`	String (hex value)	Background color for all screens
`viewBackgroundHighlightColor`	String (hex value)	Color for some highlighted area in screen background
`separatorColor`	String (hex value)	Color for table view cells separator
`selectedButtonTextColor`	String (hex value)	Color for selected buttons text
`selectedButtonBackgroundColor`	String (hex value)	Background color for selected buttons
`font`	String	Font name for text
`boldFont`	String	Font name for bold text
`identificationInstructionImageForSelfie`	Image	Custom image for Selfie Authentication instructions. We recommend using images smaller than 300dp
`identificationInstructionImageForPassport`	Image	Custom image for passport scan instructions. We recommend using images smaller than 300dp
`identificationInstructionImageForDriverLicense`	Image	Custom image for driver's license scan instructions. We recommend using images smaller than 300dp
`identificationInstructionImageForIdCard`	Image	Custom image for ID card scan instructions. We recommend using images smaller than 300dp
`identificationNfcSymbolCheck`	Image	Custom image NFC chip presence verification instructions in the document
`identificationNfcInstruction`	Image	Custom image NFC document scan instructions
`identificationNfcScanInside`	Image	Custom image for NFC document inside scan instructions