Asset Upload

Overview

This endpoint allows you to upload required documents, such as government IDs, business registration documents, and bank statements, as part of the verification process. Successful uploads return a filename that you must include in your subsequent verification request.

Host: https://api.bive.ai

Steps

1. Prepare Document

• Ensure the document is in an accepted format (e.g., PDF, JPG, PNG)

• Verify the file size is within the allowed (5MB) limit

2. Make Upload Request

• Send a POST request to the upload endpoint (https://api.bive.ai/identity/upload)

• Set the enctype to form/multipart-data

• Include any other required parameters (see "Request Body")

Request Body

Type	Filename	Description
gov_id	File (image/png, image/jpeg)	Note: International passport, Drivers license, and State government ID are the only acceptable government IDs.
selfie	File (image/png, image/jpeg)	Note: The photo must only show one person with their face clearly visible. It is required that you only submit a trusted photo. Results will be inaccurate if you submit a fraudulent photo.
account_statement	File (application/pdf)	Note: The expected document is a business bank account statement.
biz_reg	File (application/pdf)	Note: The expected document is a business registration document that shows the business name, tax ID and business address.

Note: At least one field is required.

Example Request (using curl)

curl -X POST "https://api.bive.ai/identity/upload" \
  -H "Api-Key: YOUR_TOKEN_HERE" \
  -F "gov_id=@/path/to/passport.jpg" \
  -F "selfie=@/path/to/selfie.png" \
  -F "account_statement=@/path/to/statement.pdf" \
  -F "biz_reg=@/path/to/business_registration.pdf"

Receive Filename

Upon successful upload, the API will return a JSON response containing the generated filename.

Sample Response Body

{
  "gov_id": "gov-id-f5c0800f-c02b-4b9f-b5b5-64f8b99d1fb2.png",
  "selfie": "selfie-b2354384-8c8a-4900-89ec-1ebbd9bd88b7.png",
  "account_statement": "statement-b2354384-8c8a-4900-89ec-1ebbd9bd88b7.png",
  "biz_reg": "biz_reg-b2354384-8c8a-4900-89ec-1ebbd9bd88b7.png"
}

3. Save Filename

• Save the returned filename

4. Use Filename in Verification Request

• Include the saved filename in the appropriate field of your verification request

Sample Usage in Person Verification

{
  "gov_id": "gov-id-f5c0800f-c02b-4b9f-b5b5-64f8b99d1fb2.png",
  "media": "selfie-b2354384-8c8a-4900-89ec-1ebbd9bd88b7.png",
  "first_name": "John",
  "last_name": "Doe"
  
}

Response Details

• Successful Response (200 OK):

  • JSON object with a filename field

• Error Response:

  • JSON object with an error field containing an error message and/or code

File Type and Size Limits

• Accepted file types: PDF, JPG, PNG

• Maximum file size: 5MB

Error Handling

• 400 Bad Request: Invalid file type or size

• 500 Internal Server Error: Server-side error during upload

Security Considerations

• Uploaded documents are stored securely

• Sensitive information is handled with appropriate security measures

• Documents and verifications are automatically deleted after 30 days