Skip to content

Getting Started

Quick start

Create a minimal verification case and confirm read/write path against the FinCheckers API.

  • Getting Started
  • 1 min read

Goal

In under an hour you should:

  1. Authenticate against your tenant
  2. Create one verification case with a document submission
  3. Read it back with decision-review fields present

1. Authenticate

import { FinCheckersClient } from '@fincheckers/sdk'

const client = new FinCheckersClient({
  baseUrl: process.env.FINCHECKERS_API_BASE_URL!,
  tenantId: process.env.FINCHECKERS_TENANT_ID!,
  token: process.env.FINCHECKERS_API_TOKEN!,
})

const session = await client.auth.verify()
console.log(session.tenantId, session.scopes)

2. Create a verification case

const verificationCase = await client.cases.create({
  type: 'income',
  subjectRef: 'applicant_sample_001',
  sources: ['document', 'employer_attestation'],
})

Use verification types and source values configured for your tenant. See Verification concepts.

3. Attach a document and read review context

await client.cases.attachDocument(verificationCase.id, {
  kind: 'pay_stub',
  contentType: 'application/pdf',
  // Upload handle returned by your storage step — shape is tenant-specific.
  uploadId: 'upload_sample_001',
})

const detail = await client.cases.get(verificationCase.id, {
  include: ['documents', 'findings', 'review'],
})

console.log(detail.status, detail.review)

If review is empty, confirm the case has completed document processing and that your token includes the cases:read scope.

4. Clean up (evaluation tenants)

await client.cases.archive(verificationCase.id)

Related reading