Evidence

People are a core part of the Checkmate system - the very reason Checkmate exists is so you can securely view, share and edit personal identity documents. On this page, we'll dive into the fields available on the Person model and how you can use them to create entities programatically.

The evidence model

The person model contains all the information about an individual, such as their legal identity, address, contact information and bank accounts. Each structure is individually encrypted, allowing fine-grained access and sharing. Many of the fields applicable to people are also applicable to companies, (e.g bank accounts). For details on these models you can refer to their individual docs.

Document properties

Creating evidence from a document

Create a new evidence record for a file in memory. This method automatically generates metadata attributes, but won't upload the file. Uploading is handled automatically when a claim using this evidence is encrypted and uploaded.

import { Evidence, DocumentType } from '@checkmateid/sdk'

const passport = await Evidence.Document.create({
  file,
  type: DocumentType.Passport,
  details: {
    documentNumber: '12345678',
    issuanceDate: '2010-01-01',
    expirationDate: '2017-01-01',
  }
})

Updating evidence document

You can update the file by calling update(), which supports the same options and will merge detail changes. This calculates the new file metadata and stages the changes for the next time the entity is saved.

await passport.update({
  file: newFile,
  details: {
    documentNumber: '87654321',
    issuanceDate: '2017-01-01',
    expirationDate: '2024-01-01',
  }
})

Document.create()

import { Evidence, DocumentType } from '@checkmateid/sdk'

const passport = await Evidence.Document.create({
  file,
  type: DocumentType.Passport,
  details: {
    documentNumber: '12345678',
    issuanceDate: '2010-01-01',
    expirationDate: '2017-01-01',
  }
})