Digital IDs

'Digital ID' cards are used to present identification for employees, students, drivers, guests, etc.

Wallet Card type

Wallet card type

 Wallet card subtype
idcard

 employees, nationals, students, drivers, guests, others

Employees

Figure 1: Sample UI: Digital IDs - Employees

Nationals

Figure 2: Sample UI: Digital IDs - Nationals

Students

Figure 3: Sample UI: Digital IDs - Students

Drivers

Figure 4: Sample UI: Digital IDs - Drivers

Wallet Card data fields

Attributes

Type

 Value

 Description
Payload object

 cardTemplate
Object

 (Required)
Wallet card template object
cardTemplate.prtnrId
String(32)

 (Required)
Partner ID
cardTemplate.templateRefId
String(19)

 (Required)
Partner Template ID
cardTemplate.title
String(32)

 (Required)
Wallet Card Name
cardTemplate.countryCode
String(2)

 (Conditional)
The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType
String(100)

 (Conditional)
This value is set to “idcard”.
* Required when creating a template.
cardTemplate.subType
String(100)

 (Conditional)
Select from these values: employees, nationals, drivers, and others.
* Required when creating a template.
cardTemplate.saveInServerYn
String(2)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.prtnrAppPckgName
String(128)

 (Optional)
The Application Package Name.
cardTemplate.appLogoImg
String(200)

 (Optional)
The banner logo image URL.
cardTemplate.noNetworkSupportYn
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn
String(1)

 (Optional)
This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state
String(15)

 (Optional)
Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff
String(1)

 (Optional)
TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc
String(500)

 (Optional)
Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551317",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "idcard",
    "subType": "employees",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "saveInServerYn": "Y",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "Y",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}