TypeScript

Call the Dojah REST API from Node.js / TypeScript with the typed Dojah client.

This is a server-side client using your secret key (passed as Authorization) — never ship it in client code. For verification UI in an app, use a Widget SDK.

Install

Terminal

npm install dojah-typescript-sdk

Make a request

verify.ts

import { Dojah } from "dojah-typescript-sdk"

const dojah = new Dojah({
  authorization: process.env.DOJAH_SECRET_KEY,
  appId: process.env.DOJAH_APP_ID,
})

const result = await dojah.aml.screenAml({
  first_name: "David",
  last_name: "Ukpo",
  date_of_birth: "12-10-2000",
})

Screening itself is POST /api/v2/aml/screening. Set schema to "individual" or "organization"; the matches come back on that response. Published SDK releases still send screenAml to the older platform route. Every endpoint in the API reference is exposed on the client, grouped by API.

Get started

Core concepts

API Endpoints

Widget SDKs

API clients

Install

Make a request

​Install

​Make a request

Install

Make a request