| attributes.{fields}
|
title
String(32)
|
(Required)
Main title of cards.
e.g., Commercial Access, Employee badge.
|
holderName
String(64)
|
(Required)
Name of the cardholder.
|
secondHolderName
String(64)
|
(Optional)
Second Name of the cardholder.
|
organization
String(64)
|
(Optional)
Organisation to which the cardholder belongs.
i.e., name of department, division, affiliation, association or team, Name of college or school.
|
position
String(64)
|
(Optional)
Position of the cardholder.
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
|
address
String(256)
|
(Optional)
Address of the cardholder.
|
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
(Deprecated)
String(1024k)
|
(Optional)
First document of identity.
|
document.format
(Deprecated)
String(32)
|
(Optional)
Document format.
Allowed value: pdf, jpeg, png.
|
document.status
(Deprecated)
String(16)
|
(Optional)
Status of the data.
Allowed value: UNCHANGED
|
document{i}
String(1024k)
|
(Optional)
Document of identity.
This can be images of ID cards or cardholder's photos on an enlarged screen. Image data encoded Base64.
In case the card has multiple documents, they can have an index.
i: 1 ~ 5
The file size should not be greater than 128 kB.
|
document{i}.format
String(32)
|
(Optional)
Document format
Allowed value: pdf, jpeg, png
|
document{i}.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 the cardholder.
|
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 on the card item.
The file size should not exceed 256 kB.
|
logoImage.darkUrl
String(256)
|
(Optional)
Logo image URL in dark mode.
This is a flat key name, not a nested object path.
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.
This is a flat key name, not a nested object path.
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
|
noticeDesc
String(5000)
|
(Optional)
Text of the notice.
* Long content is allowed.
* See Additional information
|
csInfo
String(4096)
|
(Required)
Provider customer service information.
Provide the value as an escaped JSON string.
* Allowed items: call, email, or website.
* See the example below.
|
privacyModeYn
String(1)
|
(Optional)
Whether user authentication is required 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 Locations
|
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)
Colour of the card art. Supports hexadecimal colour codes.
e.g., #015AAA
|
fontColor
String(8)
|
(Optional)
Colour of the text on the card art.
Allowed values: black, white
|
blinkColor
String(8)
|
(Optional)
Colour of the blinking effect in the indicator area.
Supports hexadecimal colour codes.
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 & QR Code Presentation
|
barcode.ptFormat
String(32)
|
(Optional)
Presentation Format.
e.g., BARCODE, QRCODE, SERIAL, ...
* See Barcode & QR Code Presentation
|
barcode.ptSubFormat
String(32)
|
(Optional)
Presentation Sub-format.
e.g., CODE_128, QR_CODE, ...
* See Barcode & QR Code Presentation
|
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(11)
|
(Conditional)
Refresh interval for dynamic barcode updates, in milliseconds.
* Required when barcode.generationType is INTERVAL.
|
authentication
String(64)
|
(Optional)
Authentication data that satisfies the selected authentication method.
* See Authentication Data Set (Secure Add to Wallet)
|
provision.data
String(512)
|
(Optional)
Elements to complete provisioning.
* Refer to Access Integration Guide. Samsung approval required. Contact Technical Support.
|
provision.interval
String(16)
|
(Optional)
Update interval for dynamic provisioning, in milliseconds.
* Refer to Access Integration Guide. Samsung approval required. Contact Technical Support.
|
