Flow Config

Get Flow

get

Path parameters

flow_idstring · uuidRequired

Responses

200

Successful Response

application/json

client_idintegerRequired

namestringRequired

verification_typestring · enumRequiredPossible values:

versionintegerRequired

is_activebooleanOptionalDefault: true

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get

/flow-config/{flow_id}

HTTPcURLJavaScriptPython

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": "2026-03-26T01:28:13.452Z",
  "updated_at": "2026-03-26T01:28:13.452Z"
}

Update Flow

put

Path parameters

flow_idstring · uuidRequired

Body

application/json

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

client_idintegerRequired

namestringRequired

verification_typestring · enumRequiredPossible values:

versionintegerRequired

is_activebooleanOptionalDefault: true

idstring · uuidRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

put

/flow-config/{flow_id}

HTTPcURLJavaScriptPython

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": "2026-03-26T01:28:13.452Z",
  "updated_at": "2026-03-26T01:28:13.452Z"
}

Delete Flow

delete

Path parameters

flow_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/flow-config/{flow_id}

HTTPcURLJavaScriptPython

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

totalintegerRequired

pageintegerRequired

sizeintegerRequired

422

Validation Error

application/json

get

/flow-config

HTTPcURLJavaScriptPython

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": "2026-03-26T01:28:13.452Z",
      "updated_at": "2026-03-26T01:28:13.452Z"
    }
  ]
}

Create Flow

post

Body

application/json

client_idintegerRequired

namestringRequired

verification_typestring · enumRequiredPossible values:

versionintegerRequired

is_activebooleanOptionalDefault: true

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/flow-config

HTTPcURLJavaScriptPython

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": "2026-03-26T01:28:13.452Z",
  "updated_at": "2026-03-26T01:28:13.452Z"
}