Vendor Onboarding API

This API allows vendor to submit onboarding form.

---

Endpoints Overview

Method	Endpoint	Description
POST	/api/v1/vendor/accounts/on-boarding/	submit onboarding form

---

Vendor Onboarding API

1. Submit onboarding form

Endpoint

• URL: /api/v1/vendor/accounts/on-boarding/
• Method: POST
• Permission Required: IsAuthenticated (Vendor Only)

Description

Submit onboarding form

Example Request

This is the example request

POST /api/v1/vendor/accounts/on-boarding/

---

Request Body

This is the request body

{
    "company_name": "Example Company",
    "company_address": "123 Main Street, Example City, Country",
    "shop": [
        {
            "shop_name": "Example Shop",
            "phone_number": "9876543210",
            "warehouse_location": "Example Warehouse Location",
            "shop_image": "@/path/to/shop_image.jpg"
        }
    ],
    "bank_details": {
        "account_name": "Example Account",
        "bank_name": "Example Bank",
        "account_number": "1234567890",
        "branch_name": "Example Branch",
        "cheque_book_image": "@/path/to/cheque_book.jpg"
    },
    "certificate_image": "@/path/to/certificate.jpg",
    "pan_vat_certificate_image": "@/path/to/pan_vat_certificate.jpg"
}

Request Body (Form Data)

curl --location '<https://example.com/api/v1/vendor/accounts/on-boarding/>' \
--header 'Authorization: Bearer <your_access_token>' \
--form 'company_name="Example Company"' \
--form 'company_address="123 Main Street, Example City, Country"' \
--form 'shop[0][shop_name]="Example Shop"' \
--form 'shop[0][phone_number]="9876543210"' \
--form 'shop[0][warehouse_location]="Example Warehouse Location"' \
--form 'bank_details[account_name]="Example Account"' \
--form 'bank_details[bank_name]="Example Bank"' \
--form 'bank_details[account_number]="1234567890"' \
--form 'bank_details[branch_name]="Example Branch"' \
--form 'certificate_image=@"/path/to/certificate.jpg"' \
--form 'pan_vat_certificate_image=@"/path/to/pan_vat_certificate.jpg"' \
--form 'shop[0][shop_image]=@"/path/to/shop_image.jpg"' \
--form 'bank_details[cheque_book_image]=@"/path/to/cheque_book.jpg"'

---

Success

{
    "success": true,
    "message": "Vendor onboarding request submitted successfully",
    "data": {
        "vendor_id": 123,
        "status": "under_verification"
    }
}

---

Error

{
    "success": false,
    "message": "Invalid data provided",
    "errors": {
        "company_name": ["This field is required."],
        "shop": ["At least one shop is required."],
        "bank_details": ["Bank account details are required."]
    }
}

---