curl --request GET \
--url https://api.example.com/admin/config{
"stripeAccountId": "<string>",
"stripePaymentWording": "<string>",
"externalInvoiceIdFormat": "<string>",
"products": {},
"areRetailBrokerageFirmsIndependent": true,
"areTeamBrokerageFirmsEnabled": true,
"brokerageFirmCustomFields": [
{
"key": "<string>",
"type": "BOOLEAN",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"integrationKey": "<string>"
}
],
"cognitoUserPoolId": "<string>",
"emails": [
{
"trigger": "<string>",
"templateId": "<string>",
"sendTo": [
{
"recipient": "<string>",
"roles": [
"<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>"
}
]
}
],
"yousign": {
"workspaceId": "<string>"
},
"sydiaToken": "<string>",
"ellisphereUserId": "<string>",
"ellispherePassword": "<string>",
"ellisphereContractId": "<string>",
"brokerRolesOnBrokerageFirmCreation": "RETAIL",
"businessRoles": [
{
"id": "<string>",
"roles": [
{
"role": [
"<string>"
],
"productIds": [
"<string>"
]
}
],
"forbiddenRoles": [
{
"role": [
"<string>"
],
"productIds": [
"<string>"
]
}
],
"customerRole": true,
"customerDefault": true
}
],
"signDistributionRequestOn": "PENDING",
"createPaymentCustomer": true,
"generatedDocuments": [
{
"configName": "<string>",
"templateId": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"provider": "CraftMyPdf",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
},
"generateOnDemand": true
}
],
"commonDocuments": [
{
"type": "<string>"
}
],
"sepaMandate": [
{
"mandateDocument": {
"configName": "<string>",
"templateId": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"provider": "CraftMyPdf",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
},
"generateOnDemand": true
},
"reminders": {
"delay": 1,
"maxAttempts": 5.5
},
"mandateSignature": {
"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
}
]
}
}
],
"brokerageFirmSignature": {
"reminders": {
"delay": 1,
"maxAttempts": 5.5
},
"signedDocuments": [
{
"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
}
]
}
]
},
"migration": {},
"compliance": {},
"solvability": {},
"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>"
}
]
}
]
}
]
},
"externalConnectors": {},
"reports": [
{
"type": "<string>",
"columnsMapping": [
{}
],
"availableProductIds": [
"<string>"
],
"allowedBusinessRoles": [
"<string>"
],
"automations": [
{}
]
}
],
"metabaseDashboardId": 123,
"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>"
}
}curl --request GET \
--url https://api.example.com/admin/config{
"stripeAccountId": "<string>",
"stripePaymentWording": "<string>",
"externalInvoiceIdFormat": "<string>",
"products": {},
"areRetailBrokerageFirmsIndependent": true,
"areTeamBrokerageFirmsEnabled": true,
"brokerageFirmCustomFields": [
{
"key": "<string>",
"type": "BOOLEAN",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"integrationKey": "<string>"
}
],
"cognitoUserPoolId": "<string>",
"emails": [
{
"trigger": "<string>",
"templateId": "<string>",
"sendTo": [
{
"recipient": "<string>",
"roles": [
"<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>"
}
]
}
],
"yousign": {
"workspaceId": "<string>"
},
"sydiaToken": "<string>",
"ellisphereUserId": "<string>",
"ellispherePassword": "<string>",
"ellisphereContractId": "<string>",
"brokerRolesOnBrokerageFirmCreation": "RETAIL",
"businessRoles": [
{
"id": "<string>",
"roles": [
{
"role": [
"<string>"
],
"productIds": [
"<string>"
]
}
],
"forbiddenRoles": [
{
"role": [
"<string>"
],
"productIds": [
"<string>"
]
}
],
"customerRole": true,
"customerDefault": true
}
],
"signDistributionRequestOn": "PENDING",
"createPaymentCustomer": true,
"generatedDocuments": [
{
"configName": "<string>",
"templateId": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"provider": "CraftMyPdf",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
},
"generateOnDemand": true
}
],
"commonDocuments": [
{
"type": "<string>"
}
],
"sepaMandate": [
{
"mandateDocument": {
"configName": "<string>",
"templateId": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"provider": "CraftMyPdf",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
},
"generateOnDemand": true
},
"reminders": {
"delay": 1,
"maxAttempts": 5.5
},
"mandateSignature": {
"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
}
]
}
}
],
"brokerageFirmSignature": {
"reminders": {
"delay": 1,
"maxAttempts": 5.5
},
"signedDocuments": [
{
"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
}
]
}
]
},
"migration": {},
"compliance": {},
"solvability": {},
"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>"
}
]
}
]
}
]
},
"externalConnectors": {},
"reports": [
{
"type": "<string>",
"columnsMapping": [
{}
],
"availableProductIds": [
"<string>"
],
"allowedBusinessRoles": [
"<string>"
],
"automations": [
{}
]
}
],
"metabaseDashboardId": 123,
"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>"
}
}Show child attributes
The Cognito Userpool ID
Show child attributes
The YouSign workspace ID, you can find this ID in the YouSign dashboard settings.
Show child attributes
RETAIL Tenant specific mapping between businessRoles and Korint technical roles
Show child attributes
PENDING, WAITING_FOR_SIGNATURE, APPROVED, DENIED, REVOKED Configure whether to create a payment customer on brokerage firm creation
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Metabase dashboard ID for analytics
Tenant-level AI configuration (classification, extraction)
Show child attributes
Was this page helpful?