KYB (Know Your Business) Guide - Web SDK

KYB is the process of verifying the identity and legitimacy of a business entity. This is essential for regulatory compliance, risk management, and preventing illicit activities like money laundering.

This guide details how to initiate a KYB Level 1 verification using our Web SDK flow. The process is designed to be secure and straightforward, offloading the data collection to a dedicated, secure environment.

The flow consists of a single API call to generate secure links, which are then provided to the business representative to complete the verification process in their browser.

---

Initiate KYB Level 1 Verification

To start the KYB process, you make a request to our API. In response, you will receive a unique attempt ID and two secure URLs. These URLs lead to a web interface where the company's representative can upload the necessary information and documents.

HTTP POST Request:

https://api.sandbox.avenia.io:10952/v2/kyc/new-level-1/web-sdk

info

To perform KYB for a Subaccount, pass the subAccountId field as a request parameter.

Request Body

{
  "redirectUrl": "https://example.com/kyb-complete"
}

Fields

Field	Type	Required	Description
redirectUrl	string	No	URL where users will be redirected after completing, rejecting, or canceling the KYB process. If not provided, users will remain on the verification page.

JSON Response

The response contains the attemptId for tracking and two distinct URLs for the different parts of the verification process.

{
  "attemptId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "authorizedRepresentativeUrl": "https://kyc.sandbox.avenia.io/session/rep/a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "basicCompanyDataUrl": "https://kyc.sandbox.avenia.io/session/company/a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Response Fields Explained

Field	Type	Description
attemptId	string	A unique identifier for this KYB attempt. You can use this ID to track the status of the verification.
authorizedRepresentativeUrl	string	The URL to be provided to the company's legal representative to submit their personal identity documents.
basicCompanyDataUrl	string	The URL for submitting the company's basic information and legal documents.

cURL Example

curl -X POST "https://api.sandbox.avenia.io:10952/v2/kyc/new-level-1/web-sdk" \
     -H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
     -H "Content-Type: application/json" \
     -d '{
       "redirectUrl": "https://yourapp.com/kyb-complete"
     }'

info

Once the user completes the process through the provided URLs, you will receive status updates via webhooks if they are configured for your account with the KYC events. You can also poll for the status using the attemptId.