Skip to main content
GET
/
admin
/
config
{
  "stripeAccountId": "<string>",
  "stripePaymentWording": "<string>",
  "externalInvoiceIdFormat": "<string>",
  "products": {},
  "areRetailBrokerageFirmsIndependent": true,
  "brokerageFirmCustomFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "integrationKey": "<string>"
    }
  ],
  "cognitoUserPoolId": "<string>",
  "emails": [
    {
      "trigger": "<string>",
      "templateId": "<string>",
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "receiverEmail": {
        "useCustomerContactEmail": true
      },
      "brokerEmail": {
        "useBrokerageFirmOwnerEmail": true,
        "roleId": "<string>"
      },
      "attachments": [
        {
          "type": "<string>",
          "signed": true
        }
      ],
      "payload": {
        "businessObjects": [
          "<string>"
        ],
        "target": "<string>"
      },
      "calculate": [
        "<string>"
      ],
      "messageData": [
        {
          "key": "<string>",
          "path": "<string>",
          "mapping": {},
          "format": "<string>",
          "dateFormat": "<string>"
        }
      ]
    }
  ],
  "emailsV2": [
    {
      "trigger": "<string>",
      "templateId": "<string>",
      "sendTo": [
        {
          "recipient": "<string>",
          "roles": [
            "<string>"
          ],
          "relations": [
            "<string>"
          ]
        }
      ],
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "attachments": [
        {
          "type": "<string>",
          "signed": true
        }
      ],
      "payload": {
        "businessObjects": [
          "<string>"
        ],
        "target": "<string>"
      },
      "calculate": [
        "<string>"
      ],
      "messageData": [
        {
          "key": "<string>",
          "path": "<string>",
          "mapping": {},
          "format": "<string>",
          "dateFormat": "<string>"
        }
      ]
    }
  ],
  "sydiaToken": "<string>",
  "brokerRolesOnBrokerageFirmCreation": "RETAIL",
  "businessRoles": [
    {
      "id": "<string>",
      "roles": [
        {
          "role": [
            "TENANT_ACCOUNTING_SUMMARY"
          ],
          "productIds": [
            "<string>"
          ]
        }
      ],
      "forbiddenRoles": [
        {
          "role": [
            "TENANT_ACCOUNTING_SUMMARY"
          ],
          "productIds": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "signDistributionRequestOn": "PENDING",
  "createPaymentCustomer": true,
  "generatedDocuments": [
    {
      "configName": "<string>",
      "templateId": "<string>",
      "trigger": [
        "<string>"
      ],
      "target": "<string>",
      "businessObjects": [
        "<string>"
      ],
      "documentType": "<string>",
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ]
    }
  ],
  "commonDocuments": [
    {
      "type": "<string>"
    }
  ],
  "sepaMandate": [
    {
      "mandateDocument": {
        "configName": "<string>",
        "templateId": "<string>",
        "trigger": [
          "<string>"
        ],
        "target": "<string>",
        "businessObjects": [
          "<string>"
        ],
        "documentType": "<string>",
        "filters": [
          {
            "path": "<string>",
            "operator": "equals",
            "value": "<string>"
          }
        ]
      },
      "reminders": {
        "delay": 1,
        "maxAttempts": 5.5
      },
      "mandateSignature": {
        "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
          }
        ]
      }
    }
  ],
  "brokerageFirmSignature": {
    "reminders": {
      "delay": 1,
      "maxAttempts": 5.5
    },
    "signedDocuments": [
      {
        "signature": "VIEW",
        "type": "<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
          }
        ]
      }
    ]
  },
  "migration": {},
  "compliance": {},
  "distributionRequest": {
    "approveOnSignature": true,
    "contractConfig": {
      "templateId": "<string>",
      "signature": {
        "signature": "VIEW",
        "type": "<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
          }
        ]
      }
    }
  },
  "externalConnectors": {},
  "reports": [
    {
      "type": "<string>",
      "columnsMapping": [
        {}
      ],
      "availableProductIds": [
        "<string>"
      ],
      "allowedBusinessRoles": [
        "<string>"
      ],
      "automations": [
        {}
      ]
    }
  ]
}

Response

stripeAccountId
string
required
stripePaymentWording
string
required
externalInvoiceIdFormat
string
required
products
object
required
areRetailBrokerageFirmsIndependent
boolean
required
brokerageFirmCustomFields
object[]
required
cognitoUserPoolId
string

The Cognito Userpool ID

emails
object[]
emailsV2
object[]
sydiaToken
string
brokerRolesOnBrokerageFirmCreation
enum<string>
Available options:
RETAIL
businessRoles
object[]

Tenant specific mapping between businessRoles and Korint technical roles

signDistributionRequestOn
enum<string>
Available options:
PENDING,
WAITING_FOR_SIGNATURE,
APPROVED,
DENIED,
REVOKED
createPaymentCustomer
boolean

Configure whether to create a payment customer on brokerage firm creation

generatedDocuments
object[]
commonDocuments
object[]
sepaMandate
object[]
brokerageFirmSignature
object
migration
object
compliance
object
distributionRequest
object
externalConnectors
object
reports
object[]