File Upload API - Onboarding Buddy

The Onboarding Buddy File Upload API enables developers to securely upload user files, including documents, images, and videos, with AI-driven classification and storage. Ideal for onboarding, compliance, and data management workflows, this API supports single and batch uploads for seamless integration.

Sign Up for File Upload API

Why Use the Onboarding Buddy File Upload API?

Securely upload and manage user files to streamline onboarding, ensure compliance, and enhance data workflows. The Onboarding Buddy API leverages AI-powered features like automatic classification and semantic search, making it perfect for KYC, user verification, and content management applications.

Key Features

• Single File Upload: Securely upload a single user file with metadata generation.
• Batch File Upload: Upload multiple files efficiently in a single request.
• AI Classification: Automatically classify files using AI for documents, images, or videos.
• Secure Storage: Store files with encryption and access controls for compliance.
• Semantic Search Support: Enable advanced search capabilities with Retrieval-Augmented Generation (RAG).
• Secure API Access: Use App Key, API Key, and API Secret for authenticated requests.

Relevant Endpoints

Endpoint	Method	Purpose
POST /file-service/upload	POST	Uploads a single user file and returns the file metadata.
POST /file-service/batch/upload	POST	Uploads multiple user files and returns a batch upload response.
GET /file-service/batch/poll/{batchId}	GET	Polls the status of a submitted batch file upload request using the batch ID.
GET /file-service/batch/upload/{batchId}	GET	Retrieves the metadata for a batch of uploaded user files using the batch ID.

Code Samples

Upload a Single User File

Use the POST /file-service/upload endpoint to upload a single user file. Include your API credentials in the headers for secure access.

curl -X POST https://api.onboardingbuddy.co/file-service/upload \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret" \
-H "Content-Type: multipart/form-data" \
-F "file=@/path/to/document.pdf"
    

Example Response:

{
  "fileId": "file-12345",
  "fileName": "document.pdf",
  "fileType": "document",
  "fileSize": 1048576,
  "uploadStatus": "success",
  "metadata": {
    "classification": "KYC document",
    "uploadedAt": "2025-09-09T17:56:00Z",
    "storagePath": "gs://onboarding-buddy-files/file-12345"
  }
}
    

Upload a Batch of User Files

Use the POST /file-service/batch/upload endpoint to upload multiple user files efficiently.

curl -X POST https://api.onboardingbuddy.co/file-service/batch/upload \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/document1.pdf" \
-F "files=@/path/to/image.jpg"
    

Example Response:

{
  "batchId": "batch-98765",
  "status": "processing"
}
    

Poll Batch Upload Status

Check the status of a batch upload request using the GET /file-service/batch/poll/{batchId} endpoint.

curl -X GET https://api.onboardingbuddy.co/file-service/batch/poll/batch-98765 \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret"
    

Example Response:

{
  "batchId": "batch-98765",
  "status": "completed"
}
    

Retrieve Batch Upload Metadata

Retrieve the metadata for a completed batch upload using the GET /file-service/batch/upload/{batchId} endpoint.

curl -X GET https://api.onboardingbuddy.co/file-service/batch/upload/batch-98765 \
-H "ob-app-key: your-app-key" \
-H "ob-api-key: your-api-key" \
-H "ob-api-secret: your-api-secret"
    

Example Response:

{
  "batchId": "batch-98765",
  "results": [
    {
      "fileId": "file-12346",
      "fileName": "document1.pdf",
      "fileType": "document",
      "fileSize": 1048576,
      "uploadStatus": "success",
      "metadata": {
        "classification": "KYC document",
        "uploadedAt": "2025-09-09T17:56:00Z",
        "storagePath": "gs://onboarding-buddy-files/file-12346"
      }
    },
    {
      "fileId": "file-12347",
      "fileName": "image.jpg",
      "fileType": "image",
      "fileSize": 524288,
      "uploadStatus": "success",
      "metadata": {
        "classification": "user profile image",
        "uploadedAt": "2025-09-09T17:56:00Z",
        "storagePath": "gs://onboarding-buddy-files/file-12347"
      }
    }
  ]
}
    

Applications of File Upload

The Onboarding Buddy File Upload API is ideal for:

• User Onboarding: Upload identity documents or profile images for secure user verification.
• KYC Compliance: Manage compliance documents with AI-driven classification for regulatory workflows.
• Content Management: Store and organize user-generated content like images and videos.
• Data Workflows: Enable semantic search and RAG for advanced file retrieval and analysis.

Next Steps

Get started with the Onboarding Buddy File Upload API today. Sign up to obtain your API credentials, explore the full API documentation, or discover other use cases like email validation or sanctions screening. For technical details, view all API endpoints.

Start Uploading Files Now