Getting Started with KYCryptAI

Node.js / JavaScript

Python

React / Next.js

Verify a document and get authenticity score with extracted data.

{
  "verification_id": "ver_abc123",
  "status": "verified",
  "confidence_score": 98.5,
  "document_type": "aadhaar",
  "verification_hash": "vh_1234...abcd"
}

Retrieve detailed verification information by ID.

Get paginated verification history for your account.

Delete a verification record (subject to retention policies).

Installation

Basic Usage

const KYCryptAI = require('@kycryptai/sdk');

const client = new KYCryptAI({
  apiKey: process.env.KYCRYPT_API_KEY
});

// Verify a document
const result = await client.verify({
  document: fs.createReadStream('aadhaar.jpg'),
  type: 'aadhaar'
});

console.log(result.confidence_score);

Installation

Basic Usage

from kycryptai import KYCryptAI

client = KYCryptAI(api_key="your_api_key")

# Verify a document
with open("aadhaar.jpg", "rb") as f:
    result = client.verify(
        document=f,
        document_type="aadhaar"
    )

print(f"Confidence: {result.confidence_score}%")

Installation

Basic Usage

import { KYCryptProvider, useVerification } from '@kycryptai/react';

function App() {
  return (
    <KYCryptProvider apiKey={process.env.REACT_APP_KYCRYPT_KEY}>
      <VerificationForm />
    </KYCryptProvider>
  );
}

function VerificationForm() {
  const { verify, loading, result } = useVerification();

  const handleSubmit = async (file) => {
    await verify({ document: file, type: 'aadhaar' });
  };

  return <div>{/* Your form UI */}</div>;
}

Data Handling

• • All data is encrypted in transit (TLS 1.3) and at rest (AES-256)
• • Documents are automatically deleted after 90 days (configurable)
• • PII is tokenized and stored separately from verification data
• • Users can request data deletion at any time

Compliance

• • GDPR compliant with data processing agreements
• • SOC 2 Type II certified
• • ISO 27001 certified
• • Regular third-party security audits

Low Confidence Score

Ensure document images are high quality (min 1200x1600px), well-lit, and not blurry. Avoid shadows and glare on the document.

Authentication Failed

Verify your API key is correct and has not expired. Check that you're using the Bearer token format in the Authorization header.

Rate Limit Exceeded

Implement exponential backoff and respect the rate limit headers. Consider upgrading to a higher tier for increased limits.

Webhook Not Received

Ensure your webhook endpoint is publicly accessible, returns a 200 status code, and responds within 5 seconds. Check firewall settings.

Document Quality

• • Use minimum resolution of 1200x1600 pixels
• • Ensure good lighting without shadows or glare
• • Capture the entire document within the frame
• • Avoid blurry or low-contrast images

API Security

• • Never expose API keys in client-side code
• • Rotate API keys regularly (every 90 days)
• • Use environment variables for key storage
• • Implement IP whitelisting for production
• • Monitor API usage for suspicious activity

Error Handling

• • Implement retry logic with exponential backoff
• • Log all API errors for debugging
• • Provide user-friendly error messages
• • Handle rate limits gracefully

Performance

• • Compress images before upload (max 5MB)
• • Use webhooks for async processing
• • Cache verification results when appropriate
• • Batch requests when possible

Debugging API Requests

1. Check API endpoint URL is correct (https://api.kycryptai.com/v1/...)
2. Verify Authorization header format: "Bearer YOUR_API_KEY"
3. Ensure Content-Type is set to multipart/form-data for file uploads
4. Check response status code and error message
5. Review API logs in your dashboard

Webhook Issues

1. Test webhook endpoint with a tool like ngrok for local development
2. Verify endpoint returns 200 status within 5 seconds
3. Check webhook signature validation is implemented correctly
4. Review webhook logs in dashboard for delivery status
5. Enable webhook retry in settings if needed

SDK Integration Issues

1. Ensure SDK version is up to date (npm update @kycryptai/sdk)
2. Check Node.js/Python version compatibility
3. Verify environment variables are loaded correctly
4. Review SDK documentation for breaking changes
5. Enable debug mode for detailed logs

Still Need Help?

If you're still experiencing issues, our support team is here to help:

• • Email: support@kycryptai.com
• • Live Chat: Available in dashboard
• • Community Forum: community.kycryptai.com
• • Status Page: status.kycryptai.com