# Verification Session ## GET /verification-session/verification-summary-periodic/{client\_id} > Get Periodic Summary ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/verification-summary-periodic/{client_id}":{"get":{"tags":["Verification Session"],"summary":"Get Periodic Summary","operationId":"get_periodic_summary_verification_session_verification_summary_periodic__client_id__get","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"integer","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"VerificationSummaryResponse":{"properties":{"weekly":{"items":{"$ref":"#/components/schemas/PeriodSummary"},"type":"array","title":"Weekly"},"monthly":{"items":{"$ref":"#/components/schemas/PeriodSummary"},"type":"array","title":"Monthly"},"yearly":{"items":{"$ref":"#/components/schemas/PeriodSummary"},"type":"array","title":"Yearly"},"overall":{"$ref":"#/components/schemas/OverallSummary"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"type":"object","required":["weekly","monthly","yearly","overall","metadata"],"title":"VerificationSummaryResponse"},"PeriodSummary":{"properties":{"period":{"type":"string","title":"Period"},"risk_levels":{"$ref":"#/components/schemas/RiskLevelSummary"},"statuses":{"$ref":"#/components/schemas/StatusSummary"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["period","risk_levels","statuses","total"],"title":"PeriodSummary"},"RiskLevelSummary":{"properties":{"low":{"type":"integer","title":"Low","default":0},"medium":{"type":"integer","title":"Medium","default":0},"high":{"type":"integer","title":"High","default":0},"unknown":{"type":"integer","title":"Unknown","default":0}},"type":"object","title":"RiskLevelSummary"},"StatusSummary":{"properties":{"pending":{"type":"integer","title":"Pending","default":0},"approved":{"type":"integer","title":"Approved","default":0},"rejected":{"type":"integer","title":"Rejected","default":0},"failed":{"type":"integer","title":"Failed","default":0},"expired":{"type":"integer","title":"Expired","default":0}},"type":"object","title":"StatusSummary"},"OverallSummary":{"properties":{"risk_levels":{"$ref":"#/components/schemas/RiskLevelSummary"},"statuses":{"$ref":"#/components/schemas/StatusSummary"},"total_sessions":{"type":"integer","title":"Total Sessions"}},"type":"object","required":["risk_levels","statuses","total_sessions"],"title":"OverallSummary"},"Metadata":{"properties":{"risk_levels":{"items":{"type":"string"},"type":"array","title":"Risk Levels"},"statuses":{"items":{"type":"string"},"type":"array","title":"Statuses"},"time_ranges":{"additionalProperties":{"type":"string"},"type":"object","title":"Time Ranges"}},"type":"object","required":["risk_levels","statuses","time_ranges"],"title":"Metadata"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## List Sessions > Get a list of all verification sessions. You can filter by status, client ID, and date range. This helps track the progress of all verification processes. ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/":{"get":{"tags":["Verification Session"],"summary":"List Sessions","description":"Get a list of all verification sessions. You can filter by status, client ID, and date range. This helps track the progress of all verification processes.","operationId":"list_sessions_verification_session__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"default":20,"title":"Size"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/VerificationStatus"},{"type":"null"}],"title":"Status"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VerificationSessionListResponse"},"title":"Response List Sessions Verification Session Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"VerificationStatus":{"type":"string","enum":["pending","approved","rejected"],"title":"VerificationStatus"},"VerificationSessionListResponse":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"verification_type":{"anyOf":[{"$ref":"#/components/schemas/VerificationType"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"verification_config_id":{"type":"string","format":"uuid4","title":"Verification Config Id"},"id":{"type":"string","format":"uuid4","title":"Id"},"session_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Token"},"consent_given":{"type":"boolean","title":"Consent Given","default":false},"consent_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Consent Timestamp"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"personal_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Personal Details"},"business_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Business Details"},"risk_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Level"},"verification_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Verification Config"},"invitations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Invitations"}},"type":"object","required":["client_id","verification_config_id","id","created_at"],"title":"VerificationSessionListResponse"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Create Session Route > Create a new verification session for a user. This is the first step in the verification process. It generates a unique session ID that will be used throughout the verification flow. ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/":{"post":{"tags":["Verification Session"],"summary":"Create Session Route","description":"Create a new verification session for a user. This is the first step in the verification process. It generates a unique session ID that will be used throughout the verification flow.","operationId":"create_session_route_verification_session__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationSessionCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationSessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"VerificationSessionCreate":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"verification_type":{"anyOf":[{"$ref":"#/components/schemas/VerificationType"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/VerificationStatus","default":"pending"},"verification_config_id":{"type":"string","format":"uuid4","title":"Verification Config Id"}},"type":"object","required":["client_id","verification_config_id"],"title":"VerificationSessionCreate"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"VerificationStatus":{"type":"string","enum":["pending","approved","rejected"],"title":"VerificationStatus"},"VerificationSessionResponse":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"verification_type":{"anyOf":[{"$ref":"#/components/schemas/VerificationType"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"verification_config_id":{"type":"string","format":"uuid4","title":"Verification Config Id"},"id":{"type":"string","format":"uuid4","title":"Id"},"session_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Token"},"consent_given":{"type":"boolean","title":"Consent Given","default":false},"consent_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Consent Timestamp"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"personal_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Personal Details"},"business_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Business Details"},"id_document":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Id Document"},"liveness_check":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Liveness Check"},"address_proof":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Address Proof"},"business_documents":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Business Documents"},"ultimate_beneficial_owners":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Ultimate Beneficial Owners"},"directors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Directors"},"invitations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Invitations"},"risk_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Level"}},"type":"object","required":["client_id","verification_config_id","id","created_at"],"title":"VerificationSessionResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /verification-session/{session\_id} > Get Session ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/{session_id}":{"get":{"tags":["Verification Session"],"summary":"Get Session","operationId":"get_session_verification_session__session_id__get","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"include_relationships","in":"query","required":false,"schema":{"type":"boolean","description":"Load related documents","default":false,"title":"Include Relationships"},"description":"Load related documents"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationSessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"VerificationSessionResponse":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"verification_type":{"anyOf":[{"$ref":"#/components/schemas/VerificationType"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"verification_config_id":{"type":"string","format":"uuid4","title":"Verification Config Id"},"id":{"type":"string","format":"uuid4","title":"Id"},"session_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Token"},"consent_given":{"type":"boolean","title":"Consent Given","default":false},"consent_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Consent Timestamp"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"personal_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Personal Details"},"business_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Business Details"},"id_document":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Id Document"},"liveness_check":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Liveness Check"},"address_proof":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Address Proof"},"business_documents":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Business Documents"},"ultimate_beneficial_owners":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Ultimate Beneficial Owners"},"directors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Directors"},"invitations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Invitations"},"risk_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Level"}},"type":"object","required":["client_id","verification_config_id","id","created_at"],"title":"VerificationSessionResponse"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## DELETE /verification-session/{session\_id} > Delete Session ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/{session_id}":{"delete":{"tags":["Verification Session"],"summary":"Delete Session","operationId":"delete_session_verification_session__session_id__delete","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## PATCH /verification-session/{session\_id} > Update Session ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/{session_id}":{"patch":{"tags":["Verification Session"],"summary":"Update Session","operationId":"update_session_verification_session__session_id__patch","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationSessionUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationSessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"VerificationSessionUpdate":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/VerificationStatus"},{"type":"null"}]},"rejection_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejection Reason"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"consent_given":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Consent Given"},"consent_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Consent Timestamp"},"session_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Token"},"risk_level":{"anyOf":[{"$ref":"#/components/schemas/RiskLevel"},{"type":"null"}]}},"type":"object","title":"VerificationSessionUpdate"},"VerificationStatus":{"type":"string","enum":["pending","approved","rejected"],"title":"VerificationStatus"},"RiskLevel":{"type":"string","enum":["low","medium","high","unknown"],"title":"RiskLevel"},"VerificationSessionResponse":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"verification_type":{"anyOf":[{"$ref":"#/components/schemas/VerificationType"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"verification_config_id":{"type":"string","format":"uuid4","title":"Verification Config Id"},"id":{"type":"string","format":"uuid4","title":"Id"},"session_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Token"},"consent_given":{"type":"boolean","title":"Consent Given","default":false},"consent_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Consent Timestamp"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"personal_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Personal Details"},"business_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Business Details"},"id_document":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Id Document"},"liveness_check":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Liveness Check"},"address_proof":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Address Proof"},"business_documents":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Business Documents"},"ultimate_beneficial_owners":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Ultimate Beneficial Owners"},"directors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Directors"},"invitations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Invitations"},"risk_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Level"}},"type":"object","required":["client_id","verification_config_id","id","created_at"],"title":"VerificationSessionResponse"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Invite Users > Send verification invites to users via email and/or SMS. You can invite individual users or bulk invite multiple users using a CSV file. Each invite contains a unique link for the user to start their verification process. ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/invite":{"post":{"tags":["Verification Session"],"summary":"Invite Users","description":"Send verification invites to users via email and/or SMS. You can invite individual users or bulk invite multiple users using a CSV file. Each invite contains a unique link for the user to start their verification process.","operationId":"invite_users_verification_session_invite_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_invite_users_verification_session_invite_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitatioResponseWithCount"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_invite_users_verification_session_invite_post":{"properties":{"invite_type":{"$ref":"#/components/schemas/InviteType"},"flow_config_id":{"type":"string","title":"Flow Config Id"},"client_id":{"type":"integer","title":"Client Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"existing_business":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Existing Business"},"csv_file":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Csv File"}},"type":"object","required":["invite_type","flow_config_id","client_id","email","phone","business_name","existing_business"],"title":"Body_invite_users_verification_session_invite_post"},"InviteType":{"type":"string","enum":["bulk","single"],"title":"InviteType"},"InvitatioResponseWithCount":{"properties":{"invitations":{"items":{"$ref":"#/components/schemas/InvitationResponse"},"type":"array","title":"Invitations"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["invitations","count"],"title":"InvitatioResponseWithCount"},"InvitationResponse":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"session_id":{"type":"string","format":"uuid4","title":"Session Id"},"recipient_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Email"},"recipient_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Phone"},"unique_url":{"type":"string","title":"Unique Url"},"sent_at":{"type":"string","format":"date-time","title":"Sent At"},"delivered":{"type":"boolean","title":"Delivered"}},"type":"object","required":["id","session_id","unique_url","sent_at","delivered"],"title":"InvitationResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /verification-session/verify/{session\_id} > Open Chat Interface ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/verify/{session_id}":{"get":{"tags":["Verification Session"],"summary":"Open Chat Interface","operationId":"open_chat_interface_verification_session_verify__session_id__get","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"token","in":"query","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /verification-session/invites/ > List Invites ```json {"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/verification-session/invites/":{"get":{"tags":["Verification Session"],"summary":"List Invites","operationId":"list_invites_verification_session_invites__get","parameters":[{"name":"client_id","in":"query","required":false,"schema":{"type":"integer","title":"Client Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"default":20,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"InvitationListResponse":{"properties":{"invites":{"items":{"$ref":"#/components/schemas/InvitationResponse"},"type":"array","title":"Invites"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"size":{"type":"integer","title":"Size"}},"type":"object","required":["invites","total","page","size"],"title":"InvitationListResponse"},"InvitationResponse":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"session_id":{"type":"string","format":"uuid4","title":"Session Id"},"recipient_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Email"},"recipient_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Phone"},"unique_url":{"type":"string","title":"Unique Url"},"sent_at":{"type":"string","format":"date-time","title":"Sent At"},"delivered":{"type":"boolean","title":"Delivered"}},"type":"object","required":["id","session_id","unique_url","sent_at","delivered"],"title":"InvitationResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.beetlelabs.ai/verification-session.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.