Get enrollment config

Request

This endpoint fetches the enrollment config for the company.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/enrollment-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

termsAndConditionsListArray of strings

List of terms and conditions. Each item is rich text that renders a bullet point with text and link.

Example:

[
  "I agree to the <a href=\"https://www.spotnana.com/terms/\">Terms of Service</a>",
  "I agree to the <a href=\"https://www.spotnana.com/privacy/\">Privacy Policy</a>"
]

templateSettingsobject(EnrollmentTemplateSettings)

Template settings for enrollment emails.

industryDropdownOptionsArray of strings

Dropdown options for company industry selection.

skipOfacComplianceCheckboolean

Skip OFAC compliance check during enrollment.

registrarLoginActionsArray of strings

Login action types assigned to users created via enrollment.

companySpecifiedAttributeConfigsArray of objects(CompanySpecifiedAttributeConfig)

Configuration for company-specified attributes on the enrollment form.

termsAndConditionsstringrequireddeprecated

Deprecated: Use termsAndConditionsList instead. Link to terms and conditions.

Example:"https://www.spotnana.com/terms/"

Response

{
  "termsAndConditions": "https://www.spotnana.com/terms/",
  "termsAndConditionsList": [
    "I agree to the <a href=\"https://www.spotnana.com/terms/\">Terms of Service</a>",
    "I agree to the <a href=\"https://www.spotnana.com/privacy/\">Privacy Policy</a>"
  ],
  "templateSettings": {
    "applicationReceivedTemplate": "string",
    "applicationRejectedTemplate": "string",
    "applicationApprovedTemplate": "string",
    "applicationAlreadyOnFileTemplate": "SELF_ENROLLMENT_APPLICATION_ALREADY_ON_FILE"
  },
  "industryDropdownOptions": [
    "string"
  ],
  "skipOfacComplianceCheck": true,
  "registrarLoginActions": [
    "PRIVACY_CONSENT_ACTION"
  ],
  "companySpecifiedAttributeConfigs": [
    { … }
  ]
}