Enclave Installation & Execution
Setting up the environment of the enclave server provided by VerifyVASP.
System Requirements
Structure of the system/infrastructure
Enclave Server
CPU: Minimum 2G, 4G recommended
Memory: Minimum 2G, 4G recommended
Storage: Minimum 8G, 16G recommended (including the docker and container)
Installing Enclave Server
Download enclave docker image
Enclave docker image is in Private Registry. You can acquire access by delivering a Docker Hub Credential ID to the admin.
A VASP can download a Docker image by first requesting access from VV admin manager (corporate@verifyvasp.com).
VASPs would require
VASP’s Docker Hub credential (ID)to provide access. Once access is granted, they can follow the instruction.Download
Enclave Server Environment Variable
| Environment Variable | Default | Description |
|---|---|---|
VEGA_SERVER_PORT | 21117 | Port no. of the enclave server. |
VEGA_ENCLAVE_PUBLIC_ENDPOINT | Public endpoint URL of the enclave server accessible from VV central server. Must use HTTPS protocol. e.g. “https://api.vasp.com/enclave” | |
VEGA_ALLIANCE_ACCESS_KEY | accessKey part of the API-Key | |
VEGA_ALLIANCE_SECRET_KEY | secretKey part of the API-Key | |
VEGA_DATABASE_CLIENT | mysql2 | A type of database. An appropriate value for a database client is to be entered. pg, mysql, mysql2, oracledb, mssql values can be used. |
VEGA_DATABASE_USERNAME | Database user name | |
VEGA_DATABASE_PASSWORD | Database password | |
VEGA_DATABASE_HOST | Address to access database | |
VEGA_DATABASE_PORT | 3306 | Port number to access database |
VEGA_DATABASE_DB | verifyvasp | Database name that enclave server uses |
VEGA_DATABASE_SEARCH_PATH | enclave | Custom schema name for PostgreSQL |
VEGA_DATABASE_POOL_MIN | 0 | Minimum value of database connection pool |
VEGA_DATABASE_POOL_MAX | 5 | Maximum value of database connection pool |
VEGA_VERIFICATION_API_PATH | User verification API endpoint URL. | |
VEGA_VERIFICATION_ACCOUNT_API_PATH | User account (wallet address and owner name) verification API Endpoint URL. | |
VEGA_VERIFICATION_TRANSACTION_API_PATH | API Endpoint URL to check the status of the transaction process. | |
VEGA_VERIFICATION_CALLBACK_API_PATH | Callback API Endpoint URL to receive the result of asynchronous request. | |
VEGA_VERIFICATION_AUTHORIZATION_TOKEN | Verification token to call API with VASP backend. When the enclave server calls API with the VASP backend, verification taken is delivered to the header of VASP | |
VEGA_VERIFICATION_AUTHORIZATION_KEY | Header key value to pass the authentication token when making API calls to the VASP backend. If not set, the authentication token is passed through the | |
VEGA_API_ENDPOINT | VerifyVASP central API server address. As mentioned above, one of the two environments could be used depending on the purpose. In a production environment, register through | |
VEGA_LOG_LEVEL | info | You can determine the log level of the enclave server. none, error, warn, info, debug values can be used. |
VEGA_PUBLIC_KEY_TTL | 1800000 | The duration to cache the public key of the other VASP which will be used for E2EE can be set up. The unit must be milliseconds. |
VEGA_ENCRYPTION_KEY_BASE64 | Encryption key to be used to encrypt personal information. Unless the VEGA_DECRYPT_API_ENDPOINT below is entered, the environment value set up in VEGA_ENCRYPTION_KEY_BASE64 will be used as an encryption key of the database (Not Recommended). If the VEGA_DECRYPT_API_ENDPOINT is set up, the environment value set up in VEGA_ENCRYPTION_KEY_BASE64 will be set up as an inputKey of the request body. Then, the outputKey as a response to calling the API issued is used as an encryption key. | |
VEGA_DECRYPT_API_ENDPOINT | The outside service endpoint to decrypt the encryption key set up in VEGA_ENCRYPTION_KEY_BASE64 once again. It is set up to use the outside service relevant to encryption, such as HSM. | |
VEGA_CHAINALYSIS_SANCTION_API_KEY | If you want to screen the other party's wallet address using the Chainalysis sanction API integration feature, set the Chainalysis Sanction API Key. | |
VEGA_CHAINALYSIS_KYT_API_KEY | If you want to use the Chainalysis KYT API integration to perform a risk assessment of the other party's wallet address or transfer transaction, set the Chainalysis KYT API Key. | |
VEGA_REFINITIV_WCO_API_KEY | If you want to use the Refinitiv World Check One API integration to perform risk assessments of the other party's user, set up a Refinitiv World Check One API Key. | |
VEGA_REFINITIV_WCO_API_SECRET | If you want to use the Refinitiv World Check One API integration to perform risk assessments of the other party's user, set the secret issued with the Refinitiv World Check One API Key | |
VEGA_REFINITIV_WCO_GROUP_ID | If you want to use the Refinitiv World Check One API integration to perform risk assessments of the other party's user, set the group ID created in the Refinitiv console sit. All screening cases performed through the integration belong to this group. |
How to Run Enclave
How to Run by Writing an Environment Value on a File
Run by writing an environment value on a file. (e.g. stg_env)
Run
How to Run by Entering an Environment Value as Command
Enclave Server Activation
Activate Enclave Server and Check
How to check if the enclave server is successfully activated
On the docker log, a message like “Listening port at 21117,” which means that it is listening through the port number previously set up, must be shown.
(However, an error log must not follow.)
Enclave Server Health Check
GET request via <enclave endpoint>/healthcheck.
In the VV central server, the health of each VASP enclave server is regularly (every 5-10 sec) checked.
Enclave Server Reactivation
If the Enclave docker stops, it should be reactivated.
Or if the logs as follows are shown in the Enclave docker log, it should be reactivated.
“Unhandled Rejection detect: <error message>”
“Uncaught Exception detect: <error message>”
Last updated
