Retrieve a profile portal configuration
1 min
GET
https://api.detected.app/api/v2/public/profiles/{uuid}/portal-configuration
Path Parameters
- uuidstringrequiredDescription
Responses
200
- object
- dataProfilePortalConfigurationResourceResponse
- declaratoryobjectDescription
- enabledbooleanDescription
- textstringDescription
- documentobjectDescription
- enabledbooleanDescription
- documentsobject[]Description
- uuidstringDescription
- namestringDescription
- descriptionstringDescription
- requiredbooleanDescription
- example_documentobject[]Description
- optionsstring[]Description
- documentstringDescription
- advanced_documentsobjectDescription
- enabledbooleanDescription
- config_idsnumber[]Description
- identityobjectDescription
- enabledbooleanDescription
- directorobjectDescription
- enabledbooleanDescription
- enable_director_country_of_birthbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- max_numbernumberDescription
- auto_screeningbooleanDescription
- director_companyobjectDescription
- max_numbernumberDescription
- people_modelobjectDescription
- idnumberDescription
- submitterobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- ownershipobjectDescription
- enabledbooleanDescription
- enable_ownership_percentagebooleanDescription
- enable_owner_country_of_birthbooleanDescription
- ownership_percentagestringDescription
- max_numbernumberDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- company_principalsobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- authorised_representativeobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- authorised_signatoryobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- treasurerobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- secretaryobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- syndicatorobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- memberobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- agentobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- designated_memberobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- club_managerobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- trusteeobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- max_numbernumberDescription
- auto_screeningbooleanDescription
- trustee_companyobjectDescription
- max_numbernumberDescription
- people_modelobjectDescription
- idnumberDescription
- partnerobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- max_numbernumberDescription
- auto_screeningbooleanDescription
- partner_companyobjectDescription
- max_numbernumberDescription
- people_modelobjectDescription
- idnumberDescription
- syndicate_managerobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- individualobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- lead_partnerobjectDescription
- enabledbooleanDescription
- people_modelobjectDescription
- idnumberDescription
- auto_screeningbooleanDescription
- max_numbernumberDescription
- additional_locationsobjectDescription
- enabledbooleanDescription
- entitiesobjectDescription
- enabledbooleanDescription
- formsobjectDescription
- enabledbooleanDescription
- form_idsnumber[]Description
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
- x-ratelimit-reset
- retry-after
401
- object
- messagestringDescription
404
- object
- messagestringDescription
429
- object
- messagestringDescription
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/profiles/{uuid}/portal-configuration \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/profiles/{uuid}/portal-configuration", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.detected.app/api/v2/public/profiles/{uuid}/portal-configuration")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/profiles/{uuid}/portal-configuration"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"data": {
"declaratory": {
"enabled": false,
"text": ""
},
"document": {
"enabled": false,
"documents": [
{
"uuid": "",
"name": "",
"description": "",
"required": false,
"example_document": [
{
"options": [
""
],
"document": ""
}
]
}
]
},
"advanced_documents": {
"enabled": false,
"config_ids": [
0
]
},
"identity": {
"enabled": false
},
"director": {
"enabled": false,
"enable_director_country_of_birth": false,
"people_model": {
"id": 0
},
"max_number": 0,
"auto_screening": false,
"director_company": {
"max_number": 0,
"people_model": {
"id": 0
}
}
},
"submitter": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false
},
"ownership": {
"enabled": false,
"enable_ownership_percentage": false,
"enable_owner_country_of_birth": false,
"ownership_percentage": "",
"max_number": 0,
"people_model": {
"id": 0
},
"auto_screening": false
},
"company_principals": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"authorised_representative": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"authorised_signatory": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"treasurer": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"secretary": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"syndicator": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"member": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"agent": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"designated_member": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"club_manager": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"trustee": {
"enabled": false,
"people_model": {
"id": 0
},
"max_number": 0,
"auto_screening": false,
"trustee_company": {
"max_number": 0,
"people_model": {
"id": 0
}
}
},
"partner": {
"enabled": false,
"people_model": {
"id": 0
},
"max_number": 0,
"auto_screening": false,
"partner_company": {
"max_number": 0,
"people_model": {
"id": 0
}
}
},
"syndicate_manager": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"individual": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"lead_partner": {
"enabled": false,
"people_model": {
"id": 0
},
"auto_screening": false,
"max_number": 0
},
"additional_locations": {
"enabled": false
},
"entities": {
"enabled": false
},
"forms": {
"enabled": false,
"form_ids": [
0
]
}
}
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"message": ""
}404
// Not Found. The requested resource does not exist, or is not available to your account.
{
"message": ""
}429
// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.
{
"message": ""
}