Add kyc level 2 by gianfra-t · Pull Request #587 · pendulum-chain/vortex

gianfra-t · 2025-04-23T18:56:07Z

Changes summary

Companies should now be able to register with cnpj by filling the extra fields required. If registered via cnpj, the kyc flow will go directly to the level 2 screen after a successful level 1 verification.
cpf users are now prompted with the level 2 screen after confirming a ramp that will go above the level 1 limits.
Both users and companies that were rejected at level 1 can now re-attempt the registration as if it were the first time.

Code changes

Adds a component for KYC level 2 page. This component handles fetching the upload url's from the backend and performing the upload of the documents.
Adds logic to the existing useKYCProcess hook, to handle both level 1 and level 2 logic.
Component for KYC level 2 added to PIXKYCForm component.
Added company-specific fields to kyc level 1 form, to allow registering via cnpj.

Backend

Adds endpoint to request the upload urls for level 2.
Adjust kyc status endpoint to also work with level 2 kyc.

netlify · 2025-04-23T18:56:30Z

✅ Deploy Preview for pendulum-pay ready!

Name	Link
🔨 Latest commit	`60b8992`
🔍 Latest deploy log	https://app.netlify.com/sites/pendulum-pay/deploys/6819049faf07610008e1bc40
😎 Deploy Preview	https://deploy-preview-587--pendulum-pay.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sharqiewicz · 2025-04-29T15:24:30Z

    }

-    const lastEventCached = await eventPoller.getLatestEventForUser(subaccount.id);
+    const lastEventCached = await eventPoller.getLatestEventForUser(subaccount.id, 'KYC');


I was thinking it might be a great idea to create an enum, like SubscriptionEvents, to include values such as KYC and other related events. This way, we can avoid scattering strings throughout the codebase, making our code cleaner and easier to maintain.

Sharqiewicz · 2025-04-29T16:22:01Z

 export const WALLETCONNECT_ASSETHUB_ID = 'polkadot:68d56f15f85d3136970ec16946040bc1';

 export const TRANSFER_WAITING_TIME_SECONDS = 6000;
+export const BRLA_MAXIMUM_LEVEL_2_AMOUNT_UNITS = 1000000;


can we link brla docs for the future reference?

This level is not known, at least to me, so it was a placeholder to test. I'll add a comment.

Sharqiewicz · 2025-04-29T16:24:02Z

-  const { setRampKycStarted, resetRampState } = useRampActions();
+
+  const offrampKycLevel2Started = useRampKycLevel2Started();
+  const desiredLevel = offrampKycLevel2Started ? 2 : 1;


I was wondering if we could implement an enum for KYCLevels instead of using magic numbers?
This might help make the code more readable and maintainable.

True, I'll add one for the numbers in this component.

Sharqiewicz · 2025-04-29T16:25:32Z

+        if (isValidCnpj(taxId)) {
+          await createSubaccount({
+            ...formData,
+            // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion


Please just add a condition like

if (!formData.partnerCpf) { throw new Error('useKYCProcess: Partner CPF must be defined at this point'); }

Sharqiewicz · 2025-04-30T09:57:48Z

+      validSetter(false);
+      return;
+    }
+    if (!ALLOWED_TYPES.includes(file.type)) {


I think we should enhance our file validation, the file.type can be spoofed and we should also check for the file extension like:

const extension = `.${getFileExtension(file.name)}`; if (!ALLOWED_EXTENSIONS.includes(extension.toLowerCase())) {

We could also use Zod for the validation.

Let's add this to our todo's and once we are sure about the restrictions that brla imposes on the images (regarding size, etc), we can add this improvement. Wdyt?

Copilot

Pull Request Overview

This pull request implements a new KYC level 2 component and integrates level 2 handling into the overall KYC flow for both companies (using CNPJ) and individuals (CPF). Key changes include adding a dedicated document upload component for level 2, updating the KYC process hook and related UI components, and extending backend models, endpoints, and migrations to support KYC level 2 verification.

Reviewed Changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
frontend/src/constants/constants.ts	Added constant for maximum level 2 KYC amount.
frontend/src/components/Ramp/Onramp/index.tsx	Removed an unused hook import.
frontend/src/components/BrlaComponents/VerificationStatus/index.tsx	Updated status prop and styling to differentiate between level 1 and level 2.
frontend/src/components/BrlaComponents/KYCLevel2Form/index.tsx	Introduced the new document upload UI component for KYC level 2.
frontend/src/components/BrlaComponents/KYCForm/index.tsx	Updated form fields and flow based on account type and KYC level.
frontend/src/components/BrlaComponents/BrlaField/index.tsx	Extended field options with company-specific fields.
api/src/models/kycLevel2.model.ts & migrations	Added new model and migration for KYC level 2 data storage.
api/src/api/services/kyc/kyc.service.ts & others	Integrated new endpoints and service logic to request and manage KYC level 2 verification.
api/src/api/controllers/brla.controller.ts	Updated subaccount creation and introduced the startKYC2 endpoint.

ebma

Looking great overall, nice job 👍

I left a few comments, mostly minor stuff.

ebma · 2025-05-02T08:15:52Z

 router.route('/createSubaccount').post(validataSubaccountCreation, brlaController.createSubaccount);

-router.route('/triggerPayIn').post(validateTriggerPayIn, brlaController.triggerPayIn);
+router.route('/startKYC2').post(brlaController.startKYC2);


Just for the sake of it, why don't we add a validate... function like we do for any other post request.

ebma · 2025-05-02T08:41:42Z

+        },
+        "companyName": {
+          "required": "Company name is required",
+          "minLength": "Company name must be at least 3 characters",


Are you sure it's 3 and not 5?

no idea, just copy the other validations. I don't think brla checks this right?

I think they do actually. But we'll see.

Copilot

Pull Request Overview

This PR extends the KYC flow to support Level 2 verification for both companies and individuals, enabling registration via CNPJ and allowing previously rejected users to reattempt verification. Key changes include the introduction of a new migration for the kyc_level_2 table, additions to API endpoints and services to support KYC Level 2, and updates to related validators and controllers.

Reviewed Changes

Copilot reviewed 48 out of 48 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
api/src/database/migrations/001-initial-schema.ts	Adds the kyc_level_2 table and corresponding indexes to support KYC Level 2.
api/src/constants/constants.ts	Updates BRLA_BASE_URL port configuration.
api/src/api/services/transactions/onrampTransactions.ts	Formats nonce calculation for clarity.
api/src/api/services/ramp/quote.service.ts	Improves formatting in funding amount logic.
api/src/api/services/phases/*	Minor formatting and parameter adjustments in several phase handlers.
api/src/api/services/pendulum/apiManager.ts	Standardizes object formatting in promise resolves.
api/src/api/services/moonbeam/balance.ts	Adjusts import formatting and parameter definitions.
api/src/api/services/kyc/kyc.service.ts	Introduces KYC Level 2 logic and integrates a new endpoint call.
api/src/api/services/brla/*	Updates types, mappings, and endpoints to include KYC Level 2 and retry flows.
api/src/api/routes/v1/*	Replaces the triggerPayIn route with startKYC2 and updates generics formatting.
api/src/api/middlewares/validators.ts	Adds a startKYC2Validator to validate document type for KYC Level 2.
api/src/api/controllers/brla.controller.ts	Integrates KYC Level 2 flows in subaccount creation and KYC status retrieval.

Copilot · 2025-05-05T12:47:11Z

      res.status(400).json({ error: 'Subaccount already created' });
      return;
+    } else if (subaccount && subaccount.kyc.level === 0) {
+      console.log('subaccountPayload', subaccountPayload);


[nitpick] Consider removing or replacing the debug console.log statement with structured logging (e.g., using logger.info) to avoid potential performance or security concerns in production.

I think it's not a bad idea to leave this for debugging using backend logs.

Right, we can leave it. We could still change the line to use the logger instance that we have. We should always try to use that logger over simple console.logs in our backend because the logger will use the respective configuration (it's logging to file as well as console). I also forget about this often though.

true, I forgot we added this after the migration.

ebma · 2025-05-05T14:37:39Z

          console.error('Validation flags were true, but file data is missing. This is a bug.');
          return;
        }
+        console.log('CNH upload URL:', response.uploadUrls);


Shall we remove this?

ebma · 2025-05-05T18:07:27Z

              const amountNum = Number(executionInput.quote.inputAmount);
              const remainingLimitNum = Number(remainingLimitInUnits);
-              if (amountNum > remainingLimitNum) {
+              if (true) {


I don't think this is intended?

ebma

Looks good to me 🆗

gianfra-t added 7 commits April 21, 2025 12:45

add brla api mappings for kyc level 2

3d998b5

remove old triggerPayIn endpoint

dbe6a89

add new table and model for handling kyc level 2 state

576c6c1

adjust kyc2 model, add kyc service

985c26f

add route to start level 2 process

88c27e2

WIP file upload endpoint

ce43bfc

wip

77d219b

gianfra-t added 8 commits April 23, 2025 16:50

validate files, send files to requested url

353f925

combine kyc 2 logic into one endpoint, relay urls for upload back to UI

55e9934

add kyc2 component, testing

02de41e

improve kyc level 2 UI, reuse hooks and components from level 1

04c5d87

comment

020cdf1

add fields for compnay kyb level 1, restructure kyc flow

e7191fd

add kyb level 1 fields

e4a55a8

filter status query by kyc level

fffca0e

Sharqiewicz reviewed Apr 28, 2025

View reviewed changes

Comment thread api/package.json Outdated

gianfra-t added 7 commits April 28, 2025 14:15

remove unused packages

dbd9b80

Merge branch 'staging' into add-kyc-level-2

2799a12

replace with enum variant

f57465b

trigger kyc level 2 state when limit reached

fb18162

check for hard kyc limit on preRampCheck

27af92d

linting, add document type buttons

9c8b4eb

lint issues

85b60f9

Sharqiewicz requested changes Apr 29, 2025

View reviewed changes

gianfra-t marked this pull request as ready for review April 29, 2025 18:34

Sharqiewicz reviewed Apr 30, 2025

View reviewed changes

gianfra-t added 3 commits April 30, 2025 09:14

review improvements

7897e1e

add enum for kyc level

a1a59ce

enable ramp guard after kyc approved

212f077

gianfra-t changed the title ~~Add kyc level 2~~ [In-Progress] Add kyc level 2 Apr 30, 2025

improve kyc status endpoint

2339b3a

ebma requested a review from Copilot May 2, 2025 08:06

Copilot AI reviewed May 2, 2025

View reviewed changes

Comment thread frontend/src/components/BrlaComponents/KYCLevel2Form/index.tsx Outdated

ebma requested changes May 2, 2025

View reviewed changes

gianfra-t added 7 commits May 2, 2025 13:17

add kyc status handler guard

cf5b3cc

add guard to avoid infinite re-render

47205c9

renamings, ramp limit check improvements

82b56a2

remove logs

e0f8e6a

improve PIXKYCForm return statement

6507a48

Merge branch 'staging' into add-kyc-level-2

e11af6e

run prettier, add validator to startKYCLevel2 endpoint

792bf25

gianfra-t changed the title ~~[In-Progress] Add kyc level 2~~ Add kyc level 2 May 5, 2025

gianfra-t requested review from Sharqiewicz, Copilot and ebma May 5, 2025 12:46

Copilot AI reviewed May 5, 2025

View reviewed changes

point to brla production env

2ad5d73

ebma reviewed May 5, 2025

View reviewed changes

gianfra-t added 3 commits May 5, 2025 14:04

add translations to DocumentUpload component, renamings

3d7d3ea

correct translation

0e75244

rollback testing changes

ce310fa

ebma reviewed May 5, 2025

View reviewed changes

revert mock condition

7c4fee1

ebma approved these changes May 5, 2025

View reviewed changes

Sharqiewicz added 2 commits May 5, 2025 20:32

add KycLevel2Toggle

00608ed

use KYCLevel2Toggle

60b8992

Sharqiewicz approved these changes May 5, 2025

View reviewed changes

gianfra-t merged commit e7bb0f2 into staging May 5, 2025
5 checks passed

ebma mentioned this pull request May 9, 2025

Enable KYC level 2 for retail users #578

Closed

Conversation

gianfra-t commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes summary

Code changes

Backend

Uh oh!

netlify Bot commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for pendulum-pay ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

ebma left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ebma left a comment

Choose a reason for hiding this comment

gianfra-t commented Apr 23, 2025 •

edited

Loading

netlify Bot commented Apr 23, 2025 •

edited

Loading