UBOs | Beetlelabs API

Read Ubos

get

Get all UBO information associated with a verification session. This helps in reviewing the ownership structure of the business being verified.

Query parameters

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

session_idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

GET /beetlelabs-verification/ubos/ HTTP/1.1
Host: beetlelabs.ai
Accept: */*

[
  {
    "session_id": "123e4567-e89b-12d3-a456-426614174000",
    "full_name": "text",
    "date_of_birth": "2025-07-30",
    "nationality": "text",
    "ownership_percentage": 1,
    "residential_address": "text",
    "id_document_type": "PASSPORT",
    "id_document_number": "text",
    "id_document_path": "text",
    "id_document_back_path": "text",
    "liveness_check_path": "text",
    "verification_notes": "text",
    "consent": false,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Create Ubo

post

Add information about Ultimate Beneficial Owners (UBOs) of a business. UBOs are individuals who ultimately own or control the business. This information is crucial for compliance and anti-money laundering purposes.

Body

session_idstring · uuidRequired

full_namestringRequired

date_of_birthstring · dateRequired

nationalitystringRequired

ownership_percentageintegerRequired

residential_addressstringRequired

id_document_typestring · enumRequiredPossible values:

id_document_numberstringRequired

id_document_pathstringRequired

id_document_back_pathany ofOptional

stringOptional

or

nullOptional

liveness_check_pathany ofOptional

stringOptional

or

nullOptional

verification_notesany ofOptional

stringOptional

or

nullOptional

consentany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

POST /beetlelabs-verification/ubos/ HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 364

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "date_of_birth": "2025-07-30",
  "nationality": "text",
  "ownership_percentage": 1,
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_path": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false
}

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "date_of_birth": "2025-07-30",
  "nationality": "text",
  "ownership_percentage": 1,
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_path": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Read Ubo

get

Path parameters

ubo_idstring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

GET /beetlelabs-verification/ubos/{ubo_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "date_of_birth": "2025-07-30",
  "nationality": "text",
  "ownership_percentage": 1,
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_path": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Update Ubo

put

Path parameters

ubo_idstring · uuidRequired

Body

full_nameany ofOptional

stringOptional

or

nullOptional

date_of_birthany ofOptional

string · dateOptional

or

nullOptional

nationalityany ofOptional

stringOptional

or

nullOptional

ownership_percentageany ofOptional

integerOptional

or

nullOptional

residential_addressany ofOptional

stringOptional

or

nullOptional

id_document_typeany ofOptional

string · enumOptionalPossible values:

or

nullOptional

id_document_numberany ofOptional

stringOptional

or

nullOptional

id_document_pathany ofOptional

stringOptional

or

nullOptional

id_document_back_pathany ofOptional

stringOptional

or

nullOptional

liveness_check_pathany ofOptional

stringOptional

or

nullOptional

verification_notesany ofOptional

stringOptional

or

nullOptional

consentany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

PUT /beetlelabs-verification/ubos/{ubo_id} HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "full_name": "text",
  "date_of_birth": "2025-07-30",
  "nationality": "text",
  "ownership_percentage": 1,
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_path": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": true
}

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "date_of_birth": "2025-07-30",
  "nationality": "text",
  "ownership_percentage": 1,
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_path": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Ubo

delete

Path parameters

ubo_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

DELETE /beetlelabs-verification/ubos/{ubo_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

No content