Policies

Endpointhttps://api.dxn.services

Create complex business logic you can instantly access via API.

List Policies

GET

https://api.dxn.services

/policies

List Policies › query Parameters

nextPage

string

Pagination token returned from a previous list response

List Policies › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List Policies › Responses

A paginated list of policies

A paginated list of policies.

object[] · required

The list of policies

nextPage

string

Token to fetch the next page of results

GET/policies

curl --request GET \
  --url https://api.dxn.services/policies \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "policy": {
        "input": {
          "type": "object",
          "properties": {
            "age": {
              "type": "number"
            },
            "income": {
              "type": "number"
            }
          }
        },
        "output": {
          "type": "object",
          "properties": {
            "approved": {
              "type": "boolean"
            },
            "reason": {
              "type": "string"
            }
          }
        },
        "rules": [
          {
            "name": "Rule 1",
            "condition": {
              ">=": [
                {
                  "var": "input.age"
                },
                18
              ]
            },
            "actions": [
              {
                "=": [
                  {
                    "var": "output.approved"
                  },
                  true
                ]
              },
              {
                "=": [
                  {
                    "var": "output.reason"
                  },
                  "Approved based on age"
                ]
              }
            ]
          },
          {
            "name": "Rule 2",
            "condition": {
              "<": [
                {
                  "var": "input.income"
                },
                50000
              ]
            },
            "actions": [
              {
                "=": [
                  {
                    "var": "output.approved"
                  },
                  false
                ]
              },
              {
                "=": [
                  {
                    "var": "output.reason"
                  },
                  "Denied based on income"
                ]
              }
            ]
          }
        ]
      },
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ],
  "nextPage": "eyJ2IjoyLCJwIjo0fQ=="
}

json

application/json

Create a New Policy

POST

https://api.dxn.services

/policies

Create a New Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a New Policy › Request Body

Request body for creating a new policy.

object · required

The JDM-compatible policy document

Create a New Policy › Responses

A paginated list of policies

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

POST/policies

curl --request POST \
  --url https://api.dxn.services/policies \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy": {
    "input": {
      "type": "object",
      "properties": {
        "age": {
          "type": "number"
        },
        "income": {
          "type": "number"
        }
      }
    },
    "output": {
      "type": "object",
      "properties": {
        "approved": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    "rules": [
      {
        "name": "Rule 1",
        "condition": {
          ">=": [
            {
              "var": "input.age"
            },
            18
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              true
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Approved based on age"
            ]
          }
        ]
      },
      {
        "name": "Rule 2",
        "condition": {
          "<": [
            {
              "var": "input.income"
            },
            50000
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              false
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Denied based on income"
            ]
          }
        ]
      }
    ]
  }
}
'

shell

Example Request Body

{
  "policy": {
    "input": {
      "type": "object",
      "properties": {
        "age": {
          "type": "number"
        },
        "income": {
          "type": "number"
        }
      }
    },
    "output": {
      "type": "object",
      "properties": {
        "approved": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    "rules": [
      {
        "name": "Rule 1",
        "condition": {
          ">=": [
            {
              "var": "input.age"
            },
            18
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              true
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Approved based on age"
            ]
          }
        ]
      },
      {
        "name": "Rule 2",
        "condition": {
          "<": [
            {
              "var": "input.income"
            },
            50000
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              false
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Denied based on income"
            ]
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "policy": {
    "input": {
      "type": "object",
      "properties": {
        "age": {
          "type": "number"
        },
        "income": {
          "type": "number"
        }
      }
    },
    "output": {
      "type": "object",
      "properties": {
        "approved": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    "rules": [
      {
        "name": "Rule 1",
        "condition": {
          ">=": [
            {
              "var": "input.age"
            },
            18
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              true
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Approved based on age"
            ]
          }
        ]
      },
      {
        "name": "Rule 2",
        "condition": {
          "<": [
            {
              "var": "input.income"
            },
            50000
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              false
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Denied based on income"
            ]
          }
        ]
      }
    ]
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Get a Policy

GET

https://api.dxn.services

/policies/{policyId}

Get a Policy › path Parameters

policyId

string · required

The ID of the policy

Get a Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get a Policy › Responses

The policy

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

GET/policies/{policyId}

curl --request GET \
  --url https://api.dxn.services/policies/:policyId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "policy": {
    "input": {
      "type": "object",
      "properties": {
        "age": {
          "type": "number"
        },
        "income": {
          "type": "number"
        }
      }
    },
    "output": {
      "type": "object",
      "properties": {
        "approved": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    "rules": [
      {
        "name": "Rule 1",
        "condition": {
          ">=": [
            {
              "var": "input.age"
            },
            18
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              true
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Approved based on age"
            ]
          }
        ]
      },
      {
        "name": "Rule 2",
        "condition": {
          "<": [
            {
              "var": "input.income"
            },
            50000
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              false
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Denied based on income"
            ]
          }
        ]
      }
    ]
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Update a Policy

PUT

https://api.dxn.services

/policies/{policyId}

Update a Policy › path Parameters

policyId

string · required

The ID of the policy

Update a Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a Policy › Responses

The policy

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

PUT/policies/{policyId}

curl --request PUT \
  --url https://api.dxn.services/policies/:policyId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "policy": {
    "input": {
      "type": "object",
      "properties": {
        "age": {
          "type": "number"
        },
        "income": {
          "type": "number"
        }
      }
    },
    "output": {
      "type": "object",
      "properties": {
        "approved": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    "rules": [
      {
        "name": "Rule 1",
        "condition": {
          ">=": [
            {
              "var": "input.age"
            },
            18
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              true
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Approved based on age"
            ]
          }
        ]
      },
      {
        "name": "Rule 2",
        "condition": {
          "<": [
            {
              "var": "input.income"
            },
            50000
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              false
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Denied based on income"
            ]
          }
        ]
      }
    ]
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a Policy

DELETE

https://api.dxn.services

/policies/{policyId}

Delete a Policy › path Parameters

policyId

string · required

The ID of the policy

Delete a Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete a Policy › Responses

The policy

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

DELETE/policies/{policyId}

curl --request DELETE \
  --url https://api.dxn.services/policies/:policyId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "policy": {
    "input": {
      "type": "object",
      "properties": {
        "age": {
          "type": "number"
        },
        "income": {
          "type": "number"
        }
      }
    },
    "output": {
      "type": "object",
      "properties": {
        "approved": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    "rules": [
      {
        "name": "Rule 1",
        "condition": {
          ">=": [
            {
              "var": "input.age"
            },
            18
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              true
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Approved based on age"
            ]
          }
        ]
      },
      {
        "name": "Rule 2",
        "condition": {
          "<": [
            {
              "var": "input.income"
            },
            50000
          ]
        },
        "actions": [
          {
            "=": [
              {
                "var": "output.approved"
              },
              false
            ]
          },
          {
            "=": [
              {
                "var": "output.reason"
              },
              "Denied based on income"
            ]
          }
        ]
      }
    ]
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Decisions

List Policies

GET

https://api.dxn.services

/policies

List Policies › query Parameters

nextPage

string

Pagination token returned from a previous list response

List Policies › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List Policies › Responses

A paginated list of policies

A paginated list of policies.

object[] · required

The list of policies

nextPage

string

Token to fetch the next page of results

Create a New Policy

POST

https://api.dxn.services

/policies

Create a New Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a New Policy › Request Body

Request body for creating a new policy.

object · required

The JDM-compatible policy document

Create a New Policy › Responses

A paginated list of policies

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

Get a Policy

GET

https://api.dxn.services

/policies/{policyId}

Get a Policy › path Parameters

policyId

string · required

The ID of the policy

Get a Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get a Policy › Responses

The policy

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

Update a Policy

PUT

https://api.dxn.services

/policies/{policyId}

Update a Policy › path Parameters

policyId

string · required

The ID of the policy

Update a Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a Policy › Responses

The policy

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated

Delete a Policy

DELETE

https://api.dxn.services

/policies/{policyId}

Delete a Policy › path Parameters

policyId

string · required

The ID of the policy

Delete a Policy › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete a Policy › Responses

The policy

A policy document as returned by the API.

id

string · required

The unique identifier for the policy

object · required

The JDM-compatible policy document

createdAt

string · date-time · required

When the policy was created

updatedAt

string · date-time · required

When the policy was last updated