Directors

Read Directors

get

Query parameters

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

session_idstring · uuid · nullableOptional

Responses

200

Successful Response

application/json

session_idstring · uuidRequired

full_namestringRequired

date_of_birthstring · date · nullableOptional

nationalitystringRequired

positionstringRequired

residential_addressstring · nullableOptional

id_document_typestring · enum · nullableOptionalPossible values:

id_document_numberstring · nullableOptional

id_document_urlstring · nullableOptional

id_document_back_pathstring · nullableOptional

liveness_check_pathstring · nullableOptional

verification_notesstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

422

Validation Error

application/json

get/directors/

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

[
  {
    "session_id": "123e4567-e89b-12d3-a456-426614174000",
    "full_name": "text",
    "date_of_birth": "2026-07-10",
    "nationality": "text",
    "position": "text",
    "residential_address": "text",
    "id_document_type": "PASSPORT",
    "id_document_number": "text",
    "id_document_url": "text",
    "id_document_back_path": "text",
    "liveness_check_path": "text",
    "verification_notes": "text",
    "consent": false,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Create Director

post

Body

session_idstring · uuidRequired

full_namestringRequired

date_of_birthstring · date · nullableOptional

nationalitystringRequired

positionstringRequired

residential_addressstring · nullableOptional

id_document_typestring · enum · nullableOptionalPossible values:

id_document_numberstring · nullableOptional

id_document_urlstring · nullableOptional

id_document_back_pathstring · nullableOptional

liveness_check_pathstring · nullableOptional

verification_notesstring · nullableOptional

consentboolean · nullableOptionalDefault: false

Responses

201

Successful Response

application/json

session_idstring · uuidRequired

full_namestringRequired

date_of_birthstring · date · nullableOptional

nationalitystringRequired

positionstringRequired

residential_addressstring · nullableOptional

id_document_typestring · enum · nullableOptionalPossible values:

id_document_numberstring · nullableOptional

id_document_urlstring · nullableOptional

id_document_back_pathstring · nullableOptional

liveness_check_pathstring · nullableOptional

verification_notesstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

422

Validation Error

application/json

post/directors/

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

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "date_of_birth": "2026-07-10",
  "nationality": "text",
  "position": "text",
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_url": "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": "2026-07-10",
  "nationality": "text",
  "position": "text",
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_url": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Read Director

get

Path parameters

director_idstring · uuidRequired

Responses

200

Successful Response

application/json

session_idstring · uuidRequired

full_namestringRequired

date_of_birthstring · date · nullableOptional

nationalitystringRequired

positionstringRequired

residential_addressstring · nullableOptional

id_document_typestring · enum · nullableOptionalPossible values:

id_document_numberstring · nullableOptional

id_document_urlstring · nullableOptional

id_document_back_pathstring · nullableOptional

liveness_check_pathstring · nullableOptional

verification_notesstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

422

Validation Error

application/json

get/directors/{director_id}

GET /beetlelabs-verification/directors/{director_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "date_of_birth": "2026-07-10",
  "nationality": "text",
  "position": "text",
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_url": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Update Director

put

Path parameters

director_idstring · uuidRequired

Body

full_namestring · nullableOptional

date_of_birthstring · date · nullableOptional

nationalitystring · nullableOptional

positionstring · nullableOptional

residential_addressstring · nullableOptional

id_document_typestring · enum · nullableOptionalPossible values:

id_document_numberstring · nullableOptional

id_document_urlstring · nullableOptional

id_document_back_pathstring · nullableOptional

liveness_check_pathstring · nullableOptional

verification_notesstring · nullableOptional

consentboolean · nullableOptional

Responses

200

Successful Response

application/json

session_idstring · uuidRequired

full_namestringRequired

date_of_birthstring · date · nullableOptional

nationalitystringRequired

positionstringRequired

residential_addressstring · nullableOptional

id_document_typestring · enum · nullableOptionalPossible values:

id_document_numberstring · nullableOptional

id_document_urlstring · nullableOptional

id_document_back_pathstring · nullableOptional

liveness_check_pathstring · nullableOptional

verification_notesstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

422

Validation Error

application/json

put/directors/{director_id}

PUT /beetlelabs-verification/directors/{director_id} HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "full_name": "text",
  "date_of_birth": "2026-07-10",
  "nationality": "text",
  "position": "text",
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_url": "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": "2026-07-10",
  "nationality": "text",
  "position": "text",
  "residential_address": "text",
  "id_document_type": "PASSPORT",
  "id_document_number": "text",
  "id_document_url": "text",
  "id_document_back_path": "text",
  "liveness_check_path": "text",
  "verification_notes": "text",
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Director

delete

Path parameters

director_idstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/directors/{director_id}

DELETE /beetlelabs-verification/directors/{director_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

No content

PreviousUBOs NextBusiness Documents

Last updated 1 year ago