Schemes · min plan: starter · medium (3u) · scope: read:schemes · both

Scheme Codes

Returns active and historical export-promotion scheme definitions and provenance.

GET /v1/master/schemes

Required scope

read:schemes

API credits

3 per success

Minimum plan

starter

Rate-limit bucket

medium

Parameters

Name	In	Type	Required	Description
status	query	string	—	active, discontinued, or proposed.

Sample request

curl "https://getway.clearie.neximprove.com/v1/master/schemes?status=active" -H "Authorization: Bearer $CLEARIE_API_KEY"

Sample response

{
  "items": [
    {
      "code": "RODTEP",
      "name": "Remission of Duties and Taxes on Exported Products",
      "status": "active"
    }
  ],
  "meta": {
    "weighted_units": 3
  }
}

Live response contract

Live calls require API-key authentication, read:schemes scope, plan access, and available quota. Successful calls consume 3 API credits.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {

items* array [

item object {

code* string// e.g. "RODTEP"

name* string// e.g. "Remission of Duties and Taxes on Exported Products"

status* string// e.g. "active"

}

]

meta* object {

weighted_units* integer// e.g. 3

}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.

Open in workspace Create account