{
"image": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOCIgaGVpZ2h0PSIxOCIgdmlld0JveD0iMCAwIDE4IDE4Ij48bWV0YWRhdGEgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj48ZGM6Y3JlYXRvcj5UaGluZyBJZGVudGl0eTwvZGM6Y3JlYXRvcj48ZGM6c291cmNlPmh0dHBzOi8vdGhpbmdpZGVudGl0eS5jb208L2RjOnNvdXJjZT48L21ldGFkYXRhPjxyZWN0IHdpZHRoPSIxOCIgaGVpZ2h0PSIxOCIgZmlsbD0iI0ZGRkZGRiIvPjxwYXRoIGZpbGw9IiMwMDAwMDAiIGQ9Ik0xLDFoMXYxaC0xek0zLDFoMXYxaC0xek01LDFoMXYxaC0xek03LDFoMXYxaC0xek05LDFoMXYxaC0xek0xMSwxaDF2MWgtMXpNMTMsMWgxdjFoLTF6TTE1LDFoMXYxaC0xek0xLDJoMnYxaC0yek01LDJoNHYxaC00ek0xMCwyaDJ2MWgtMnpNMTUsMmgydjFoLTJ6TTEsM2gxdjJoLTF6TTUsM2gxdjFoLTF6TTcsM2gydjJoLTJ6TTEyLDNoMXYxaC0xek0zLDRoMnYxaC0yek0xMCw0aDF2MWgtMXpNMTIsNGgydjFoLTJ6TTE2LDRoMXYxaC0xek0xLDVoM3YxaC0zek01LDVoMnYxaC0yek05LDVoMXYxaC0xek0xMiw1aDR2MWgtNHpNMSw2aDF2MmgtMXpNMyw2aDF2MmgtMXpNNiw2aDJ2MWgtMnpNOSw2aDJ2MWgtMnpNMTIsNmg1djFoLTV6TTYsN2gzdjFoLTN6TTExLDdoMXYxaC0xek0xNCw3aDF2MWgtMXpNMSw4aDR2MWgtNHpNNyw4aDV2MWgtNXpNMTYsOGgxdjFoLTF6TTEsOWgxdjFoLTF6TTksOWgxdjFoLTF6TTExLDloMXYxaC0xek0xMyw5aDN2MWgtM3pNMSwxMGgydjFoLTJ6TTYsMTBoMnYxaC0yek0xMCwxMGgxdjJoLTF6TTEzLDEwaDR2MWgtNHpNMSwxMWgxdjFoLTF6TTQsMTFoMXYxaC0xek04LDExaDF2MWgtMXpNMTQsMTFoMXYxaC0xek0xLDEyaDV2MWgtNXpNNywxMmgxdjFoLTF6TTksMTJoMXYxaC0xek0xMSwxMmgydjFoLTJ6TTE1LDEyaDJ2MWgtMnpNMSwxM2gydjFoLTJ6TTUsMTNoM3YxaC0zek05LDEzaDJ2MWgtMnpNMTQsMTNoMXYxaC0xek0xLDE0aDF2MWgtMXpNNCwxNGgzdjFoLTN6TTEwLDE0aDV2MWgtNXpNMTYsMTRoMXYxaC0xek0xLDE1aDJ2MWgtMnpNOCwxNWgydjFoLTJ6TTEyLDE1aDF2MWgtMXpNMTUsMTVoMXYxaC0xek0xLDE2aDE2djFoLTE2eiIvPjwvc3ZnPg=="
}{
"errors": [
{
"code": "Validation.Invalid.errorCorrectionLevel",
"path": "errorCorrectionLevel"
}
]
}Render 2D barcode
Render one validated code definition as SVG.
Set compression on each definition to EPC_BASE64 or EPC_HEX for a compressed Digital Link. Omit or send null for an uncompressed URI. Compression requires a GTIN and serial number.
{
"image": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOCIgaGVpZ2h0PSIxOCIgdmlld0JveD0iMCAwIDE4IDE4Ij48bWV0YWRhdGEgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj48ZGM6Y3JlYXRvcj5UaGluZyBJZGVudGl0eTwvZGM6Y3JlYXRvcj48ZGM6c291cmNlPmh0dHBzOi8vdGhpbmdpZGVudGl0eS5jb208L2RjOnNvdXJjZT48L21ldGFkYXRhPjxyZWN0IHdpZHRoPSIxOCIgaGVpZ2h0PSIxOCIgZmlsbD0iI0ZGRkZGRiIvPjxwYXRoIGZpbGw9IiMwMDAwMDAiIGQ9Ik0xLDFoMXYxaC0xek0zLDFoMXYxaC0xek01LDFoMXYxaC0xek03LDFoMXYxaC0xek05LDFoMXYxaC0xek0xMSwxaDF2MWgtMXpNMTMsMWgxdjFoLTF6TTE1LDFoMXYxaC0xek0xLDJoMnYxaC0yek01LDJoNHYxaC00ek0xMCwyaDJ2MWgtMnpNMTUsMmgydjFoLTJ6TTEsM2gxdjJoLTF6TTUsM2gxdjFoLTF6TTcsM2gydjJoLTJ6TTEyLDNoMXYxaC0xek0zLDRoMnYxaC0yek0xMCw0aDF2MWgtMXpNMTIsNGgydjFoLTJ6TTE2LDRoMXYxaC0xek0xLDVoM3YxaC0zek01LDVoMnYxaC0yek05LDVoMXYxaC0xek0xMiw1aDR2MWgtNHpNMSw2aDF2MmgtMXpNMyw2aDF2MmgtMXpNNiw2aDJ2MWgtMnpNOSw2aDJ2MWgtMnpNMTIsNmg1djFoLTV6TTYsN2gzdjFoLTN6TTExLDdoMXYxaC0xek0xNCw3aDF2MWgtMXpNMSw4aDR2MWgtNHpNNyw4aDV2MWgtNXpNMTYsOGgxdjFoLTF6TTEsOWgxdjFoLTF6TTksOWgxdjFoLTF6TTExLDloMXYxaC0xek0xMyw5aDN2MWgtM3pNMSwxMGgydjFoLTJ6TTYsMTBoMnYxaC0yek0xMCwxMGgxdjJoLTF6TTEzLDEwaDR2MWgtNHpNMSwxMWgxdjFoLTF6TTQsMTFoMXYxaC0xek04LDExaDF2MWgtMXpNMTQsMTFoMXYxaC0xek0xLDEyaDV2MWgtNXpNNywxMmgxdjFoLTF6TTksMTJoMXYxaC0xek0xMSwxMmgydjFoLTJ6TTE1LDEyaDJ2MWgtMnpNMSwxM2gydjFoLTJ6TTUsMTNoM3YxaC0zek05LDEzaDJ2MWgtMnpNMTQsMTNoMXYxaC0xek0xLDE0aDF2MWgtMXpNNCwxNGgzdjFoLTN6TTEwLDE0aDV2MWgtNXpNMTYsMTRoMXYxaC0xek0xLDE1aDJ2MWgtMnpNOCwxNWgydjFoLTJ6TTEyLDE1aDF2MWgtMXpNMTUsMTVoMXYxaC0xek0xLDE2aDE2djFoLTE2eiIvPjwvc3ZnPg=="
}{
"errors": [
{
"code": "Validation.Invalid.errorCorrectionLevel",
"path": "errorCorrectionLevel"
}
]
}POST /code applies.
This operation requires write:codes and does not save a generated-code record or a file.
Barcode modes
mode | Encoded data |
|---|---|
GS1_DATAMATRIX | GS1 element string with FNC1, Data Matrix ECC 200. |
DATAMATRIX_GS1_DIGITAL_LINK_URI | GS1 Digital Link URI in Data Matrix. Requires digitalLinkStem. |
GS1_QR | GS1 element string with FNC1 in QR Code. |
QR_GS1_DIGITAL_LINK_URI | GS1 Digital Link URI in QR Code. Requires digitalLinkStem. |
errorCorrectionLevel accepts L, M, Q or H.
Omitting it or sending null selects L. The requested level is used without automatic upgrading.
Data Matrix uses fixed ECC 200: omit errorCorrectionLevel or send null; any other value is rejected.
ais and extensionParameters may be omitted or null for empty lists.
linkType and context are optional. The image field contains the SVG encoded as Base64.
Compression
The optionalcompression field accepts EPC_BASE64 (ex) or EPC_HEX (eh).
Omit it or send null to render an uncompressed URI.
Compression is available in QR_GS1_DIGITAL_LINK_URI and DATAMATRIX_GS1_DIGITAL_LINK_URI modes.
It requires a GTIN, a serial number and digitalLinkStem, with the
same AI restrictions as generation.
{
"mode": "QR_GS1_DIGITAL_LINK_URI",
"errorCorrectionLevel": "L",
"digitalLinkStem": "https://thingidentity.com",
"primaryKey": { "key": "01", "value": "09528765123457" },
"ais": [{ "key": "21", "value": "123456789123" }],
"compression": "EPC_HEX"
}
image, a Base64-encoded SVG;
this image encoding is separate from the EPC encoding selected by compression.
Invalid compression returns 422 with Validation.Invalid.compression at path compression.
The GS1_QR and GS1_DATAMATRIX modes do not accept compression.
Download an SVG
curl --fail-with-body -X POST 'https://api.thingidentity.com/code/render' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/vnd.thingidentity.public.v1+json' \
-H 'Accept: application/vnd.thingidentity.public.v1+json' \
--data '{
"mode": "QR_GS1_DIGITAL_LINK_URI",
"digitalLinkStem": "https://gtin.at",
"primaryKey": { "key": "01", "value": "09521234543213" },
"ais": [{ "key": "10", "value": "LOT42" }]
}' \
| jq -r '.image' | base64 --decode > code.svg
200 OK with a JSON object containing image.
Example response body:
{
"image": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOCIgaGVpZ2h0PSIxOCIgdmlld0JveD0iMCAwIDE4IDE4Ij48bWV0YWRhdGEgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj48ZGM6Y3JlYXRvcj5UaGluZyBJZGVudGl0eTwvZGM6Y3JlYXRvcj48ZGM6c291cmNlPmh0dHBzOi8vdGhpbmdpZGVudGl0eS5jb208L2RjOnNvdXJjZT48L21ldGFkYXRhPjxyZWN0IHdpZHRoPSIxOCIgaGVpZ2h0PSIxOCIgZmlsbD0iI0ZGRkZGRiIvPjxwYXRoIGZpbGw9IiMwMDAwMDAiIGQ9Ik0xLDFoMXYxaC0xek0zLDFoMXYxaC0xek01LDFoMXYxaC0xek03LDFoMXYxaC0xek05LDFoMXYxaC0xek0xMSwxaDF2MWgtMXpNMTMsMWgxdjFoLTF6TTE1LDFoMXYxaC0xek0xLDJoMnYxaC0yek01LDJoNHYxaC00ek0xMCwyaDJ2MWgtMnpNMTUsMmgydjFoLTJ6TTEsM2gxdjJoLTF6TTUsM2gxdjFoLTF6TTcsM2gydjJoLTJ6TTEyLDNoMXYxaC0xek0zLDRoMnYxaC0yek0xMCw0aDF2MWgtMXpNMTIsNGgydjFoLTJ6TTE2LDRoMXYxaC0xek0xLDVoM3YxaC0zek01LDVoMnYxaC0yek05LDVoMXYxaC0xek0xMiw1aDR2MWgtNHpNMSw2aDF2MmgtMXpNMyw2aDF2MmgtMXpNNiw2aDJ2MWgtMnpNOSw2aDJ2MWgtMnpNMTIsNmg1djFoLTV6TTYsN2gzdjFoLTN6TTExLDdoMXYxaC0xek0xNCw3aDF2MWgtMXpNMSw4aDR2MWgtNHpNNyw4aDV2MWgtNXpNMTYsOGgxdjFoLTF6TTEsOWgxdjFoLTF6TTksOWgxdjFoLTF6TTExLDloMXYxaC0xek0xMyw5aDN2MWgtM3pNMSwxMGgydjFoLTJ6TTYsMTBoMnYxaC0yek0xMCwxMGgxdjJoLTF6TTEzLDEwaDR2MWgtNHpNMSwxMWgxdjFoLTF6TTQsMTFoMXYxaC0xek04LDExaDF2MWgtMXpNMTQsMTFoMXYxaC0xek0xLDEyaDV2MWgtNXpNNywxMmgxdjFoLTF6TTksMTJoMXYxaC0xek0xMSwxMmgydjFoLTJ6TTE1LDEyaDJ2MWgtMnpNMSwxM2gydjFoLTJ6TTUsMTNoM3YxaC0zek05LDEzaDJ2MWgtMnpNMTQsMTNoMXYxaC0xek0xLDE0aDF2MWgtMXpNNCwxNGgzdjFoLTN6TTEwLDE0aDV2MWgtNXpNMTYsMTRoMXYxaC0xek0xLDE1aDJ2MWgtMnpNOCwxNWgydjFoLTJ6TTEyLDE1aDF2MWgtMXpNMTUsMTVoMXYxaC0xek0xLDE2aDE2djFoLTE2eiIvPjwvc3ZnPg=="
}
422 with an errors array.Authorizations
The access_token from POST /oauth/token.
Body
Barcode type. Digital Link modes require digitalLinkStem.
GS1_DATAMATRIX, DATAMATRIX_GS1_DIGITAL_LINK_URI, GS1_QR, QR_GS1_DIGITAL_LINK_URI "QR_GS1_DIGITAL_LINK_URI"
The identifying application identifier. With a digitalLinkStem it must be a GS1 Digital Link primary key in the GS1 Barcode Syntax Dictionary; without one, 03 is additionally accepted, the identifier for made-to-order trade items.
GTIN (01) accepts 8, 12, 13 or 14 digits, verifies the mod-10 check digit and normalises the value to 14 digits, so the value you get back may be longer than the one you sent.
Hide child attributes
Hide child attributes
GS1 application identifier. Browse the official GS1 Application Identifiers directory for meanings, value formats, required associations and Digital Link usage. The API validates identifiers against its bundled GS1 Barcode Syntax Dictionary; not every AI is valid as a primary key or in every combination.
"01"
"09521234543213"
QR only: L, M, Q or H. Omitted or null selects L for QR. For Data Matrix omit or send null.
L, M, Q, H, null Further application identifiers. Pass [] for none.
Each key must exist in the GS1 Barcode Syntax Dictionary and its value must match the format that dictionary declares. An AI may not repeat the primary key, keys may not repeat each other, and GS1 "requires" and "excludes" relations between AIs are enforced.
With a digitalLinkStem every AI must be either a path qualifier of the chosen primary key, taken from a single consistent qualifier sequence, or a data attribute that GS1 Digital Link URI Syntax allows in the query string. Qualifiers keep the order GS1 defines, not the order you send.
Temperature AIs (4330 to 4333) are normalised for you: the magnitude is padded to six digits and a negative value keeps its trailing minus.
When compression is selected, the EPC path carries these AIs instead of separate path and query fields.
Hide child attributes
Hide child attributes
GS1 application identifier. Browse the official GS1 Application Identifiers directory for meanings, value formats, required associations and Digital Link usage. The API validates identifiers against its bundled GS1 Barcode Syntax Dictionary; not every AI is valid as a primary key or in every combination.
"01"
"09521234543213"
Optional custom query parameters appended to a GS1 Digital Link URI. Omit, send null or pass [] for none.
Only with a digitalLinkStem; a non-empty list without one is rejected. Keys must not be linkType or context, must contain at least one non-digit, must be unique, and both keys and values are limited to unreserved ASCII and URI punctuation.
The origin a GS1 Digital Link path is appended to. Supplying it is what makes this a GS1 Digital Link: send a stem and you get a URI, leave it out and you get a GS1 element string. Must be http or https with a host, and carry no userinfo, query or fragment. A single trailing slash is stripped; empty path segments are rejected.
"https://gtin.at"
The GS1 link type the URI resolves to. Only with a digitalLinkStem. A gs1: value must be one the generator offers from the GS1 Web Vocabulary page types; gs1:defaultPage, gs1:defaultPageMulti and gs1:handledBy are not selectable. Any other value must be an absolute http or https URI.
"gs1:pip"
Value for the GS1 Digital Link context query parameter. Only with a digitalLinkStem, same character rules as extension parameter values.
"dpp"
Optional EPC compression of a GS1 Digital Link URI. EPC_BASE64 encodes the EPC binary in URL-safe Base64 (an ex path); EPC_HEX uses hexadecimal (an eh path). Omit or send null for an uncompressed URI.
Requires primary key 01 (GTIN), AI 21 (serial number), and digitalLinkStem. AIs 03, 717, 8014 and 8040–8043 cannot be stored in EPC binary, so a code that contains any of them cannot be compressed. The EPC path carries the AIs; extensionParameters, linkType, and context remain query parameters. Human-readable interpretation (hri) is unchanged.
An unknown or inapplicable value produces Validation.Invalid.compression: HTTP 422 for a single code, or a per-item error in the batch HTTP 200 response.
Only available for QR_GS1_DIGITAL_LINK_URI and DATAMATRIX_GS1_DIGITAL_LINK_URI; not for GS1 element-string modes.
EPC_BASE64, EPC_HEX, null "EPC_BASE64"
"EPC_HEX"
Response
Base64-encoded SVG in the image field.
Base64-encoded SVG document (UTF-8).