Intigriti API

https://intigriti.readme.io/reference
Admin
Intigriti API is a REST-based platform for managing bug bounty submissions, programs, payouts, and...
Tokens:55,377
Snippets:209
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get All Submission Types (cURL)

Source: https://intigriti.readme.io/reference/submissionpossibletypes-4

Use this cURL command to make a GET request to the Intigriti API to retrieve all possible submission types. Ensure you include the 'accept' header for JSON response.

```shell
curl --request GET \
     --url https://api.intigriti.com/external/company/v2/submission-possible-types \
     --header 'accept: application/json'
```

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

### Get All Company Payouts (cURL)

Source: https://intigriti.readme.io/reference/payouts-4

Use this cURL command to make a GET request to the API endpoint for retrieving all company payouts. Ensure you include the 'accept' header.

```Shell
curl --request GET \
     --url https://api.intigriti.com/external/company/v2/payouts \
     --header 'accept: application/json'
```

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

### Get Reward Bucket Budget

Source: https://intigriti.readme.io/reference/rewardsystem_getrewardbucket-5

Fetches the reward bucket budget information.

```APIDOC
## GET /v2/reward-system/budget

### Description
Returns the reward bucket budget of the company.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/reward-system/budget

### Responses
#### Success Response (200)
- **budgetLeft** (MoneyViewModel) - The amount of budget remaining.
- **budgetInValidation** (MoneyViewModel) - The amount of budget currently in validation.
- **budgetSpent** (MoneyViewModel) - The amount of budget already spent.
- **budgetTotal** (MoneyViewModel) - The total allocated budget.

#### Error Response (401)
- **identifier** (string) - Unique error identifier.
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **code** (string) - Specific error code.
- **extraParameters** (object) - Additional error details.

#### Error Response (403)
- **identifier** (string) - Unique error identifier.
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **code** (string) - Specific error code.
- **extraParameters** (object) - Additional error details.

#### Error Response (500)
- **identifier** (string) - Unique error identifier.
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **code** (string) - Specific error code.
- **extraParameters** (object) - Additional error details.
```

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

### Get All Programs

Source: https://intigriti.readme.io/reference/programs_getallprograms-4

Retrieves all programs visible on the intigriti platform. The scope is determined by the Bearer Token.

```APIDOC
## GET /v2/programs

### Description
Returns all your programs that are visible on the intigriti platform.
The scope of programs is determined by the Bearer Token provided in the request.

### Method
GET

### Endpoint
/v2/programs

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the program (GUID).
- **handle** (string) - The handle of the program.
- **companyId** (string) - The unique identifier of the company associated with the program (GUID).
- **companyHandle** (string) - The handle of the company.
- **logoUrl** (string) - The URL of the program's logo.
- **name** (string) - The name of the program.
- **status** (object) - The status of the program, containing 'id' (integer) and 'value' (string).
- **confidentialityLevel** (object) - The confidentiality level of the program, containing 'id' (integer) and 'value' (string).
- **webLinks** (object) - Links related to the program, containing a 'details' (string) field.
- **type** (object) - The type of the program, containing 'id' (integer) and 'value' (string).

#### Response Example
{
  "example": "[
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "handle": "example-program",
      "companyId": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
      "companyHandle": "example-company",
      "logoUrl": "https://example.com/logo.png",
      "name": "Example Program Name",
      "status": {
        "id": 1,
        "value": "Active"
      },
      "confidentialityLevel": {
        "id": 2,
        "value": "Public"
      },
      "webLinks": {
        "details": "https://example.com/program-details"
      },
      "type": {
        "id": 3,
        "value": "Bug Bounty"
      }
    }
  ]"
}
```

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

### Get Program Detail by ID

Source: https://intigriti.readme.io/reference/programs_getlegacyprogram-3

Fetches the details of a specific program using its ID.

```APIDOC
## GET /v2/programs/{programId}

### Description
Retrieves the detailed information for a specific program.

### Method
GET

### Endpoint
/v2/programs/{programId}

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program (GUID format).

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **programId** (string) - The unique identifier of the program.
- **handle** (string) - The handle of the program.
- **name** (string) - The name of the program.
- **companyId** (string) - The unique identifier of the company associated with the program.
- **companyHandle** (string) - The handle of the company.
- **description** (string) - A description of the program.
- **options** (array) - A list of program options.
- **state** (object) - The state of the program.
- **confidentialityLevel** (object) - The confidentiality level of the program.
- **maxConfidentialityLevel** (object) - The maximum confidentiality level of the program.
- **logoUrl** (string) - The URL of the program's logo.
- **domain** (array) - A list of domains associated with the program.
- **inScope** (object) - Information about in-scope assets.
- **outOfScope** (object) - Information about out-of-scope assets.
- **faq** (object) - Frequently asked questions for the program.
- **severityAssessment** (object) - Information about severity assessment.
- **rulesOfEngagement** (object) - The rules of engagement for the program.
- **submissionQuestions** (array) - A list of questions for submissions.
- **bounties** (array) - A list of bounties offered for the program.
- **attachmentCount** (integer) - The number of attachments for the program.
- **bugBounty** (object) - Information about the bug bounty program.

#### Response Example
{
  "programId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "handle": "example-program",
  "name": "Example Program",
  "companyId": "f0e9d8c7-b6a5-4321-0987-fedcba012345",
  "companyHandle": "example-company",
  "description": "This is an example program.",
  "options": [],
  "state": null,
  "confidentialityLevel": null,
  "maxConfidentialityLevel": null,
  "logoUrl": "https://example.com/logo.png",
  "domain": [],
  "inScope": null,
  "outOfScope": null,
  "faq": null,
  "severityAssessment": null,
  "rulesOfEngagement": null,
  "submissionQuestions": [],
  "bounties": [],
  "attachmentCount": 0,
  "bugBounty": null
}
```

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

### Get all program updates (company-wide)

Source: https://intigriti.readme.io/reference/programupdates-4

Retrieves all program updates for your company. This endpoint is useful for getting a consolidated view of all program-related updates.

```APIDOC
## Get all program updates (company-wide)

### Description
Returns all program updates of your company.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/programs/updates

### Request Example
```curl --request GET \
     --url https://api.intigriti.com/external/company/v2/programs/updates \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns all program updates of your company.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get program detail

Source: https://intigriti.readme.io/reference/programs-4

Retrieves a full representation of a specific program using its ID.

```APIDOC
## GET https://api.intigriti.com/external/company/v2/programs/{programId}

### Description
Retrieves a full representation of the given program.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/programs/{programId}

### Parameters
#### Path Parameters
- **programId** (string) - required - The ID of the program to retrieve.

### Response
#### Success Response (200)
Returns a full representation of the given program.

### Request Example
```curl
curl --request GET \
     --url https://api.intigriti.com/external/company/v2/programs/programId \
     --header 'accept: application/json'
```
```

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

### Get Legacy Program

Source: https://intigriti.readme.io/reference/programs_getlegacyprogram-3

Retrieves detailed information about a legacy program, including its budget status and user data.

```APIDOC
## GET /programs/{programId}

### Description
Retrieves detailed information about a specific legacy program.

### Method
GET

### Endpoint
/programs/{programId}

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program.

### Response
#### Success Response (200)
- **budgetLeft** (MoneyViewModel) - The remaining budget.
- **budgetSpent** (MoneyViewModel) - The amount of budget spent.
- **budgetInValidation** (MoneyViewModel) - The budget currently in validation.
- **budgetTotal** (MoneyViewModel) - The total budget allocated.
- **companyUserViewModel** (CompanyUserViewModel) - Information about the company user associated with the program.
- **webLinksViewModel** (WebLinksViewModel) - Links related to the program.

#### Response Example
```json
{
  "budgetLeft": {
    "amount": 1000.00,
    "currency": "USD"
  },
  "budgetSpent": {
    "amount": 500.00,
    "currency": "USD"
  },
  "budgetInValidation": {
    "amount": 100.00,
    "currency": "USD"
  },
  "budgetTotal": {
    "amount": 1600.00,
    "currency": "USD"
  },
  "companyUserViewModel": {
    "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "userName": "John Doe",
    "avatarUrl": "https://example.com/avatar.jpg",
    "role": "Admin",
    "email": "john.doe@example.com"
  },
  "webLinksViewModel": {
    "details": "https://example.com/program/details",
    "submissions": "https://example.com/program/submissions"
  }
}
```
```

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

### Get All Program Updates (Company-Wide)

Source: https://intigriti.readme.io/reference/programupdates-4

Use this endpoint to retrieve all program updates for your company. Requires OAuth2 Bearer token authentication.

```Shell
curl --request GET \
     --url https://api.intigriti.com/external/company/v2/programs/updates \
     --header 'accept: application/json'
```

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

### Get Program Payouts

Source: https://intigriti.readme.io/reference/programs_getprogrampayouts-4

Fetches all payouts for a specified program ID.

```APIDOC
## GET /v2/programs/{programId}/payouts

### Description
Retrieves all payouts of a given program.

### Method
GET

### Endpoint
/v2/programs/{programId}/payouts

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program.

### Responses
#### Success Response (200)
Returns an array of PayoutViewModel objects.

- **id** (string) - The unique identifier of the payout.
- **originators** (PayoutOriginatorsViewModel) - Information about the payout originators.
- **amount** (MoneyViewModel) - The payout amount and currency.
- **type** (EnumerationViewModel) - The type of the payout.
- **researcher** (ResearcherViewModel) - Details of the researcher who received the payout.
- **status** (EnumerationViewModel) - The current status of the payout.
- **createdAt** (integer) - The timestamp when the payout was created.
```

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

### Get All Program Submissions

Source: https://intigriti.readme.io/reference/programs_getprogramsubmissions-4

Fetches all submissions for a specified program. This endpoint is useful for retrieving a comprehensive list of all submitted entries within a program.

```APIDOC
## GET /programs/{programId}/submissions

### Description
Retrieves all submissions for a given program.

### Method
GET

### Endpoint
/programs/{programId}/submissions

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program.
```

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

### Get all program updates of a program

Source: https://intigriti.readme.io/reference/programupdates_getbyprogramid-4

Retrieves a list of all updates for a given program, identified by its program ID.

```APIDOC
## GET /v2/programs/{programId}/updates

### Description
Retrieves all program updates for a specific program.

### Method
GET

### Endpoint
/v2/programs/{programId}/updates

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program (GUID format).

### Response
#### Success Response (200)
Returns an array of `ProgramUpdateOverviewViewModel` objects, each representing a program update.

- **id** (string) - The unique identifier of the program update (GUID format).
- **originators** (object) - Information about the originators of the update.
  - **programId** (string) - The ID of the program associated with the originators (GUID format).
- **title** (string) - The title of the program update.
- **description** (string) - The description of the program update.
- **createdAt** (integer) - The timestamp when the update was created (int64 format).
- **publishedAt** (integer) - The timestamp when the update was published (int64 format), can be null.
```

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

### Get all possible submission types

Source: https://intigriti.readme.io/reference/submissionpossibletypes-4

This endpoint retrieves a list of all submission types that can be used when creating a submission.

```APIDOC
## GET https://api.intigriti.com/external/company/v2/submission-possible-types

### Description
Returns all possible submission types.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/submission-possible-types

### Headers
- `accept`: `application/json`

### Response
#### Success Response (200)
Returns a list of submission types. The exact structure of the response is not detailed in the source, but it is expected to be in JSON format.
```

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

### Get all possible submission types

Source: https://intigriti.readme.io/reference/submissionpossibletypes_getsubmissiontypes-4

Retrieves all possible submission types, including their IDs, CWE information, names, and categories.

```APIDOC
## GET /v2/submission-possible-types

### Description
Retrieves all possible submission types.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/submission-possible-types

### Responses
#### Success Response (200)
- **id** (string) - The unique identifier for the submission type (format: guid).
- **cwe** (string) - The Common Weakness Enumeration identifier, if applicable.
- **name** (string) - The name of the submission type.
- **category** (object) - Information about the category the submission type belongs to.
  - **id** (string) - The unique identifier for the category (format: guid).
  - **name** (string) - The name of the category.

#### Response Example
```json
[
  {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "cwe": "CWE-79",
    "name": "Cross-Site Scripting",
    "category": {
      "id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
      "name": "Web Application Vulnerabilities"
    }
  }
]
```
```

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

### Get all reward requests

Source: https://intigriti.readme.io/reference/rewardsystem-5

Retrieves a list of all reward requests for the company. Supports filtering by creation and update times, and pagination.

```APIDOC
## GET /external/company/v2/reward-system/reward-requests

### Description
Retrieves all reward requests for the company.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/reward-system/reward-requests

### Query Parameters
- **Limit** (int32) - Optional - Maximum amount of records that are retrieved. (0 to 200)
- **Offset** (int32) - Optional - Amount of records to be skipped when retrieving. (0 to 2147483647)
- **CreatedSince** (int64) - Optional - Return records that were created as of the given date time in unix timestamp format. (0 to 9223372036854780000)
- **UpdatedSince** (int64) - Optional - Return records that were updated as of the given date time in unix timestamp format. (0 to 9223372036854780000)

### Responses
#### Success Response (200)
Returns all reward requests of the company.

#### Error Responses
- **401**: Unauthorized
- **403**: Forbidden
- **500**: Internal Server Error
```

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

### Get all possible groups for a submission

Source: https://intigriti.readme.io/reference/submissions_getpossiblegroups-4

Retrieves a list of all groups that a specific submission can be assigned to. This is useful for understanding the available assignment options for a given submission.

```APIDOC
## GET /v2/submissions/{submissionCode}/possible-groups

### Description
Retrieves all possible groups for the given submission.

### Method
GET

### Endpoint
/v2/submissions/{submissionCode}/possible-groups

### Parameters
#### Path Parameters
- **submissionCode** (string) - Required - The unique identifier of the submission.

#### Success Response (200)
- **id** (string) - The unique identifier of the group.
- **name** (string) - The name of the group.
```

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

### Go HTTP Client for Token Refresh

Source: https://intigriti.readme.io/reference/scripted

Implement token refresh using Go's standard 'net/http' package. This example shows how to construct and send the POST request with the necessary form data.

```go
package main 

import ( 
"fmt"
"strings"
"net/http"
"io/ioutil"
)

func main() {
url := "https://login.uat.intigriti.com/connect/token"
method := "POST"

payload := strings.NewReader("client_id=<client_id>&client_secret=<client_secret>&grant_type=refresh_token&redirect_url=https%3A%2F%2Foauth.pstmn.io%2Fv1%2Fcallback&refresh_token=<refresh_token>&code=&redirect_uri=&scope=")

client := &http.Client {
}

req, err := http.NewRequest(method, url, payload)

if err != nil {
fmt.Println(err)
return
}

req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

res, err := client.Do(req)

if err != nil {
fmt.Println(err)
return
}

defer res.Body.Close()

body, err := ioutil.ReadAll(res.Body)

if err != nil {
fmt.Println(err)
return
}
  
fmt.Println(string(body))
}
```

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

### OpenAPI Definition Example

Source: https://intigriti.readme.io/reference/programs_getprogramsubmissions-4

This JSON object represents an OpenAPI definition. It details scopes for platform and reward system access, security definitions, and Readme-specific configurations.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Intigriti API",
    "version": "1.0.0",
    "description": "This is the Intigriti API documentation."
  },
  "servers": [
    {
      "url": "https://api.intigriti.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://auth.intigriti.com/oauth2/authorize",
            "tokenUrl": "https://auth.intigriti.com/oauth2/token",
            "scopes": {
              "core_platform:read": "Gives read permissions for the core platform endpoints",
              "core_platform:write": "Gives write permissions for the core platform endpoints",
              "reward_system:read": "Gives read permissions for the reward system endpoints",
              "reward_system:write": "Gives write permissions for the reward system endpoints",
              "offline_access": "Gives permission to retrieve a refresh token"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "authorizationCode": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 105,
      "1": 221,
      "2": 237,
      "3": 167,
      "4": 161,
      "5": 172,
      "6": 21,
      "7": 192,
      "8": 11,
      "9": 20,
      "10": 222,
      "11": 251
    }
  }
}
```

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

### Get All Submissions

Source: https://intigriti.readme.io/reference/submissions_getoverview-4

Retrieves a list of all submissions for the company. You can filter the results by specifying a timestamp to get submissions updated since a particular date and time.

```APIDOC
## GET /v2/submissions

### Description
Retrieves all submissions of the company. Optionally, filter submissions updated since a specific date and time.

### Method
GET

### Endpoint
/v2/submissions

### Parameters
#### Query Parameters
- **UpdatedSince** (integer) - Optional - Return records that were updated as of the given date time in unix timestamp format.

### Response
#### Success Response (200)
- **code** (string) - The unique code for the submission.
- **originators** (object) - Information about the submission originators.
- **internalReference** (object) - Internal reference details for the submission.
- **title** (string) - The title of the submission.
- **severity** (object) - The severity level of the submission.
- **state** (object) - The current state of the submission.
- **totalPayout** (object) - The total payout amount for the submission.
- **createdAt** (integer) - The timestamp when the submission was created.
- **lastUpdatedAt** (integer) - The timestamp when the submission was last updated.
- **awaitingFeedback** (boolean) - Indicates if the submission is awaiting feedback.
- **destroyed** (boolean) - Indicates if the submission has been destroyed.
- **assignee** (object) - Information about the assignee of the submission.

#### Response Example
{
  "example": "[SubmissionOverviewViewModel]"
}
```

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

### Request Initial Token Set

Source: https://intigriti.readme.io/reference/token-endpoint

Use this method to obtain your initial set of API tokens, including a refresh token, when you do not already have one. This requires an authorization code.

```APIDOC
## Request Initial Token Set

### Description
Obtain your initial API tokens, including a refresh token, by providing authorization code and client credentials.

### Method
POST

### Endpoint
`https://login.intigriti.com/connect/token` (PROD) or `https://login.uat.intigriti.com/connect/token` (UAT)

### Parameters
#### Request Body
- **grant_type** (string) - Required - Add "authorization_code"
- **client_id** (string) - Required - Add your Client ID
- **client_secret** (string) - Required - Add your Client secret
- **code** (string) - Required - Add your authorization code
- **redirect_uri** (string) - Required - Add your redirect URL
- **refresh_token** (string) - Optional - Not applicable for initial token set
- **scope** (string) - Required - Add the required token scopes, including "offline_access"

### Request Example
```json
{
  "grant_type": "authorization_code",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "code": "AUTHORIZATION_CODE",
  "redirect_uri": "YOUR_REDIRECT_URI",
  "scope": "offline_access read write"
}
```

### Response
#### Success Response (200)
- **access_token** (string) - Your access token
- **refresh_token** (string) - Your refresh token
- **expires_in** (integer) - Lifetime of the refresh token in seconds
- **token_type** (string) - "Bearer"
- **scope** (string) - Your token scopes

#### Response Example
```json
{
  "access_token": "eyJ...",
  "refresh_token": "def...",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "offline_access read write"
}
```
```

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

### Get All Company Payouts - OpenAPI Definition

Source: https://intigriti.readme.io/reference/payouts_getpayouts-4

This snippet defines the GET endpoint for retrieving all company payouts. It specifies the request method, tags, summary, operation ID, and the structure of the successful response.

```json
{
  "x-generator": "NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))",
  "openapi": "3.0.0",
  "info": {
    "title": "Intigriti v2.0",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.intigriti.com/external/company"
    }
  ],
  "paths": {
    "/v2/payouts": {
      "get": {
        "tags": [
          "Payouts"
        ],
        "summary": "Get all company payouts",
        "operationId": "Payouts_GetPayouts",
        "responses": {
          "200": {
            "description": "Returns all payouts of the company.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PayoutViewModel"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "authorizationCode": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "EnumerationViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "MoneyViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "value": {
            "type": "number",
            "format": "decimal"
          },
          "currency": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "UserViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userId": {
            "type": "string",
            "format": "guid"
          },
          "userName": {
            "type": "string",
            "nullable": true
          },
          "avatarUrl": {
            "type": "string",
            "nullable": true
          },
          "role": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "ResearcherViewModel": {
        "allOf": [
          {
            "$ref": "#/components/schemas/UserViewModel"
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ranking": {
                "nullable": true,
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/ResearcherRankingViewModel"
                  }
                ]
              },
              "identityChecked": {
                "type": "boolean"
              }
            }
          }
        ]
      },
      "ResearcherRankingViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "rank": {
            "type": "integer",
            "format": "int32"
          },
          "reputation": {
            "type": "integer",
            "format": "int32"
          },
          "streak": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/EnumerationViewModel"
              }
            ]
          }
        }
      },
      "PayoutViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "originators": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/PayoutOriginatorsViewModel"
              }
            ]
          },
          "amount": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/MoneyViewModel"
              }
            ]
          },
          "type": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/EnumerationViewModel"
              }
            ]
          },
          "researcher": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/ResearcherViewModel"
              }
            ]
          },
          "status": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/EnumerationViewModel"
              }
            ]
          },
          "createdAt": {
            "type": "integer",
            "format": "int64"
          },
          "paidAt": {
            "type": "integer",
            "format": "int64",
            "nullable": true
          },
          "lastUpdatedAt": {
            "type": "integer",
            "format": "int64",
            "nullable": true
          }
        }
      }
    }
  }
}
```

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

### Get Payout of a Reward Request - OpenAPI Definition

Source: https://intigriti.readme.io/reference/rewardsystem_get-5

This OpenAPI definition describes the GET endpoint for retrieving the payout details of a specific reward request. It includes path parameters, response schemas for success and error cases, and security requirements.

```json
{
  "x-generator": "NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))",
  "openapi": "3.0.0",
  "info": {
    "title": "Intigriti v2.0",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.intigriti.com/external/company"
    }
  ],
  "paths": {
    "/v2/reward-system/reward-requests/{rewardRequestId}/payout": {
      "get": {
        "tags": [
          "RewardSystem"
        ],
        "summary": "Get payout of a reward request",
        "operationId": "RewardSystem_Get",
        "parameters": [
          {
            "name": "rewardRequestId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "guid"
            },
            "x-position": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the payout of the given reward request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutViewModel"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                }
              }
            }
          }
        },
        "security": [
          {
            "authorizationCode": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "EnumerationViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "MoneyViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "value": {
            "type": "number",
            "format": "decimal"
          },
          "currency": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "UserViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "userId": {
            "type": "string",
            "format": "guid"
          },
          "userName": {
            "type": "string",
            "nullable": true
          },
          "avatarUrl": {
            "type": "string",
            "nullable": true
          },
          "role": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "ResearcherViewModel": {
        "allOf": [
          {
            "$ref": "#/components/schemas/UserViewModel"
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ranking": {
                "nullable": true,
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/ResearcherRankingViewModel"
                  }
                ]
              },
              "identityChecked": {
                "type": "boolean"
              }
            }
          }
        ]
      },
      "ResearcherRankingViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "rank": {
            "type": "integer",
            "format": "int32"
          },
          "reputation": {
            "type": "integer",
            "format": "int32"
          },
          "streak": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/EnumerationViewModel"
              }
            ]
          }
        }
      },
      "PayoutViewModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "originators": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/PayoutOriginatorsViewModel"
              }
            ]
          },
          "amount": {
            "nullable": true,
            "oneOf": [

```

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

### JavaScript Fetch API for Token Refresh

Source: https://intigriti.readme.io/reference/scripted

Implement token refresh using the browser's Fetch API. This example constructs the request body using URLSearchParams and sends a POST request.

```javascript
const myHeaders = new Headers(); 
myHeaders.append("Content-Type", "application/x-www-form-urlencoded"); 

const urlencoded = new URLSearchParams(); 
urlencoded.append("client_id", "<client_id>"); 
urlencoded.append("client_secret", "<client_secret>"); 
urlencoded.append("grant_type", "refresh_token"); 
urlencoded.append("redirect_url", "https://oauth.pstmn.io/v1/callback"); 
urlencoded.append("refresh_token", "<refresh_token>"); 
urlencoded.append("code", ""); 
urlencoded.append("redirect_uri", ""); 
urlencoded.append("scope", ""); 

const requestOptions = { 
method: "POST", 
headers: myHeaders, 
body: urlencoded, 
redirect: "follow" 
};

fetch("https://login.uat.intigriti.com/connect/token", requestOptions) 
.then((response) => response.text()) 
.then((result) => console.log(result)) 
.catch((error) => console.error(error)); 
```

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

### Get Submission Payouts

Source: https://intigriti.readme.io/reference/submissions_getpayouts-4

Fetches all payouts for a specified submission.

```APIDOC
## GET /v2/submissions/{submissionCode}/payouts

### Description
Retrieves all payout records associated with a given submission.

### Method
GET

### Endpoint
/v2/submissions/{submissionCode}/payouts

### Parameters
#### Path Parameters
- **submissionCode** (string) - Required - The unique identifier for the submission.

### Responses
#### Success Response (200)
- **PayoutViewModel** (array) - An array of payout objects.

### Response Example
```json
[
  {
    "id": "string",
    "originators": {
      "type": { "id": 0, "value": "string" },
      "amount": { "value": 0.0, "currency": "string" }
    },
    "amount": { "value": 0.0, "currency": "string" },
    "type": { "id": 0, "value": "string" },
    "researcher": {
      "userId": "string (uuid)",
      "userName": "string",
      "avatarUrl": "string",
      "role": "string",
      "ranking": {
        "rank": 0,
        "reputation": 0,
        "streak": { "id": 0, "value": "string" }
      },
      "identityChecked": true
    },
    "status": { "id": 0, "value": "string" },
    "createdAt": 0
  }
]
```
```

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

### Get Submission Integrations

Source: https://intigriti.readme.io/reference/submissions_getintegrations-4

Retrieves all integrations of a specified submission.

```APIDOC
## GET /v2/submissions/{submissionCode}/integrations

### Description
Retrieves all integrations associated with the given submission code.

### Method
GET

### Endpoint
/v2/submissions/{submissionCode}/integrations

### Parameters
#### Path Parameters
- **submissionCode** (string) - Required - The unique code of the submission.

### Response
#### Success Response (200)
- **integrationId** (string) - The unique identifier for the integration.
- **url** (string) - The URL associated with the integration, if any.
- **createdAt** (integer) - The timestamp when the integration was created.
- **deletedAt** (integer) - The timestamp when the integration was deleted, if applicable.
- **type** (object) - An object representing the type of integration, containing 'id' and 'value'.
- **name** (string) - The name of the integration.
- **reference** (string) - A reference identifier for the integration.

#### Response Example
```json
[
  {
    "integrationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "url": "https://example.com/integration",
    "createdAt": 1678886400,
    "deletedAt": null,
    "type": {
      "id": 1,
      "value": "Webhook"
    },
    "name": "Example Webhook",
    "reference": "REF123"
  }
]
```
```

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

### Get all researchers of a program

Source: https://intigriti.readme.io/reference/programs_getprogramresearchers-4

Fetches all researchers participating in a specified program.

```APIDOC
## Get all researchers of a program

### Description
Retrieves a list of all researchers associated with a specific program.

### Method
GET

### Endpoint
/programs/{programId}/researchers

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program.
```

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

### CURL Command for Token Refresh

Source: https://intigriti.readme.io/reference/scripted

Use the CURL command-line tool to perform a token refresh. This example demonstrates setting the request method, headers, and URL-encoded data.

```bash
curl --location 'https://login.uat.intigriti.com/connect/token' \ 
--header 'Content-Type: application/x-www-form-urlencoded' \ 
--data-urlencode 'client_id=<client_id>' \ 
--data-urlencode 'client_secret=<client_secret>' \ 
--data-urlencode 'grant_type=refresh_token' \ 
--data-urlencode 'redirect_url=https://oauth.pstmn.io/v1/callback' \ 
--data-urlencode 'refresh_token=<refresh_token>' \ 
--data-urlencode 'code=' \ 
--data-urlencode 'redirect_uri=' \ 
--data-urlencode 'scope=' 
```

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

### Get all company payouts

Source: https://intigriti.readme.io/reference/payouts-4

Retrieves a list of all payouts associated with the company.

```APIDOC
## GET https://api.intigriti.com/external/company/v2/payouts

### Description
Returns all payouts of the company.

### Method
GET

### Endpoint
https://api.intigriti.com/external/company/v2/payouts

### Request Example
```curl
curl --request GET \
     --url https://api.intigriti.com/external/company/v2/payouts \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns all payouts of the company.
```

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

### Get Program Researchers

Source: https://intigriti.readme.io/reference/programs_getprogramresearchers-4

Retrieves all researchers associated with a specified program. Requires authentication.

```APIDOC
## GET /v2/programs/{programId}/researchers

### Description
Retrieves all linked researchers of the given program.

### Method
GET

### Endpoint
/v2/programs/{programId}/researchers

### Parameters
#### Path Parameters
- **programId** (string) - Required - The unique identifier of the program (GUID format).

### Responses
#### Success Response (200)
Returns an array of ProgramResearcherViewModel objects, each containing user information and program-specific metrics.

#### Response Example
```json
[
  {
    "user": {
      "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "userName": "John Doe",
      "avatarUrl": "https://example.com/avatar.jpg",
      "role": "Researcher"
    },
    "metrics": {
      "rank": 1,
      "reputation": 100,
      "streak": {
        "id": 1,
        "value": "Active"
      },
      "validity": 0.95
    },
    "createdAt": 1678886400000,
    "status": {
      "id": 1,
      "value": "Active"
    }
  }
]
```
```

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

### SubmissionOverviewStateViewModel

Source: https://intigriti.readme.io/reference/submissions_getoverview-4

Provides the current state and closure reason for a submission.

```APIDOC
## SubmissionOverviewStateViewModel

### Description
Provides the current state and closure reason for a submission.

### Properties
- **status** (object) - Optional - The current status of the submission, referencing EnumerationViewModel.
- **closeReason** (object) - Optional - The reason for closing the submission, referencing EnumerationViewModel.
```

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

### Get Submission Detail

Source: https://intigriti.readme.io/reference/submissions_get-4

Retrieves a full representation of a given submission using its unique code.

```APIDOC
## GET /v2/submissions/{submissionCode}

### Description
Retrieves a full representation of the given submission.

### Method
GET

### Endpoint
/v2/submissions/{submissionCode}

### Parameters
#### Path Parameters
- **submissionCode** (string) - Required - The unique code of the submission to retrieve.

### Responses
#### Success Response (200)
- Returns a full representation of the given submission.

### Security
- authorizationCode
```
Tokens:
Raw