@dossier-wiki/cloud-sdk 0.1.0 → 0.2.0-staging.3dda5e6

package/dist/{api.d.ts → types/api.d.ts}

@@ -23,84 +23,50 @@ export interface SanctionSearchInput {
     idNumbers?: string[];
 }
 export interface IdDocument {
-    /** Document type (e.g. `passport`, `national_id`). */
     documentType?: string;
-    /** ISO 3166-1 alpha-2 country code of issuance. */
     countryOfIssue?: string;
-    /** Document number or identifier. */
     idNumber?: string;
-    /** Date of issue (format varies by source). */
     dateOfIssue?: string;
-    /** Date of expiry (format varies by source). */
     dateOfExpiry?: string;
-    /** Free-form supplementary details from the source list. */
     additionalInfo?: string;
 }
 export interface Sanction {
-    /** Subject classification (e.g. `individual`, `entity`). */
     entityType: string;
-    /** Primary name as published on the sanctions list. */
     name: string;
-    /** Honorifics or titles (e.g. `Mr.`, `Dr.`). */
     titles?: string[];
-    /** Official designations (e.g. `Minister`, `General`). */
     designations?: string[];
-    /** Dates of birth as published — may include multiple entries when sources disagree. */
     dateOfBirth?: string[];
-    /** Places of birth as published. */
     placeOfBirth?: string[];
-    /** Free-form remarks from the source list. */
     comments?: string;
     identificationDocuments?: IdDocument[];
-    /** Addresses as published. */
     address?: string[];
-    /** Date the subject was first listed on the source. */
     listedDate?: string;
-    /** Sanctions program codes (e.g. `SDGT`, `Security Council Resolution 1267`). */
     sanctionsProgramme: string[];
-    /** Citizenship(s) as published. */
     citizenship?: string[];
     aliases?: string[];
-    /** Nationality as published. */
     nationality?: string;
-    /** Associated countries (ISO 3166-1 alpha-2 where available). */
     country?: string[];
-    /** URLs of associated images. */
     image?: string[];
-    /** Originating sanctions list. */
     source: SanctionSource;
-    /** External ID from the originating source. */
     extId: string;
-    /** Source-specific extra fields not modeled above. */
     additionalData?: Record<string, unknown>;
-    /** Verbatim original record from the source, when retained. */
     originalData?: string;
-    /** Pagination cursor returned by the upstream search engine. */
     sort?: [number, number];
 }
-/** Response from `POST /sanctions/search`. Costs 5 credits per request. */
 export interface SanctionSearchResponse {
     totalHits: number;
-    /** Echoed (normalized, lowercased) query terms used for the search. */
     searchingFor: string[];
     documents: Sanction[];
 }
 export interface DossierSearchInput {
-    /** Full name of the individual to search for. */
     fullName: string;
-    /** When true, bypasses cached results and runs a fresh search. Default: false. */
     noCache?: boolean;
-    /** When true, only returns high-risk profiles (PEP, sanctioned, adverse media). Default: true. */
     onlyShowHighRiskProfiles?: boolean;
 }
 export interface PersonIdentificationDocument {
-    /** Document type (e.g. `passport`, `national_id`). */
     type: string;
-    /** Document number or identifier. */
     number: string;
-    /** Additional details about the document. */
     description: string;
-    /** IDs of source documents referencing this identification. */
     referenceDocumentIds: string[];
 }
 export interface AssociatesAndRelatives {
@@ -122,7 +88,7 @@ export interface DocumentMatch {
     matchingQueries: string[];
     matchingChunk: string;
 }
-export interface Document {
+export interface DossierDocument {
     id: string;
     originalUrl: string;
     title: string;
@@ -130,21 +96,14 @@ export interface Document {
     matches: DocumentMatch;
 }
 export interface PEPScorecard {
-    /** PEP likelihood score from 0.0 (unlikely) to 1.0 (certain). */
     pepLikelihoodScore: number;
-    /** PEP category (e.g. "Head of State", "Senior Government Official"). */
     category: string;
-    /** Step-by-step reasoning explaining how the PEP score was derived. */
     reasoningSteps: string[];
 }
 export interface RiskScorecard {
-    /** PEP-specific scoring breakdown (present when PEP indicators are found). */
     pepScorecard?: PEPScorecard;
-    /** Overall risk score from 0.0 (low risk) to 1.0 (high risk). */
     overallRiskScore: number;
-    /** Narrative explanation of the risk assessment. */
     riskReasoning: string;
-    /** Risk category (e.g. `high`, `medium`, `low`). */
     riskCategory: string;
 }
 export interface IndividualDossier {
@@ -160,115 +119,106 @@ export interface IndividualDossier {
     keywords: string[];
     positionsHeld: PositionsHeld[];
     documentIds?: string[];
-    documents?: Document[];
+    documents?: DossierDocument[];
     individualSummary: string;
     riskScorecard?: RiskScorecard;
     cachedResult?: boolean;
-    /** ISO 8601 timestamp. */
     createdAt: string;
 }
 export type DossierSearchResponse = IndividualDossier[];
 export interface IdentificationDocumentInput {
-    /** Document type (e.g. `passport`, `national_id`, `drivers_license`). */
     type?: string;
-    /** Document number or identifier. */
     number?: string;
-    /** ISO 3166-1 alpha-2 country code of the issuing country. */
     country?: string;
 }
 export interface CreateScreeningRequestDto {
-    /** Full name of the individual to screen. */
     fullName: string;
-    /** Your own reference ID (e.g. customer ID, case number). */
     externalId?: string;
-    /** Identification document details to improve match accuracy. */
     identificationDocument?: IdentificationDocumentInput;
-    /** Date of birth in `YYYY-MM-DD` format. */
     dateOfBirth?: string;
-    /** ISO 3166-1 alpha-2 country code. */
     country?: string;
 }
 export interface CreateScreeningRequestResponseDto {
-    /** Unique ID of the created screening request. */
     requestId: string;
 }
-export type KycSessionState = 'home' | 'permission-granting' | 'dv-get-started' | 'dv-document-selection' | 'dv-document-upload' | 'dv-positioning-front' | 'dv-capturing-front' | 'dv-flip-prompt' | 'dv-positioning-back' | 'dv-capturing-back' | 'dv-complete' | 'lv-get-started' | 'lv-initializing' | 'lv-aligning' | 'lv-countdown' | 'lv-complete' | 'lv-timeout';
-export type KycDocumentVerificationStatus = 'pending' | 'running' | 'completed' | 'failed';
-export interface CreateKycSessionDTO {
-    /** External reference ID used to correlate the session with your records. */
+export type KycSessionCheckpoint = 'home' | 'permission-granting' | 'dv-document-selection' | 'dv-capture-tips' | 'dv-document-upload' | 'dv-positioning-front' | 'dv-capturing-front' | 'dv-flip-prompt' | 'dv-positioning-back' | 'dv-capturing-back' | 'dv-complete' | 'aadhaar-get-started' | 'aadhaar-otp-sent' | 'aadhaar-verified' | 'lv-get-started' | 'lv-initializing' | 'lv-capture' | 'lv-complete' | 'lv-timeout' | 'fc-active' | 'verification-results' | 'document-verification' | 'liveness-verification' | 'form-submission' | 'signature-submission' | 'results' | 'completion';
+export type KycSessionStatus = 'not-started' | 'in-progress' | 'complete' | 'approved' | 'rejected';
+export type KycStepSubmissionStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
+export interface KycCustomerDTO {
     externalId?: string;
-    /** Session expiry duration in milliseconds. Defaults to 1 hour. */
-    expiresInMs?: number;
-    /** Customer email — when set alongside `customerName`, an invitation email is sent. */
-    customerEmail?: string;
-    /** Customer display name, used in the invitation email greeting. */
-    customerName?: string;
-}
-export interface KycSessionDataOutputDTO {
-    /** Selected country code. */
-    country?: string;
-    /** Selected document type. */
-    documentType?: string;
-    /** Document aspect ratio (width / height). */
-    documentRatio?: number;
-    /** Whether the document has both front and back sides. */
-    isDoubleSided?: boolean;
+    name?: string;
+    email?: string;
 }
-export interface KycDocumentVerificationDTO {
-    instanceId: string;
-    processorId: string;
-    status: KycDocumentVerificationStatus;
-    statusLabel?: string | null;
-    documentTypeId?: string | null;
-    /** Unix ms when verification was triggered. */
-    triggeredAt: number;
-    /** Unix ms when verification completed; `null` while in progress. */
-    completedAt?: number | null;
-    error?: string | null;
-    /** Full processing result (validation, extraction, post-processing). */
-    result?: Record<string, unknown> | null;
-    /** Per-stage progress entries. */
-    stageProgress?: string[] | null;
-    /** Chronological processing log with timestamps. */
-    processingLog?: string[] | null;
-    /** References to original, cropped, and detected face images. */
-    files?: string[] | null;
-}
-export interface KycFaceVerificationDTO {
-    /** Whether the face on the document matches the liveness frame. */
-    verified: boolean;
-    /** Distance between the two face embeddings (lower = more similar). */
-    distance: number;
-    /** Distance threshold used for the verification decision. */
-    threshold: number;
-    /** Face recognition model used. */
-    model: string;
-    /** Unix ms when the verification was performed. */
-    performedAt: number;
+export interface KycResultMediaDTO {
+    label: string;
+    key: string;
+    mediaType: string;
+    type?: string | null;
+    url?: string | null;
+    metadata?: Record<string, unknown> | null;
+}
+export interface KycStepSubmissionDTO {
+    attemptId?: string | null;
+    status: KycStepSubmissionStatus;
+    input?: Record<string, unknown> | null;
+    output?: Record<string, unknown> | null;
+    processorInstanceId?: string | null;
     error?: string | null;
+    /** Unix ms when the submission started. */
+    startedAt: number;
+    /** Unix ms when the submission completed; `null` while in progress. */
+    completedAt?: number | null;
+    media: KycResultMediaDTO[];
+}
+export interface KycSessionResultStepDTO {
+    stepId: string;
+    type: string;
+    status: KycStepSubmissionStatus;
+    submissions: KycStepSubmissionDTO[];
+    summary?: KycStepSubmissionDTO | null;
+}
+export interface KycSessionResultDTO {
+    steps: KycSessionResultStepDTO[];
+    rollup: Record<string, unknown>;
+}
+export interface KycSessionSuspiciousDTO {
+    isSuspicious: boolean;
+    reason?: string | null;
 }
 export interface KycSessionOutputDTO {
     id: string;
-    organizationId: string;
-    externalId?: string;
-    customerName?: string;
-    customerEmail?: string;
-    state: KycSessionState;
-    data: KycSessionDataOutputDTO;
+    customer: KycCustomerDTO;
+    userProgress: {
+        checkpoint: string;
+        attempts: Record<string, unknown>[];
+    };
+    status: KycSessionStatus;
     isInvalid: boolean;
-    isComplete: boolean;
-    /** Unix ms. */
+    suspicious: KycSessionSuspiciousDTO;
+    currentUser?: string | null;
+    /** Unix ms when created. */
     createdAt: number;
-    /** Unix ms. `null` after completion. */
+    /** Unix ms. `null` if no expiry. */
     expiresAt?: number | null;
-    /** Unix ms. `null` if not yet completed. */
+    /** Unix ms. `null` while in progress. */
     completedAt?: number | null;
-    documentVerification?: KycDocumentVerificationDTO | null;
-    faceVerification?: KycFaceVerificationDTO | null;
+    workflowSnapshot: Record<string, unknown>;
+    flowConfig?: Record<string, unknown> | null;
+    stepPreviewData?: Record<string, unknown> | null;
+    result: KycSessionResultDTO;
+    adminDecision?: Record<string, unknown> | null;
+}
+export interface CreateKycSessionDTO {
+    customer?: KycCustomerDTO;
+    /** Session expiry duration in milliseconds. Defaults to 1 hour (3,600,000 ms). */
+    expiresInMs?: number;
+    /** Optional Workflow ID. If omitted, the organization default is used. */
+    workflowId?: string;
+    flowConfig?: Record<string, unknown>;
 }
 export interface CreateKycSessionOutputDTO {
     session: KycSessionOutputDTO;
-    /** Short-lived JWT token for customer access to the session. */
+    /** Short-lived JWT for customer access to the session. */
     token: string;
     /** Full URL the customer should visit to complete KYC verification. */
     sessionUrl: string;
@@ -280,9 +230,8 @@ export interface DateRange {
     end?: string;
 }
 export interface KycSessionFiltersDTO {
-    /** Free-text search across session ID, external ID, customer name, and email. */
     searchQuery?: string;
-    state?: KycSessionState;
+    checkpoint?: KycSessionCheckpoint;
     isComplete?: boolean;
     isInvalid?: boolean;
     createdAt?: DateRange;
@@ -295,12 +244,140 @@ export interface KycSessionFiltersDTO {
 }
 export interface PaginatedKycSessionsDTO {
     sessions: KycSessionOutputDTO[];
-    /** Total before pagination. */
     totalCount: number;
 }
 export interface DeleteSessionOutputDTO {
     success: boolean;
 }
+export type KycWorkflowStepType = 'id_verification' | 'document_collection' | 'liveness' | 'form_collection' | 'esignature' | 'action';
+export interface WorkflowCondition {
+    variable: string;
+    operator: 'gt' | 'lt' | 'eq' | 'neq';
+    value: unknown;
+    targetStepId: string;
+}
+export interface WorkflowRules {
+    /** Target step ID or `'COMPLETE_SESSION'`. */
+    onSuccess: string;
+    /** Target step ID or `'FAIL_SESSION'`. */
+    onFailure: string;
+    conditions?: WorkflowCondition[];
+}
+export interface WorkflowInputMapping {
+    /** Key under which the resolved value is placed in this step's input. */
+    target: string;
+    /** stepId of an earlier step whose output supplies the value. */
+    sourceStepId: string;
+    /** Dot path into the source step's output, e.g. `formData.nic_id`. */
+    sourcePath: string;
+}
+export interface KycWorkflowStep {
+    stepId: string;
+    type: KycWorkflowStepType;
+    input: {
+        config?: Record<string, unknown>;
+        mapping?: WorkflowInputMapping[];
+    };
+    output: {
+        schema?: Record<string, unknown>;
+    };
+    rules: WorkflowRules;
+    skippable?: boolean;
+    locales?: Record<string, Record<string, unknown>>;
+}
+export interface CreateKycWorkflowInput {
+    name: string;
+    description?: string;
+    isPublic?: boolean;
+    allowedOrganizations?: string[];
+    defaultConfig?: Record<string, unknown>;
+    steps: KycWorkflowStep[];
+}
+export type UpdateKycWorkflowInput = Partial<CreateKycWorkflowInput>;
+export interface KycWorkflow {
+    id: string;
+    name: string;
+    description?: string;
+    organizationId?: string;
+    allowedOrganizations?: string[];
+    isPublic: boolean;
+    version: number;
+    defaultConfig?: Record<string, unknown>;
+    steps: KycWorkflowStep[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface WorkflowStepDefault {
+    type: KycWorkflowStepType;
+    label: string;
+    description: string;
+    defaultStepId: string;
+    defaultInput: Record<string, unknown>;
+    defaultRules: Record<string, unknown>;
+    defaultLocales: Record<string, Record<string, unknown>>;
+    schema: Record<string, unknown>;
+    skippable: boolean;
+    group: string;
+}
+export type FormFieldType = 'text' | 'long_text' | 'number' | 'currency' | 'country' | 'language' | 'email' | 'phone' | 'date' | 'select' | 'multi_select' | 'dropdown' | 'toggle' | 'boolean' | 'file' | 'heading' | 'paragraph' | 'description' | 'divider';
+export interface FormFieldOption {
+    value: string;
+    label: string;
+}
+export interface FormFieldValidation {
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    pattern?: string;
+    currencyCode?: string;
+    accept?: string[];
+    maxSizeMb?: number;
+}
+export interface FormField {
+    id: string;
+    type: FormFieldType;
+    label: string;
+    placeholder?: string;
+    helpText?: string;
+    required: boolean;
+    defaultValue?: unknown;
+    content?: string;
+    consentText?: string;
+    options?: FormFieldOption[];
+    validation?: FormFieldValidation;
+    dateFormat?: string;
+}
+export interface CreateFormTemplateInput {
+    name: string;
+    description?: string;
+    isPublic?: boolean;
+    allowedOrganizations?: string[];
+    fields: FormField[];
+}
+export type UpdateFormTemplateInput = Partial<CreateFormTemplateInput>;
+export interface FormTemplateListItem {
+    id: string;
+    name: string;
+    description?: string;
+    fieldCount: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface FormTemplate extends FormTemplateListItem {
+    isPublic?: boolean;
+    allowedOrganizations?: string[];
+    fields: FormField[];
+}
+export interface ListFormTemplatesResponse {
+    templates: FormTemplateListItem[];
+    totalCount: number;
+}
+export interface ListFormTemplatesQuery {
+    searchQuery?: string;
+    limit?: number;
+    offset?: number;
+}
 export type DocumentProcessorId = 'INVOICE' | 'SRI_LANKA_ID' | 'SRI_LANKA_FORM1_COMPANY_REGISTRATION' | 'SRI_LANKA_FORM15_ANNUAL_RETURN';
 export type DocumentProcessingInstanceStatus = 'pending' | 'running' | 'completed' | 'failed' | 'error';
 /**
@@ -311,20 +388,12 @@ export type DocumentProcessingInstanceStatus = 'pending' | 'running' | 'complete
  * SRI_LANKA_ID: `name`, `dateOfBirth` (YYYY-MM-DD), `idNumber`, `address`
  */
 export type DocumentProcessingInputData = Record<string, string | number | boolean | null>;
-/**
- * Open key/value bag stored on a document processing instance. Persisted as
- * provided on the input and echoed back on every response shape. Not sent to
- * the AI — useful for syncing with external systems (e.g. customer IDs).
- *
- * Example: `{ externalCustomerId: "testing-123" }`
- */
+/** Open key/value bag stored on the instance; not sent to the AI. */
 export type DocumentProcessingMetadata = Record<string, unknown>;
 export interface InitiateDocumentProcessingInput {
     processorId: DocumentProcessorId;
     files: FileInput[];
-    /** Cross-check context for the AI (per-processor keys; see `DocumentProcessingInputData`). */
     inputData?: DocumentProcessingInputData;
-    /** Arbitrary metadata stored on the instance but not sent to the AI. */
     metadata?: DocumentProcessingMetadata;
     /** Default `true`. Crop document images before validation/extraction. */
     shouldCropImages?: boolean;
@@ -338,11 +407,9 @@ export interface ListDocumentProcessingInstancesQuery {
     offset?: number;
     includeFileUrls?: boolean;
 }
-/** Stage IDs emitted by the standard document processing pipeline. */
 export type DocumentProcessingStageId = 'crop_and_detect_faces' | 'pre_validate_and_extract' | 'post_validation' | (string & {});
 export type DocumentProcessingStageStatus = 'pending' | 'running' | 'success' | 'completed' | 'failed';
 export interface DocumentProcessingFileObject {
-    /** Storage key for the file. */
     key: string;
     filename: string;
     mimeType: string;
@@ -350,21 +417,12 @@ export interface DocumentProcessingFileObject {
     size: number;
     /** Signed URL with ~5-minute expiry. */
     url: string;
-    /** ISO 8601 expiry of `url`. */
     urlExpiresAt?: string;
-    /** ISO 8601 upload timestamp. */
     uploadedAt?: string;
 }
-/**
- * One uploaded source document. The processor cropped each image (when crop
- * is enabled) and ran face detection — both surfaced as separate variants.
- */
 export interface DocumentProcessingFile {
-    /** Reference to the original uploaded file. Always present. */
     original: DocumentProcessingFileObject;
-    /** Reference to the cropped variant. Absent when cropping was skipped. */
     cropped?: DocumentProcessingFileObject;
-    /** Faces detected on the document, one entry per face. */
     detectedFaces?: DocumentProcessingFileObject[];
 }
 export interface DocumentProcessingValidationRule {
@@ -389,10 +447,6 @@ export interface DocumentProcessingExtractedField<T = unknown> {
     originalTextConfidence?: number;
     isOriginalTextHandwritten?: boolean;
 }
-/**
- * Multilingual variant — emitted for fields like `name`, `address`, `placeOfBirth`
- * on documents printed in multiple scripts (e.g. LKA NIC in Sinhala/Tamil/English).
- */
 export interface DocumentProcessingTransliteratedField {
     enTransliterations: Array<{
         transliteratedText: string;
@@ -407,7 +461,6 @@ export interface DocumentProcessingTransliteratedField {
     }>;
 }
 export type DocumentProcessingSchemaField = DocumentProcessingExtractedField | DocumentProcessingTransliteratedField;
-/** Extracted document schema is processor-specific; default to a permissive map. */
 export type DocumentProcessingExtractedSchema = Record<string, DocumentProcessingSchemaField>;
 export interface DocumentProcessingPostProcessingRuleResult {
     id: string;
@@ -436,15 +489,11 @@ export interface DocumentProcessingResult<TSchema extends DocumentProcessingExtr
     validation: DocumentProcessingValidation;
     extraction: DocumentProcessingValidation;
     schema: TSchema;
-    /**
-     * Flattened, English-normalised mirror of `schema`. Keys are processor-specific
-     * (e.g. `name`, `idNumber`, `nicNumber`, `dateOfBirth`, `issuingCountry`).
-     */
+    /** Flattened, English-normalised mirror of `schema`. */
     normalizedData?: Record<string, string | number | null> | null;
     postProcessing: DocumentProcessingPostProcessing;
     stages: DocumentProcessingStageRef[];
 }
-/** Subject (extracted name/identifier) surfaced on the list endpoint. */
 export interface DocumentProcessingInstanceSubject {
     name: string;
     identifier: string;
@@ -456,13 +505,9 @@ export interface DocumentProcessingInstanceSummary {
     subject?: DocumentProcessingInstanceSubject;
     status: DocumentProcessingInstanceStatus;
     statusLabel: string;
-    /** ISO 8601. */
     createdAt: string;
-    /** ISO 8601. */
     updatedAt: string;
-    /** ISO 8601, null while still processing. */
     completedAt: string | null;
-    /** Open key/value bag set at instance creation (e.g. `{ externalCustomerId: "..." }`). */
     metadata?: DocumentProcessingMetadata | null;
 }
 /** Full instance returned by `POST /document-processing` and `GET /document-processing/{id}`. */
@@ -471,15 +516,10 @@ export interface DocumentProcessingInstance<TSchema extends DocumentProcessingEx
     processorId: DocumentProcessorId;
     status: DocumentProcessingInstanceStatus;
     statusLabel: string;
-    /** ISO 8601. */
     createdAt: string;
-    /** ISO 8601. */
     updatedAt: string;
-    /** ISO 8601, null while still processing. */
     completedAt?: string | null;
-    /** Open key/value bag set at instance creation (e.g. `{ externalCustomerId: "..." }`). */
     metadata?: DocumentProcessingMetadata | null;
-    /** Full processing result. Null until processing completes. */
     result: DocumentProcessingResult<TSchema> | null;
     files: DocumentProcessingFile[];
 }
@@ -501,11 +541,6 @@ export interface DocumentProcessingDeleteResponse {
     success: boolean;
     message: string;
 }
-/**
- * Processor descriptor returned by `GET /document-processing/processors`.
- * The exact schema isn't published; we narrow `id` to the known enum and
- * keep additional fields permissive.
- */
 export interface DocumentProcessorTypeDTO {
     id: DocumentProcessorId;
     label?: string;
@@ -520,10 +555,106 @@ export interface DocumentProcessingEvent {
     instanceId: string;
     stageId: DocumentProcessingStageId;
     status: DocumentProcessingStageStatus;
-    /** ISO 8601 timestamp of the stage transition. */
     timestamp?: string;
     error?: string | null;
-    /** Stage-specific payload, mirrors `DocumentProcessingStageData` when present. */
     data?: DocumentProcessingStageData | null;
 }
+/** Media type for uploaded verification artifacts. */
+export type KycMediaType = 'document-front' | 'document-back' | 'liveness-video' | 'random-frame' | 'form-data' | 'signature';
+/** Full session state returned by the customer-facing `GET /api/session/:id`. */
+export interface KycSessionOnboardingState {
+    id: string;
+    status: string;
+    isInvalid: boolean;
+    userProgress: {
+        checkpoint: string;
+    };
+    createdAt: number;
+    expiresAt: number | null;
+    completedAt: number | null;
+    currentUser: string | null;
+    externalReason: string | null;
+    workflowSnapshot: {
+        name: string;
+        defaultConfig?: Record<string, unknown> | null;
+        steps: {
+            stepId: string;
+            type: string;
+        }[];
+    };
+    flowConfig?: Record<string, unknown> | null;
+    stepPreviewData: Record<string, unknown> | null;
+}
+/** Response from `GET /api/session/:id/status` — lightweight polling endpoint. */
+export interface KycSessionStatusResponse {
+    currentUser: string | null;
+    isInvalid: boolean;
+    completedAt: number | null;
+    expiresAt: number | null;
+    status: string;
+    externalReason: string | null;
+}
+/** Response from `GET /api/session/:id/owner`. */
+export interface KycSessionOwnerResponse {
+    currentUser: string | null;
+}
+/** Single telemetry event logged to an attempt. */
+export interface KycAttemptEvent {
+    eventCategory?: string;
+    description?: string;
+    eventTimestamp?: number;
+    currentState?: string;
+}
+/** A media file associated with an attempt. */
+export interface KycAttemptMedia {
+    mediaType: KycMediaType;
+    key: string;
+    filename: string;
+    mimeType: string;
+    /** File size in bytes. */
+    size: number;
+    /** Unix ms when the file was uploaded. */
+    uploadedAt: number;
+    metadata?: Record<string, unknown>;
+}
+/** Full attempt record returned by `createAttempt()` and `appendEvents()`. */
+export interface KycAttemptOutput {
+    id: string;
+    createdAt: number;
+    events: KycAttemptEvent[];
+    media: KycAttemptMedia[];
+    endedAt?: number;
+    browserId: string;
+    linkedId: string;
+    requestId: string;
+}
+/** Input for `DossiersKycSession.uploadMedia()`. */
+export interface KycMediaUploadInput {
+    /** The file to upload (Blob or File). */
+    file: Blob | File;
+    /** Type of media artifact being uploaded. */
+    mediaType: KycMediaType;
+    /** MIME type, e.g. `'image/jpeg'`, `'video/webm'`. */
+    mimeType: string;
+    /** Filename for the uploaded entry. */
+    filename: string;
+    /** Document type selected by the user (document collection steps only). */
+    selectedDocumentTypeId?: string;
+    /** Workflow step ID this upload is associated with. */
+    stepId?: string;
+    /** Additional capture-quality metadata (e.g. liveness scores). */
+    metadata?: Record<string, unknown>;
+}
+/** Response from `POST /api/session/:id/aadhaar/generate-otp`. */
+export interface AadhaarOtpResponse {
+    referenceId: string;
+    message: string;
+}
+/** Response from `POST /api/session/:id/aadhaar/verify-otp`. */
+export interface AadhaarVerifyResponse {
+    status: string;
+    name: string;
+    gender: string;
+    dateOfBirth: string;
+}
 //# sourceMappingURL=api.d.ts.map