API Documentation

This endpoint adds an existing TOE to the users portfolio.

post
https://api.sandbox.riskrecon.com/v1/toe/

This endpoint adds an existing TOE to the users portfolio. The toe_id and other information can be obtained from the /v1/toes/by_domains response.

Path Params
string
required

Filter by the Toe ID.

Body Params
risk_relationship_slugs
array of strings

Risk relationship slugs which are returned from /v1/portfolio/risk_relationships_folders. This is optional.

risk_relationship_slugs
integer
enum
required
Defaults to 2

The SubscriptionLevelConfig. 1 (Discover) or 2 (Advisor). This defaults to 2.

Allowed:
integer
enum
Defaults to 2

The SubscriptionLevelConfig for privacy. Only 2 (Advisor) is available and this is only available if your customer has privacy enabled.

Allowed:
internal_names
array of strings | null

The user defined names for the TOE.

internal_names
internal_ids
array of strings | null

The user defined identifiers for the TOE. These can be used to query the TOE.

internal_ids
string
enum
required
Defaults to continuous

Scan frequency. This must be either one_time or continuous. The default is continuous.

Allowed:
Responses

Updated 7 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago