Skip to main content

Developer Tool overview

This developer tool provides a platform for companies who are looking to transform their existing technology with an added layer of security provided by VeriDoc Global’s APIs.

How to integrate

Follow the steps below for easy integration:

  • Register an account by clicking the register link Register
  • Get your API key and Secret Key
  • Explore the API Documents and sample code
  • Integrate with VeriDoc Global server and make a call
  • And most importantly, please don’t forget to ask if you get stuck

VeriDoc Global provides a simple and effective platform to secure documents and items for verification and authentication purposes. This is done using our verification protocol which uses blockchain technology.

In the Developer Tool, each user account is assigned a secret API Key which they can use to integrate with VeriDoc Global’s verification platform. VeriDoc Global Developer Tool provides a TestNet (sandbox) environment for clients to utilize our APIs to secure documents and data on the blockchain.

Important Links

List of all APIs

See also the release notes and response codes.

Integration Types

1. Integration Type 1

The verification results page is hosted on the VeriDoc Global domain.

After successfully verifying the document authenticity (via the verification gateway on VeriDoc Global’s domain), a user is directed to a verification results page on the VeriDoc Global domain where the document and details are available for a final visual comparison check.

2. Integration Type 2

The verification results page is hosted on the client's domain.

After successfully verifying the document authenticity (via the verification gateway on VeriDoc Global’s domain), a user is redirected to the client's domain where the document and details are available for final visual comparison check.

Need help in deciding which integration type is best for you or the APIs you will need to get started with? Check out some of the most frequently developed use cases by visiting the link:

Workflow Models for Industry Use Cases

Document Storage For Your Files

The original document is stored on the client’s server. VeriDoc Global does not store the client’s private information and does not offer document storage services.

Whenever a user scans a QR code on any document secured by VeriDoc Global, the original document is retrieved from the client’s server, converted into a hash, and compared to the hash on VeriDoc Global’s database and on the blockchain. This is referred to as the three-step hash verification. If the hash values all match up, a document preview is shown on the verification results page.

VeriDoc Global requires permanent access to the document stored on the client’s server to do the three-step hash verification. It is also required for previewing the original document for a final visual comparison check.

If a client does not have a dedicated server for file storage and would like to test Developer Tool APIs manually using the Postman collection, they can use Google Drive to store their documents.

To do so, follow the following steps:

1. Upload your document PDF to your google drive after you have placed a VeriDoc secured QR code on the file.

2. Right click on the file to see a list of options.

3. Select "Get Link" option.

4. Change the view permission to "Anyone with the link" as "Viewer".

5. Click "Copy Link".

6. Extract the unique ID from the link to create file url in the following format: https://drive.google.com/open?id=UNIQUEIDGOESHERE

Send the URL in the format shown in Step 6 as the fileurl parameter of the Submit Document API body. Example:

If the file url copied from Google drive is: https://drive.google.com/file/d/1E2X78s6vI2lYWyy1Vu7onFfr0jYb6t0H/view?usp=sharing

The file url format should be https://drive.google.com/open?id=1E2X78s6vI2lYWyy1Vu7onFfr0jYb6t0H

Please note that the above steps are for manually storing a document in Google Drive to test Developer Tool APIs using Postman Collection.

For sensitive documents and to automate workflow VeriDoc Global recommends using a dedicated cloud file storage service such as Amazon Simple Storage Service (Amazon S3). You can set up a free account here: https://aws.amazon.com/s3/?p=ft&c=st&z=3

Moving from Test to Live Environment

After successfully integrating with the Developer Tool using one of the above integration types, clients can request integration with VeriDoc Global’s MainNet environment.

To move from TestNet environment to the MainNet multichain environment, commercials will need to be discussed to enable a mainnet connection and a wallet for you to track and manage your blockchain transaction expenditure.

From that point onwards you will be able to fund your wallet to start securing documents on the blockchain using VeriDoc Global’s APIs.

Switching between Test and Live Environment

Your mainnet (live) API and Secret keys are different to Testnet (sandbox) keys. After receiving your Mainnet keys you can change between Testnet and mainnet development environments at any time by changing API and secret keys in your API request headers. This allows for ease of switching between sandbox and live environments for testing existing and/or new APIs.

Download Ready To Use Postman Collection

Postman is a software development tool. It enables people to test calls to APIs. Download the Postman App using the steps mentioned below and send your first VeriDoc API request in minutes by following the steps given below: