Skip to main content
POST
Resolve a scanned payload

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Body

application/json
payload
string
required

Exact opaque value read by the scanner, limited to 4096 UTF-8 bytes and permitting the GS1 group separator

Maximum string length: 4096
alternate_payloads
string[]

Exact alternate representations reported for the same physical label; each is limited to 4096 UTF-8 bytes and permits the GS1 group separator

Required array length: 1 - 3 elements
Maximum string length: 4096
symbology
enum<string>
Available options:
aztec,
ean13,
ean8,
qr,
pdf417,
upc_e,
datamatrix,
code39,
code93,
itf14,
codabar,
code128,
upc_a

Response

Resolution result

data
object
required
meta
object
required