Skip to main content
GET
/
clients
/
{id}
/
checklist
Get the compliance checklist for a client in a given scope
curl --request GET \
  --url https://api.artu.ai/clients/{id}/checklist \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Environment: <api-key>'
{
  "resourceId": "<string>",
  "items": [
    {
      "id": "<string>",
      "label": "<string>",
      "message": "<string>",
      "levels": [
        "<string>"
      ],
      "kind": "<unknown>",
      "rollup": {
        "total": 4503599627370495,
        "okCount": 4503599627370495,
        "children": [
          {
            "resourceId": "<string>",
            "items": [
              {
                "id": "<string>",
                "label": "<string>",
                "message": "<string>",
                "levels": [
                  "<string>"
                ],
                "kind": "<unknown>",
                "rollup": {
                  "total": 4503599627370495,
                  "okCount": 4503599627370495,
                  "children": [
                    {
                      "resourceId": "<unknown>",
                      "items": "<unknown>"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "complete": {}
}

Authorizations

​
Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

​
X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
scope
enum<string>
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
​
includeChildren
boolean
default:true

Response

200 - application/json

OK

​
resourceType
enum<string>
required
Available options:
client,
transaction
​
resourceId
string
required
Minimum string length: 1
​
scope
enum<string>
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
​
items
object[]
required
​
complete
object
required