LogoLogo
Home
  • Beetlelabs
  • Personal Details(KYC)
  • UBOs
  • Directors
  • Business Documents
  • Flow Config
  • ID,Address Document Proof
  • Liveness
  • Business details(KYB)
  • Verification Session
  • Models
Powered by GitBook
On this page
Export as PDF

Flow Config

PreviousBusiness DocumentsNextID,Address Document Proof
LogoLogo

Company

  • Home
  • Team
  • Blog

Social

  • LinkedIn
  • Twitter

Copyright © 2025 BeetleLabs.Ai | All Rights Reserved

Delete Flow

delete
Path parameters
flow_idstring · uuidRequired
Responses
204
Successful Response
422
Validation Error
application/json
delete
DELETE /beetlelabs-verification/flow-config/{flow_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

No content

List Flows

get
Query parameters
pageinteger · min: 1OptionalDefault: 1
sizeinteger · max: 100OptionalDefault: 20
client_idany ofOptional
integerOptional
or
nullOptional
verification_typeany ofOptional
stringOptional
or
nullOptional
countryany ofOptional
stringOptional
or
nullOptional
business_typeany ofOptional
stringOptional
or
nullOptional
customer_typeany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /beetlelabs-verification/flow-config HTTP/1.1
Host: beetlelabs.ai
Accept: */*
{
  "total": 1,
  "page": 1,
  "size": 1,
  "items": [
    {
      "client_id": 1,
      "name": "text",
      "verification_type": "INDIVIDUAL",
      "version": 1,
      "is_active": true,
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-06-06T16:33:52.698Z",
      "updated_at": "2025-06-06T16:33:52.698Z"
    }
  ]
}
  • GETGet Flow
  • PUTUpdate Flow
  • DELETEDelete Flow
  • GETList Flows
  • POSTCreate Flow

Get Flow

get
Path parameters
flow_idstring · uuidRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /beetlelabs-verification/flow-config/{flow_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*
{
  "client_id": 1,
  "name": "text",
  "verification_type": "INDIVIDUAL",
  "version": 1,
  "is_active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-06-06T16:33:52.698Z",
  "updated_at": "2025-06-06T16:33:52.698Z"
}

Update Flow

put
Path parameters
flow_idstring · uuidRequired
Body
nameany ofOptional
stringOptional
or
nullOptional
versionany ofOptional
integerOptional
or
nullOptional
is_activeany ofOptional
booleanOptional
or
nullOptional
configany ofOptional
or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
put
PUT /beetlelabs-verification/flow-config/{flow_id} HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "name": "text",
  "version": 1,
  "is_active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "client_id": 1,
  "name": "text",
  "verification_type": "INDIVIDUAL",
  "version": 1,
  "is_active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-06-06T16:33:52.698Z",
  "updated_at": "2025-06-06T16:33:52.698Z"
}

Create Flow

post
Body
client_idintegerRequired
namestringRequired
verification_typestring · enumRequiredPossible values:
versionintegerRequired
is_activebooleanOptionalDefault: true
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /beetlelabs-verification/flow-config HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "client_id": 1,
  "name": "text",
  "verification_type": "INDIVIDUAL",
  "version": 1,
  "is_active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "client_id": 1,
  "name": "text",
  "verification_type": "INDIVIDUAL",
  "version": 1,
  "is_active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-06-06T16:33:52.698Z",
  "updated_at": "2025-06-06T16:33:52.698Z"
}