Business details(KYB)

Get Verification Summary

get

Query parameters

client_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/client_kybs/summary

GET /beetlelabs-verification/client_kybs/summary?client_id=1 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

idstring · uuid4Required

client_idintegerRequired

session_idstring · uuid4 · nullableOptional

business_namestringRequired

business_emailstring · nullableRequired

business_registered_addressstring · nullableRequired

business_registration_numberstringRequired

verification_statusstring · enumRequiredPossible values:

risk_levelstring · enumRequiredPossible values:

created_atstring · date-timeRequired

assigned_officerstring · nullableRequired

business_websitestring · nullableRequired

incorporation_datestring · date-time · nullableRequired

incorporation_countrystring · nullableRequired

annual_revenuestring · nullableRequired

revenue_currencystring · enum · nullableRequiredPossible values:

business_typestring · nullableRequired

business_ceostring · nullableOptional

business_industrystring · nullableOptional

business_logo_urlstring · nullableOptional

consentboolean · nullableOptional

422

Validation Error

application/json

get/client_kybs/{client_id}/{session_id}

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": "2026-07-10T14:36:26.735Z",
  "documents": [
    {
      "id": "text",
      "file_url": "text",
      "verification_status": "pending",
      "created_at": "2026-07-10T14:36:26.735Z"
    }
  ],
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2026-07-10T14:36:26.735Z",
  "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

totalintegerRequired

pageintegerRequired

sizeintegerRequired

422

Validation Error

application/json

get/client_kybs/{client_id}

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": "2026-07-10T14:36:26.735Z",
      "documents": [
        {
          "id": "text",
          "file_url": "text",
          "verification_status": "pending",
          "created_at": "2026-07-10T14:36:26.735Z"
        }
      ],
      "assigned_officer": "text",
      "business_website": "text",
      "incorporation_date": "2026-07-10T14:36:26.735Z",
      "incorporation_country": "text",
      "annual_revenue": "text",
      "revenue_currency": "AED",
      "business_type": "text",
      "business_ceo": "text",
      "business_industry": "text",
      "business_logo_url": "text",
      "consent": true
    }
  ]
}

Create Client

post

Body

business_namestringRequired

business_emailstring · nullableOptional

session_idstring · uuid4 · nullableOptional

business_registration_numberstringRequired

business_registered_addressstringRequired

verification_statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: mediumPossible values:

assigned_officerstring · nullableOptional

client_idintegerRequired

business_websitestring · nullableOptional

incorporation_datestring · date-time · nullableOptional

incorporation_countrystring · nullableOptional

annual_revenuestring · nullableOptional

revenue_currencystring · enum · nullableOptionalPossible values:

business_typestring · nullableOptional

business_ceostring · nullableOptional

business_industrystring · nullableOptional

business_logo_urlstring · nullableOptional

consentboolean · nullableOptionalDefault: false

Responses

200

Successful Response

application/json

idstring · uuid4Required

client_idintegerRequired

session_idstring · uuid4 · nullableOptional

business_namestringRequired

business_emailstring · nullableRequired

business_registered_addressstring · nullableRequired

business_registration_numberstringRequired

verification_statusstring · enumRequiredPossible values:

risk_levelstring · enumRequiredPossible values:

created_atstring · date-timeRequired

assigned_officerstring · nullableRequired

business_websitestring · nullableRequired

incorporation_datestring · date-time · nullableRequired

incorporation_countrystring · nullableRequired

annual_revenuestring · nullableRequired

revenue_currencystring · enum · nullableRequiredPossible values:

business_typestring · nullableRequired

business_ceostring · nullableOptional

business_industrystring · nullableOptional

business_logo_urlstring · nullableOptional

consentboolean · nullableOptional

422

Validation Error

application/json

post/client_kybs/

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": "2026-07-10T14:36:26.735Z",
  "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": "2026-07-10T14:36:26.735Z",
  "documents": [
    {
      "id": "text",
      "file_url": "text",
      "verification_status": "pending",
      "created_at": "2026-07-10T14:36:26.735Z"
    }
  ],
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2026-07-10T14:36:26.735Z",
  "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_namestring · nullableOptional

business_emailstring · nullableOptional

business_registration_numberstring · nullableOptional

business_registered_addressstring · nullableOptional

verification_statusstring · enum · nullableOptionalDefault: pendingPossible values:

risk_levelstring · enum · nullableOptionalDefault: mediumPossible values:

assigned_officerstring · nullableOptional

business_websitestring · nullableOptional

incorporation_datestring · date-time · nullableOptional

incorporation_countrystring · nullableOptional

annual_revenuestring · nullableOptional

revenue_currencystring · enum · nullableOptionalPossible values:

business_typestring · nullableOptional

business_ceostring · nullableOptional

business_industrystring · nullableOptional

business_logo_urlstring · nullableOptional

consentboolean · nullableOptional

Responses

200

Successful Response

application/json

idstring · uuid4Required

client_idintegerRequired

session_idstring · uuid4 · nullableOptional

business_namestringRequired

business_emailstring · nullableRequired

business_registered_addressstring · nullableRequired

business_registration_numberstringRequired

verification_statusstring · enumRequiredPossible values:

risk_levelstring · enumRequiredPossible values:

created_atstring · date-timeRequired

assigned_officerstring · nullableRequired

business_websitestring · nullableRequired

incorporation_datestring · date-time · nullableRequired

incorporation_countrystring · nullableRequired

annual_revenuestring · nullableRequired

revenue_currencystring · enum · nullableRequiredPossible values:

business_typestring · nullableRequired

business_ceostring · nullableOptional

business_industrystring · nullableOptional

business_logo_urlstring · nullableOptional

consentboolean · nullableOptional

422

Validation Error

application/json

patch/client_kybs/{session_id}

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": "2026-07-10T14:36:26.735Z",
  "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": "2026-07-10T14:36:26.735Z",
  "documents": [
    {
      "id": "text",
      "file_url": "text",
      "verification_status": "pending",
      "created_at": "2026-07-10T14:36:26.735Z"
    }
  ],
  "assigned_officer": "text",
  "business_website": "text",
  "incorporation_date": "2026-07-10T14:36:26.735Z",
  "incorporation_country": "text",
  "annual_revenue": "text",
  "revenue_currency": "AED",
  "business_type": "text",
  "business_ceo": "text",
  "business_industry": "text",
  "business_logo_url": "text",
  "consent": true
}

PreviousLiveness NextVerification Session

Last updated 1 year ago