Create user's signing method

How to create signing methods for your users.

Request Endpoint: reference

POST /api/users/{userId}/signing-methods

Parameter	Param Type	Description	Data Type	Mandatory
`{userId}`	Path	The ID of the user for whom to create the signing method for	String	✅
`type`	Body	The type of signing method to create for this user. Allowed values: `PIN, BIOMETRIC, EMERGENCY_CODE`	String	✅
`value`	Body	The value of the signing method. For `PIN`, the value should be 6 digits. For `EMERGENCY_CODE`, the value should be 25 characters, or you can leave it blank to autogenerate the code with the correct entropy.	String	❌
`physicalDeviceId`	Body	A unique authentication ID, such as FaceID, TouchID, etc. This is to be set with the type: `BIOMETRIC`.	String	❌

Request Body:

{
  "type": "PIN",
  "value": "123456"
}

Response Body:

📘

Signing Method ID: This is the result.id param.

{
    "success": true,
    "result": {
        "id": "f3371883-2024-469b-a122-ca22f58ba6b9",
        "type": "PIN",
        "incorrectAttempts": 0,
        "remainingAttempts": 10,
        "hasMasterSecret": true
    }
}

Updated 5 months ago