Personal Details(KYC)

Read Personal Details

get

Query parameters

pageinteger · min: 1OptionalDefault: 1

sizeinteger · max: 100OptionalDefault: 20

session_idstring · uuid · nullableOptional

Responses

200

Successful Response

application/json

client_idintegerRequired

session_idstring · uuidRequired

residential_addressstring · nullableOptional

occupationstringRequired

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get/personal-details/

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": "2026-07-10T15:56:43.147Z",
    "updated_at": "2026-07-10T15:56:43.147Z"
  }
]

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_addressstring · nullableOptional

occupationstringRequired

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptionalDefault: false

Responses

201

Successful Response

application/json

client_idintegerRequired

session_idstring · uuidRequired

residential_addressstring · nullableOptional

occupationstringRequired

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

post/personal-details/

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": "2026-07-10T15:56:43.147Z",
  "updated_at": "2026-07-10T15:56:43.147Z"
}

Get Verification Summary

get

Query parameters

client_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/personal-details/summary

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

client_idintegerRequired

session_idstring · uuidRequired

residential_addressstring · nullableOptional

occupationstringRequired

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get/personal-details/{session_id}

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": "2026-07-10T15:56:43.147Z",
    "updated_at": "2026-07-10T15:56:43.147Z"
  }
]

Read Personal Details

get

Path parameters

details_idstring · uuidRequired

Responses

200

Successful Response

application/json

client_idintegerRequired

session_idstring · uuidRequired

residential_addressstring · nullableOptional

occupationstringRequired

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get/personal-details/{details_id}

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": "2026-07-10T15:56:43.147Z",
  "updated_at": "2026-07-10T15:56:43.147Z"
}

Delete Personal Details

delete

Path parameters

details_idstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/personal-details/{details_id}

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_addressstring · nullableOptional

occupationstring · nullableOptional

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationboolean · nullableOptional

email_verificationboolean · nullableOptional

statusstring · enum · nullableOptionalPossible values:

risk_levelstring · enum · nullableOptionalPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptional

Responses

200

Successful Response

application/json

client_idintegerRequired

session_idstring · uuidRequired

residential_addressstring · nullableOptional

occupationstringRequired

source_of_fundsstring · nullableOptional

nationalitystring · nullableOptional

mobile_verificationbooleanOptionalDefault: false

email_verificationbooleanOptionalDefault: false

statusstring · enumOptionalDefault: pendingPossible values:

risk_levelstring · enumOptionalDefault: unknownPossible values:

country_of_birthstring · nullableOptional

genderstring · nullableOptional

consentboolean · nullableOptionalDefault: false

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

patch/personal-details/{details_id}

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": "2026-07-10T15:56:43.147Z",
  "updated_at": "2026-07-10T15:56:43.147Z"
}

PreviousBeetlelabs NextUBOs

Last updated 1 year ago