LogoLogo
Home
  • Beetlelabs
  • Personal Details(KYC)
  • UBOs
  • Directors
  • Business Documents
  • Flow Config
  • ID,Address Document Proof
  • Liveness
  • Business details(KYB)
  • Verification Session
  • Models
Powered by GitBook
LogoLogo

Company

  • Home
  • Team
  • Blog

Social

  • LinkedIn
  • Twitter

Copyright © 2025 BeetleLabs.Ai | All Rights Reserved

On this page
Export as PDF

Business details(KYB)

PreviousLivenessNextVerification Session

Get Verification Summary

get
Query parameters
client_idintegerRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /beetlelabs-verification/client_kybs/summary HTTP/1.1
Host: beetlelabs.ai
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Get Customer

get
Path parameters
client_idintegerRequired
session_idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /beetlelabs-verification/client_kybs/{client_id}/{session_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*
{
  "id": "text",
  "client_id": 1,
  "session_id": "text",
  "business_name": "text",
  "business_email": "text",
  "business_registered_address": "text",
  "business_registration_number": "text",
  "verification_status": "pending",
  "risk_level": "low",
  "created_at": "2025-06-06T14:22:33.608Z",
  "documents": [
    {
      "id": "text",
      "file_url": "text",
      "verification_status": "pending",
      "created_at": "2025-06-06T14:22:33.608Z"
    }
  ],
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2025-06-06T14:22:33.608Z",
  "incorporation_country": "text",
  "annual_revenue": "text",
  "revenue_currency": "AED",
  "business_type": "text",
  "business_ceo": "text",
  "business_industry": "text",
  "business_logo_url": "text",
  "consent": true
}

List Customers

get
Path parameters
client_idintegerRequired
Query parameters
pageinteger · min: 1OptionalDefault: 1
sizeinteger · max: 100OptionalDefault: 10
verification_statusstringOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /beetlelabs-verification/client_kybs/{client_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*
{
  "total": 1,
  "page": 1,
  "size": 1,
  "results": [
    {
      "id": "text",
      "client_id": 1,
      "session_id": "text",
      "business_name": "text",
      "business_email": "text",
      "business_registered_address": "text",
      "business_registration_number": "text",
      "verification_status": "pending",
      "risk_level": "low",
      "created_at": "2025-06-06T14:22:33.608Z",
      "documents": [
        {
          "id": "text",
          "file_url": "text",
          "verification_status": "pending",
          "created_at": "2025-06-06T14:22:33.608Z"
        }
      ],
      "assigned_officer": "text",
      "business_website": "text",
      "incorporation_date": "2025-06-06T14:22:33.608Z",
      "incorporation_country": "text",
      "annual_revenue": "text",
      "revenue_currency": "AED",
      "business_type": "text",
      "business_ceo": "text",
      "business_industry": "text",
      "business_logo_url": "text",
      "consent": true
    }
  ]
}
  • GETGet Verification Summary
  • GETGet Customer
  • GETList Customers
  • POSTCreate Client
  • PATCHUpdate Client

Create Client

post
Body
business_namestringRequired
business_emailany ofOptional
stringOptional
or
nullOptional
session_idany ofOptional
string · uuid4Optional
or
nullOptional
business_registration_numberstringRequired
business_registered_addressstringRequired
verification_statusstring · enumOptionalDefault: pendingPossible values:
risk_levelstring · enumOptionalDefault: mediumPossible values:
assigned_officerany ofOptional
stringOptional
or
nullOptional
client_idintegerRequired
business_websiteany ofOptional
stringOptional
or
nullOptional
incorporation_dateany ofOptional
string · date-timeOptional
or
nullOptional
incorporation_countryany ofOptional
stringOptional
or
nullOptional
annual_revenueany ofOptional
stringOptional
or
nullOptional
revenue_currencyany ofOptional
string · enumOptionalPossible values:
or
nullOptional
business_typeany ofOptional
stringOptional
or
nullOptional
business_ceoany ofOptional
stringOptional
or
nullOptional
business_industryany ofOptional
stringOptional
or
nullOptional
business_logo_urlany ofOptional
stringOptional
or
nullOptional
discrepancyany ofOptional
or
nullOptional
consentany ofOptionalDefault: false
booleanOptional
or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /beetlelabs-verification/client_kybs/ HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 559

{
  "business_name": "text",
  "business_email": "text",
  "session_id": "text",
  "business_registration_number": "text",
  "business_registered_address": "text",
  "verification_status": "pending",
  "risk_level": "medium",
  "assigned_officer": "text",
  "client_id": 1,
  "business_website": "text",
  "incorporation_date": "2025-06-06T14:22:33.608Z",
  "incorporation_country": "text",
  "annual_revenue": "text",
  "revenue_currency": "AED",
  "business_type": "text",
  "business_ceo": "text",
  "business_industry": "text",
  "business_logo_url": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": false
}
{
  "id": "text",
  "client_id": 1,
  "session_id": "text",
  "business_name": "text",
  "business_email": "text",
  "business_registered_address": "text",
  "business_registration_number": "text",
  "verification_status": "pending",
  "risk_level": "low",
  "created_at": "2025-06-06T14:22:33.608Z",
  "documents": [
    {
      "id": "text",
      "file_url": "text",
      "verification_status": "pending",
      "created_at": "2025-06-06T14:22:33.608Z"
    }
  ],
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2025-06-06T14:22:33.608Z",
  "incorporation_country": "text",
  "annual_revenue": "text",
  "revenue_currency": "AED",
  "business_type": "text",
  "business_ceo": "text",
  "business_industry": "text",
  "business_logo_url": "text",
  "consent": true
}

Update Client

patch
Path parameters
session_idstringRequired
Body
business_nameany ofOptional
stringOptional
or
nullOptional
business_emailany ofOptional
stringOptional
or
nullOptional
business_registration_numberany ofOptional
stringOptional
or
nullOptional
business_registered_addressany ofOptional
stringOptional
or
nullOptional
verification_statusany ofOptionalDefault: pending
string · enumOptionalPossible values:
or
nullOptional
risk_levelany ofOptionalDefault: medium
string · enumOptionalPossible values:
or
nullOptional
assigned_officerany ofOptional
stringOptional
or
nullOptional
business_websiteany ofOptional
stringOptional
or
nullOptional
incorporation_dateany ofOptional
string · date-timeOptional
or
nullOptional
incorporation_countryany ofOptional
stringOptional
or
nullOptional
annual_revenueany ofOptional
stringOptional
or
nullOptional
revenue_currencyany ofOptional
string · enumOptionalPossible values:
or
nullOptional
business_typeany ofOptional
stringOptional
or
nullOptional
business_ceoany ofOptional
stringOptional
or
nullOptional
business_industryany ofOptional
stringOptional
or
nullOptional
business_logo_urlany ofOptional
stringOptional
or
nullOptional
discrepancyany ofOptional
or
nullOptional
consentany ofOptional
booleanOptional
or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
patch
PATCH /beetlelabs-verification/client_kybs/{session_id} HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 524

{
  "business_name": "text",
  "business_email": "text",
  "business_registration_number": "text",
  "business_registered_address": "text",
  "verification_status": "pending",
  "risk_level": "medium",
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2025-06-06T14:22:33.608Z",
  "incorporation_country": "text",
  "annual_revenue": "text",
  "revenue_currency": "AED",
  "business_type": "text",
  "business_ceo": "text",
  "business_industry": "text",
  "business_logo_url": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": true
}
{
  "id": "text",
  "client_id": 1,
  "session_id": "text",
  "business_name": "text",
  "business_email": "text",
  "business_registered_address": "text",
  "business_registration_number": "text",
  "verification_status": "pending",
  "risk_level": "low",
  "created_at": "2025-06-06T14:22:33.608Z",
  "documents": [
    {
      "id": "text",
      "file_url": "text",
      "verification_status": "pending",
      "created_at": "2025-06-06T14:22:33.608Z"
    }
  ],
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2025-06-06T14:22:33.608Z",
  "incorporation_country": "text",
  "annual_revenue": "text",
  "revenue_currency": "AED",
  "business_type": "text",
  "business_ceo": "text",
  "business_industry": "text",
  "business_logo_url": "text",
  "consent": true
}