Palm Biometrics & Verification Webhooks

{
      "version": 1,
      "data": {
        "userId": "123",
        "action": "terminal-action",
        "idempotencyKey": "d5062447-a2b7-4783-9f94-ddd62ca75ea1",
        "authorizedAt": "2024-06-24T21:11:32.339Z",
        "state": "CHALLENGE_SUCCEEDED",
        "verificationMethod": "PALM_BIOMETRICS_RR",
        "custom" : {
          "mode": "ENROLLMENT",
          ....
        },
      },
      "type: "action.verified"
  }

{
	"isVerified": true,
	"message": "A custom success message",
	"error": "A custom error message"
}

Every palm biometric enrollment and re-authentication/verification flow delegates decisions to the configured webhook API end-point, this is where custom business logic and messages can be handled and returned as a response.

Standard Authsignal webhook verification should be considered. For more info, take a look at our webhook docs

Webhooks request event schema

string

The userId of the user performing the action

string

The action code being performed

string

A unique key representing the action

string

The time at which the user were authorized at in ISO 8601 format.

string

The outcome of the verification

string

The method of verification

object

Always has a mode attribute which determines the mode of the terminal. Values can be ENROLLMENT | ACCESS | PAYMENT

Show attributes

Additional data points, differs per scenario.Enrollment mode:

{
  "mode": "ENROLLMENT"
}

Access mode:

{
  "mode": "ACCESS"
}

Payment mode:

{
  "mode": "PAYMENT",
  "amount": "1.20",
  "currency": "NZD"
}

{
      "version": 1,
      "data": {
        "userId": "123",
        "action": "terminal-action",
        "idempotencyKey": "d5062447-a2b7-4783-9f94-ddd62ca75ea1",
        "authorizedAt": "2024-06-24T21:11:32.339Z",
        "state": "CHALLENGE_SUCCEEDED",
        "verificationMethod": "PALM_BIOMETRICS_RR",
        "custom" : {
          "mode": "ENROLLMENT",
          ....
        },
      },
      "type: "action.verified"
  }

Note that a single terminal can perform registrations, access, and payment flows which will all occur through the same action and therefore the same webhook.

Webhooks response schema

{
	"isVerified": true,
	"message": "A custom success message",
	"error": "A custom error message"
}

boolean

required

Specifies if the webhook successfully verifies the user action after applying custom logic.

string

A message that is displayed on the terminal after successful verification.

string

A message that is displayed on the terminal after unsuccessful verification.

⌘I

{
      "version": 1,
      "data": {
        "userId": "123",
        "action": "terminal-action",
        "idempotencyKey": "d5062447-a2b7-4783-9f94-ddd62ca75ea1",
        "authorizedAt": "2024-06-24T21:11:32.339Z",
        "state": "CHALLENGE_SUCCEEDED",
        "verificationMethod": "PALM_BIOMETRICS_RR",
        "custom" : {
          "mode": "ENROLLMENT",
          ....
        },
      },
      "type: "action.verified"
  }

{
	"isVerified": true,
	"message": "A custom success message",
	"error": "A custom error message"
}

Getting started

Integrations

Authentication methods

Implementation options

Actions & rules

Users

Advanced usage

Palm Biometrics & Verification Webhooks

Webhooks request event schema

Webhooks response schema

​Webhooks request event schema

​Webhooks response schema

Webhooks request event schema

Webhooks response schema