| attributes.{fields}
|
title
String (32)
|
(Required)
Main title of cards
e.g., Commercial Access, Employee badge
|
holderName
String (64)
|
(Required)
Name of card holders
|
secondHolderName
String (64)
|
(Optional)
Second Name of card holders
|
organization
String (64)
|
(Optional)
Organization of card holders belonging
i.e., name of department, division, affiliation, association or team, Name of college or school
|
position
String (64)
|
(Optional)
Position of card holders
e.g., Engineer, 5th grade
|
identifier
String (64)
|
(Required)
Unique ID value
i.e., Unique card number assigned to the card holder
e.g., S 123 456 789 012 X
|
idNumber
String(64)
|
(Optional)
Representative value for an ID
i.e., ID number, Document number, Card/Roll number assigned by the Institution or College
e.g., B19MBA115
|
idStatus
String(64)
|
(Optional)
Card holder's status
Ex. Full time student, Graduate, Exchange, Post-graduate, Under-graduate.
|
address
String(256)
|
(Optional)
Address of card holders
|
placeOfLocation
String (64)
|
(Optional)
Place of location associated with the cardholder
|
idPhoto
String(128k)
|
(Optional)
Holder’s photo image data encoded Base64
The file size should not be greater than 128 kB
|
idPhoto.format
String (32)
|
(Optional)
Image file format
e.g., jpeg, png
* Unsupported image formats may exist
|
idPhoto.status
String (16)
|
(Optional)
Status of the data
Allowed value: UNCHANGED
|
document
String(1024k)
|
(Optional)
First document of identity
|
document.format
String (32)
|
(Optional)
Document format
- Allowed value: pdf, jpeg, png
|
document.status
String (16)
|
(Optional)
Status of the data
Allowed value: UNCHANGED
|
issueDate
Long(13)
|
(Required)
Issue date
Epoch timestamp in milliseconds
|
birthdate
String(16)
|
(Optional)
Date of birth
|
gender
String (16)
|
(Optional)
Gender of card holders
|
classification
String(16)
|
(Optional)
Classified identity type
|
expiry
Long(13)
|
(Optional)
Expiry date in timestamp format Issued data is cleaned up after it expires
Epoch timestamp in milliseconds
|
contacts
String(32)
|
(Optional)
Personal contact information such as phone number
|
logoImage
String(256)
|
(Optional)
Logo image URL to be displayed in card item
The file size should not exceed 256 kB
|
logoImage.darkUrl
String (256)
|
(Optional)
Logo image URL in dark mode
The file size should not exceed 256 kB
* If this value does not exist, logoImage will be substituted
|
logoImage.lightUrl
String(256)
|
(Optional)
Logo image URL in light mode
The file size should not exceed 256 kB
* If this value does not exist, logoImage will be substituted
|
logoText
String (16)
|
(Optional)
Text as an alternative to logoImage
|
providerName
String(32)
|
(Required)
Content provider name
i.e., Partnering institute
|
issuerName
String(32)
|
(Optional)
Place of issue or Issuing authority name
|
extraInfo
String (512)
|
(Optional)
Additional information
i.e., bloodGroup, guardianName, govRefID
* See Additional Information format
|
noticeDesc
String (5000)
|
(Optional)
Text of the notice
* Long content is allowed
* See Additional Information format
|
csInfo
String (512)
|
(Required)
Providers’ customer service Information
Using data in JSON format converted to escape string
* Allowed items: call, email, or website
* See the example below.
|
privacyModeYn
String(1)
|
(Optional)
Whether or not to require user
authentication when using the card Either ‘Y’ or ‘N’
* Default: ‘N’
|
appLinkLogo
String(256)
|
(Optional)
App link image URL
The file size should not exceed 256 kB
|
appLinkName
String(32)
|
(Optional)
App link name
|
appLinkData
String(256)
|
(Optional)
Information about the partner app link
|
locations
String(1024)
|
(Optional)
List of locations where the card can be used
* See Location format
|
coverImage
String(256)
|
(Optional)
Card cover image URL
The file size should not exceed 512 kB
The recommended size for image resources is 888 x 555 px
|
bgImage
String(256)
|
(Optional)
Card background image URL
The file size should not exceed 512 kB
The recommended size for image resources is 888 x 555 px
|
bgColor
String(8)
|
(Optional)
Color of the card art Support Hex color code
e.g., #015AAA
|
fontColor
String(8)
|
(Optional)
Color of the font on the card art
Allowed value: black, white
|
blinkColor
String(8)
|
(Optional)
Color of the blinking effect in the Indicator area
Support Hex color code
e.g., #015AAA
|
preventCaptureYn
String(1)
|
(Optional)
Flag whether this wallet card view prevents screen capture
Either 'Y' or 'N'
* Default: 'N'
|
barcode.value
String(4096)
|
(Optional)
Actual data that is delivered when the barcode/QR code is scanned.
|
barcode.serialType
String(32)
|
(Optional)
Presentation Type
e.g., SERIALNUMBER, BARCODE, ...
* See Barcode format
|
barcode.ptFormat
String(32)
|
(Optional)
Presentation Format
e.g., BARCODE, QRCODE, SERIAL, ...
* See Barcode format
|
barcode.ptSubFormat
String(32)
|
(Optional)
Presentation Sub-format
e.g., CODE_128, QR_CODE, ...
* See Barcode format
|
barcode.errorCorrectionLevel
String(4)
|
(Optional)
Amount of redundancy or error correction data included in the code.
There are four error correction levels available in QR codes.
- Code options: L/M/Q/H
* Default: L
|
barcode.Interval
String(4)
|
(Optional)
Update interval if support for dynamic updates
Epoch timestamp in milliseconds.
|
authentication
String(64)
|
(Optional)
Authentication data which meets choose options.
* See Authentication for details
|
provision.data
String(512)
|
(Optional)
Elements to complete provisioning
* See Provisioning for details
|
provision.interval
String(16)
|
(Optional)
Update interval if support for dynamic updates
Epoch timestamp in milliseconds
|
