7x Developer Portal & API Documentation

Validates whether a PO Box renewal can be cancelled and issues a verification reference. Acts as the first step of the OTP-based cancellation confirmation flow.

Request builder

GET

/api/v1/Renewal/ValidateCancel

BoxNumberinteger

EmirateCodestring

api-versionstring

Reference details

Query Parameters

BoxNumber?integer

Formatint32

EmirateCode?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Renewal/ValidateCancel"

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "referenceNumber": "string"}

{  "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

Validates whether a PO Box renewal can be cancelled and issues a verification reference. Acts as the first step of the OTP-based cancellation confirmation flow.

Request builder

GET

/api/v1/Renewal/ValidateCancel

BoxNumberinteger

EmirateCodestring

api-versionstring

Reference details

Query Parameters

BoxNumber?integer

Formatint32

EmirateCode?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Renewal/ValidateCancel"

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "referenceNumber": "string"}

{  "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`