Business management
37 routes. Paths are relative to https://api.intersink.com/v1.
- GET/business/{id}Full business profile by ID. Banking, the address record and the owner's address, location, phone and signatory are for the owner only; members get null for them.
- GET/business/{id}/change-requestsChange requests of a business (paged, max 100)
- POST/business/{id}/change-requestsRequest a change to a reviewed field (legal name, address, …)
- POST/business/{id}/change-requests/{requestId}/cancelCancel a pending change request
- POST/business/{id}/change-requests/batchRequest several changes with one reason and proof (all are stored, or none)
- POST/business/{id}/closeClose the business (owner only). A soft close: the business and its channels are archived.
- GET/business/{id}/documentsReview documents of a business (paged, max 100)
- POST/business/{id}/documentsUpload a review document (multipart: file + document_type + document_no?)
- DELETE/business/{id}/documents/{documentId}Remove a document (archived; verified documents stay)
- GET/business/{id}/reviewReview status (draft/submitted/in_review/approved/rejected)
- POST/business/{id}/review/submitSubmit the business for verification (draft|rejected → submitted)
- POST/business/{id}/review/withdrawWithdraw a submission before review starts (submitted → draft)
- GET/business/{id}/transferThe pending ownership transfer, if any
- POST/business/{id}/transferStep 1: owner offers the business to another account (7 days)
- POST/business/{id}/transfer/cancelCancel the pending ownership transfer
- GET/business/{id}/verificationVerification checklist: details, documents, call and agreement, and what is missing
- GET/business/{id}/verification/agreementThe customer agreement to sign (text, version, SHA-256) and the signature if signed
- POST/business/{id}/verification/agreement/signSign the customer agreement electronically (typed full name; version and SHA-256 of the text read)
- POST/business/{id}/verification/callAsk for the verification call with our team (times that suit, phone)
- POST/business/{id}/verification/call/cancelCancel the requested or booked verification call
- PATCH/business/{id}/verification/detailsKind of organisation, legal name, registration and tax numbers, website, signatory
- POST/business/addressUpdate or create business address details
- POST/business/bankingUpdate or create business banking details
- POST/business/channel/createCreate a channel for the business
- GET/business/documents/typesDocument types a business can upload
- GET/business/groupGet list of Business Groups
- GET/business/groupsGet list of Business Groups
- GET/business/listGet current user business list
- POST/business/registerRegister a new business
- GET/business/transfers/{transferId}A transfer offer addressed to me
- POST/business/transfers/{transferId}/acceptStep 2: the named account accepts and becomes the owner
- POST/business/transfers/{transferId}/declineDecline an ownership transfer addressed to you
- GET/business/typeGet list of Business Types
- GET/business/typesGet list of Business Types
- POST/business/update/{id}Update business information by ID
- POST/business/upload/{id}Upload business logo and cover
- GET/business/verification/typesKinds of organisation and the documents each must upload
Full business profile by ID. Banking, the address record and the owner's address, location, phone and signatory are for the owner only; members get null for them.
GET/business/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet. Full business details returned
Change requests of a business (paged, max 100)
GET/business/{id}/change-requests
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| status | string, query | One of: "pending", "approved", "rejected", "cancelled". |
| business_id | string, query | Only this business's requests (the channel's queue) |
Response
200. The payload in data is not described in the spec yet.
Request a change to a reviewed field (legal name, address, …)
POST/business/{id}/change-requests
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| fieldrequired | string | One of: "tradename", "legalname", "email", "mobile", "address_1", "address_2", "city", "pincode", "country", "entity_type", "registration_number", "tax_number", "website", "signatory". |
| new_valuerequired | string | The value asked for. signatory: JSON {"name","title","email","phone"}; entity_type: one of the verification kinds. At most 1000 characters. Example: "Acme Retail Pvt Ltd" |
| reasonrequired | string | At most 1000 characters. Example: "Company renamed after board resolution" |
| document_id | number | Supporting document (a document of this business) Minimum 1. |
Response
201. The payload in data is of type object.
Cancel a pending change request
POST/business/{id}/change-requests/{requestId}/cancel
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| requestIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Request several changes with one reason and proof (all are stored, or none)
POST/business/{id}/change-requests/batch
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| changesrequired | object[] | |
| changes[].fieldrequired | string | One of: "tradename", "legalname", "email", "mobile", "address_1", "address_2", "city", "pincode", "country", "entity_type", "registration_number", "tax_number", "website", "signatory". |
| changes[].new_valuerequired | string | The value asked for (as in CreateChangeRequestDto.new_value) At most 1000 characters. Example: "12345678" |
| reasonrequired | string | At most 1000 characters. Example: "Company number typo" |
| document_id | number | Supporting document (a document of this business) Minimum 1. |
Response
201. data is object[].
Close the business (owner only). A soft close: the business and its channels are archived.
POST/business/{id}/close
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| confirmrequired | string | Type the business tradename (or legal name) to confirm At most 255 characters. |
| reason | string | At most 1000 characters. |
Response
200. The payload in data is not described in the spec yet.
Review documents of a business (paged, max 100)
GET/business/{id}/documents
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| status | string, query | One of: "pending", "verified", "rejected". |
Response
200. The payload in data is not described in the spec yet.
Upload a review document (multipart: file + document_type + document_no?)
POST/business/{id}/documents
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body multipart/form-data
| Field | Type | Description |
|---|---|---|
| document_typerequired | number | document_type id (GET /business/documents/types) Minimum 1. Example: 1 |
| document_no | string | At most 100 characters. Example: "U72900KA2021PTC000000" |
Response
201. The payload in data is not described in the spec yet.
Remove a document (archived; verified documents stay)
DELETE/business/{id}/documents/{documentId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| documentIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Review status (draft/submitted/in_review/approved/rejected)
GET/business/{id}/review
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Submit the business for verification (draft|rejected → submitted)
POST/business/{id}/review/submit
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Withdraw a submission before review starts (submitted → draft)
POST/business/{id}/review/withdraw
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
The pending ownership transfer, if any
GET/business/{id}/transfer
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Step 1: owner offers the business to another account (7 days)
POST/business/{id}/transfer
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| emailrequired | string | Email of the account that will own the business At most 254 characters. Example: "[email protected]" |
Response
201. The payload in data is not described in the spec yet.
Cancel the pending ownership transfer
POST/business/{id}/transfer/cancel
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Verification checklist: details, documents, call and agreement, and what is missing
GET/business/{id}/verification
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
The customer agreement to sign (text, version, SHA-256) and the signature if signed
GET/business/{id}/verification/agreement
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Sign the customer agreement electronically (typed full name; version and SHA-256 of the text read)
POST/business/{id}/verification/agreement/sign
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Ask for the verification call with our team (times that suit, phone)
POST/business/{id}/verification/call
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Cancel the requested or booked verification call
POST/business/{id}/verification/call/cancel
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Kind of organisation, legal name, registration and tax numbers, website, signatory
PATCH/business/{id}/verification/details
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Update or create business address details
POST/business/address
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| business_id | string | Example: "uuid-of-business" |
| firstname | string | |
| lastname | string | |
| mobile | string | |
| company | string | |
| landmark | string | |
| address_1 | string | |
| address_2 | string | |
| city | string | |
| pincode | string | |
| country | object | |
| zone | string | |
| area | string | |
| location | object | |
| type | string | |
| file | object | Upload proof image/pdf |
Response
200. The payload in data is not described in the spec yet. Address details saved successfully
Update or create business banking details
POST/business/banking
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| bank_namerequired | string | Example: "HDFC Bank" |
| holder_namerequired | string | Example: "John Doe" |
| account_norequired | string | Example: "50100234567890" |
| ifscrequired | string | Example: "HDFC0001234" |
| swift | string | Example: "SWIFT123" |
| upi | string | Example: "john@upi" |
| type | string | Example: "savings" |
| description | string | Example: "Business primary account" |
| phone | string | Example: "+919876543210" |
| string | Example: "[email protected]" | |
| sort_code | string | Example: "123456" |
| routing_no | string | Example: "123456789" |
| country | object | Example: 3 |
| business_idrequired | string | Example: "uuid-of-business" |
Response
200. The payload in data is not described in the spec yet. Banking details saved successfully
Create a channel for the business
POST/business/channel/create
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| titlerequired | string | Example: "My Online Store" |
| description | string | Example: "Official channel for our business" |
| trademark_id | number | Id of a trademark registered to a business you manage Minimum 1. Example: 3 |
| category_id | string | Example: "uuid-of-category" |
| business_id | string | Example: "uuid-of-business" |
| link | string | Example: "https://mywebsite.com" |
| keywords | string | Example: "keyword1, keyword2" |
Response
201. The payload in data is not described in the spec yet. Channel created successfully
Document types a business can upload
GET/business/documents/types
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. data is object[].
Get list of Business Groups
GET/business/group
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Get list of Business Groups
GET/business/groups
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Get current user business list
GET/business/list
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet. Business list returned
Register a new business
POST/business/register
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| tradenamerequired | string | Example: "Acme Trading" |
| legalnamerequired | string | Example: "Acme Solutions Ltd" |
| firstname | string | Example: "Firstname" |
| lastname | string | Example: "Lastname" |
| emailrequired | string | Example: "[email protected]" |
| mobilerequired | string | Example: "+919876543210" |
| channel_id | string | Example: "uuid-of-channel" |
| logo | string | Example: "uuid-of-file" |
| cover | string | Example: "uuid-of-cover-file" |
| description | string | Example: "Business description here" |
| address_1 | string | Example: "123 Street Name" |
| address_2 | string | Example: "Apartment 4B" |
| city | string | Example: "Indore" |
| pincode | string | Example: "452001" |
| country | number | Id of a row in the country collection Minimum 1. Example: 1 |
| link | string | Example: "https://example.com" |
| keywords | string | Example: "trading, monk, west" |
| location | object | Example: "Lat: 22.7, Long: 75.8" |
| address_id | string | Example: "uuid-of-address-record" |
| banking_id | object | Example: "id-of-banking-record" |
Response
201. The payload in data is not described in the spec yet. Business registered successfully
A transfer offer addressed to me
GET/business/transfers/{transferId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| transferIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Step 2: the named account accepts and becomes the owner
POST/business/transfers/{transferId}/accept
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| transferIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Decline an ownership transfer addressed to you
POST/business/transfers/{transferId}/decline
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| transferIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Get list of Business Types
GET/business/type
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Get list of Business Types
GET/business/types
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Update business information by ID
POST/business/update/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| timezone | string | Example: "Europe/London" |
| fiscal_year_start | number | Month the financial year starts (1 = January) Minimum 1, maximum 12. Example: 4 |
| require_2fa | boolean | Members must use 2-step verification (owner only; the owner is never locked out) |
| logo | string | |
| cover | string | |
| description | string | |
| address_1 | string | |
| address_2 | string | |
| city | string | |
| pincode | string | |
| country | number | Minimum 1. |
| link | string | |
| keywords | string | |
| location | object | |
| address_id | string | |
| banking_id | object |
Response
200. The payload in data is not described in the spec yet. Business updated successfully
Upload business logo and cover
POST/business/upload/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet. Assets uploaded successfully
Kinds of organisation and the documents each must upload
GET/business/verification/types
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet.