Customer Compliance Rules

This endpoint allows users to retrieve all compliance rules currently configured for an authenticated customer.

Authentication

• Include your Access-Token and x-api-key in the header of your requests.

Permissions

The external-api-compliance-rules permission is required to access this endpoint.

Endpoint

• URL: https://api.genlogs.io/customer-compliance-rules

• Method: GET

Headers

• Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

• x-api-key (string, required): The API key provided by GenLogs.

Request Example:

curl --location 'https://api.genlogs.io/customer-compliance-rules' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>' \

Response:

• 200 OK: A JSON object containing the list of carrier rules under the authenticated customer.

• 401 Unauthorized: If the authentication credentials (Access-Token) is missing or incorrect.

• 403 Forbidden: If the permission has not been set to your user.

• 500 Internal Server Error: If there is an issue on the server that prevents processing the request.

Response Body:

200 OK

{
    "rules": [
        {
            "id": "18ff81b0-acdd-4a9c-a025-b87b1ee201b0",
            "rule_name": "Observed by GenLogs",
            "status": "enabled",
            "param_values": {
                "date_interval": "2_years",
                "decision_matrix": {
                    "false": "review",
                    "true": "pass"
                },
                "fail_message": false,
                "pass_message": true
            }
        }
    ]
}

401 Forbidden

{
  "detail": {
    "message": "Token is missing",
    "subcode": "TOKEN_MISSING"
  }
}

403 Forbidden

{
    "detail": "User does not have the required permissions to access this resource"
}

Retrieve customer compliance rules

get

Returns all compliance rules configured for the authenticated customer. Only rules belonging to the customer associated with the Access-Token are returned. Requires the external-api-compliance-rules permission.

Authorizations

Access-Token & X-Api-Key

Access-TokenstringRequired

JWT provided directly in the Access-Token header. No "Bearer" prefix.

x-api-keystringRequired

API key provided by GenLogs.

Responses

200

Compliance rules retrieved successfully.

application/json

401

Unauthorized – Invalid or missing Access-Token.

application/json

403

Forbidden – User does not have the required permission.

application/json

500

Internal Server Error.

application/json

get

/customer-compliance-rules

HTTPcURLJavaScriptPython

GET /customer-compliance-rules HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Accept: */*

{
  "rules": [
    {
      "id": "18ff81b0-acdd-4a9c-a025-b87b1ee201b0",
      "rule_name": "Observed by GenLogs",
      "status": "enabled",
      "param_values": {
        "date_interval": "2_years",
        "decision_matrix": {
          "false": "review",
          "true": "pass"
        },
        "fail_message": false,
        "pass_message": true
      }
    }
  ]
}