7x Developer Portal & API Documentation

Verifies the OTP/reference for cancellation and confirms cancellation authorization. Completes the validation flow before final cancellation actions are executed.

Request builder

POST

/api/v1/Renewal/VerifyCancel

api-versionstring

*object

boxNumber*integer

emirateCode*string

referenceNumber*string

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Renewal/VerifyCancel" \  -H "Content-Type: application/json" \  -d '{    "boxNumber": 0,    "emirateCode": "string",    "referenceNumber": "string"  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "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

Verifies the OTP/reference for cancellation and confirms cancellation authorization. Completes the validation flow before final cancellation actions are executed.

Request builder

POST

/api/v1/Renewal/VerifyCancel

api-versionstring

*object

boxNumber*integer

emirateCode*string

referenceNumber*string

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

boxNumber*integer

Formatint32

emirateCode*string

Length1 <= length

referenceNumber*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Renewal/VerifyCancel" \  -H "Content-Type: application/json" \  -d '{    "boxNumber": 0,    "emirateCode": "string",    "referenceNumber": "string"  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "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}

boxNumber*integer

Formatint32

emirateCode*string

Length1 <= length

referenceNumber*string

Length1 <= length

Query Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Request Body

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`