@onfido/api

Node.js library for the Onfido API

Usage no npm install needed!

<script type="module">
  import onfidoApi from 'https://cdn.skypack.dev/@onfido/api';
</script>

README

Onfido Node.js Library

The official Node.js library for integrating with the Onfido API.

Documentation can be found at https://documentation.onfido.com

This library is only for use on the backend, as it uses Onfido API tokens which must be kept secret. If you do need to collect applicant data in the frontend of your application, we recommend that you use one of the Onfido SDKs.

This version uses Onfido API v3.2. Refer to our API versioning guide for details of which client library versions use which versions of the API.

Installation

For npm:

npm install @onfido/api

For Yarn:

yarn add @onfido/api

Getting started

Require the package:

const { Onfido, Region } = require("@onfido/api");

For TypeScript users, types are available as well:

import { Onfido, Region, Applicant, OnfidoApiError } from "@onfido/api";

Configure with your API token and region:

const onfido = new Onfido({
  apiToken: process.env.ONFIDO_API_TOKEN,
  // Supports Region.EU, Region.US and Region.CA
  region: Region.EU
});

Using with async/await (in an async function):

try {
  const applicant = await onfido.applicant.create({
    firstName: "Jane",
    lastName: "Doe"
  });

  const check = await onfido.check.create({
    applicantId: applicant.id,
    reportNames: ["identity_enhanced"]
  });

  return check;
} catch (error) {
  if (error instanceof OnfidoApiError) {
    // An error response was received from the Onfido API, extra info is available.
    console.log(error.message);
    console.log(error.type);
    console.log(error.isClientError());
  } else {
    // No response was received for some reason e.g. a network error.
    console.log(error.message);
  }
}

Using with promises:

onfido.applicant
  .create({
    firstName: "Jane",
    lastName: "Doe"
  })
  .then(applicant =>
    onfido.check.create({
      applicantId: applicant.id,
      reportNames: ["identity_enhanced"]
    })
  )
  .then(check =>
    // Handle successfully created check.
  )
  .catch(error => {
    // Handle error.
  });

Response format

Most responses will be normal JavaScript objects. Property names will be in camelCase rather than snake_case, including property names in nested objects.

const applicant = await onfido.applicant.create({
  firstName: "Jane",
  lastName: "Doe",
  address: {
    flatNumber: "12",
    postcode: "S2 2DF",
    country: "GBR",
  }
});

console.log(applicant);
{
  id: "<APPLICANT_ID>",
  createdAt: "2020-01-22T10:44:01Z",
  firstName: "Jane",
  lastName: "Doe",
  email: null,
  dob: null,
  deleteAt: null,
  href: "/v3/applicants/<APPLICANT_ID>",
  address: {
    flatNumber: "12",
    buildingNumber: null,
    buildingName: null,
    street: null,
    subStreet: null,
    town: null,
    state: null,
    postcode: "S2 2DF",
    country: "GBR",
    line1: null,
    line2: null,
    line3: null
  },
  idNumbers: []
}

File downloads, for example onfido.document.download(documentId), will return instances of OnfidoDownload.

These objects will have a content type, e.g. image/png.

download.contentType;

Call asStream() to get a Readable stream of the download. You can read more about Readable streams.

const readableStream = download.asStream();

File upload

For some common types of streams, like instances of fs.ReadStream, you can provide the stream directly in the file property:

onfido.document.upload({
  applicantId: "<APPLICANT_ID>",
  file: fs.createReadStream("path/to/passport.png"),
  type: "passport"
});

Alternatively, you may need to provide some extra information, for example when uploading a Base64 encoded image:

const buffer = Buffer.from(base64Data, "base64");
const bufferStream = new PassThrough();
bufferStream.end(buffer);

onfido.document.upload({
  applicantId: "<APPLICANT_ID>",
  file: {
    contents: bufferStream,
    filepath: "image.png",
    contentType: "image/png"
  },
  type: "passport"
});

More documentation

More documentation and code examples can be found at https://documentation.onfido.com