Onfido Settings

The Onfido settings are defined in JSON format as key-value pairs. The following settings are available:

JSON Key Description
SourceEntityName The entity associated with the digital journey that calls the Onfido processor.
Needed only if the Onfido processor is used on an edit form (to alter an existing record) to update the workflow entity's business status after the scan.
If the Onfido processor is used on an insert form (to create a new record), this key is not needed.
UseProcessorForOCR Boolean value. When set to true, on OCR request is sent to DCS.
UseProcessorForCheck Boolean value. When set to true, the raw identity check reports received from the Onfido service are attached to the FTOS_ONFIDO_CHECK entity (in the FTOS_ONFIDO_CHECKREPORT related entity).
UploadFallback Boolean value - default: false.
When set to true, an optimized camera UI is used to take a live photo of the identity document. When this is not possible (because of an unsupported browser or mobile device), it falls back to the mobile device's default camera application.
IMPORTANT!  
This method does not guarantee live capture, because some mobile device browsers and camera applications allow uploads from the user's gallery of photos.
OnfidoCountry The identity document's issuing country specified using a 3-letter ISO 3166-1 alpha-3 country code.
OnfidoDocumentType An array with desired document types. Allowed values are: "national_identity_card", "passport", "driving_licence", and "residence_permit".
Referrer The URL of the web page where the Web SDK is used. The referrer sent by the browser must match the referrer URL pattern in the SDK token for the SDK to successfully authenticate.
DocumentHasTwoSides Boolean value indicating if the user must scan both sides of the identity document.
UseDefaultValues Boolean value. When set to true, the processor creates a new Onfido applicant with the information defined in DefaultApplicantData.
UseFaceSimilarity Boolean value. When set to true, the RequestedVariant field is displayed to validate face similarity.
RequestedVariant String, displayed if the Use Face Similarity field is set to true. The allowed values are: "standard" (default), "video", or"motion".
DefaultApplicantData JSON object containing key-value pairs for the default Onfido applicant's data.
ApplicantData The attributes from which the Onfido applicant's data is retrieved.
Entities Indicates the entities that populates with the scanned values.
  • DestinationEntityName – Name of the entity that is populated with the scanned data.
  • SourceEntityName – Entity associated with the digital journey that uses the automation processor. If this is the same entity that is populated, this value is identical to DestinationEntityName.
  • SourceLookupDestinationName – Name of the SourceEntityName lookup key that points to DestinationEntityName. If they are the same entity, enter the primary key.
OptionSets Replaces values returned by the Onfido processor with entries from an option set.
  • OptionSetName – Name of the option set that stores the valid replacement values.
  • MappingName – Name of the field as returned by the Onfido processor.
  • OptionSetItems – Key-value pairs that map the value returned by the Onfido processor (the key) to the replacement value from the option set (the value).
If the value returned by the Onfido processor is not found in the OptionSetItems keys, the entry is not be populated. The user is able to manually select only values from OptionSetName.
LookupEntities Validates values returned by the Onfido processor based on records in an entity.
  • MappingName – Name of the field as returned by the Onfido processor.
  • EntityName – Name of the entity that stores the valid values.
  • AttributeKey – Name of the attribute in EntityName that stores the valid values.
Parent – Defines hierarchical relationships between lookup entities. For instance, you can check if a city name belongs to a valid county name.
  • MappingParentName – Name of the parent field as returned by the Onfido processor.
  • AttributeParentKey – Name of the EntityName lookup key linked to the parent entity.
If the value returned by the Onfido processor is not found in the lookup entity, the entry does not populate. The user is able to manually select only values from the lookup entity.
MaskNextStepUrlSuccess Location in the user interface where the user is redirected after a successful check.
  • entity – Entity name.
  • form – Form name of the above entity.
  • section – Optional parameter for the section name of the above form.
MaskNextStepUrlFail Location in the user interface where the user is redirected after a failed check.
  • entity – Entity name.
  • form – Form name of the above entity.
  • section – Optional parameter for the section name of the above form.
UseLocalization Boolean value. Setting it to true enables user interface localization. Localization uses the FTOS_DFP_OnfidoLocalization client script library to populate the interface text fields. By default, only the en-US locale is defined. Edit the library to add additional languages.
DocumentType Used for embedded documents. The document type that identifies the set of attribute mappings used by the processor (see Onfido Mappings). Only one document type can be enabled per automation processor.
DocumentTypes
(Ecosystem SysPack 2.5.0 or later)		 Lists the accepted GenericDocumentTypes(Ecosystem SysPack 2.5.0 or later). e.g.:
Copy
"generic_document": [
        {"id": "my_single_side_document"},
        {"id": "my_two_sides_document"}
      ]
DisableLogSDKMessages
(Ecosystem SysPack 2.5.0 or later)		 Set this property to true if you do not wish to retain SDK logs.
LogLevel
(Ecosystem SysPack 2.5.0 or later)		 Controls the minimum severity level for the logged messages. Set it to error to capture only SDK errors or to debug to include all SDK log messages.
DisableSaveBrowserDetails
(Ecosystem SysPack 2.5.0 or later)		 Set this property to true to prevent storage of user platform details in the FTOS_DFP_Logging entity.
crossDevicePolicy
(Ecosystem SysPack 2.5.0 or later)		 Set this property to to disable to allow image uploads from the current device, or force to always redirect the user to a device with a camera for a live photo.
_crossDeviceLinkMethods
(Ecosystem SysPack 2.5.0 or later)		 Choose how the secondary device (with a camera) should link from the primary device: qr_code, copy_link, or sms.
enterpriseFeatures
(Ecosystem SysPack 2.5.0 or later)		 Allows you to hide or replace the Onfido logo, or display custom text instead:
  • hideOnfidoLogo - Removes the Onfido logo.
  • logoCobrand - Adds a custom logo image:
    • darkLogoSrc - URI of the replacement logo for dark mode.
    • lightLogoSrc - URI of the replacement logo for light mode
  • cobrand
    • text - Adds a custom text to the logo
GenericDocumentTypes
(Ecosystem SysPack 2.5.0 or later)		 Set up custom documents for scanning, supporting one or more pages.
  • id - The document type that identifies the set of attribute mappings used by the processor (see Onfido Mappings).
  • title - Provides a title for the custom document.
  • subtitle - Provides a subtitle for the custom document.
  • country - Custom document's issuing country specified using a 3-letter ISO 3166-1 alpha-3 country code.
  • pages - Number of pages of the custom document.

Examples

Copy 
{  
   "CustomUI": "",
   "SourceEntityName": "FTOS_Test_Onfido",
   "UseProcessorForOCR":true,
   "UseProcessorForCheck":true,
   "DisableSaveBrowserDetails": false,
   "DisableLogSDKMessages": false,
   "LogLevel": "debug",
   "OnfidoCountry":"ROU",
   "OnfidoDocumentType": ["national_identity_card"],
   "UploadFallback":true,
   "FaceSimilarityType": "video",
   "ReportNames": ["document"],
   "DocumentHasTwoSides": true,
   "UseDefaultValues":true,
   "DefaultApplicantData":{
       "LastName": "DefaultLastName",
       "FirstName": "DefaultFirstName",
       "Email": "DefaultEmail@email.com"
   }, 
   "ApplicantData":{
       "LastName": {
           "AttributeName": "applicantId_lastName",
           "Extension": "applicantData"
       },
       "FirstName": {
           "AttributeName": "applicantId_firstName",
           "Extension": "applicantData"
       },
       "Email": {
           "AttributeName": "applicantId_email",
           "Extension": "applicantData"
       }
   },
   "WaitingForResponseTimeout":1,  
   "Entities":[  
      {  
         "DestinationEntityName":"FTOS_Test_Onfido_Applicant",
         "SourceEntityName":"FTOS_Test_Onfido",
         "SourceLookupDestinationName":"applicantId"
      },
      {  
         "DestinationEntityName":"FTOS_Test_Onfido_ApplicantAddress",
         "SourceEntityName":"FTOS_Test_Onfido",
         "SourceLookupDestinationName":"applicantAddress"
      }
   ],  
  
   "OptionSets":[  
      {  
         "OptionSetName":"Gender Type",
         "MappingName":"Sex",
         "OptionSetItems":{  
            "Male":"Male",
            "Female":"Female"
         }
      }
   ],
   "LookupEntities":[  
      {  
         "MappingName":"DistrictCode",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"BirthDistrictBody",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"IssuingCountry",
         "EntityName":"FTOS_CMB_Country",
         "AttributeKey":"code"
      },
      {  
         "MappingName":"City",
         "EntityName":"City",
         "AttributeKey":"Name",
         "Parent":{  
            "AttributeParentKey":"DistrictId",
            "MappingParentName":"DistrictCode"
         }
      }
   ],
    "maskNextStepURLSuccess":{  
      "entity":"FTOS_Test_Onfido",
      "form":"FTOS_Test_Onfido_FDF",
      "section":"Success"
    },
   "maskNextStepURLFail":{  
      "entity":"FTOS_Test_Onfido",
      "form":"FTOS_Test_Onfido_FDF",
      "section":"Fail"
   },
   "UseLocalization": true,
   "DocumentType":"IdRom"
}
Copy 
{  
   "CustomUI": "",
   "SourceEntityName": "FTOS_Test_Onfido",
   "UseProcessorForOCR":true,
   "UseProcessorForCheck":true,
   "DisableSaveBrowserDetails": false,
   "DisableLogSDKMessages": false,
   "LogLevel": "debug",
   "UploadFallback":true,
   "OnfidoCountry":"ROU",
   "DocumentTypes": {
      "generic_document": [
        {"id": "my_single_side_document"},
        {"id": "my_two_sides_document"}
      ]
    },
   "GenericDocumentTypes": [
      {
        "id": "my_single_side_document",
        "title": "My single side document",
        "subTitle": "Details about my one side document",
        "country": "ROU",
        "pages": 1
      },
      {
        "id": "my_two_sides_document",
        "title": "My two sides document",
        "subTitle": "Details about my two sides document",
        "country": "ROU",
        "pages": 1
      }
   ],
   "ReportNames": ["document"],
   "FaceSimilarityType": "video",
   "DocumentHasTwoSides": false,
   "UseDefaultValues":true,
   "DefaultApplicantData":{
       "LastName": "DefaultLastName",
       "FirstName": "DefaultFirstName",
       "Email": "DefaultEmail@email.com"
   }, 
   "ApplicantData":{
       "LastName": {
           "AttributeName": "applicantId_lastName",
           "Extension": "applicantData"
       },
       "FirstName": {
           "AttributeName": "applicantId_firstName",
           "Extension": "applicantData"
       },
       "Email": {
           "AttributeName": "applicantId_email",
           "Extension": "applicantData"
       }
   },
   "WaitingForResponseTimeout":1,  
   "Entities":[  
      {  
         "DestinationEntityName":"FTOS_Test_Onfido_Applicant",
         "SourceEntityName":"FTOS_Test_Onfido",
         "SourceLookupDestinationName":"applicantId"
      },
      {  
         "DestinationEntityName":"FTOS_Test_Onfido_ApplicantAddress",
         "SourceEntityName":"FTOS_Test_Onfido",
         "SourceLookupDestinationName":"applicantAddress"
      }
   ],  
  
   "OptionSets":[  
      {  
         "OptionSetName":"Gender Type",
         "MappingName":"Sex",
         "OptionSetItems":{  
            "Male":"Male",
            "Female":"Female"
         }
      }
   ],
   "LookupEntities":[  
      {  
         "MappingName":"DistrictCode",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"BirthDistrictBody",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"IssuingCountry",
         "EntityName":"FTOS_CMB_Country",
         "AttributeKey":"code"
      },
      {  
         "MappingName":"City",
         "EntityName":"City",
         "AttributeKey":"Name",
         "Parent":{  
            "AttributeParentKey":"DistrictId",
            "MappingParentName":"DistrictCode"
         }
      }
   ],
    "maskNextStepURLSuccess":{  
      "entity":"FTOS_Test_Onfido",
      "form":"FTOS_Test_Onfido_FDF",
      "section":"Success"
    },
   "maskNextStepURLFail":{  
      "entity":"FTOS_Test_Onfido",
      "form":"FTOS_Test_Onfido_FDF",
      "section":"Fail"
   },
   "UseLocalization": true,
   "DocumentType":"IdRom"
}
Copy 
{  
   "CustomUI": "",
   "SourceEntityName": "FTOS_Test_Onfido",
   "UseProcessorForOCR":true,
   "UseProcessorForCheck":true,
   "DisableSaveBrowserDetails": false,
   "DisableLogSDKMessages": false,
   "LogLevel": "debug",
   "OnfidoCountry":"ROU",
   "OnfidoDocumentType": ["national_identity_card"],
   "UploadFallback":true,
   "FaceSimilarityType": "video",
   "EnterpriseFeatures": {
      "logoCobrand": {
          "darkLogoSrc": "https://www.freepnglogos.com/uploads/company-logo-png/company-logo-telestream-press-kit-12.png",
          "lightLogoSrc": "https://www.freepnglogos.com/uploads/company-logo-png/company-logo-telestream-press-kit-12.png"
      }
    },
    "ReportNames": ["document"],
   "DocumentHasTwoSides": true,
   "UseDefaultValues":true,
   "DefaultApplicantData":{
       "LastName": "DefaultLastName",
       "FirstName": "DefaultFirstName",
       "Email": "DefaultEmail@email.com"
   }, 
   "ApplicantData":{
       "LastName": {
           "AttributeName": "applicantId_lastName",
           "Extension": "applicantData"
       },
       "FirstName": {
           "AttributeName": "applicantId_firstName",
           "Extension": "applicantData"
       },
       "Email": {
           "AttributeName": "applicantId_email",
           "Extension": "applicantData"
       }
   },
   "WaitingForResponseTimeout":1,  
   "Entities":[  
      {  
         "DestinationEntityName":"FTOS_Test_Onfido_Applicant",
         "SourceEntityName":"FTOS_Test_Onfido",
         "SourceLookupDestinationName":"applicantId"
      },
      {  
         "DestinationEntityName":"FTOS_Test_Onfido_ApplicantAddress",
         "SourceEntityName":"FTOS_Test_Onfido",
         "SourceLookupDestinationName":"applicantAddress"
      }
   ],  
  
   "OptionSets":[  
      {  
         "OptionSetName":"Gender Type",
         "MappingName":"Sex",
         "OptionSetItems":{  
            "Male":"Male",
            "Female":"Female"
         }
      }
   ],
   "LookupEntities":[  
      {  
         "MappingName":"DistrictCode",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"BirthDistrictBody",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"IssuingCountry",
         "EntityName":"FTOS_CMB_Country",
         "AttributeKey":"code"
      },
      {  
         "MappingName":"City",
         "EntityName":"City",
         "AttributeKey":"Name",
         "Parent":{  
            "AttributeParentKey":"DistrictId",
            "MappingParentName":"DistrictCode"
         }
      }
   ],
    "maskNextStepURLSuccess":{  
      "entity":"FTOS_Test_Onfido",
      "form":"FTOS_Test_Onfido_FDF",
      "section":"Success"
    },
   "maskNextStepURLFail":{  
      "entity":"FTOS_Test_Onfido",
      "form":"FTOS_Test_Onfido_FDF",
      "section":"Fail"
   },
   "UseLocalization": true,
   "DocumentType":"IdRom"
}