Documents

Documents store identification and verification files for clients.

Creating Document Records

Documents are created in two steps: create the record, then upload the file.

import { DocumentCategory } from "@artu-ai/compliance-sdk";

const doc = await sdk.documents.create({
  clientId: "client_abc123",
  scope: "MX",
  type: "ine_front",
  category: DocumentCategory.Identity,
});

console.log(doc.id);
console.log(doc.status); // "pending_upload"

Document Categories

Category	Description
`Identity`	Identity documents (INE, passport)
`Address`	Proof of address
`Financial`	Financial statements, tax records
`Legal`	Legal documents (powers of attorney, articles)
`Other`	Other document types

Document Types

Mexico

Type	Enum	Description
`ine_front`	`MexDocumentType.IneFront`	INE (voter ID) front
`ine_back`	`MexDocumentType.IneBack`	INE (voter ID) back
`passport`	`MexDocumentType.Passport`	Passport
`curp`	`MexDocumentType.Curp`	CURP document
`rfc_constancia`	`MexDocumentType.RfcConstancia`	RFC certificate
`declaracion_anual`	`MexDocumentType.DeclaracionAnual`	Annual tax declaration
`address_proof`	`MexDocumentType.AddressProof`	Proof of address
`acta_constitutiva`	`MexDocumentType.ActaConstitutiva`	Articles of incorporation
`poder_notarial`	`MexDocumentType.PoderNotarial`	Power of attorney
`other`	`MexDocumentType.Other`	Other document type

import { MexDocumentType } from "@artu-ai/shared";

const doc = await sdk.documents.create({
  clientId: "client_abc123",
  scope: "MX",
  type: MexDocumentType.IneFront,
  category: DocumentCategory.Identity,
});

Retrieving Documents

const doc = await sdk.documents.retrieve("doc_xyz789");

console.log(doc.id);
console.log(doc.type);
console.log(doc.status);
console.log(doc.isAvailable);

Need to search by your own IDs or metadata? Use retrieveByExternalId or retrieveByMetadata (see SDK reference).

Updating Documents

const updated = await sdk.documents.update("doc_xyz789", {
  expiresAt: new Date("2030-01-01"),
  metadata: {
    verified: true,
    verifiedBy: "admin@example.com",
  },
});

Listing Documents

All Documents

const { data } = await sdk.documents.list({
  limit: 50,
});

By Client

const { data } = await sdk.documents.listByClient("client_abc123");

By Type

const { data } = await sdk.documents.list({
  filter: {
    clientId: "client_abc123",
    type: "ine_front",
  },
});

Async Iterator

for await (const doc of sdk.documents.iterate()) {
  console.log(doc.id, doc.type);
}

Document Status

Status	Description
`pending_upload`	Record created, awaiting file upload
`processing`	File uploaded, being processed
`available`	Document is available
`failed`	Processing failed
`expired`	Document has expired

Checking Document Existence

// Check if a specific document type exists for a client
const hasINE = await sdk.documents.hasDocumentType(
  "client_abc123",
  "ine_front",
);

if (!hasINE) {
  console.log("Client needs to upload INE front");
}

Counting Documents

const count = await sdk.documents.countByClient("client_abc123");
console.log(`Client has ${count} documents`);

Deleting Documents

await sdk.documents.delete("doc_xyz789");

Document Model Properties

Property	Type	Description
`id`	`string`	Unique identifier
`clientId`	`string`	Parent client ID
`type`	`string`	Document type
`category`	`DocumentCategory`	Document category
`scope`	`string`	Scope code
`status`	`DocumentStatus`	Current status
`isAvailable`	`boolean`	True if available
`filename`	`string \| undefined`	Original filename
`mimeType`	`string \| undefined`	File MIME type
`size`	`number \| undefined`	File size in bytes
`expiresAt`	`Date \| undefined`	Expiration date
`metadata`	`object \| undefined`	Custom metadata
`createdAt`	`Date`	Creation timestamp
`updatedAt`	`Date`	Last update timestamp

Batch Operations

Create multiple document records:

const result = await sdk.documents.createMany([
  { clientId, type: "ine_front", category: DocumentCategory.Identity, ... },
  { clientId, type: "ine_back", category: DocumentCategory.Identity, ... },
]);

Mexico Document Fields

Mexico documents can include extracted field data:

import { isIneFront, isRfcConstancia } from "@artu-ai/compliance-sdk/mx";

const doc = await sdk.documents.retrieve("doc_xyz789");

if (isIneFront(doc)) {
  // Access INE-specific fields
  console.log(doc.fields.cic);
  console.log(doc.fields.ocr);
  console.log(doc.fields.claveElector);
  console.log(doc.fields.seccion);
}

if (isRfcConstancia(doc)) {
  // Access RFC constancia fields
  console.log(doc.fields.rfc);
  console.log(doc.fields.regimenFiscal);
}

See Mexico Scope for all document type guards.

Getting Started

Core Resources

Patterns

Concepts

Creating Document Records

Document Categories

Document Types

Retrieving Documents

Updating Documents

Listing Documents

All Documents

By Client

By Type

Async Iterator

Document Status

Checking Document Existence

Counting Documents

Deleting Documents

Document Model Properties

Batch Operations

Mexico Document Fields

​Creating Document Records

​Document Categories

​Document Types

​Retrieving Documents

​Updating Documents

​Listing Documents

​All Documents

​By Client

​By Type

​Async Iterator

​Document Status

​Checking Document Existence

​Counting Documents

​Deleting Documents

​Document Model Properties

​Batch Operations

​Mexico Document Fields

Creating Document Records

Document Categories

Document Types

Retrieving Documents

Updating Documents

Listing Documents

All Documents

By Client

By Type

Async Iterator

Document Status

Checking Document Existence

Counting Documents

Deleting Documents

Document Model Properties

Batch Operations

Mexico Document Fields