Seccl API

https://docs.seccl.tech/
Admin
Seccl API is a REST-based platform for managing investment accounts, client onboarding, portfolio...
Tokens:3,897
Snippets:23
Trust Score:8.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Example OAuth Access Token Response

Source: https://docs.seccl.tech/index__gl=1_2y0ttp__gcl_au_MTQzNzc3MTUwOS4xNzYyNDY1MTEw

This is an example of a successful JSON response when requesting an OAuth access token. It includes the 'access_token' for authenticating subsequent API calls, the 'scope' of access granted, the token's validity period in seconds ('expires_in'), and the 'token_type' (typically 'Bearer').

```json
{
  "access_token": "###TOKEN###",
  "scope": "create:scopes",
  "expires_in": 7200,
  "token_type": "Bearer"
}
```

--------------------------------

### POST /setpassword - Set Password Using Access Token

Source: https://docs.seccl.tech/index__gl=1%2A2y0ttp%2A_gcl_au%2AMTQzNzc3MTUwOS4xNzYyNDY1MTEw

This action creates a new password using an access token. It requires user and firm identifiers, the new password, and a password token.

```APIDOC
## POST /setpassword

### Description
This action creates a new password using the access token. It requires user and firm identifiers, the new password, and a password token.

### Method
POST

### Endpoint
`{{apiRoute}}/setpassword`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Headers
- **Content-Type** (string) - Required - `application/json`
- **Authorization** (string) - Required - `Bearer {{YOUR_API_TOKEN}}`

#### Request Body
- **firmId** (string) - Required - The unique identifier for your firm.
- **id** (string) - Required - The unique identifier of the user or the email address of the user.
- **password** (string) - Required - The secret password to be set.
- **passwordToken** (string) - Required - The password token provided by Seccl.

### Request Example
```json
{
  "id": "{{userId}}",
  "firmId": "{{firmId}}",
  "password": "<new password>",
  "passwordToken": "<password token provided to the user>"
}
```

### Response
#### Success Response (200)
No response body.
```

--------------------------------

### Set User Password with Access Token

Source: https://docs.seccl.tech/index__gl=1%2A2y0ttp%2A_gcl_au%2AMTQzNzc3MTUwOS4xNzYyNDY1MTEw

Set a new password for a user using an access token. This endpoint requires user identifiers, the new password, and a password token. The response body is empty upon success.

```curl
curl --location -g '{{apiRoute}}/setpassword' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{YOUR_API_TOKEN}}' \
--data '{ \
          "id": "{{userId}}", \
          "firmId": "{{firmId}}", \
          "password": "<new password>", \
          "passwordToken": "<password token provided to the user>" \
      }'
```

```json
{
          "id": "{{userId}}",
          "firmId": "{{firmId}}",
          "password": "<new password>",
          "passwordToken": "<password token provided to the user>"
      }
```

--------------------------------

### Access and Authentication

Source: https://docs.seccl.tech/index__gl=1%2A2y0ttp%2A_gcl_au%2AMTQzNzc3MTUwOS4xNzYyNDY1MTEw

Details on how to authenticate requests to the Seccl API, including existing and new authentication methods.

```APIDOC
## Access and Authentication

### Description
Details on how to authenticate requests to the Seccl API. This includes information on using API tokens, HTTPS, and the upcoming OAuth 2.0 integration for enhanced security.

### Method
GET (for retrieving information) / POST (for authentication actions)

### Endpoint
`{{apiRoute}}/authenticate` (existing)
`{{authRoute}}/oauth/token` (new OAuth 2.0)

### Parameters

#### Query Parameters
* **None specified for existing `/authenticate` endpoint.**
* **For `/oauth/token` endpoint (OAuth 2.0):
  - `grant_type` (string) - Required - Typically 'client_credentials' for M2M flows.
  - `client_id` (string) - Required - Provided by Seccl.
  - `client_secret` (string) - Required - Provided by Seccl.**

### Request Example

#### Existing `/authenticate` Endpoint (Conceptual)
```json
{
  "username": "your_username",
  "password": "your_password"
}
```

#### New `/oauth/token` Endpoint (Conceptual)
```json
{
  "grant_type": "client_credentials",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}
```

### Response

#### Success Response (200)
* **`access_token`** (string) - The token used to authenticate subsequent API requests.
* **`token_type`** (string) - The type of token (e.g., 'Bearer').
* **`expires_in`** (integer) - The time in seconds until the token expires.

#### Response Example (Conceptual)
```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}
```

### Notes
* All API requests must be made over HTTPS.
* API requests without authentication will fail.
* The `authRoute` is specific to your firm/environment (e.g., `https://seccl-staging-{{firmId}}.uk.auth0.com`).
```

--------------------------------

### POST /oauth/token

Source: https://docs.seccl.tech/index__gl=1_2y0ttp__gcl_au_MTQzNzc3MTUwOS4xNzYyNDY1MTEw

Obtain an access token for authentication purposes. Access tokens are valid for up to 2 hours and should be reused.

```APIDOC
## POST /oauth/token

### Description
This endpoint is used to obtain an access token for authentication purposes. It accepts a POST request to the URL `{{authRoute}}/oauth/token` with the necessary credentials provided in the request body. Access tokens are valid for up to 2 hours. To ensure efficient use of resources and maintain optimal system performance, we kindly ask that firms reuse the access token during its validity period rather than requesting a new token for each API call.

### Method
POST

### Endpoint
`{{authRoute}}/oauth/token`

### Parameters
#### Query Parameters
None

#### Request Body
- **grant_type** (text) - Required - The type of grant being requested (e.g., authorization_code, password).
- **client_id** (text) - Required - The unique identifier for the client making the request.
- **client_secret** (text) - Required - The secret key associated with the client ID.
- **audience** (text) - Required - The intended audience for the token, usually the API that the client wants to access.

### Request Example
```json
{
  "grant_type": "client_credentials",
  "client_id": "{{client_id}}",
  "client_secret": "{{client_secret}}",
  "audience": "{{apiRoute}}"
}
```

### Response
#### Success Response (200)
- **access_token** (text) - The token that can be used to authenticate subsequent requests.
- **scope** (text) - The scope of access granted by the token.
- **expires_in** (integer) - The duration in seconds for which the token is valid.
- **token_type** (text) - The type of token issued (typically "Bearer").

#### Response Example
```json
{
  "access_token": "###TOKEN###",
  "scope": "create:scopes",
  "expires_in": 7200,
  "token_type": "Bearer"
}
```
```

--------------------------------

### POST /oauth/token

Source: https://docs.seccl.tech/index__gl=1_2y0ttp__gcl_au_MTQzNzc3MTUwOS4xNzYyNDY1MTEw

This endpoint generates an access token using OAuth 2.0 for API authentication. It is part of the new authentication pattern leveraging Okta/Auth0.

```APIDOC
## POST /oauth/token

### Description
Generates an access token using OAuth 2.0 for API authentication. This is the new authentication method replacing the existing `/authenticate` endpoint.

### Method
POST

### Endpoint
{{authRoute}}/oauth/token

### Parameters
#### Request Body
- **grant_type** (string) - Required - Typically 'client_credentials' for machine-to-machine authentication.
- **client_id** (string) - Required - The client ID obtained from your Okta/Auth0 instance.
- **client_secret** (string) - Required - The client secret obtained from your Okta/Auth0 instance.

### Request Example
```json
{
  "grant_type": "client_credentials",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET"
}
```

### Response
#### Success Response (200)
- **access_token** (string) - The generated access token for API requests.
- **token_type** (string) - The type of token, usually 'Bearer'.
- **expires_in** (integer) - The time in seconds until the token expires.

#### Response Example
```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}
```
```

--------------------------------

### POST /oauth/token - OAuth Token Request

Source: https://docs.seccl.tech/index__gl=1%2A2y0ttp%2A_gcl_au%2AMTQzNzc3MTUwOS4xNzYyNDY1MTEw

This endpoint is used to obtain an access token for authentication purposes. It accepts a POST request with necessary credentials. Access tokens are valid for up to 2 hours and should be reused.

```APIDOC
## POST /oauth/token

### Description
This endpoint is used to obtain an access token for authentication purposes. It accepts a POST request to the URL `{{authRoute}}/oauth/token` with the necessary credentials provided in the request body. Access tokens are valid for up to 2 hours.

### Method
POST

### Endpoint
`{{authRoute}}/oauth/token`

### Parameters
#### Query Parameters
None

#### Request Body
Parameters should be sent in `x-www-form-urlencoded` format:
- **grant_type** (text) - Required - The type of grant being requested (e.g., authorization_code, password).
- **client_id** (text) - Required - The unique identifier for the client making the request.
- **client_secret** (text) - Required - The secret key associated with the client ID.
- **audience** (text) - Required - The intended audience for the token, usually the API that the client wants to access.

### Request Example
```json
{
  "grant_type": "client_credentials",
  "client_id": "{{client_id}}",
  "client_secret": "{{client_secret}}",
  "audience": "{{apiRoute}}"
}
```

### Response
#### Success Response (200)
- **access_token** (string) - The token that can be used to authenticate subsequent requests.
- **scope** (string) - The scope of access granted by the token.
- **expires_in** (integer) - The duration in seconds for which the token is valid.
- **token_type** (string) - The type of token issued (typically "Bearer").

#### Response Example
```json
{
  "access_token": "###TOKEN###",
  "scope": "create:scopes",
  "expires_in": 7200,
  "token_type": "Bearer"
}
```
```

--------------------------------

### Generate OAuth Access Token

Source: https://docs.seccl.tech/index__gl=1%2A2y0ttp%2A_gcl_au%2AMTQzNzc3MTUwOS4xNzYyNDY1MTEw

Obtain an access token for authenticating API requests. This endpoint requires client credentials and the target audience. The token is valid for up to 2 hours and should be reused.

```curl
curl --location -g 'https://seccl-{{firmId}}-staging.uk.auth0.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={{client_id}}' \
--data-urlencode 'client_secret={{client_secret}}' \
--data-urlencode 'audience={{apiRoute}}'
```

```json
{
  "access_token": "###TOKEN###",
  "scope": "create:scopes",
  "expires_in": 7200,
  "token_type": "Bearer"
}
```

--------------------------------

### Request OAuth Access Token using cURL

Source: https://docs.seccl.tech/index__gl=1_2y0ttp__gcl_au_MTQzNzc3MTUwOS4xNzYyNDY1MTEw

This snippet demonstrates how to acquire an OAuth access token using a cURL command. It sends a POST request with form-urlencoded data, including the grant type, client ID, client secret, and audience to the authentication endpoint. Ensure you replace placeholders like {{firmId}}, {{client_id}}, {{client_secret}}, and {{apiRoute}} with your actual credentials and API route.

```curl
curl --location -g 'https://seccl-{{firmId}}-staging.uk.auth0.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={{client_id}}' \
--data-urlencode 'client_secret={{client_secret}}' \
--data-urlencode 'audience={{apiRoute}}'
```
Tokens:
Raw