Update a signing method
How to update your user's signing method.
We allow three singing methods: PIN, Emergency code, Biometric, and PASSWORD. You can update the signing method of a user by providing a valid signing method in the header request.
Request Endpoint: reference
PUT /api/users/{userId}/signing-methods/{signingMethodId}
Parameter | Param Type | Value | Description | Example Value |
---|---|---|---|---|
Signing-Method | Header | id:value | id : This is the ID of the signing methodvalue : This is the value of the signing method | 756ae7a7-3713-43ee-9936-0dff50306488:123456 |
Parameter | Param Type | Description | Data Type | Mandatory |
---|---|---|---|---|
{userId} | Path | The ID of the user for whom to update the signing method for | String | ✅ |
{signingMethodId} | Path | This is the ID of the signing method you want to update | String | ✅ |
value | Body | The new 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 | ❌ |
Request Body:
{
"value": "987654"
}
Response Body:
The signing method was updated successfully.
{
"success": true,
"result": {
"id": "f3371883-2024-469b-a122-ca22f58ba6b9",
"type": "PIN",
"incorrectAttempts": 0,
"remainingAttempts": 10,
"lastUsedSuccess": "2023-12-06T12:45:32.018063",
"hasMasterSecret": true
}
}
Updated 12 days ago