Skip to main content
POST
Scope: scans:verify. For Private Codes, which only Satyakod reads. Send frames from the camera preview, a few per second, until one comes back with found: true. The body is multipart/form-data.
file
required
A JPEG, PNG or WebP image up to 2 MB. Around 1280 px on the long side reads well.
string
default:"true"
false records the scan. Leave it true for checks that shouldn’t count, such as testing a label.
boolean
required
Whether a code was read in the frame. When false, send the next frame.
string
When found: genuine, suspicious or counterfeit. A code issued by another workspace is reported as counterfeit with the reason “Not a code this workspace issued”.
string
object[]
string
string