@verifiquemos/sdk

Official TypeScript SDK for the Verifiquemos compliance API.

KYC, RENAP, OFAC, ONU, Lista Engel, PEP, CPE — for Guatemala-specific compliance, in one API call.

Requirements

• Node.js >= 20
• ESM and CommonJS both supported (the package ships dual import / require entry points and .d.ts types)

Install

npm install @verifiquemos/sdk

Quickstart

import { VerifiquemosClient } from "@verifiquemos/sdk";

const client = new VerifiquemosClient({
  apiKey: process.env.VERIFIQUEMOS_API_KEY!,
});

// Submit a validation.
// cui is NOT a parameter — it is extracted from the DPI via OCR.
const created = await client.validations.create({
  naturalezaCliente: "individual",
  doesInternationalTransfers: false,
  dpiFile: dpiBlob, // Blob of the DPI image
});

// Poll until done
let result;
while (true) {
  result = await client.validations.get(created.id);
  if (result?.status === "completed") break;
  await new Promise((r) => setTimeout(r, 3000));
}

// Download the PDF report
const pdf = await client.validations.report(created.id);

Error handling

import { ApiError, RateLimitError, NetworkError } from "@verifiquemos/sdk";

try {
  await client.validations.create({ ... });
} catch (e) {
  if (e instanceof RateLimitError) {
    console.log(`Retry after ${e.retryAfterSeconds}s`);
  } else if (e instanceof ApiError && e.isPaymentRequired()) {
    console.log("Buy more credits");
  } else if (e instanceof NetworkError) {
    console.log("Connection failed");
  } else {
    throw e;
  }
}

Configuration

| Option | Default | Description | |---|---|---| | apiKey | (required) | Server-issued API key from your dashboard. Starts with vfq_. | | baseUrl | https://api.verifiquemos.com | Override for staging/dev. | | fetch | globalThis.fetch | Inject your own (useful for testing). | | idempotencyKeyFactory | ULID generator | Override the Idempotency-Key strategy. |

Versioning

The SDK follows semver. Major version bumps mirror major API contract changes; minor bumps add SDK methods or non-breaking API surface; patches are bugfixes.

Documentation

• API reference: https://api.verifiquemos.com/scalar
• Developer portal: https://verifiquemos.com/developers
• Runnable examples: examples/
• Release notes: CHANGELOG.md

Support

• Email: [email protected]

Development

cd verifiquemos-sdk-typescript
npm install
npm test             # vitest (mock fetch in-memory)
npm run lint         # eslint 10 (flat config; ignora src/generated.ts)
npm run typecheck    # tsc --noEmit
npm run build        # tsup → dist/ (ESM .js + CJS .cjs + .d.ts)

# src/generated.ts se genera desde el OpenAPI del API. No editarlo a mano;
# regenerar tras cambios de contrato (requiere el repo hermano ../verifiquemos-api):
npm run regen-types  # lee ../verifiquemos-api/openapi.json

El hook prepublishOnly corre lint + typecheck + test + build antes de cada npm publish, asi que las publicaciones fallan rapido si alguno falla.

Publicacion a npm: el push de un tag git v<version> dispara el pipeline (npm publish --access public). Ver CHANGELOG.md.

License

MIT