Skip to content
Guide & API

Create a Session

POST
https://api.facefile.co/identity/sessions

Creates a Session object. After the Session is created, display FaceSign app to a user using the session clientSecret.

Headers

  • Authorization: Bearer *your_api_key*
  • Content-Type: application/json

Body Params

Pass attributes of SessionSettings into the request body.

Response

NodeJS Sample

import FaceSignClient, { SessionSettings } from '@facesignai/api'
 
const fApi = new FaceSignClient({
  auth: 'your_api_key'
})
 
const sessionSettings: SessionSettings = {
  clientReferenceId: 'someClientId',
  metadata: {},
  requestedData: [
    {
      key: 'userName',
      isRequired: true,
      description: 'The user full name'
    },
    {
      key: 'birthday',
      isRequired: true,
      description: 'The user birthday'
    }
  ]
}
 
const { clientSecret, session } = await fApi.session.create(sessionSettings)