Create a user
How to create a new user.
Request Endpoint: reference
POST /api/users
Parameter | Param Type | Description | Data Type | Mandatory |
---|---|---|---|---|
reference | Body | A free-form text to specify a reference for the user you create. It can help group specific users. | String | ❌ |
signingMethod | Body | This object has information about the signing method type and its value. | Object | ❌ |
signingMethod.type | Body | The type of signing method to create for this user. Allowed values: PIN, BIOMETRIC, EMERGENCY_CODE | String | ❌ |
signingMethod.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 | ❌ |
Request Body:
{
"reference": "Test User",
"signingMethod": {
"type": "PIN",
"value": "123456"
}
}
Response Body:
- User ID: This is the
result.id
param.- Signing Method ID: This is the
result.signingMethods.id
param.
{
"success": true,
"result": {
"id": "6a5a9020-e969-4d9a-ae4b-fcd91a75769d",
"reference": "Test User",
"createdAt": "2023-12-06T12:11:12.702586449",
"signingMethods": [
{
"id": "48ba3bbb-cd2a-47f8-87d7-9fa812e0470a",
"type": "PIN",
"incorrectAttempts": 0,
"remainingAttempts": 10,
"hasMasterSecret": true
}
]
}
}
Updated 5 months ago