@inkress/admin-sdk 1.1.43 → 1.1.45

package/README.md

@@ -128,7 +128,7 @@ const products = await inkress.public.getMerchantProducts('merchant-username', {
 
 // Get merchant fees
 const fees = await inkress.public.getMerchantFees('merchant-username', {
-  currency: 'JMD',
+  currency_code: 'JMD',  // JMD = 1, USD = 2
   total: 1000
 });
 ```
@@ -142,8 +142,8 @@ The SDK automatically translates human-readable strings to API integers:
 const order = await inkress.orders.create({
   total: 99.99,
   currency_code: 'USD',
-  status: 'pending',      // SDK converts 'pending' → integer
-  kind: 'online',         // SDK converts 'online' → integer
+  status: 'pending',
+  kind: 'online',
   customer: {
     email: 'customer@example.com',
     first_name: 'John',
@@ -154,19 +154,16 @@ const order = await inkress.orders.create({
 
 // Update merchant with contextual values
 const merchant = await inkress.merchants.update(123, {
-  status: 'approved',               // SDK converts to integer
-  platform_fee_structure: 'customer_pay',  // SDK converts to integer
+  status: 'approved',
+  platform_fee_structure: 'customer_pay',
   provider_fee_structure: 'merchant_absorb'
 });
 
-// Create user with contextual status and kind
+// Create user
 const user = await inkress.users.create({
   email: 'user@example.com',
   first_name: 'John',
   last_name: 'Doe',
-  password: 'secure-password',
-  status: 'pending',       // SDK converts to account_pending integer
-  kind: 'organisation'     // SDK converts to user_organisation integer
 });
 ```
 
@@ -180,7 +177,7 @@ const orders = await inkress.orders.query({
   status: ['confirmed', 'shipped'],  // Array → IN query
   total: { min: 100, max: 1000 },   // Range query
   reference_id: { contains: 'VIP' }, // String search
-  inserted_at: { after: '2024-01-01' },
+  inserted_at: { min: '2024-01-01' },
   page: 1,
   page_size: 20
 });
@@ -238,11 +235,10 @@ The SDK provides access to 23+ fully-typed resources:
 - **Addresses** - Address management
 - **Tokens** - API token management
 - **Webhook URLs** - Webhook configuration
+- **KYC** - Know Your Customer verification and compliance
 
 ### Content & Other
 - **Generics** - Dynamic endpoint access
-- **KYC** - Know Your Customer operations
-- **Payout** - Payout processing
 - **Public** - Public-facing merchant data
 
 ---
@@ -555,7 +551,7 @@ await inkress.billingPlans.get(planId);
 await inkress.billingPlans.create({
   name: 'Premium Plan',
   amount: 29.99,
-  currency: 'USD',
+  currency_code: 'USD',  // JMD = 1, USD = 2
   kind: 'subscription',     // Contextual
   status: 'active'
 });
@@ -675,7 +671,7 @@ await inkress.paymentLinks.list({ status: 'active' });
 await inkress.paymentLinks.create({
   title: 'Product Payment',
   amount: 99.99,
-  currency: 'USD',
+  currency_code: 'USD',  // JMD = 1, USD = 2
   status: 'active'
 });
 
@@ -696,7 +692,7 @@ await inkress.financialAccounts.list();
 await inkress.financialAccounts.create({
   name: 'Main Account',
   type: 'checking',
-  currency: 'USD'
+  currency_code: 'USD'  // JMD = 1, USD = 2
 });
 
 // Update account
@@ -808,12 +804,255 @@ await inkress.public.getMerchantProducts('merchant-name', {
 
 // Get merchant fees (fully typed)
 const fees = await inkress.public.getMerchantFees('merchant-name', {
-  currency: 'USD',
+  currency_code: 'USD',  // JMD = 1, USD = 2
   total: 100
 });
 // Returns: PublicMerchantFees
 ```
 
+---
+
+## KYC (Know Your Customer) Module
+
+The KYC module helps you manage merchant verification and compliance documents. It provides both client-side document requirements and server-side status tracking.
+
+### Understanding Entity Types
+
+Different merchant types require different KYC documents:
+
+| Entity Type | Description | Required Documents |
+|------------|-------------|-------------------|
+| `personal` | Individual merchant | 3 documents |
+| `sole-trader` | Sole proprietorship | 5 documents |
+| `llc` | Limited Liability Company | 9 documents |
+| `non-profit` | Non-profit organization | 6 documents |
+| `alumni` | Alumni association | 6 documents |
+| `other` | Other business types | 9 documents |
+
+### Document Types
+
+```typescript
+type KycDocumentType = 
+  | 'Proof of Identity'
+  | 'Proof of Address'
+  | 'Proof of Bank Account Ownership'
+  | 'Business Certificate'
+  | 'Articles of Incorporation'
+  | 'Annual Return'
+  | 'Notice of Directors'
+  | 'Notice of Secretary'
+  | 'Tax Compliance Certificate';
+```
+
+### Quick Status Check
+
+```typescript
+// Check if KYC is complete for the authenticated merchant
+const isComplete = await inkress.kyc.isKycComplete('llc');
+
+if (isComplete) {
+  console.log('✅ Merchant is fully verified!');
+} else {
+  console.log('⚠️ Verification incomplete');
+}
+```
+
+### Get Requirements Status (with API call)
+
+Fetch the complete KYC status including all document submissions:
+
+```typescript
+const response = await inkress.kyc.getRequirementsStatus('llc');
+
+if (response.state === 'ok') {
+  const status = response.result!;
+  
+  console.log(`Completion: ${status.completion_percentage}%`);
+  console.log(`Complete: ${status.is_complete ? 'Yes' : 'No'}`);
+  console.log(`Approved: ${status.total_approved}/${status.total_required}`);
+  console.log(`Pending: ${status.total_pending}`);
+  console.log(`Rejected: ${status.total_rejected}`);
+  
+  // Check individual documents
+  status.document_statuses.forEach(doc => {
+    console.log(`${doc.document_type}: ${doc.status || 'not submitted'}`);
+    
+    if (doc.status === 'rejected' && doc.rejection_reason) {
+      console.log(`  Reason: ${doc.rejection_reason}`);
+    }
+  });
+}
+```
+
+### Get Missing Documents
+
+Find out which documents still need to be submitted:
+
+```typescript
+const missing = await inkress.kyc.getMissingDocuments('llc');
+
+if (missing.length > 0) {
+  console.log('Please submit the following documents:');
+  missing.forEach(doc => console.log(`  • ${doc}`));
+} else {
+  console.log('All documents submitted!');
+}
+```
+
+### Client-Side Requirements (no API call)
+
+View required documents without making an API request:
+
+```typescript
+// Get requirements for a specific entity type
+const docs = inkress.kyc.getRequiredDocuments('llc');
+console.log(`LLC requires ${docs.length} documents:`, docs);
+// Returns: ['Proof of Identity', 'Proof of Address', ...]
+
+// Get all requirements at once
+const allRequirements = inkress.kyc.getAllRequirements();
+console.log('Personal:', allRequirements.personal);
+console.log('LLC:', allRequirements.llc);
+// Returns complete mapping of all entity types to their required documents
+```
+
+### Submit KYC Documents
+
+```typescript
+// Upload a document
+await inkress.kyc.uploadDocument({
+  kind: 'document_submission',
+  status: 'pending',
+  data: {
+    document_type: 'Proof of Identity',
+    document_url: 'https://cdn.example.com/id-card.pdf',
+    notes: 'Government-issued ID card'
+  }
+});
+
+// Update bank information
+await inkress.kyc.updateBankInfo({
+  kind: 'bank_info_update',
+  status: 'pending',
+  data: {
+    account_number: '123456789',
+    routing_number: '987654321',
+    bank_name: 'Example Bank',
+    account_holder_name: 'John Doe'
+  }
+});
+```
+
+### Complete Onboarding Flow Example
+
+```typescript
+async function checkKycOnboarding(entityType: 'llc' | 'personal' | 'sole-trader') {
+  console.log('🚀 Starting KYC Onboarding Check...\n');
+
+  // Step 1: Show what's required
+  const required = inkress.kyc.getRequiredDocuments(entityType);
+  console.log(`📋 ${entityType} requires ${required.length} documents:`);
+  required.forEach((doc, i) => console.log(`  ${i + 1}. ${doc}`));
+  console.log('');
+
+  // Step 2: Check current status
+  const statusResponse = await inkress.kyc.getRequirementsStatus(entityType);
+  
+  if (statusResponse.state === 'ok') {
+    const status = statusResponse.result!;
+    
+    console.log('📊 Current Status:');
+    console.log(`  Completion: ${status.completion_percentage}%`);
+    console.log(`  Approved: ${status.total_approved}/${status.total_required}`);
+    console.log(`  Pending: ${status.total_pending}`);
+    console.log(`  Rejected: ${status.total_rejected}`);
+    console.log('');
+  }
+
+  // Step 3: Check if complete
+  const isComplete = await inkress.kyc.isKycComplete(entityType);
+  
+  if (isComplete) {
+    console.log('✅ KYC Complete - Merchant is verified!');
+  } else {
+    // Step 4: Show what's missing
+    const missing = await inkress.kyc.getMissingDocuments(entityType);
+    console.log('⚠️ Action Required:');
+    console.log(`Please submit ${missing.length} document(s):`);
+    missing.forEach(doc => console.log(`  • ${doc}`));
+  }
+}
+
+// Run the check
+await checkKycOnboarding('llc');
+```
+
+### TypeScript Types
+
+```typescript
+import type {
+  EntityType,
+  KycDocumentType,
+  KycRequirements,
+  KycDocumentStatus,
+  KYC_DOCUMENT_REQUIREMENTS
+} from '@inkress/admin-sdk';
+
+// Document status interface
+interface KycDocumentStatus {
+  document_type: KycDocumentType;
+  required: boolean;
+  submitted: boolean;
+  status?: 'pending' | 'approved' | 'rejected';
+  submitted_at?: string;
+  reviewed_at?: string;
+  rejection_reason?: string;
+}
+
+// Complete requirements interface
+interface KycRequirements {
+  entity_type: EntityType;
+  required_documents: KycDocumentType[];
+  document_statuses: KycDocumentStatus[];
+  total_required: number;
+  total_submitted: number;
+  total_approved: number;
+  total_rejected: number;
+  total_pending: number;
+  completion_percentage: number;
+  is_complete: boolean;
+}
+```
+
+### KYC Status Values
+
+The API returns integer status codes that are automatically converted:
+
+| Integer | API Value | Simplified |
+|---------|-----------|------------|
+| 1 | `pending` | `pending` |
+| 2 | `in_review` | `pending` |
+| 3 | `approved` | `approved` |
+| 4 | `rejected` | `rejected` |
+
+The SDK automatically handles the conversion between integers and human-readable strings.
+
+### Best Practices
+
+1. **Cache Requirements**: The `getRequiredDocuments()` and `getAllRequirements()` methods don't make API calls - use them freely for UI display.
+
+2. **Periodic Status Checks**: Poll `getRequirementsStatus()` periodically to track verification progress.
+
+3. **Handle Rejections**: Check `rejection_reason` when a document is rejected to provide clear feedback to users.
+
+4. **Track Submissions**: Use `submitted_at` and `reviewed_at` timestamps to show processing time.
+
+5. **Authentication**: All KYC methods use the authenticated merchant from the `Client-Id` header (set via `username` config).
+
+See [examples/kyc-requirements.ts](examples/kyc-requirements.ts) for complete working examples.
+
+---
+
 ## Advanced Query System
 
 The SDK provides a powerful type-safe query system with two interfaces:

package/dist/index.d.ts

@@ -99,6 +99,7 @@ export declare class InkressSDK {
 export * from './types';
 export * from './client';
 export type { WebhookPayload, WebhookVerificationOptions, IncomingWebhookRequest, } from './resources/webhook-urls';
+export { KYC_DOCUMENT_REQUIREMENTS, type EntityType, type KycDocumentType, type KycDocumentStatus, type KycRequirements, } from './resources/kyc';
 export { InkressSDK as default };
 export type { OrderQueryParams, ProductQueryParams, UserQueryParams, MerchantQueryParams, CategoryQueryParams, BillingPlanQueryParams, SubscriptionQueryParams, PaymentLinkQueryParams, FinancialAccountQueryParams, FinancialRequestQueryParams, WebhookUrlQueryParams, TokenQueryParams, AddressQueryParams, CurrencyQueryParams, ExchangeRateQueryParams, FeeQueryParams, PaymentMethodQueryParams, TransactionEntryQueryParams, OrderFilterParams, ProductFilterParams, UserFilterParams, MerchantFilterParams, CategoryFilterParams, BillingPlanFilterParams, SubscriptionFilterParams, PaymentLinkFilterParams, FinancialAccountFilterParams, FinancialRequestFilterParams, WebhookUrlFilterParams, TokenFilterParams, AddressFilterParams, CurrencyFilterParams, ExchangeRateFilterParams, FeeFilterParams, PaymentMethodFilterParams, TransactionEntryFilterParams, OrderListResponse, ProductListResponse, UserListResponse, MerchantListResponse, CategoryListResponse, BillingPlanListResponse, SubscriptionListResponse, PaymentLinkListResponse, FinancialAccountListResponse, FinancialRequestListResponse, WebhookUrlListResponse, TokenListResponse, AddressListResponse, CurrencyListResponse, ExchangeRateListResponse, FeeListResponse, PaymentMethodListResponse, TransactionEntryListResponse, PageInfo, } from './types/resources';
 export { ORDER_FIELD_TYPES, PRODUCT_FIELD_TYPES, USER_FIELD_TYPES, MERCHANT_FIELD_TYPES, CATEGORY_FIELD_TYPES, BILLING_PLAN_FIELD_TYPES, SUBSCRIPTION_FIELD_TYPES, PAYMENT_LINK_FIELD_TYPES, FINANCIAL_ACCOUNT_FIELD_TYPES, FINANCIAL_REQUEST_FIELD_TYPES, WEBHOOK_URL_FIELD_TYPES, TOKEN_FIELD_TYPES, ADDRESS_FIELD_TYPES, CURRENCY_FIELD_TYPES, EXCHANGE_RATE_FIELD_TYPES, FEE_FIELD_TYPES, PAYMENT_METHOD_FIELD_TYPES, TRANSACTION_ENTRY_FIELD_TYPES, } from './types/resources';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAa;IAG3B,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,YAAY,EAAE,oBAAoB,CAAC;IACnD,SAAgB,aAAa,EAAE,qBAAqB,CAAC;IACrD,SAAgB,KAAK,EAAE,aAAa,CAAC;IACrC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC,SAAgB,YAAY,EAAE,oBAAoB,CAAC;IACnD,SAAgB,iBAAiB,EAAE,yBAAyB,CAAC;IAC7D,SAAgB,iBAAiB,EAAE,yBAAyB,CAAC;IAC7D,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,aAAa,EAAE,qBAAqB,CAAC;IACrD,SAAgB,IAAI,EAAE,YAAY,CAAC;IACnC,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,SAAgB,kBAAkB,EAAE,0BAA0B,CAAC;IAC/D,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;gBAE/B,MAAM,EAAE,aAAa;IA2BjC;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAIrD;;OAEG;IACH,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC;CAGhD;AAGD,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AAGzB,YAAY,EACV,cAAc,EACd,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,CAAC;AAGjC,YAAY,EAEV,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,wBAAwB,EACxB,2BAA2B,EAG3B,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAG5B,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAG5B,QAAQ,GACT,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,wBAAwB,EACxB,wBAAwB,EACxB,6BAA6B,EAC7B,6BAA6B,EAC7B,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,eAAe,EACf,0BAA0B,EAC1B,6BAA6B,GAC9B,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,eAAe,GACrB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAC5B,KAAK,SAAS,GACf,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAa;IAG3B,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,YAAY,EAAE,oBAAoB,CAAC;IACnD,SAAgB,aAAa,EAAE,qBAAqB,CAAC;IACrD,SAAgB,KAAK,EAAE,aAAa,CAAC;IACrC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC,SAAgB,YAAY,EAAE,oBAAoB,CAAC;IACnD,SAAgB,iBAAiB,EAAE,yBAAyB,CAAC;IAC7D,SAAgB,iBAAiB,EAAE,yBAAyB,CAAC;IAC7D,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,aAAa,EAAE,qBAAqB,CAAC;IACrD,SAAgB,IAAI,EAAE,YAAY,CAAC;IACnC,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,SAAgB,kBAAkB,EAAE,0BAA0B,CAAC;IAC/D,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;gBAE/B,MAAM,EAAE,aAAa;IA2BjC;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAIrD;;OAEG;IACH,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC;CAGhD;AAGD,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AAGzB,YAAY,EACV,cAAc,EACd,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EACL,yBAAyB,EACzB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,CAAC;AAGjC,YAAY,EAEV,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,wBAAwB,EACxB,2BAA2B,EAG3B,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAG5B,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAG5B,QAAQ,GACT,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,wBAAwB,EACxB,wBAAwB,EACxB,6BAA6B,EAC7B,6BAA6B,EAC7B,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,eAAe,EACf,0BAA0B,EAC1B,6BAA6B,GAC9B,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,eAAe,GACrB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAC5B,KAAK,SAAS,GACf,MAAM,wBAAwB,CAAC"}

package/dist/index.esm.js

@@ -3469,6 +3469,62 @@ class PublicResource {
     }
 }
 
+/**
+ * KYC document requirements by entity type
+ * These are the standard documents required for each type of business entity
+ */
+const KYC_DOCUMENT_REQUIREMENTS = {
+    personal: [
+        'Proof of Identity',
+        'Proof of Address',
+        'Proof of Bank Account Ownership',
+    ],
+    'sole-trader': [
+        'Proof of Identity',
+        'Proof of Address',
+        'Proof of Bank Account Ownership',
+        'Business Certificate',
+        'Articles of Incorporation',
+    ],
+    llc: [
+        'Proof of Identity',
+        'Proof of Address',
+        'Proof of Bank Account Ownership',
+        'Business Certificate',
+        'Articles of Incorporation',
+        'Annual Return',
+        'Notice of Directors',
+        'Notice of Secretary',
+        'Tax Compliance Certificate',
+    ],
+    'non-profit': [
+        'Proof of Identity',
+        'Proof of Address',
+        'Proof of Bank Account Ownership',
+        'Business Certificate',
+        'Articles of Incorporation',
+        'Annual Return',
+    ],
+    alumni: [
+        'Proof of Identity',
+        'Proof of Address',
+        'Proof of Bank Account Ownership',
+        'Business Certificate',
+        'Articles of Incorporation',
+        'Annual Return',
+    ],
+    other: [
+        'Proof of Identity',
+        'Proof of Address',
+        'Proof of Bank Account Ownership',
+        'Business Certificate',
+        'Articles of Incorporation',
+        'Annual Return',
+        'Notice of Directors',
+        'Notice of Secretary',
+        'Tax Compliance Certificate',
+    ],
+};
 // Field type definitions for query validation
 const KYC_FIELD_TYPES = {
     id: 'number',
@@ -3549,6 +3605,185 @@ class KycResource {
     async updateBankInfo(data) {
         return this.client.post('/legal_requests', data);
     }
+    // ============================================================================
+    // KYC DOCUMENT REQUIREMENTS & STATUS
+    // ============================================================================
+    /**
+     * Get required KYC documents for a specific entity type
+     * This is a client-side method that doesn't make an API call
+     *
+     * @param entityType - The type of business entity
+     * @returns Array of required document types
+     *
+     * @example
+     * const docs = kyc.getRequiredDocuments('llc');
+     * // Returns: ['Proof of Identity', 'Proof of Address', ...]
+     */
+    getRequiredDocuments(entityType) {
+        return [...KYC_DOCUMENT_REQUIREMENTS[entityType]];
+    }
+    /**
+     * Get all KYC document requirements (without making an API call)
+     * Useful for displaying the full list in your application
+     *
+     * @returns Complete mapping of entity types to required documents
+     *
+     * @example
+     * const allRequirements = kyc.getAllRequirements();
+     * console.log(allRequirements.llc); // ['Proof of Identity', ...]
+     */
+    getAllRequirements() {
+        return { ...KYC_DOCUMENT_REQUIREMENTS };
+    }
+    /**
+     * Get KYC requirements and submission status for the authenticated merchant
+     * Fetches all KYC requests and maps them to required documents
+     *
+     * @param entityType - The merchant's business entity type
+     * @returns Complete KYC requirements with submission status
+     *
+     * @example
+     * const status = await kyc.getRequirementsStatus('llc');
+     * console.log(`Completion: ${status.completion_percentage}%`);
+     * console.log(`Approved: ${status.total_approved}/${status.total_required}`);
+     *
+     * // Check individual document status
+     * status.document_statuses.forEach(doc => {
+     *   console.log(`${doc.document_type}: ${doc.status || 'not submitted'}`);
+     * });
+     */
+    async getRequirementsStatus(entityType) {
+        // Get required documents for this entity type
+        const requiredDocuments = this.getRequiredDocuments(entityType);
+        // Fetch all KYC requests for the authenticated merchant
+        const params = {
+            kind: 'document_submission',
+        };
+        const response = await this.list(params);
+        if (response.state === 'error' || !response.result) {
+            return {
+                state: 'error',
+            };
+        }
+        const kycRequests = response.result.entries || [];
+        // Map submitted documents
+        const submittedDocs = new Map();
+        kycRequests.forEach(request => {
+            var _a;
+            const docType = (_a = request.data) === null || _a === void 0 ? void 0 : _a.document_type;
+            if (docType && requiredDocuments.includes(docType)) {
+                // Keep the most recent submission for each document type
+                const existing = submittedDocs.get(docType);
+                if (!existing || new Date(request.inserted_at) > new Date(existing.inserted_at)) {
+                    submittedDocs.set(docType, request);
+                }
+            }
+        });
+        // Build document statuses
+        const documentStatuses = requiredDocuments.map(docType => {
+            var _a;
+            const submission = submittedDocs.get(docType);
+            if (!submission) {
+                return {
+                    document_type: docType,
+                    required: true,
+                    submitted: false,
+                };
+            }
+            // Convert integer status to string using translator
+            // The API returns status as a number, but the type says it's a string
+            const statusString = StatusTranslator.toStringWithoutContext(submission.status, 'legal_request');
+            // Map to our simplified status types
+            let status;
+            if (statusString) {
+                if (statusString === 'pending' || statusString === 'in_review') {
+                    status = 'pending';
+                }
+                else if (statusString === 'approved') {
+                    status = 'approved';
+                }
+                else if (statusString === 'rejected') {
+                    status = 'rejected';
+                }
+            }
+            const reviewedAt = submission.updated_at !== submission.inserted_at
+                ? submission.updated_at
+                : undefined;
+            return {
+                document_type: docType,
+                required: true,
+                submitted: true,
+                status,
+                submitted_at: submission.inserted_at,
+                reviewed_at: reviewedAt,
+                rejection_reason: (_a = submission.data) === null || _a === void 0 ? void 0 : _a.rejection_reason,
+            };
+        });
+        // Calculate statistics
+        const totalRequired = requiredDocuments.length;
+        const totalSubmitted = documentStatuses.filter(d => d.submitted).length;
+        const totalApproved = documentStatuses.filter(d => d.status === 'approved').length;
+        const totalRejected = documentStatuses.filter(d => d.status === 'rejected').length;
+        const totalPending = documentStatuses.filter(d => d.status === 'pending').length;
+        const completionPercentage = totalRequired > 0
+            ? Math.round((totalApproved / totalRequired) * 100)
+            : 0;
+        const isComplete = totalApproved === totalRequired;
+        const requirements = {
+            entity_type: entityType,
+            required_documents: requiredDocuments,
+            document_statuses: documentStatuses,
+            total_required: totalRequired,
+            total_submitted: totalSubmitted,
+            total_approved: totalApproved,
+            total_rejected: totalRejected,
+            total_pending: totalPending,
+            completion_percentage: completionPercentage,
+            is_complete: isComplete,
+        };
+        return {
+            state: 'ok',
+            result: requirements,
+        };
+    }
+    /**
+     * Check if all required documents have been approved for the authenticated merchant
+     *
+     * @param entityType - The merchant's business entity type
+     * @returns True if all required documents are approved
+     *
+     * @example
+     * const isComplete = await kyc.isKycComplete('llc');
+     * if (isComplete) {
+     *   console.log('Merchant is fully verified!');
+     * }
+     */
+    async isKycComplete(entityType) {
+        var _a;
+        const response = await this.getRequirementsStatus(entityType);
+        return ((_a = response.result) === null || _a === void 0 ? void 0 : _a.is_complete) || false;
+    }
+    /**
+     * Get list of missing (not submitted or rejected) documents for the authenticated merchant
+     *
+     * @param entityType - The merchant's business entity type
+     * @returns Array of document types that need to be submitted or resubmitted
+     *
+     * @example
+     * const missing = await kyc.getMissingDocuments('llc');
+     * if (missing.length > 0) {
+     *   console.log('Please submit:', missing.join(', '));
+     * }
+     */
+    async getMissingDocuments(entityType) {
+        const response = await this.getRequirementsStatus(entityType);
+        if (response.state === 'error' || !response.result) {
+            return [];
+        }
+        return response.result.document_statuses
+            .filter(doc => !doc.submitted || doc.status === 'rejected')
+            .map(doc => doc.document_type);
+    }
 }
 
 class PaymentLinksResource {
@@ -4700,5 +4935,5 @@ class InkressSDK {
     }
 }
 
-export { ADDRESS_FIELD_TYPES, AddressQueryBuilder, BILLING_PLAN_FIELD_TYPES, BillingPlanQueryBuilder, CATEGORY_FIELD_TYPES, CURRENCY_FIELD_TYPES, CategoryQueryBuilder, CurrencyQueryBuilder, EXCHANGE_RATE_FIELD_TYPES, ExchangeRateQueryBuilder, FEE_FIELD_TYPES, FINANCIAL_ACCOUNT_FIELD_TYPES, FINANCIAL_REQUEST_FIELD_TYPES, FeeQueryBuilder, FinancialAccountQueryBuilder, FinancialRequestQueryBuilder, HttpClient, InkressApiError, InkressSDK, MERCHANT_FIELD_TYPES, MerchantQueryBuilder, ORDER_FIELD_TYPES, OrderQueryBuilder, PAYMENT_LINK_FIELD_TYPES, PAYMENT_METHOD_FIELD_TYPES, PRODUCT_FIELD_TYPES, PaymentLinkQueryBuilder, PaymentMethodQueryBuilder, ProductQueryBuilder, QueryBuilder, SUBSCRIPTION_FIELD_TYPES, SubscriptionQueryBuilder, TOKEN_FIELD_TYPES, TRANSACTION_ENTRY_FIELD_TYPES, TokenQueryBuilder, TransactionEntryQueryBuilder, USER_FIELD_TYPES, UserQueryBuilder, WEBHOOK_URL_FIELD_TYPES, WebhookUrlQueryBuilder, InkressSDK as default, processQuery };
+export { ADDRESS_FIELD_TYPES, AddressQueryBuilder, BILLING_PLAN_FIELD_TYPES, BillingPlanQueryBuilder, CATEGORY_FIELD_TYPES, CURRENCY_FIELD_TYPES, CategoryQueryBuilder, CurrencyQueryBuilder, EXCHANGE_RATE_FIELD_TYPES, ExchangeRateQueryBuilder, FEE_FIELD_TYPES, FINANCIAL_ACCOUNT_FIELD_TYPES, FINANCIAL_REQUEST_FIELD_TYPES, FeeQueryBuilder, FinancialAccountQueryBuilder, FinancialRequestQueryBuilder, HttpClient, InkressApiError, InkressSDK, KYC_DOCUMENT_REQUIREMENTS, MERCHANT_FIELD_TYPES, MerchantQueryBuilder, ORDER_FIELD_TYPES, OrderQueryBuilder, PAYMENT_LINK_FIELD_TYPES, PAYMENT_METHOD_FIELD_TYPES, PRODUCT_FIELD_TYPES, PaymentLinkQueryBuilder, PaymentMethodQueryBuilder, ProductQueryBuilder, QueryBuilder, SUBSCRIPTION_FIELD_TYPES, SubscriptionQueryBuilder, TOKEN_FIELD_TYPES, TRANSACTION_ENTRY_FIELD_TYPES, TokenQueryBuilder, TransactionEntryQueryBuilder, USER_FIELD_TYPES, UserQueryBuilder, WEBHOOK_URL_FIELD_TYPES, WebhookUrlQueryBuilder, InkressSDK as default, processQuery };
 //# sourceMappingURL=index.esm.js.map