Digital IDs
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 ~ 5the file size should not be greater than 128 kb document{i} formatstring 32 optional document format- allowed value pdf, jpeg, png document{i} statusstring 16 optional status of the dataallowed value unchanged issuedatelong 13 required issue date epoch timestamp in milliseconds birthdatestring 16 optional date of birth genderstring 16 optional gender of card holders classificationstring 16 optional classified identity type expirylong 13 optional expiry date in timestamp format issued data is cleaned up after it expires epoch timestamp in milliseconds contactsstring 32 optional personal contact information such as phone number logoimagestring 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 namei e , partnering institute issuername string 32 optional place of issue or issuing authority name extrainfo string 512 optional additional informationi 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’ applinklogostring 256 optional app link image url the file size should not exceed 256 kb applinknamestring 32 optional app link name applinkdatastring 256 optional information about the partner app link locationsstring 1024 optional list of locations where the card can be used* see location format coverimagestring 256 optional card cover image urlthe file size should not exceed 512 kb the recommended size for image resources is 888 x 555 px bgimagestring 256 optional card background image urlthe file size should not exceed 512 kb the recommended size for image resources is 888 x 555 px bgcolorstring 8 optional color of the card art support hex color code e g , #015aaa fontcolorstring 8 optional color of the font on the card art allowed value black, white blinkcolorstring 8 optional color of the blinking effect in the indicator area support hex color code e g , #015aaa preventcaptureynstring 1 optional flag whether this wallet card view prevents screen capture either 'y' or 'n' * default 'n' barcode valuestring 4096 optional actual data that is delivered when the barcode/qr code is scanned barcode serialtypestring 32 optional presentation type e g , serialnumber, barcode, * see barcode format barcode ptformatstring 32 optional presentation format e g , barcode, qrcode, serial, * see barcode format barcode ptsubformatstring 32 optional presentation sub-format e g , code_128, qr_code, * see barcode format barcode errorcorrectionlevelstring 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 intervalstring 4 optional update interval if support for dynamic updates epoch timestamp in milliseconds authenticationstring 64 optional authentication data which meets choose options * see authentication for details provision datastring 512 optional elements to complete provisioning* see provisioning for details provision intervalstring 16 optional update interval if support for dynamic updatesepoch timestamp in milliseconds example { "card" { "type" "idcard", "subtype" "employees", "data" [ { "refid" "identitycard-bpo1r3e5-3313-0991-z404-sq12994414u8", "createdat" 1658385817000, "updatedat" 1658385817000, "language" "en", "attributes" { "title" "employee id card", "holdername" "kim samsung", "secondholdername" " samsung ", "organization" "digital wallet, mx", "position" "professional", "identifier" "2306070003", "idphoto" "{base64 encoded image data}", "idphoto format" "jpeg", "document1" "{base64 encoded pdf data}", "document1 format" "pdf", "document2" "{base64 encoded pdf data}", "document2 format" "pdf", "issuedate" "1658385817000", "expiry" "1765855665000", "logoimage" "https // /logo png", "providername" "samsung electronics", "extrainfo" "{\"count\" 1,\"info\" [{\"title\" \"shortcode\",\"content\" [\"404457\"]}]}", "noticedesc" "{\"count\" 2,\"info\" [{\"title\" \"notice1\",\"content\" [\"description1\",\"description2\"]},{\"title\" \"notice2\",\"content\" [\"description1\",\"description2\"]}]}", "csinfo" "{\"call\" \"555 123-4567\", \"email\" \"cs@email com\", \"website\" \"https //homepage com/cs\"}", "applinkname" "samsung electronics", "applinklogo" "https // /applinklogo png", "applinkdata" "https //www applinkorweblink com", "coverimage" "https // /card/cover png", "bgimage" "https // /card/background png", "fontcolor" "dark", "barcode value" "5728306720836720763017601", "barcode serialtype" "qrcode", "barcode ptformat" "qrcode", "barcode ptsubformat" "qr_code", "barcode interval" "300000", "authentication" "samsung@samsung com", "provision data" "{\"appkey\" \"abcdefaei;fadaf=\",\"telno\" \"01012345678\",\"provider\" \"sec\",\"id\" \"0000000000000000\",\"authkey\" \"a3b7fgj0ea\"}" }, "localization" [ { "language" "ko", "attributes" { "title" "사원증", "holdername" "김삼성", "secondholdername" "kim samsung", "providername" "삼성전자" } } ] } ] } }