Verify (1.0.0)

Download OpenAPI specification:Download

A collection of endpoints to decode the official New Zealand covid-19 passport.
This API offers processing of PDF, Image and Decoded QR data.

General

Verifying PDF

To verify a passport in the form of a PDF.
The passport must be on the first page of the document, other pages are ignored.
Due to hosting limitations, maximum file size is 5mb.

header Parameters
Content-Type
string
Example: application/pdf
Request Body schema: form-data
file_name
string <binary>

Responses

Verifying Image

Use when you want to validate a image which contains a QR code of the covid passport.
Supported file types: jpeg, png, bmp, tiff, gif.
Due to hosting limitations, maximum file size is 5mb.

header Parameters
Content-Type
string
Example: image/png
Request Body schema: multipart/form-data
file_name
string <binary>

Responses

Verifying QR data

Use when you already have the contents of the QR code

header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json