Developer Central Guide | Virifi Help Center

What is a REST API, anyway?

API is short for 'Application Programming Interface' . An API is a set of rules that lets programs talk to each other, exposing data and functionality across the Internet in a consistent format.

REST stands for 'Representational State Transfer'. This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term 'REST API', they are generally referring to an API accessed using the HTTP protocol at a predefined set of URLs.

These URLs represent various resources — any information or content accessed at that location, which can be returned as JSON, HTML, audio files, or images. Often resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT, and DELETE. The action represented by the first and last of these is clear, but POST and PUT have specific meanings. How they are defined is confusing, but the general rule is: use POST to create resources, and PUT to update resources.

Working with Virifi's APIs

What you'll need

All the APIs uses Authorization header key. You can generate an API Key under Settings > Developer Central > Create API Key.

This API key is linked to the account you used to generate it. This means that all credit transactions completed via API will be reflected in the credit history under the credits section.

Note: Document signing is an asynchronous process. To receive real-time signing status updates, configure a webhook.
Learn more in the Webhooks for Signing guide.

Let's get started

Base URL - https://virifi.io/api/developer

1. Ping

Method	GET
Endpoint	/ping
Description	This API is used to see if your integration is working properly.
Request headers	"Authorization": "Bearer API-KEY"
Request Body	No params
Successful Response	200 OK No Content
Possible Error Responses	400 API key not found 400 API Key is deactivated by owner user 400 No user found 400 Your organization is blocked by Virifi.io 400 Jwt Malformed

2. Add Member

Method	POST
Endpoint	/add-member
Description	This API is used to add a member. Member will be registered as Third Party User with limited access to the platform. Member need to follow the invite link sent over the mail and proceed with next step to complete KYB verification and generate API keys.
Request headers	"ContentType": "application/json" "Authorization": "Bearer API-KEY"
Request Body	"firstName": string, "lastName": string, "email": string
Successful Responses	200 OK Invitation email sent on the requested email.
Possible Error Responses	401 Missing Parameters 401 Low Credit Balance 401 Invitation Already Sent 401 Only Business email 401 User Already Exists

3. Certify Document

Method	`POST`
Endpoint	/certify-document
Description	This API is used to certify document/s. At any given time, the maximum number of documents allowed is five.
Request headers	"ContentType": "multipart/form-data" "Authorization": "Bearer API-KEY"
Request Body	"folderName": string, "digitalTwin": Boolean, "totalDoc": string, "doc0": Blob, "doc1": Blob
Successful Response	200 OK, Certified PDF document to type Array Buffer.
Possible Error Responses	400 No file Upload 401 Missing Parameters 401 Low Credit Balance 401 Only 5 Documents

4. Sign Document

Method	`POST`
Endpoint	/sign-document
Description	This API is used to sign documents. The account owner's email address should be listed as the first entry in `signUser` key for "Sign By Yourself" and "Sign and Invite Others" options. In AES, account owner's contact number should be configured on the Virifi Platform under Profile section.
Request headers	"ContentType": "multipart/form-data" "Authorization": "Bearer API-KEY"
Request Body	Advance Electronic Signature (AES) "fileName": string, "digitalTwin": Boolean, "doc": Blob, "signBy": string 1. signByYouself 2. signAndInviteOthers 3. signOther "signUser": Array < Array >, "email": string "number": string "groupId": number "signatureType": "AES", "webhookUrl": "https://webhook.site/*****", "breakSigningChain": boolean, "isSequence": boolean, "sendEmailToAllUsers": boolean Professional Electronic Signature (PES) "fileName": string, "digitalTwin": Boolean, "doc": Blob, "signBy": string 1. signByYouself 2. signAndInviteOthers 3. signOther "signUser": Array < Array >, "email": string "groupId": number "signatureType": "PES", "webhookUrl": "https://webhook.site/*****", "breakSigningChain": boolean, "isSequence": boolean, "sendEmailToAllUsers": boolean
Successful Responses	200 OK Signed PDF Array Buffer (Sign By Yourself). E-KYB URL (For PES Type, Sign By Yourself and Sign and Invite Others). PDF Sign successful message and email will be sent to others for their signatures. Mail sent to others for their signatures message (Request Others Signature).
Possible Error Responses	400 No file Upload 401 Missing Parameters 401 Low Credit Balance 401 Number is not verified

5. Verify Document

Method	POST
Endpoint	/verify-document
Description	This API is used to verify the a certified or signed document.
Request headers	"ContentType": "application/json" "Authorization": "API-KEY"
Request Body	Blob (PDF)
Successful Response	Certified Document 200 OK, Verification Successful: “success” Document Hash: “data_hash” Document ID: “_id” Organization ID: "organizationId" Revocation Status:”revoke" Digital Twin Availability: "digitalTwin" Organization Name: ”name" Organization Verification Status: ”verified" Signed Document 200 OK, Verification Successful: “success” Document Hash: “data_hash” Document ID: “_id” Organization ID: "organizationId" Revocation Status:”revoke" Digital Twin Availability: "digitalTwin" Organization Name: ”name" Organization Verification Status: ”verified” Signature Type (AES/PES): “signatureType”
Possible Error Responses	400 'No file upload' 404 'PDF not found in database' 404 'This PDF not belong to this organization' 404 'PDF found in database but not found in blockchain'

6. Revoke Certified Document

Method	POST
Endpoint	/revoke-document
Description	This API is used to revoke a certified document.
Request headers	"ContentType": "application/json" "Authorization": "API-KEY"
Request Body	{ docId: string }
Successful Response	200 OK, Revocation Successful: "message" Document Hash: “data_hash” Document ID: “_id” Organization ID: "organizationId" Revocation Status:”revoke" Digital Twin Availability: "digitalTwin"
Possible Error Responses	401, 'Doc not Exist!!' 401, 'Document is not a certificate'

Download Postman Collection

Virifi Developer API.postman_collection.json