7x Developer Portal & API Documentation

Retrieves Ministry of Economy entity records using the provided entity code. Used to prefill or validate corporate profile information in rental and renewal flows.

Request builder

GET

/api/v1/MOE/GetEntitiesById

entityCodestring

api-versionstring

Reference details

Query Parameters

entityCode?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/MOE/GetEntitiesById"

{  "message": "string",  "payload": [    {      "tradeLicenseNo": "string",      "entityNameAr": "string",      "entityNameEn": "string",      "entityEmirateCode": "string",      "licenseIssueDate": "2019-08-24T14:15:22Z",      "licenseExpiryDate": "2019-08-24T14:15:22Z",      "issueEntityCode": "string"    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Retrieves Ministry of Economy entity records using the provided entity code. Used to prefill or validate corporate profile information in rental and renewal flows.

Request builder

GET

/api/v1/MOE/GetEntitiesById

entityCodestring

api-versionstring

Reference details

Query Parameters

entityCode?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/MOE/GetEntitiesById"

{  "message": "string",  "payload": [    {      "tradeLicenseNo": "string",      "entityNameAr": "string",      "entityNameEn": "string",      "entityEmirateCode": "string",      "licenseIssueDate": "2019-08-24T14:15:22Z",      "licenseExpiryDate": "2019-08-24T14:15:22Z",      "issueEntityCode": "string"    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`