Signature

Required Class: Signature Class

Generating a Signature

Smile ID requires you to send a unique signature and timestamp with every job you run. Although running jobs using any of our libraries will automatically calculate the signature, there might be instances you want to run a job using our REST API or generate signatures. In such instances you can use the sample code below to calculate a signature:

const smileIdentityCore = require("smile-identity-core");
const Signature = smileIdentityCore.Signature;

// Initialize
partner_id = '<Put your partner ID here>'; // login to the Smile ID portal to view your partner id
api_key = '<Put your base64 encoded API key here>'; // copy your API key from the Smile ID portal

connection = new Signature(partner_id, api_key);

// Generate the Signature
generated_signature = connection.generate_signature('<put your custom timestamp>') // where timestamp is optional

Response

The response will be a hash:

{
  "signature": "<the generated signature>",
  "timestamp": "2023-12-17T01:41:13.845Z"
}

Confirming an Incoming Signature

To ensure the response you receive from your callback is actually from Smile ID, you can confirm the returned signature and timestamp. You can use the sample code below to confirm the signature:

const smileIdentityCore = require("smile-identity-core");
const Signature = smileIdentityCore.Signature;

// Initialize
partner_id = '<Put your partner ID here>'; // login to the Smile ID portal to view your partner id
api_key = '<Put your API key here>'; // copy your API key from the Smile ID portal

connection = new Signature(partner_id, api_key);

// Confirm a signature
signature = connection.confirm_signature('<put the received timestamp>','<put the received signature>') 

Response

The response will be a boolean

true or false