PalmID Server API Definitions

SESSION_ID API

App Server requests a session_id from the PalmId Server.

URL:

https://api2.palmid.com/saas/session/get_id

Method:

GET

Header:

Field	Value	Description
pms-project-id	PROJECT_ID	The project id used to group the users
Authorization	Bearer PMS_API_KEY	The api key used to authenticated with PalmId PMS server

Content-Type:

application/json

Response Example:

{
  sessionId: "a52bbf7264f2e711888321636532faf9"
}

REGISTRATION API

URL:

https://api2.palmid.com/saas/users

Method:

POST

Header:

Field	Value	Description
pms-project-id	PROJECT_ID	The project id used to group the users
Authorization	Bearer PMS_API_KEY	The api key used to authenticated with PalmId PMS server

Body Example:

{
  "palms": [
    {
      "palmModel": "string",
      "metadata": "string",
      "verifyPalmModels": [
        "string"
      ]
    },
    {
      "palmImage": "string",
      "metadata": "string",
      "verifyPalmImages": [
        "string",
        {
          "rgb": "string",
          "ir": "string"
        }
      ]
    }
  ],
  "allowDuplicates": true,
  "duplicateMatchMode": "rgb",
  "duplicateScoreThreshold": 0.55,
  "verifyScoreThreshold": 0.6,
  "verifyMatchMode": "rgb",
  "nonce": "string"
}

Content-Type:

application/json

Response Example:

{
  "id": "string",
  "palms": [
    {
      "id": "string",
      "metadata": "string"
    }
  ]
}

409 Duplicate Example:

{
  "code": "PalmModelDuplicateFound",
  "duplicateId": "string",
  "score": 0,
  "message": "string"
}

VERIFICATION API

Verify the user with the palm.

URL:

https://api2.palmid.com/saas/user/user_id /verify

Method:

POST

Header:

Field	Value	Description
pms-project-id	PROJECT_ID	The project id used to group the users
Authorization	Bearer PMS_API_KEY	The api key used to authenticated with PalmId PMS server

Body Example:

{
  "palmModel": "string",
  "matchMode": "rgb",
  "scoreThreshold": 0.5,
  "updateModel": true,
  "nonce": "string"
}

Content-Type:

application/json

Response Example:

{
  "id": "string",
  "score": 0,
  "is_match": true,
  "palms": [
    {
      "id": "string",
      "score": 0,
      "is_match": true,
      "is_updated": true
    }
  ]
}

VERIFY API

App Server requests the PalmID Server to validate the session_id and json result received by the PalmID SDK. The session_id has to be a valid and non-expired id issued by PalmID Server before. The json result can be of two types: registration and verification. Each of them contains different fields.

URL:

https://api2.palmid.com/saas/session/verify

Method:

POST

Header:

Field	Value	Description
pms-project-id	PROJECT_ID	The project id used to group the users
Authorization	Bearer PMS_API_KEY	The api key used to authenticated with PalmId PMS server

Body Example:

{
  sessionId: "a52bbf7264f2e711888321636532faf9"
}

Content-Type:

application/json

Registration Response Example:

{
  "resultCode": 0,
  "result": {
    "id": "string",
    "palms": [
      {
        "id": "string",
        "metadata": "string"
      }
    ]
  }
}

Registration Duplicate Response Example:

{
  "resultCode": 0,
  "result": {
    "code": "PalmModelDuplicateFound",
    "duplicateId": "string",
    "score": 0,
    "message": "string"
  }
}

Verification Response Example:

{
  "resultCode": 0,
  "result": {
    "id": "string",
    "score": 0,
    "is_match": true,
    "palms": [
      {
        "id": "string",
        "score": 0,
        "is_match": true,
        "is_updated": true
      }
    ]
  }
}

13 August 2025