ChainIT Overview

Introduction

Welcome to the ChainIT SDK documentation. This guide helps you understand how to use ChainIT APIs to build secure and reliable integrations.

With ChainIT SDKs, you can verify individuals and businesses, collect information through forms, and manage products in one platform. The APIs are organized by product lines and versions, making it easy to find what you need and get started quickly.

Product Lines

ChainIT APIs are organized by product lines and capabilities. Each product line represents a distinct business workflow and exposes a dedicated set of APIs.

Hosted UI

White-label onboarding under your brand — see the journey, how it helps, features.

KYC (Know Your Customer)

The KYC product line helps verify the identity of individual users. It provides APIs to collect and check personal details so users can be onboarded safely and in line with compliance requirements. KYC APIs are commonly used when identity verification is required before giving users access to a service.

KYB (Know Your Business)

The KYB SDK helps organizations onboard and verify businesses by sending verification invites and managing the verification process. It allows organizations to select the required checks, track progress, and ensure businesses complete all necessary verification steps.

Once a business finishes all assigned verification tasks from the ChainIT ID Mobile app, the SDK provides APIs to view detailed information, including verification status, completed checks, and other details. This helps organizations review, manage, and maintain verified business records effectively.

Pactvera

Pactvera helps organizations create and manage form-based requests to collect structured information from users. It allows forms to be configured, sent, tracked, and managed in a simple and controlled way for use cases such as agreements, declarations, and data collection.

Pactvera APIs provide clear visibility into the status of each form request and support management of the form lifecycle from creation to completion.

Product

The Product SDK helps organizations create and manage products within the ChainIT Marketplace. It provides APIs to define product details, set required information, and maintain product records.

In addition, the Product SDK supports listing products in the ChainIT marketplace. These APIs allow products to be published, managed, and made visible to end users, making it easy to move from product creation to marketplace availability.

Environments & Base URLs

ChainIT provides separate environments for development and production:

Environment	Base URL
Sandbox	https://api.sandbox.chainit.com
Production	https://api.chainit.com

Authentication Overview

All ChainIT APIs are secured using OAuth 2.0, ensuring that only authorized applications and organizations can access platform resources.

Every API request must include a valid access token issued for your organization. Tokens are scoped to specific product capabilities and permissions, allowing fine-grained control over what each client application can access.

Access tokens must be included in the Authorization header of each request using the Bearer token format:

Authorization: Bearer <<your_access_token>>

Detailed authentication flows, token generation, and scope configuration are described in the OAuth section of this documentation.

Versioning Strategy

ChainIT APIs are versioned to ensure stability and backward compatibility for all integrations.

 

API v1 represents a stable and production-ready version of the ChainIT APIs. All enhancements that do not introduce breaking changes may be added within this version.

 

If breaking changes become necessary, they will be released under a new major version (for example, v2), allowing existing integrations to continue functioning without disruption.

 

This versioning strategy ensures that developers can upgrade at their own pace while maintaining uninterrupted service.

Request & Response Conventions

ChainIT APIs follow consistent request and response conventions to make integrations predictable and easy to implement. All endpoints use standardized formats, status codes, and response structures so developers can build against the platform with minimal custom handling.

Key Conventions

• Data Format: All APIs accept and return data in JSON format

• Response Structure: Responses follow a uniform envelope structure across both successful and error responses

• HTTP Status Codes: Standard codes indicate request results

  • 2xx - Successful operations
  • 4xx - Client errors
  • 5xx - Server errors

• Pagination: List endpoints follow a consistent pagination pattern using common parameters such as page number and result limits

• Metadata: Each response includes metadata useful for tracing and debugging requests

By maintaining these conventions across all APIs, ChainIT ensures reliable integrations, simplified error handling, and a consistent developer experience.

Getting Started

To begin integrating with ChainIT:

1. Set up your development environment using the Sandbox base URL
2. Obtain your OAuth 2.0 credentials
3. Generate an access token
4. Make your first API request
5. Review the product line documentation relevant to your use case

For detailed guides and examples, explore the specific product line sections in this documentation.