The ZipID API is a RESTful API for partners and businesses to automate the creation of Verification of Identity (VOI) orders and retrieval of VOI reports.
Our API has been designed first and foremost to be simple for partners to integrate with. Subsequent iterations will include more features and flexibility as we get feedback. The key features of our API are highlighted below and for more details please read our API docs.
Creating an order
Partner system posts order request to ZipID including details of person(s) to be verified
ZipID returns a unique booking form URL and order ID
Business user (or person to be verified) completes minimal booking form to choose appointment date, time and which identity documents will be presented
For a more visual overview of this process you can view our API overview diagram (PDF).
Getting status of an order and retrieving report
Partner system sends get request for order ID
ZipID return order status, and if complete, a report URL for accessing the report
Downloading a report
VOI report owners can receive reports by- Browser download
Partner system directs business user to report URL where user enters their ZipID credentialsReport is downloaded in the browser
- Seamless delivery by the partner system ^
Partner system sends POST request with a report access token
Report is downloaded by the Partner system, PDF is saved and stored ready for the user when needed
^ Seamless delivery by partner system
Provides API Access by the VOI report owner only. Available for on premises deployments and require a ZipID API Access Token for their account only.To begin using the ZipID API:
- Request access by emailing us at dev@zipid.com.au
- Read the API docs
- Generate a test authentication token
- View and try out our API example
- Design and build your integration
- Generate a live authentication token