> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-docs/api-reference/profiles/portal-configuration.md). # Portal Configuration The onboarding portal configuration assigned to a profile. The configuration defines the steps required in the onboarding process. See the Onboarding Portal Configurations section for the configurations available in your account. ## Retrieve a profile portal configuration > Returns the portal configuration currently assigned to a profile, with the detail of every setting. \*\*List portal configurations\*\* (\`GET /portal-configurations\`) lists the available configurations. ```json {"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Profile Portal Configuration","description":"The onboarding portal configuration assigned to a profile. The configuration defines the steps required in the onboarding process. See the Onboarding Portal Configurations section for the configurations available in your account."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer `. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"profileUuid":{"name":"uuid","in":"path","description":"UUID of the profile.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"ProfilePortalConfigurationResourceResponse":{"title":"Profile Portal Configuration Response","properties":{"declaratory":{"description":"Declaratory settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"text":{"description":"Text of the declaration shown to the representative who submits the profile.","type":"string","nullable":true}},"type":"object","nullable":false},"document":{"description":"Document settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"documents":{"description":"List of documents.","type":"array","items":{"properties":{"uuid":{"description":"UUID of the document.","type":"string","nullable":false},"name":{"description":"Name of the document.","type":"string","nullable":false},"description":{"description":"Description of the document.","type":"string","nullable":false},"required":{"description":"Whether the customer must provide the document.","type":"boolean","nullable":false},"example_document":{"description":"Example of the document, shown to the customer.","type":"array","items":{"properties":{"options":{"description":"Example document options.","type":"array","items":{"type":"string"},"nullable":true},"document":{"description":"Example Document.","type":"string","nullable":true}},"type":"object"},"nullable":true}},"type":"object"}}},"type":"object","nullable":false},"advanced_documents":{"description":"Advanced documents settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"config_ids":{"description":"IDs of the advanced document configurations.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":true},"identity":{"description":"Identity verification settings, with a block for each representative type (for example `director` or `ownership`), or `null` for types it doesn't apply to.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":false,"additionalProperties":true},"director":{"description":"Director settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"enable_director_country_of_birth":{"description":"Whether the country of birth is collected for each director.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":true},"max_number":{"description":"Maximum number of directors that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"director_company":{"description":"Company director settings.","properties":{"max_number":{"description":"Maximum number of company directors that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":true}},"type":"object","nullable":false},"submitter":{"description":"Submitter settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false}},"type":"object","nullable":true},"ownership":{"description":"Ownership settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"enable_ownership_percentage":{"description":"Whether the ownership percentage is collected for each owner.","type":"boolean","nullable":false},"enable_owner_country_of_birth":{"description":"Whether the country of birth is collected for each owner.","type":"boolean","nullable":false},"ownership_percentage":{"description":"Ownership percentage at or above which a representative is treated as an owner.","type":"string","nullable":true},"max_number":{"description":"Maximum number of owners that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false}},"type":"object","nullable":false},"company_principals":{"description":"Company principal settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of company principals that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"authorised_representative":{"description":"Authorised representative settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of authorised representatives that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"authorised_signatory":{"description":"Authorised signatory settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of authorised signatories that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"treasurer":{"description":"Treasurer settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of treasurers that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"secretary":{"description":"Secretary settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of secretaries that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"syndicator":{"description":"Syndicator settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of syndicators that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"member":{"description":"Member settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of members that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"agent":{"description":"Agent settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of agents that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"designated_member":{"description":"Designated member settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of designated members that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"club_manager":{"description":"Club manager settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of club managers that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"trustee":{"description":"Trustee settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of trustees that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"trustee_company":{"description":"Trustee company settings.","properties":{"max_number":{"description":"Maximum number of trustee companies that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":true},"partner":{"description":"Partner settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of partners that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"partner_company":{"description":"Partner company settings.","properties":{"max_number":{"description":"Maximum number of partner companies that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":true},"syndicate_manager":{"description":"Syndicate manager settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of syndicate managers that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"individual":{"description":"Individual representative settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of individual representatives that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"lead_partner":{"description":"Lead partner settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of lead partners that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"additional_locations":{"description":"Additional locations settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":true},"entities":{"description":"Entities settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":true},"forms":{"description":"Forms settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"form_ids":{"description":"List of form IDs.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":true},"questionnaire":{"description":"Questionnaire settings, or `null` if not used.","type":"object","nullable":true,"additionalProperties":true},"shareholder":{"description":"Shareholder settings, or `null` if not used.","type":"object","nullable":true,"additionalProperties":true},"shareholder_entity":{"description":"Shareholder entity settings, or `null` if not used.","type":"object","nullable":true,"additionalProperties":true}},"type":"object","additionalProperties":true,"description":"The portal configuration applied to the profile. It has a block of settings for each part of the portal and each representative type; blocks that don't apply are `null`, and new settings may be added over time."}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/profiles/{uuid}/portal-configuration":{"get":{"tags":["Profile Portal Configuration"],"summary":"Retrieve a profile portal configuration","description":"Returns the portal configuration currently assigned to a profile, with the detail of every setting. **List portal configurations** (`GET /portal-configurations`) lists the available configurations.","operationId":"ac246af0e146fbcf0c961485660d3b0e","parameters":[{"$ref":"#/components/parameters/profileUuid"}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ProfilePortalConfigurationResourceResponse"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}}}} ``` ## Update a profile portal configuration > Updates the portal configuration assigned to a profile. Currently you can only update the forms assigned to the configuration. More options will be added over time.\ > \ > To remove all forms from the configuration, set \`forms.form\_ids\` to \`null\`. See the examples. ```json {"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Profile Portal Configuration","description":"The onboarding portal configuration assigned to a profile. The configuration defines the steps required in the onboarding process. See the Onboarding Portal Configurations section for the configurations available in your account."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer `. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"profileUuid":{"name":"uuid","in":"path","description":"UUID of the profile.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"schemas":{"ProfilePortalConfigurationUpdateRequest":{"title":"Profile Portal Configuration Update Request","properties":{"forms":{"description":"Form settings for the portal configuration.","properties":{"enabled":{"description":"Whether the forms section is shown in the portal.","type":"boolean","nullable":false},"form_ids":{"description":"IDs of the forms to assign to the configuration, or `null` to remove all forms.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":false}},"type":"object"},"ProfilePortalConfigurationResourceResponse":{"title":"Profile Portal Configuration Response","properties":{"declaratory":{"description":"Declaratory settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"text":{"description":"Text of the declaration shown to the representative who submits the profile.","type":"string","nullable":true}},"type":"object","nullable":false},"document":{"description":"Document settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"documents":{"description":"List of documents.","type":"array","items":{"properties":{"uuid":{"description":"UUID of the document.","type":"string","nullable":false},"name":{"description":"Name of the document.","type":"string","nullable":false},"description":{"description":"Description of the document.","type":"string","nullable":false},"required":{"description":"Whether the customer must provide the document.","type":"boolean","nullable":false},"example_document":{"description":"Example of the document, shown to the customer.","type":"array","items":{"properties":{"options":{"description":"Example document options.","type":"array","items":{"type":"string"},"nullable":true},"document":{"description":"Example Document.","type":"string","nullable":true}},"type":"object"},"nullable":true}},"type":"object"}}},"type":"object","nullable":false},"advanced_documents":{"description":"Advanced documents settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"config_ids":{"description":"IDs of the advanced document configurations.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":true},"identity":{"description":"Identity verification settings, with a block for each representative type (for example `director` or `ownership`), or `null` for types it doesn't apply to.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":false,"additionalProperties":true},"director":{"description":"Director settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"enable_director_country_of_birth":{"description":"Whether the country of birth is collected for each director.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":true},"max_number":{"description":"Maximum number of directors that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"director_company":{"description":"Company director settings.","properties":{"max_number":{"description":"Maximum number of company directors that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":true}},"type":"object","nullable":false},"submitter":{"description":"Submitter settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false}},"type":"object","nullable":true},"ownership":{"description":"Ownership settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"enable_ownership_percentage":{"description":"Whether the ownership percentage is collected for each owner.","type":"boolean","nullable":false},"enable_owner_country_of_birth":{"description":"Whether the country of birth is collected for each owner.","type":"boolean","nullable":false},"ownership_percentage":{"description":"Ownership percentage at or above which a representative is treated as an owner.","type":"string","nullable":true},"max_number":{"description":"Maximum number of owners that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false}},"type":"object","nullable":false},"company_principals":{"description":"Company principal settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of company principals that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"authorised_representative":{"description":"Authorised representative settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of authorised representatives that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"authorised_signatory":{"description":"Authorised signatory settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of authorised signatories that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"treasurer":{"description":"Treasurer settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of treasurers that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"secretary":{"description":"Secretary settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of secretaries that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"syndicator":{"description":"Syndicator settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of syndicators that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"member":{"description":"Member settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of members that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"agent":{"description":"Agent settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of agents that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"designated_member":{"description":"Designated member settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of designated members that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"club_manager":{"description":"Club manager settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of club managers that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"trustee":{"description":"Trustee settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of trustees that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"trustee_company":{"description":"Trustee company settings.","properties":{"max_number":{"description":"Maximum number of trustee companies that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":true},"partner":{"description":"Partner settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of partners that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"partner_company":{"description":"Partner company settings.","properties":{"max_number":{"description":"Maximum number of partner companies that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":true},"syndicate_manager":{"description":"Syndicate manager settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of syndicate managers that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"individual":{"description":"Individual representative settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of individual representatives that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"lead_partner":{"description":"Lead partner settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"integer","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of lead partners that can be added.","type":"number","nullable":true}},"type":"object","nullable":true},"additional_locations":{"description":"Additional locations settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":true},"entities":{"description":"Entities settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":true},"forms":{"description":"Forms settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"form_ids":{"description":"List of form IDs.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":true},"questionnaire":{"description":"Questionnaire settings, or `null` if not used.","type":"object","nullable":true,"additionalProperties":true},"shareholder":{"description":"Shareholder settings, or `null` if not used.","type":"object","nullable":true,"additionalProperties":true},"shareholder_entity":{"description":"Shareholder entity settings, or `null` if not used.","type":"object","nullable":true,"additionalProperties":true}},"type":"object","additionalProperties":true,"description":"The portal configuration applied to the profile. It has a block of settings for each part of the portal and each representative type; blocks that don't apply are `null`, and new settings may be added over time."}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/profiles/{uuid}/portal-configuration":{"patch":{"tags":["Profile Portal Configuration"],"summary":"Update a profile portal configuration","description":"Updates the portal configuration assigned to a profile. Currently you can only update the forms assigned to the configuration. More options will be added over time.\n\nTo remove all forms from the configuration, set `forms.form_ids` to `null`. See the examples.","operationId":"1175fa5ebfe28c414632bed7ebf0b0bf","parameters":[{"$ref":"#/components/parameters/profileUuid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilePortalConfigurationUpdateRequest"}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ProfilePortalConfigurationResourceResponse"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://detected.gitbook.io/detected-docs/api-reference/profiles/portal-configuration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.