Documentation
Everything you need to integrate Rightdocs into your applications.
⌘K
Quick Start
Get started with Rightdocs in just a few minutes. This guide will walk you through installing the SDK, authenticating, and making your first verification request.
1. Install the SDK
npm
npm install @rightdocs/sdk2. Get Your API Key
Create an account and generate an API key from your dashboard. Keep this key secure and never expose it in client-side code.
3. Make Your First Request
TypeScript
import { Rightdocs } from '@rightdocs/sdk';
const client = new Rightdocs('YOUR_API_KEY');
// Verify a document
const result = await client.verify({
file: documentBuffer,
type: 'contract',
options: {
deepAnalysis: true,
includeMetadata: true,
}
});
console.log(result.trustScore); // 87
console.log(result.riskLevel); // "low"
console.log(result.findings); // [...]Understanding the Response
The verification response includes several key fields:
trustScoreA score from 0-100 indicating document authenticity confidenceriskLevelCategorized as "low", "medium", "high", or "critical"findingsDetailed array of individual analysis results