Trade License API

TL Service Contract

TL Calculator Service Contract

PreviousTrade License Data Model NextFire NOC Service

Last updated 1 year ago

Was this helpful?

Get the list of Trade License defined in the system.

Search and get Trade License(s) based on defined search criteria.
In case multiple parameters are passed Trade License(s) will be searched as an AND combination of all the parameters.

post

/v1/_search

Query parameters

pageNumberinteger · default: 1

Page number

statusstring

Search based on status.

idsinteger · int64[]

unique identifier of trade licence

applicationNumberstring · min: 2 · max: 64

Unique application number for a trade license application.

licenseNumberstring · min: 2 · max: 64

The unique license number for a Trade license.

oldLicenseNumberstring · min: 2 · max: 64

The unique Old license number for a Trade license.

mobileNumberstring

The mobile number of a Trade owner.

Pattern: [0-9]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tl-service/v1/_search'

200

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 1,
      "commencementDate": 1,
      "issuedDate": 1,
      "financialYear": "text",
      "validFrom": 1,
      "validTo": 1,
      "tradeLicenseDetail": {
        "surveyNo": "text",
        "subOwnerShipCategory": "text",
        "structureType": "text",
        "operationalArea": 1,
        "address": {
          "tenantId": "text",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "addressId": "text",
          "addressNumber": "text",
          "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",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          },
          "type": [
            "PERMANENT"
          ]
        },
        "additionalDetail": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "channel": "COUNTER",
        "owners": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ],
            "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
                }
              }
            ]
          }
        ],
        "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
            }
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "licenseType": "TEMPORARY",
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}

Trade License(s) Retrived Successfully

Create new Trade Licenses.

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 -

PropertyId and OldPropertyId is not mandatory, If entered then validate. Invalid number fails trade license creation
supportDocuments for a given Trade License will created. In case of not attaching the Mandatory Supported Documents creation of New Trade License Fails.
LicenseNumber will be autogenerated on final approval for new License.
ApplicationNumber will be autogenerated for new Trade License

post

/v1/_create

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Licensesobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tl-service/v1/_create' \
  --header 'Content-Type: application/json'

201

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 1,
      "commencementDate": 1,
      "issuedDate": 1,
      "financialYear": "text",
      "validFrom": 1,
      "validTo": 1,
      "tradeLicenseDetail": {
        "surveyNo": "text",
        "subOwnerShipCategory": "text",
        "structureType": "text",
        "operationalArea": 1,
        "address": {
          "tenantId": "text",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "addressId": "text",
          "addressNumber": "text",
          "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",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          },
          "type": [
            "PERMANENT"
          ]
        },
        "additionalDetail": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "channel": "COUNTER",
        "owners": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ],
            "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
                }
              }
            ]
          }
        ],
        "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
            }
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "licenseType": "TEMPORARY",
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}

ReponseInfo with Trade License(s) created successfully

update existing licenses.

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 -

Before payment Employee or Citizen can update any details of trade license
After payment Citizen or Employee can't change any details of TL.

post

/v1/_update

Body

RequestInfoobject

Licensesobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tl-service/v1/_update' \
  --header 'Content-Type: application/json'

201

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 1,
      "commencementDate": 1,
      "issuedDate": 1,
      "financialYear": "text",
      "validFrom": 1,
      "validTo": 1,
      "tradeLicenseDetail": {
        "surveyNo": "text",
        "subOwnerShipCategory": "text",
        "structureType": "text",
        "operationalArea": 1,
        "address": {
          "tenantId": "text",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "addressId": "text",
          "addressNumber": "text",
          "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",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          },
          "type": [
            "PERMANENT"
          ]
        },
        "additionalDetail": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "channel": "COUNTER",
        "owners": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ],
            "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
                }
              }
            ]
          }
        ],
        "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
            }
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "licenseType": "TEMPORARY",
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}

ReponseInfo with Trade License(s) updated sudcessfully

Get the list of Trade License defined in the system.

Search and get Trade License(s) based on defined search criteria.
In case multiple parameters are passed Trade License(s) will be searched as an AND combination of all the parameters.

post

/v1/_search

Query parameters

pageNumberinteger · default: 1

Page number

statusstring

Search based on status.

idsinteger · int64[]

unique identifier of trade licence

applicationNumberstring · min: 2 · max: 64

Unique application number for a trade license application.

licenseNumberstring · min: 2 · max: 64

The unique license number for a Trade license.

oldLicenseNumberstring · min: 2 · max: 64

The unique Old license number for a Trade license.

mobileNumberstring

The mobile number of a Trade owner.

Pattern: [0-9]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tl-service/v1/_search'

200

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 1,
      "commencementDate": 1,
      "issuedDate": 1,
      "financialYear": "text",
      "validFrom": 1,
      "validTo": 1,
      "tradeLicenseDetail": {
        "surveyNo": "text",
        "subOwnerShipCategory": "text",
        "structureType": "text",
        "operationalArea": 1,
        "address": {
          "tenantId": "text",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "addressId": "text",
          "addressNumber": "text",
          "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",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          },
          "type": [
            "PERMANENT"
          ]
        },
        "additionalDetail": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "channel": "COUNTER",
        "owners": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ],
            "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
                }
              }
            ]
          }
        ],
        "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
            }
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "licenseType": "TEMPORARY",
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}

Trade License(s) Retrived Successfully

Create new Trade Licenses.

Following Conditions are applied -

PropertyId and OldPropertyId is not mandatory, If entered then validate. Invalid number fails trade license creation
supportDocuments for a given Trade License will created. In case of not attaching the Mandatory Supported Documents creation of New Trade License Fails.
LicenseNumber will be autogenerated on final approval for new License.
ApplicationNumber will be autogenerated for new Trade License

post

/v1/_create

Body

RequestInfoobject

Licensesobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tl-service/v1/_create' \
  --header 'Content-Type: application/json'

201

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 1,
      "commencementDate": 1,
      "issuedDate": 1,
      "financialYear": "text",
      "validFrom": 1,
      "validTo": 1,
      "tradeLicenseDetail": {
        "surveyNo": "text",
        "subOwnerShipCategory": "text",
        "structureType": "text",
        "operationalArea": 1,
        "address": {
          "tenantId": "text",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "addressId": "text",
          "addressNumber": "text",
          "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",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          },
          "type": [
            "PERMANENT"
          ]
        },
        "additionalDetail": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "channel": "COUNTER",
        "owners": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ],
            "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
                }
              }
            ]
          }
        ],
        "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
            }
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "licenseType": "TEMPORARY",
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}

ReponseInfo with Trade License(s) created successfully

update existing licenses.

Following Conditions are applied -

Before payment Employee or Citizen can update any details of trade license
After payment Citizen or Employee can't change any details of TL.

post

/v1/_update

Body

RequestInfoobject

Licensesobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tl-service/v1/_update' \
  --header 'Content-Type: application/json'

201

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 1,
      "commencementDate": 1,
      "issuedDate": 1,
      "financialYear": "text",
      "validFrom": 1,
      "validTo": 1,
      "tradeLicenseDetail": {
        "surveyNo": "text",
        "subOwnerShipCategory": "text",
        "structureType": "text",
        "operationalArea": 1,
        "address": {
          "tenantId": "text",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "addressId": "text",
          "addressNumber": "text",
          "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",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          },
          "type": [
            "PERMANENT"
          ]
        },
        "additionalDetail": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "channel": "COUNTER",
        "owners": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ],
            "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
                }
              }
            ]
          }
        ],
        "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
            }
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "licenseType": "TEMPORARY",
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}

ReponseInfo with Trade License(s) updated sudcessfully