SumSub KYC Plugin - Deployment Instructions

Owned by Vladislav Pavlov
Last updated: Nov 12, 2024 by Denys Tun
3 min read

SumSub in Marionette Overview

Marionette is integrated with SubSub KYC & KYB Service. This plugin allows Marionette operators to seamlessly integrate with their SumSub accounts and automate KYC processing. SumSub KYC enhances the internal KYC process built into Marionette.

Instructions:

To deploy a SumSub KYC Plugin in Marionette a in the system, add this code to the specified files and replace the secret keys with your own. The secret keys you would configure in the Sum Sub provided dashboard for your account.

Add:

global.config.yaml kyc:

kyc: ... sumsub: enabled: true image: gitlab.tunex.io:5050/marionette-develop/addons/sumsub:latest secret_key: <your_secret_key> webhook_secret_key: <your_webhook_secret_key> app_token: <your_app_token> level_name: <your_level_name>

templates\compose\extensions.yaml.t

{{#if kyc.sumsub.enabled}} sumsub: image: {{kyc.sumsub.image}} restart: always env_file: - ../config/database.env - ../config/storage.env environment: BASE_URL: {{base_url}} SUMSUB_URL: https://api.sumsub.com SECRET_KEY: {{kyc.sumsub.secret_key}} WEBHOOK_SECRET_KEY: {{kyc.sumsub.webhook_secret_key}} APP_TOKEN: {{kyc.sumsub.app_token}} LEVEL_NAME: {{kyc.sumsub.level_name}} depends_on: - nats - db {{#ifEquals components.jaeger.enabled true}} - jaeger {{/ifEquals}} {{#ifEquals mode "swarm"}} deploy: labels: - "traefik.http.routers.sumsub.rule=Host(`{{base_url}}`) && PathPrefix(`/sumsub`)" - "traefik.enable=true" - "traefik.http.services.sumsub.loadbalancer.server.port=3000" {{#if components.traefik.ssl}} - "traefik.http.routers.sumsub.entrypoints=websecure" - "traefik.http.routers.sumsub.tls=true" - "traefik.http.routers.sumsub.tls.certresolver=myresolver" - "traefik.http.routers.sumsub.middlewares=secureheaders" {{else}} - "traefik.http.routers.sumsub.entrypoints=web" {{/if}} {{/ifEquals}} {{#ifEquals mode "compose"}} labels: - "traefik.http.routers.sumsub.rule=Host(`{{base_url}}`) && PathPrefix(`/sumsub`)" - "traefik.enable=true" - "traefik.http.services.sumsub.loadbalancer.server.port=3000" {{#if components.traefik.ssl}} - "traefik.http.routers.sumsub.entrypoints=websecure" - "traefik.http.routers.sumsub.tls=true" - "traefik.http.routers.sumsub.tls.certresolver=myresolver" - "traefik.http.routers.sumsub.middlewares=secureheaders" {{else}} - "traefik.http.routers.sumsub.entrypoints=web" {{/if}} {{/ifEquals}} {{/if}}