ID,Address Document Proof

Create Id Document

post

Body

document_typestring · enumRequiredPossible values:

document_numberstringRequired

full_namestringRequired

date_of_birthstring · dateRequired

expiry_dateany ofOptional

string · dateOptional

or

nullOptional

nationalitystringRequired

front_image_urlstringRequired

back_image_urlany ofOptional

stringOptional

or

nullOptional

session_idstring · uuid4Required

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /beetlelabs-verification/document-proof/id-documents/ HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "document_type": "PASSPORT",
  "document_number": "text",
  "full_name": "text",
  "date_of_birth": "2025-06-06",
  "expiry_date": "2025-06-06",
  "nationality": "text",
  "front_image_url": "text",
  "back_image_url": "text",
  "session_id": "text"
}

{
  "document_type": "PASSPORT",
  "document_number": "text",
  "full_name": "text",
  "date_of_birth": "2025-06-06",
  "expiry_date": "2025-06-06",
  "nationality": "text",
  "front_image_url": "text",
  "back_image_url": "text",
  "id": "text",
  "session_id": "text",
  "verified": true,
  "uploaded_at": "2025-06-06T12:38:49.717Z"
}

Get Id Document

get

Path parameters

document_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /beetlelabs-verification/document-proof/id-documents/{document_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

{
  "document_type": "PASSPORT",
  "document_number": "text",
  "full_name": "text",
  "date_of_birth": "2025-06-06",
  "expiry_date": "2025-06-06",
  "nationality": "text",
  "front_image_url": "text",
  "back_image_url": "text",
  "id": "text",
  "session_id": "text",
  "verified": true,
  "uploaded_at": "2025-06-06T12:38:49.717Z"
}

Update Id Document

patch

Path parameters

document_idstringRequired

Body

verifiedbooleanRequired

verification_notesany ofRequired

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /beetlelabs-verification/document-proof/id-documents/{document_id} HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "verified": true,
  "verification_notes": "text"
}

{
  "document_type": "PASSPORT",
  "document_number": "text",
  "full_name": "text",
  "date_of_birth": "2025-06-06",
  "expiry_date": "2025-06-06",
  "nationality": "text",
  "front_image_url": "text",
  "back_image_url": "text",
  "id": "text",
  "session_id": "text",
  "verified": true,
  "uploaded_at": "2025-06-06T12:38:49.717Z"
}

Get Session Id Document

get

Path parameters

session_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /beetlelabs-verification/document-proof/sessions/{session_id}/id-document HTTP/1.1
Host: beetlelabs.ai
Accept: */*

{
  "document_type": "PASSPORT",
  "document_number": "text",
  "full_name": "text",
  "date_of_birth": "2025-06-06",
  "expiry_date": "2025-06-06",
  "nationality": "text",
  "front_image_url": "text",
  "back_image_url": "text",
  "id": "text",
  "session_id": "text",
  "verified": true,
  "uploaded_at": "2025-06-06T12:38:49.717Z"
}

Create Address Proof

post

Body

document_typestring · enumRequiredPossible values:

document_urlstringRequired

addressstringRequired

address_typeany ofOptional

string · enumOptionalPossible values:

or

nullOptional

countryany ofOptional

stringOptional

or

nullOptional

session_idstring · uuid4Required

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /beetlelabs-verification/document-proof/address-proofs/ HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "document_type": "PASSPORT",
  "document_url": "text",
  "address": "text",
  "address_type": "Residential",
  "country": "text",
  "session_id": "text"
}

{
  "document_type": "PASSPORT",
  "document_url": "text",
  "address": "text",
  "address_type": "Residential",
  "country": "text",
  "id": "text",
  "session_id": "text",
  "is_primary": true,
  "verified": true,
  "created_at": "2025-06-06T12:38:49.717Z"
}

Get Session Address Proofs

get

Path parameters

session_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /beetlelabs-verification/document-proof/sessions/{session_id}/address-proofs HTTP/1.1
Host: beetlelabs.ai
Accept: */*

[
  {
    "document_type": "PASSPORT",
    "document_url": "text",
    "address": "text",
    "address_type": "Residential",
    "country": "text",
    "id": "text",
    "session_id": "text",
    "is_primary": true,
    "verified": true,
    "created_at": "2025-06-06T12:38:49.717Z"
  }
]