Create Next App

Introduction

Discover how to seamlessly integrate our APIs into your application for optimal performance.

API BASICS

The Vibrianet API provides seamless integration with our services, enabling you to incorporate them effortlessly into your platform or product. It is designed to adhere to best practices and is structured around core resources for efficient interaction.

HTTP Methods
POST Function	Creates a new resource. Used for adding new data to the server.
GET Function	Retrieves existing resources or data from the server.
PUT Function	Updates an existing resource with new data. Typically used to replace the entire resource.
DELETE Function	Deletes an existing resource from the server.

HTTP Codes
200	Request was successful and intended action was carried out. Note that we will always send a 200 if a charge or verify request was made. Do check the data object to know how the charge went (i.e. successful or failed).
201	A resource has successfully been created.
400	A validation or client side error occurred and the request was not fulfilled.
401	The request was not authorized. This can be triggered by passing an invalid secret key in the authorization header or the lack of one.
404	Request could not be fulfilled as the request resource does not exist.
5xx	Request could not be fulfilled due to an error on Zverify end. This shouldn't happen so please report as soon as you encounter any instance of this

Request and Response

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

Keys
Success boolean	Indicates if your request was successful. Use this in combination with HTTP status codes for a full picture of the API call result.
Message string	A brief summary of the response and its status.
Data T (generic)	Contains the results of your request, which may be an object, array, or any type depending on the request.
Code string	Code represent the status of your request

Response Format

{
    "data": {
              "userId": "String",
              "name": "String",
              "email": "String,
              "avatarUrl": "String"
              "emailVerified": "Boolean"
            },
    "success": "Boolean",
    "message": "String",
    "code": "String",
}