Home

Personal Details(KYC)

Read Personal Details

get
Query parameters
pageinteger · min: 1OptionalDefault: 1
sizeinteger · max: 100OptionalDefault: 20
session_idany ofOptional
string · uuidOptional
or
nullOptional
Responses
200
Successful Response
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-07-30T17:02:21.494Z",
    "updated_at": "2025-07-30T17:02:21.494Z"
  }
]

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
or
nullOptional
occupationstringRequired
source_of_fundsany ofOptional
stringOptional
or
nullOptional
nationalityany ofOptional
stringOptional
or
nullOptional
mobile_verificationbooleanOptionalDefault: false
email_verificationbooleanOptionalDefault: false
statusstring · enumOptionalDefault: pendingPossible values:
risk_levelstring · enumOptionalDefault: unknownPossible values:
country_of_birthany ofOptional
stringOptional
or
nullOptional
genderany ofOptional
stringOptional
or
nullOptional
discrepancyany ofOptional
or
nullOptional
consentany ofOptionalDefault: false
booleanOptional
or
nullOptional
Responses
201
Successful Response
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-07-30T17:02:21.494Z",
  "updated_at": "2025-07-30T17:02:21.494Z"
}

Get Verification Summary

get
Query parameters
client_idintegerRequired
Responses
200
Successful Response
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
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-07-30T17:02:21.494Z",
    "updated_at": "2025-07-30T17:02:21.494Z"
  }
]

Read Personal Details

get
Path parameters
details_idstring · uuidRequired
Responses
200
Successful Response
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-07-30T17:02:21.494Z",
  "updated_at": "2025-07-30T17:02:21.494Z"
}

Delete Personal Details

delete
Path parameters
details_idstring · uuidRequired
Responses
204
Successful Response
delete
DELETE /beetlelabs-verification/personal-details/{details_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

No content

Update Personal Details

patch
Path parameters
details_idstring · uuidRequired
Body
residential_addressany ofOptional
stringOptional
or
nullOptional
occupationany ofOptional
stringOptional
or
nullOptional
source_of_fundsany ofOptional
stringOptional
or
nullOptional
nationalityany ofOptional
stringOptional
or
nullOptional
mobile_verificationany ofOptional
booleanOptional
or
nullOptional
email_verificationany ofOptional
booleanOptional
or
nullOptional
statusany ofOptional
string · enumOptionalPossible values:
or
nullOptional
risk_levelany ofOptional
string · enumOptionalPossible values:
or
nullOptional
country_of_birthany ofOptional
stringOptional
or
nullOptional
genderany ofOptional
stringOptional
or
nullOptional
discrepancyany ofOptional
or
nullOptional
consentany ofOptional
booleanOptional
or
nullOptional
Responses
200
Successful Response
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-07-30T17:02:21.494Z",
  "updated_at": "2025-07-30T17:02:21.494Z"
}
PreviousBeetlelabsNextUBOs