Skip to main content
GET
/
config
Get public tenant config
curl --request GET \
  --url https://api.example.com/config
{
  "brokerageFirmCustomFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "integrationKey": "<string>"
    }
  ],
  "tenantName": "<string>",
  "distributionRequest": {
    "approveOnSignature": true,
    "contractConfig": {
      "templateId": "<string>",
      "signature": {
        "signature": "VIEW",
        "type": "<string>",
        "signers": [
          {
            "recipient": "BROKER",
            "role": "<string>",
            "anchor": {
              "page": {},
              "x": 123,
              "y": 123,
              "height": 123,
              "width": 123
            },
            "mentions": [
              {
                "page": {},
                "x": 123,
                "y": 123,
                "mention": "<string>",
                "width": 123
              }
            ],
            "texts": [
              {
                "page": {},
                "x": 123,
                "y": 123,
                "width": 123,
                "maxLength": 123,
                "question": "<string>",
                "height": 123,
                "instruction": "<string>",
                "optional": true
              }
            ],
            "checkboxes": [
              {
                "page": {},
                "x": 123,
                "y": 123,
                "size": 123,
                "name": "<string>",
                "optional": true,
                "checked": true
              }
            ]
          }
        ],
        "anchor": {
          "page": {},
          "x": 123,
          "y": 123,
          "height": 123,
          "width": 123
        },
        "mentions": [
          {
            "page": {},
            "x": 123,
            "y": 123,
            "mention": "<string>",
            "width": 123
          }
        ],
        "texts": [
          {
            "page": {},
            "x": 123,
            "y": 123,
            "width": 123,
            "maxLength": 123,
            "question": "<string>",
            "height": 123,
            "instruction": "<string>",
            "optional": true
          }
        ],
        "checkboxes": [
          {
            "page": {},
            "x": 123,
            "y": 123,
            "size": 123,
            "name": "<string>",
            "optional": true,
            "checked": true
          }
        ]
      },
      "provider": "CraftMyPdf"
    }
  },
  "brokerageFirmDocuments": {
    "brokerageFirmDocumentsList": [
      {
        "category": "<string>",
        "required": true,
        "allowMultiple": true,
        "extractionFields": [
          {
            "key": "<string>",
            "type": "<string>",
            "sides": [
              "<string>"
            ]
          }
        ],
        "compliance": [
          {
            "type": "READABLE",
            "promptSlug": "<string>",
            "requiredFields": [
              "<array>"
            ],
            "validations": [
              {
                "fieldKey": "<string>",
                "operator": "DATE_IS_AFTER",
                "reference": {
                  "ref": "NOW",
                  "fieldKey": "<string>",
                  "value": "<string>"
                },
                "duration": {
                  "amount": 123,
                  "unit": "MONTH"
                },
                "pattern": "<string>",
                "expectedValue": "<string>",
                "numericValue": 123,
                "numericMin": 123,
                "numericMax": 123,
                "errorMessage": "<string>"
              }
            ]
          }
        ]
      }
    ],
    "signatureDocumentsList": [
      {
        "category": "<string>",
        "required": true,
        "allowMultiple": true,
        "extractionFields": [
          {
            "key": "<string>",
            "type": "<string>",
            "sides": [
              "<string>"
            ]
          }
        ],
        "compliance": [
          {
            "type": "READABLE",
            "promptSlug": "<string>",
            "requiredFields": [
              "<array>"
            ],
            "validations": [
              {
                "fieldKey": "<string>",
                "operator": "DATE_IS_AFTER",
                "reference": {
                  "ref": "NOW",
                  "fieldKey": "<string>",
                  "value": "<string>"
                },
                "duration": {
                  "amount": 123,
                  "unit": "MONTH"
                },
                "pattern": "<string>",
                "expectedValue": "<string>",
                "numericValue": 123,
                "numericMin": 123,
                "numericMax": 123,
                "errorMessage": "<string>"
              }
            ]
          }
        ]
      }
    ]
  },
  "reports": [
    {
      "type": "<string>",
      "columnsMapping": [
        {}
      ],
      "availableProductIds": [
        "<string>"
      ],
      "allowedBusinessRoles": [
        "<string>"
      ],
      "automations": [
        {}
      ]
    }
  ],
  "ai": {
    "classification": {
      "enabled": true,
      "interfaces": {
        "policyholderDashboard": {
          "enabled": true,
          "systemPromptSlug": "<string>",
          "judgePromptSlug": "<string>",
          "judges": [
            {
              "model": "<string>",
              "enabled": true
            }
          ]
        },
        "brokerageFirmDocuments": {
          "enabled": true,
          "systemPromptSlug": "<string>",
          "judgePromptSlug": "<string>",
          "judges": [
            {
              "model": "<string>",
              "enabled": true
            }
          ]
        },
        "nonDelegatedDocuments": {
          "enabled": true,
          "systemPromptSlug": "<string>",
          "judgePromptSlug": "<string>",
          "judges": [
            {
              "model": "<string>",
              "enabled": true
            }
          ]
        }
      }
    },
    "extraction": {
      "enabled": true,
      "promptSlug": "<string>"
    },
    "compliance": {
      "enabled": true
    },
    "conversationSystemPrompt": "<string>"
  }
}

Response

brokerageFirmCustomFields
object[]
required
tenantName
string
required
distributionRequest
object
brokerageFirmDocuments
object
reports
object[]
ai
object

Tenant-level AI configuration (classification, extraction)