List Verifications
Overview
This endpoint allows you to retrieve a list of your recent verification records. You can retrieve records from the past 30 days. Verification records older than 30 days are automatically deleted. You can also retrieve a specific verification record by providing its verification ID.
Steps
Make API Request:
Send a GET request to the verification records endpoint.
Include any optional query parameters to filter or retrieve a specific record.
Query Parameters
workflow_type
business | person
Type of verification
page_size
Integer (default: 20)
Number of records per page
next_page_token
String
Token returned for pagination
id
String (UUID)
The verification id
status
Initiated | GeneratingLivenessCheck | Completed | Running | Failed | AwaitingLivenessCheck
Status of verification
report_status
true | false
Report status
object_search_phrase
String
Phrase to filter results (e.g., business name, first/last name combinations, verification ID)
Sample Request:
// Some code
curl -X GET "https://api.bive.ai/identity/workflow" \
-H "Api-Key: YOUR_TOKEN_HERE"Receive Verification Records
The API will return a JSON response containing the verification records.
If a specific ID was requested, it will return only that record.
If no ID was requested, it will return an array of verification records.
Response Details
Successful Response (200 OK):
Error Response (422 Unprocessable Entity):
Automatic Deletion
Verification records are automatically deleted after 30 days. This ensures data privacy and efficient storage management.
Error Handling
400 Bad Request: Invalid parameters.
404 Not Found: Verification record not found (when using verification_id).
500 Internal Server Error: Server-side error.
Use Cases
Auditing and compliance
Generating verification reports
Providing customer support
Tracking verification history
Last updated