Create a security key

This endpoint enables you to create a security key for your account, which allows you to use services like encryption to our transcript API.

How to use

You can use the following cURL to obtain a response from this endpoint:

curl --location --request POST https://nodeapi.superviz.com/security \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "passphrase": "YOUR PASSPHRASE",
    }'

HTTP Request

POST https://nodeapi.superviz.com/participants

Headers

When using this endpoint, you need to provide the Authorization Bearer token.

Name	Description
Authorization	Required. You must utilize the authentication token.

Request Body

When sending a request, include the following fields in JSON format:

Name	Type	Description
passphrase	string	Required. The passphrase you want to use to encrypt your security key. It is recommended to have from 8 to 64 characters, containing uppercase and lowercase letters, numbers, and special characters.

warning

Make sure to store your passphrase in a secure location. If you lose your passphrase, you will not be able to retrieve your security keys again.

Response

If the request is successful, you will receive a 200 status code response with the following fields in the body:

Name	Type	Description
passphrase	string	The passphrase you used to encrypt your security key.
publicKey	string	The public key that you can use to encrypt your data.
privateKey	string	The private key that you can use to decrypt your data.
secretKey	string	The 128 randomly selected English words. This key functions as a password to manage and recover data in the event of passphrase loss.