Trade License API
Last updated
Was this helpful?
Last updated
Was this helpful?
Parameter to carry Request metadata in the request body
Unique id for a tenant.
Page number
Search based on status.
unique identifier of trade licence
Unique application number for a trade license application.
The unique license number for a Trade license.
The unique Old license number for a Trade license.
The mobile number of a Trade owner.
[0-9]POST /tl-service/v1/_search?tenantId=null HTTP/1.1
Host:
Accept: */*
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Licenses": [
{
"id": "text",
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"licenseNumber": "text",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"applicationDate": 1,
"commencementDate": 1,
"issuedDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"pwdExpiryDate": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressId": "text",
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Parameter to carry Request metadata in the request body
Unique id for a tenant.
Page number
Search based on status.
unique identifier of trade licence
Unique application number for a trade license application.
The unique license number for a Trade license.
The unique Old license number for a Trade license.
The mobile number of a Trade owner.
[0-9]POST /tl-service/v1/_search?tenantId=null HTTP/1.1
Host:
Accept: */*
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Licenses": [
{
"id": "text",
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"licenseNumber": "text",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"applicationDate": 1,
"commencementDate": 1,
"issuedDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"pwdExpiryDate": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressId": "text",
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}To create new Trade License in the system. API supports bulk creation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one Trade License, please pass array with one Trade License object.
Following Conditions are applied -
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
POST /tl-service/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2427
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Licenses": [
{
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text"
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text"
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"additionalDetail": "text"
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Licenses": [
{
"id": "text",
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"licenseNumber": "text",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"applicationDate": 1,
"commencementDate": 1,
"issuedDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"pwdExpiryDate": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressId": "text",
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}To update existing Trade License in the system. API supports bulk updation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To update one Trade License, please pass array with one Trade License object.
Following Conditions are applied -
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
POST /tl-service/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2427
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Licenses": [
{
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text"
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text"
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"additionalDetail": "text"
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Licenses": [
{
"id": "text",
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"licenseNumber": "text",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"applicationDate": 1,
"commencementDate": 1,
"issuedDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"pwdExpiryDate": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressId": "text",
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}To create new Trade License in the system. API supports bulk creation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one Trade License, please pass array with one Trade License object.
Following Conditions are applied -
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
POST /tl-service/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2427
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Licenses": [
{
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text"
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text"
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"additionalDetail": "text"
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Licenses": [
{
"id": "text",
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"licenseNumber": "text",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"applicationDate": 1,
"commencementDate": 1,
"issuedDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"pwdExpiryDate": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressId": "text",
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}To update existing Trade License in the system. API supports bulk updation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To update one Trade License, please pass array with one Trade License object.
Following Conditions are applied -
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
POST /tl-service/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2427
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Licenses": [
{
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"commencementDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text"
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text"
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"additionalDetail": "text"
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Licenses": [
{
"id": "text",
"tenantId": "text",
"name": "text",
"licenseType": "TEMPORARY",
"licenseNumber": "text",
"oldLicenseNumber": "text",
"propertyId": "text",
"oldPropertyId": "text",
"applicationDate": 1,
"commencementDate": 1,
"issuedDate": 1,
"financialYear": "text",
"validFrom": 1,
"validTo": 1,
"action": "INITIATE",
"status": "INITIATED",
"tradeLicenseDetail": {
"surveyNo": "text",
"subOwnerShipCategory": "text",
"structureType": "text",
"operationalArea": 1,
"owners": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"dob": "2025-05-10",
"pwdExpiryDate": "2025-05-10",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-05-10",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-05-10",
"otpReference": "text",
"tenantId": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"relationship": "FATHER",
"documents": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
],
"channel": "COUNTER",
"address": {
"tenantId": "text",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"addressId": "text",
"addressNumber": "text",
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"detail": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
},
"tradeUnits": [
{
"tenantId": "text",
"tradeType": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"accessories": [
{
"tenantId": "text",
"accessoryCategory": "text",
"uom": "text",
"uomValue": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"verificationDocuments": [
{
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"additionalDetail": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}