Personal Details(KYC)

PreviousBeetlelabs NextUBOs

Get Verification Summary

get

Query parameters

client_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

GET /beetlelabs-verification/personal-details/summary HTTP/1.1
Host: beetlelabs.ai
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Get Personal Details

get

Retrieve the personal details submitted for a specific verification session. This helps in reviewing the information provided by the user during the KYC process.

Path parameters

session_idstring · uuidRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

sizeinteger · max: 100OptionalDefault: 20

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

GET /beetlelabs-verification/personal-details/{session_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

[
  {
    "client_id": 1,
    "session_id": "123e4567-e89b-12d3-a456-426614174000",
    "residential_address": "text",
    "occupation": "text",
    "source_of_funds": "text",
    "nationality": "text",
    "mobile_verification": false,
    "email_verification": false,
    "status": "pending",
    "risk_level": "unknown",
    "country_of_birth": "text",
    "gender": "text",
    "discrepancy": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "consent": false,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-06-06T13:21:42.528Z",
    "updated_at": "2025-06-06T13:21:42.528Z"
  }
]

Read Personal Details

get

Path parameters

details_idstring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

GET /beetlelabs-verification/personal-details/{details_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

{
  "client_id": 1,
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "residential_address": "text",
  "occupation": "text",
  "source_of_funds": "text",
  "nationality": "text",
  "mobile_verification": false,
  "email_verification": false,
  "status": "pending",
  "risk_level": "unknown",
  "country_of_birth": "text",
  "gender": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-06-06T13:21:42.528Z",
  "updated_at": "2025-06-06T13:21:42.528Z"
}

Delete Personal Details

delete

Path parameters

details_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

DELETE /beetlelabs-verification/personal-details/{details_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

No content

Read Personal Details

get

Query parameters

pageinteger · min: 1OptionalDefault: 1

sizeinteger · max: 100OptionalDefault: 20

session_idany ofOptional

string · uuidOptional

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

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

[
  {
    "client_id": 1,
    "session_id": "123e4567-e89b-12d3-a456-426614174000",
    "residential_address": "text",
    "occupation": "text",
    "source_of_funds": "text",
    "nationality": "text",
    "mobile_verification": false,
    "email_verification": false,
    "status": "pending",
    "risk_level": "unknown",
    "country_of_birth": "text",
    "gender": "text",
    "discrepancy": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "consent": false,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-06-06T13:21:42.528Z",
    "updated_at": "2025-06-06T13:21:42.528Z"
  }
]

Create Personal Details

post

Submit personal details for KYC verification. This includes basic information like name, address, and contact details. This information is used to verify the identity of the individual.

Body

client_idintegerRequired

session_idstring · uuidRequired

residential_addressany ofOptional

stringOptional

nullOptional

occupationstringRequired

source_of_fundsany ofOptional

stringOptional

nullOptional

nationalityany ofOptional

stringOptional

nullOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthany ofOptional

stringOptional

nullOptional

genderany ofOptional

stringOptional

nullOptional

discrepancyany ofOptional

nullOptional

consentany ofOptionalDefault: false

booleanOptional

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

POST /beetlelabs-verification/personal-details/ HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 370

{
  "client_id": 1,
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "residential_address": "text",
  "occupation": "text",
  "source_of_funds": "text",
  "nationality": "text",
  "mobile_verification": false,
  "email_verification": false,
  "status": "pending",
  "risk_level": "unknown",
  "country_of_birth": "text",
  "gender": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": false
}

{
  "client_id": 1,
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "residential_address": "text",
  "occupation": "text",
  "source_of_funds": "text",
  "nationality": "text",
  "mobile_verification": false,
  "email_verification": false,
  "status": "pending",
  "risk_level": "unknown",
  "country_of_birth": "text",
  "gender": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-06-06T13:21:42.528Z",
  "updated_at": "2025-06-06T13:21:42.528Z"
}

Update Personal Details

patch

Path parameters

details_idstring · uuidRequired

Body

residential_addressany ofOptional

stringOptional

nullOptional

occupationany ofOptional

stringOptional

nullOptional

source_of_fundsany ofOptional

stringOptional

nullOptional

nationalityany ofOptional

stringOptional

nullOptional

mobile_verificationany ofOptional

booleanOptional

nullOptional

email_verificationany ofOptional

booleanOptional

nullOptional

statusany ofOptional

string · enumOptionalPossible values:

nullOptional

risk_levelany ofOptional

string · enumOptionalPossible values:

nullOptional

country_of_birthany ofOptional

stringOptional

nullOptional

genderany ofOptional

stringOptional

nullOptional

discrepancyany ofOptional

nullOptional

consentany ofOptional

booleanOptional

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

patch

PATCH /beetlelabs-verification/personal-details/{details_id} HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "residential_address": "text",
  "occupation": "text",
  "source_of_funds": "text",
  "nationality": "text",
  "mobile_verification": true,
  "email_verification": true,
  "status": "pending",
  "risk_level": "low",
  "country_of_birth": "text",
  "gender": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": true
}

{
  "client_id": 1,
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "residential_address": "text",
  "occupation": "text",
  "source_of_funds": "text",
  "nationality": "text",
  "mobile_verification": false,
  "email_verification": false,
  "status": "pending",
  "risk_level": "unknown",
  "country_of_birth": "text",
  "gender": "text",
  "discrepancy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "consent": false,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-06-06T13:21:42.528Z",
  "updated_at": "2025-06-06T13:21:42.528Z"
}