API — ATOMi Escrow Intelligence

Overview

Powerful, RESTful API

Our API provides programmatic access to all ATOMi features, enabling seamless integration with your systems.

🔗

RESTful Design

Standard REST architecture with JSON responses. Easy to integrate with any programming language.

🔐

Secure Authentication

JWT-based authentication with API keys. Granular permissions for different operations.

📡

Webhooks

Real-time notifications for agreement events. Configure endpoints to receive updates instantly.

📚

Comprehensive Docs

Detailed documentation with examples, SDKs, and sandbox environment for testing.

Endpoints

Available endpoints

Authentication

POST /api/auth/login Authenticate user

POST /api/auth/refresh Refresh token

GET /api/auth/me Get current user

Users

POST /api/users Create user

GET /api/users/:id Get user details

PUT /api/users/:id Update user

Wallets

GET /api/wallets List wallets

POST /api/wallets/:id/deposit Deposit funds

GET /api/wallets/:id/transactions Transaction history

Escrows

POST /api/escrows Create escrow

GET /api/escrows List escrows

POST /api/escrows/:id/fund Fund escrow

POST /api/escrows/:id/release Release funds

KYC

POST /api/kyc/individual Submit individual KYC

POST /api/kyc/company Submit company KYC

GET /api/kyc/me/status Check KYC status

Documents

POST /api/storage/upload Upload document

GET /api/storage/documents List documents

GET /api/storage/documents/:id/download Get download URL

Example

Quick integration

JavaScript

// Create an escrow agreement
const response = await fetch('https://api.atomi.com/v1/escrows', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Software Development Project',
    description: 'Custom inventory management system',
    gross_amount: 45000.00,
    buyer_id: 'user_abc123',
    seller_id: 'user_xyz789',
    milestones: [
      { name: 'Design Phase', amount: 10000, due_days: 14 },
      { name: 'Development', amount: 25000, due_days: 45 },
      { name: 'Final Delivery', amount: 10000, due_days: 60 }
    ]
  })
});

const escrow = await response.json();
console.log('Created escrow:', escrow.id);

Build with ATOMi