VendorOnBoardingApi

All URIs are relative to https://business.apis.kesk.app/v1

Method	HTTP request	Description
createVendorApplication	POST /vendors/onboarding	Create a new vendor onboarding application
deleteVendorApplication	DELETE /vendors/onboarding/`{business_id}`	Delete vendor onboarding application
deleteVendorOnboardingDocument	DELETE /vendors/onboarding/`{business_id}`/documents/`{document_id}`	Delete a document from vendor onboarding
getVendorApplication	GET /vendors/onboarding/`{business_id}`	Get vendor onboarding application
getVendorApplicationStatus	GET /vendors/onboarding/`{business_id}`/status	Get application status
getVendorDocuments	GET /vendors/onboarding/`{business_id}`/documents	Get required documents and upload status
getVendorFeeStatus	GET /vendors/onboarding/`{business_id}`/fees/status	Check fee payment status
getVendorOnboardingConfig	GET /vendors/onboarding/config/`{country_code}`/`{city_id}`	Get vendor onboarding configuration for a country, city, and registration type
payVendorOnboardingFee	POST /vendors/onboarding/`{business_id}`/fees/pay	Initiate payment for onboarding fee
replaceVendorApplication	PUT /vendors/onboarding/`{business_id}`	Replace vendor onboarding application (full replace)
submitVendorApplication	POST /vendors/onboarding/`{business_id}`/submit	Submit application for review
updateVendorApplication	PATCH /vendors/onboarding/`{business_id}`	Update vendor onboarding application (partial update)
uploadVendorOnboardingDocument	POST /vendors/onboarding/`{business_id}`/documents	Upload a document for vendor onboarding

createVendorApplication

CreateVendorApplicationResponse createVendorApplication(CreateVendorApplicationRequest)

Create a new vendor onboarding application

Creates a new draft business application. Can include initial data or be empty. Returns the existing draft application if one already exists for this user.

Parameters

Name	Type	Description	Notes
CreateVendorApplicationRequest	CreateVendorApplicationRequest

Return type

CreateVendorApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

deleteVendorApplication

DeleteVendorApplicationResponse deleteVendorApplication(business_id)

Delete vendor onboarding application

Deletes a draft application. Only allowed if status is draft.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

DeleteVendorApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

deleteVendorOnboardingDocument

VendorDeleteDocumentResponse deleteVendorOnboardingDocument(business_id, document_id)

Delete a document from vendor onboarding

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]
document_id	Long		[default to null]

Return type

VendorDeleteDocumentResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorApplication

VendorApplicationResponse getVendorApplication(business_id)

Get vendor onboarding application

Returns the current state of the application with all filled data and progress.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

VendorApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorApplicationStatus

VendorApplicationStatusResponse getVendorApplicationStatus(business_id)

Get application status

Returns current status and any feedback from reviewers.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

VendorApplicationStatusResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorDocuments

VendorDocumentsResponse getVendorDocuments(business_id)

Get required documents and upload status

Returns required documents and their upload status based on the application’s registration_type and country.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

VendorDocumentsResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorFeeStatus

VendorFeeStatusResponse getVendorFeeStatus(business_id)

Check fee payment status

Returns the payment status for the onboarding fee.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

VendorFeeStatusResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorOnboardingConfig

VendorOnboardingConfigResponse getVendorOnboardingConfig(country_code, city_id, registration_type)

Get vendor onboarding configuration for a country, city, and registration type

Returns all configuration needed for the entire onboarding flow in one call, including vendor types with categories (filtered by registration type), business types, required documents, and onboarding fee information.

Parameters

Name	Type	Description	Notes
country_code	String		[default to null]
city_id	Long		[default to null]
registration_type	RegistrationType	Registration type to filter vendor types (individual or business)	[default to null] [enum: Individual, Business]

Return type

VendorOnboardingConfigResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

payVendorOnboardingFee

VendorPayFeeResponse payVendorOnboardingFee(business_id, VendorPayFeeRequest)

Initiate payment for onboarding fee

Initiates payment for the onboarding fee. Supports Stripe (international) and Razorpay (India). Fee details are available in the /config endpoint.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]
VendorPayFeeRequest	VendorPayFeeRequest

Return type

VendorPayFeeResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

replaceVendorApplication

UpdateVendorApplicationResponse replaceVendorApplication(business_id, ReplaceVendorApplicationRequest)

Replace vendor onboarding application (full replace)

Replaces the entire application data. All required fields must be provided. Useful for importing data or full form submission.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]
ReplaceVendorApplicationRequest	ReplaceVendorApplicationRequest

Return type

UpdateVendorApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

submitVendorApplication

VendorSubmitApplicationResponse submitVendorApplication(business_id)

Submit application for review

Validates all required fields are filled and fee is paid, then changes status to submitted.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

VendorSubmitApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

updateVendorApplication

UpdateVendorApplicationResponse updateVendorApplication(business_id, UpdateVendorApplicationRequest)

Update vendor onboarding application (partial update)

Updates specific sections. Only provided fields are updated (merge behavior). Can be called multiple times as user fills out form.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]
UpdateVendorApplicationRequest	UpdateVendorApplicationRequest

Return type

UpdateVendorApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

uploadVendorOnboardingDocument

VendorUploadDocumentResponse uploadVendorOnboardingDocument(business_id)

Upload a document for vendor onboarding

Multipart upload with document type.

Parameters

Name	Type	Description	Notes
business_id	Long		[default to null]

Return type

VendorUploadDocumentResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8