Red Flag Alert GraphQL API

https://graphql.redflagalert.net/spectaql
Admin
A GraphQL API for accessing and managing detailed financial, company, and identity data, including...
Tokens:18,296
Snippets:62
Trust Score:4.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### JSON: Get Account Details Response

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON response for the 'account' query, detailing the current credit balance, the total number of billing entries, and a list of individual credit spending transactions with their amounts, dates, and notes.

```json
{
  "data": {
    "account": {
      "creditBalance": 123,
      "totalBillCount": 987,
      "creditsSpent": [
        {
          "amount": 10,
          "createdAt": "2007-12-03T10:15:30Z",
          "note": "Company report purchase"
        }
      ]
    }
  }
}
```

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

### List File Exports - GraphQL Response Example

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

An example response from the 'fileExports' GraphQL query, showing a paginated list of completed export requests, including details like ID, status, and download location.

```json
{
  "data": {
    "fileExports": {
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false
      },
      "items": [
        {
          "id": "export_789",
          "status": "COMPLETE",
          "exportType": "CSV",
          "description": "Export of high-risk companies",
          "totalResults": 1250,
          "createdDate": "2024-01-15T10:30:00Z",
          "completedDate": "2024-01-15T10:32:00Z",
          "downloadLocation": "https://exports.redflagalert.net/files/export_789.csv",
          "acknowledged": false
        }
      ],
      "totalCount": 5
    }
  }
}
```

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

### Request File Export - GraphQL Response Example

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

An example response from the 'fileExportRequest' GraphQL mutation. It shows the initial state of a newly requested data export, including its ID, status, and requested parameters.

```json
{
  "data": {
    "fileExportRequest": {
      "id": "export_789",
      "status": "REQUESTED",
      "columnSelection": "ALL_COLUMNS",
      "resultSelection": "ALL_COLUMNS",
      "apiQuery": "companies",
      "variables": "{\"where\":{\"rfa_rating\":{\"eq\":\"THREE_RED_FLAGS\"}}}",
      "exportType": "CSV",
      "description": "Export of high-risk companies",
      "totalResults": 1250,
      "etaSeconds": 120,
      "createdDate": "2024-01-15T10:30:00Z",
      "completedDate": null,
      "downloadLocation": null,
      "acknowledged": false
    }
  }
}
```

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

### ID Check Status - GraphQL Response Example

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

An example response from the 'idCheck' GraphQL query, illustrating the structure and typical data returned for a completed identity verification.

```json
{
  "data": {
    "idCheck": {
      "id": 123,
      "reference": "CHECK-2024-001",
      "checkType": "KNOW_YOUR_CLIENT",
      "user": {
        "forename": "John",
        "surname": "Doe",
        "email": "john.doe@example.com"
      },
      "result": {
        "id": 456,
        "status": "COMPLETE",
        "completedDate": "2024-01-15T11:30:00Z",
        "documentVerificationResult": {
          "result": "PASS",
          "additionalInformation": "All documents verified successfully"
        },
        "addressVerificationResult": {
          "result": "PASS",
          "matchType": "EXACT_MATCH"
        },
        "amlResult": {
          "result": "PASS",
          "status": "NO_MATCH",
          "riskLevel": "LOW",
          "matches": []
        }
      },
      "statuses": [
        {
          "status": "PENDING",
          "created": "2024-01-15T10:30:00Z"
        },
        {
          "status": "COMPLETE",
          "created": "2024-01-15T11:30:00Z"
        }
      ]
    }
  }
}
```

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

### Account Management - Get Account Details

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Retrieves account credit balance, billing history, and usage statistics.

```APIDOC
## GET /graphql

### Description
Retrieves account credit balance, billing history, and usage statistics.

### Method
GET

### Endpoint
/graphql

### Parameters
N/A (Query parameters are sent in the request body for GraphQL)

### Response
#### Success Response (200)
- **creditBalance** (Int) - The available credit balance for the account.
- **totalBillCount** (Int) - The total number of billing records.
- **creditsSpent** (Array<CreditsSpent>) - A list of credit spending records.
  - **amount** (Int) - The amount of credits spent.
  - **createdAt** (String) - The timestamp when the credits were spent (ISO 8601 format).
  - **note** (String) - A description of the credit spending.

#### Response Example
```json
{
  "data": {
    "account": {
      "creditBalance": 123,
      "totalBillCount": 987,
      "creditsSpent": [
        {
          "amount": 10,
          "createdAt": "2007-12-03T10:15:30Z",
          "note": "Company report purchase"
        }
      ]
    }
  }
}
```
```

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

### List File Exports - GraphQL Query Variables

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example variables for the 'fileExports' GraphQL query. Demonstrates how to set skip, take for pagination, and filter exports by status.

```json
{
  "skip": 0,
  "take": 10,
  "where": {
    "status": {
      "eq": "COMPLETE"
    }
  }
}
```

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

### JSON: Sign In Request Payload

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON payload for the signIn mutation, providing user credentials and specifying the management flow. Used to authenticate a user and obtain access tokens.

```json
{
  "credentials": {
    "username": "user@example.com",
    "password": "password123"
  },
  "useManagementflow": false
}
```

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

### JSON: Get Report Limits by Region Response

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON response for the 'accountReportLimits' query, showing the report limit for each specified billing region. Useful for planning report generation and understanding regional constraints.

```json
{
  "data": {
    "accountReportLimits": [
      {
        "billingRegion": "REST_OF_WORLD",
        "limit": 987
      }
    ]
  }
}
```

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

### Get Comprehensive Company Report Response (JSON)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Presents a sample JSON response for the 'Get Comprehensive Company Report' GraphQL query. This output includes a summary of the company's risk rating, financial performance, corporate structure, beneficial owners, and balance sheet details.

```json
{
  "data": {
    "companyReport": {
      "id": 123,
      "company_id": "GB12345678",
      "company_name": "Example Limited",
      "rfa_rating_summary": "This company has a stable rating with moderate risk factors.",
      "rfa_rating": "THREE_RED_FLAGS",
      "rfa_rating_breakdown": {
        "rating": "THREE_RED_FLAGS",
        "score": 65.5,
        "factors": [
          {
            "name": "Financial Performance",
            "impact": 0.3
          }
        ]
      },
      "corporate_structure": [
        {
          "company_id": "GB87654321",
          "company_name": "Parent Company Ltd",
          "relationship": "Parent",
          "percentage_held": 100
        }
      ],
      "beneficial_owners": [
        {
          "name": "Jane Doe",
          "nationality": "British",
          "date_of_birth": "1980-03-20T00:00:00Z",
          "percentage_held": 75
        }
      ],
      "profit_loss": [
        {
          "year_end_date": "2023-12-31T00:00:00Z",
          "turnover": 1500000,
          "gross_profit": 450000,
          "operating_profit": 150000
        }
      ],
      "balance_sheet": [
        {
          "year_end_date": "2023-12-31T00:00:00Z",
          "total_assets": 2000000,
          "total_liabilities": 800000,
          "net_worth": 1200000
        }
      ]
    }
  }
}
```

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

### Request File Export - GraphQL Mutation Input

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example input for the 'fileExportRequest' GraphQL mutation. This defines the parameters for the data export, including the API query, filtering variables, export format, and columns to include.

```json
{
  "fileExportRequest": {
    "apiQuery": "companies",
    "variables": "{\"where\":{\"rfa_rating\":{\"eq\":\"THREE_RED_FLAGS\"}}}",
    "exportType": "CSV",
    "description": "Export of high-risk companies",
    "columnSelection": "SELECTED_COLUMNS",
    "columns": ["company_name", "company_number", "rfa_rating", "turnover"]
  }
}
```

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

### JSON: Search Companies Response

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON response from the 'companies' query, including pagination details (hasNextPage, hasPreviousPage), a list of company items with their details (ID, name, number, rating, turnover, employees, addresses), total count, and searchAfter token for further pagination.

```json
{
  "data": {
    "companies": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false
      },
      "items": [
        {
          "id": 123,
          "company_id": "GB12345678",
          "company_name": "Example Limited",
          "company_number": "12345678",
          "rfa_rating": "THREE_RED_FLAGS",
          "turnover": 1000000,
          "employees": 50,
          "addresses": [
            {
              "address_line_1": "123 Business Street",
              "town": "London",
              "postcode": "SW1A 1AA"
            }
          ]
        }
      ],
      "totalCount": 987,
      "searchAfter": "xyz789"
    }
  }
}
```

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

### JSON: Sign In Response

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON response from the signIn mutation, containing the obtained JWT access token, refresh token, and their expiration time in seconds. Used for subsequent authenticated API calls.

```json
{
  "data": {
    "signIn": {
      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "refreshToken": "refresh_token_string",
      "expiresInSeconds": 3600
    }
  }
}
```

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

### Get Company Details Input (JSON)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Provides the input JSON payload for the 'Get Company Details by ID' GraphQL query. It specifies the required 'id' and optional 'countryCode' for the company lookup.

```json
{
  "id": 123,
  "countryCode": "GB"
}
```

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

### Get Company Details Response (JSON)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Illustrates a typical JSON response for the 'Get Company Details by ID' GraphQL query. It contains comprehensive information about the company, including its identification, financial data, addresses, and directors.

```json
{
  "data": {
    "company": {
      "id": 123,
      "company_id": "GB12345678",
      "company_name": "Example Limited",
      "company_number": "12345678",
      "rfa_rating": "THREE_RED_FLAGS",
      "rfa_rating_score": 65.5,
      "incorporation_date": "2007-12-03T10:15:30Z",
      "turnover": 1500000,
      "estimated_turnover": 1500000,
      "employees": 45,
      "addresses": [
        {
          "address_line_1": "123 Business Street",
          "address_line_2": "Suite 100",
          "town": "London",
          "county": "Greater London",
          "postcode": "SW1A 1AA",
          "country_code": "GBR"
        }
      ],
      "active_directors": [
        {
          "name": "John Smith",
          "date_of_birth": "1975-06-15T00:00:00Z",
          "appointed_date": "2010-01-01T00:00:00Z",
          "nationality": "British"
        }
      ],
      "credit_score": 75,
      "credit_limit": 50000,
      "website": "www.example.com",
      "telephone_number": "+44 20 1234 5678",
      "email": "info@example.com",
      "sic07_descriptions": ["Management consultancy activities"]
    }
  }
}
```

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

### Get Comprehensive Company Report

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Generate a detailed company report including financial statements, corporate structure, and AML results.

```APIDOC
## Get Comprehensive Company Report

### Description
Generate detailed company report with financial statements, corporate structure, and AML results.

### Method
GET

### Endpoint
`/websites/graphql_redflagalert_net_spectaql/companyReport`

### Parameters
#### Query Parameters
- **reportRequest** (CompanyReportRequestInput) - Required - An object containing the request details for the company report.
  - **companyId** (Integer) - Required - The ID of the company for which to generate the report.
  - **countryCode** (String) - Required - The country code of the company.

### Request Example
```json
{
  "reportRequest": {
    "companyId": 123,
    "countryCode": "GB"
  }
}
```

### Response
#### Success Response (200)
- **id** (Integer) - The internal ID of the company.
- **company_id** (String) - The external company identifier.
- **company_name** (String) - The name of the company.
- **rfa_rating_summary** (String) - A summary of the company's Red Flag Alert rating.
- **rfa_rating** (String) - The overall Red Flag Alert rating.
- **rfa_rating_breakdown** (Object) - A breakdown of the Red Flag Alert rating.
  - **rating** (String) - The rating level.
  - **score** (Float) - The rating score.
  - **factors** (Array) - Factors contributing to the rating.
    - **name** (String) - The name of the factor.
    - **impact** (Float) - The impact of the factor.
- **corporate_structure** (Array) - Information about the company's corporate structure.
  - **company_id** (String) - The ID of the related company.
  - **company_name** (String) - The name of the related company.
  - **relationship** (String) - The relationship to the main company.
  - **percentage_held** (Float) - The percentage held in the related company.
- **beneficial_owners** (Array) - Information about the company's beneficial owners.
  - **name** (String) - The name of the beneficial owner.
  - **nationality** (String) - The nationality of the beneficial owner.
  - **date_of_birth** (String) - The date of birth of the beneficial owner (ISO 8601 format).
  - **percentage_held** (Float) - The percentage of ownership.
- **profit_loss** (Array) - Financial profit and loss data.
  - **year_end_date** (String) - The year-end date for the data (ISO 8601 format).
  - **turnover** (Integer) - The turnover for the period.
  - **gross_profit** (Integer) - The gross profit for the period.
  - **operating_profit** (Integer) - The operating profit for the period.
- **balance_sheet** (Array) - Financial balance sheet data.
  - **year_end_date** (String) - The year-end date for the data (ISO 8601 format).
  - **total_assets** (Integer) - Total assets.
  - **total_liabilities** (Integer) - Total liabilities.
  - **net_worth** (Integer) - The net worth.

#### Response Example
```json
{
  "data": {
    "companyReport": {
      "id": 123,
      "company_id": "GB12345678",
      "company_name": "Example Limited",
      "rfa_rating_summary": "This company has a stable rating with moderate risk factors.",
      "rfa_rating": "THREE_RED_FLAGS",
      "rfa_rating_breakdown": {
        "rating": "THREE_RED_FLAGS",
        "score": 65.5,
        "factors": [
          {
            "name": "Financial Performance",
            "impact": 0.3
          }
        ]
      },
      "corporate_structure": [
        {
          "company_id": "GB87654321",
          "company_name": "Parent Company Ltd",
          "relationship": "Parent",
          "percentage_held": 100
        }
      ],
      "beneficial_owners": [
        {
          "name": "Jane Doe",
          "nationality": "British",
          "date_of_birth": "1980-03-20T00:00:00Z",
          "percentage_held": 75
        }
      ],
      "profit_loss": [
        {
          "year_end_date": "2023-12-31T00:00:00Z",
          "turnover": 1500000,
          "gross_profit": 450000,
          "operating_profit": 150000
        }
      ],
      "balance_sheet": [
        {
          "year_end_date": "2023-12-31T00:00:00Z",
          "total_assets": 2000000,
          "total_liabilities": 800000,
          "net_worth": 1200000
        }
      ]
    }
  }
}
```
```

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

### GraphQL: Get Account Details

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Retrieves account-specific information including credit balance, total billing count, and a history of credits spent. This query is useful for monitoring account usage and financial status.

```graphql
query account {
  account {
    creditBalance
    totalBillCount
    creditsSpent {
      amount
      createdAt
      note
    }
  }
}
```

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

### Get Comprehensive Company Report Input (JSON)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Provides the input JSON payload for the 'Get Comprehensive Company Report' GraphQL query. It requires a 'reportRequest' object containing the 'companyId' and 'countryCode'.

```json
{
  "reportRequest": {
    "companyId": 123,
    "countryCode": "GB"
  }
}
```

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

### JSON: Refresh Token Response

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON response from the signInRefresh mutation, providing a new access token, a new refresh token, and their expiration time. This allows for continued authenticated access.

```json
{
  "data": {
    "signInRefresh": {
      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "refreshToken": "new_refresh_token_string",
      "expiresInSeconds": 3600
    }
  }
}
```

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

### Account Management - Get Report Limits by Region

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Queries available report limits segmented by billing region.

```APIDOC
## GET /graphql

### Description
Queries available report limits segmented by billing region.

### Method
GET

### Endpoint
/graphql

### Parameters
N/A (Query parameters are sent in the request body for GraphQL)

### Response
#### Success Response (200)
- **accountReportLimits** (Array<AccountReportLimit>) - A list of report limits by billing region.
  - **billingRegion** (String) - The billing region (e.g., REST_OF_WORLD).
  - **limit** (Int) - The report limit for the specified region.

#### Response Example
```json
{
  "data": {
    "accountReportLimits": [
      {
        "billingRegion": "REST_OF_WORLD",
        "limit": 987
      }
    ]
  }
}
```
```

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

### Get Company Details by ID

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Retrieve comprehensive company information including directors, financials, and contact details using the company ID.

```APIDOC
## Get Company Details by ID

### Description
Retrieve comprehensive company information including directors, financials, and contact details.

### Method
GET

### Endpoint
`/websites/graphql_redflagalert_net_spectaql/company`

### Parameters
#### Query Parameters
- **id** (Any!) - Required - The unique identifier for the company.
- **countryCode** (String) - Optional - The country code for filtering company details.

### Request Example
```json
{
  "id": 123,
  "countryCode": "GB"
}
```

### Response
#### Success Response (200)
- **id** (Integer) - The internal ID of the company.
- **company_id** (String) - The external company identifier.
- **company_name** (String) - The name of the company.
- **company_number** (String) - The official company registration number.
- **rfa_rating** (String) - The Red Flag Alert rating for the company.
- **rfa_rating_score** (Float) - The numerical score associated with the Red Flag Alert rating.
- **incorporation_date** (String) - The date the company was incorporated (ISO 8601 format).
- **turnover** (Integer) - The company's reported turnover.
- **estimated_turnover** (Integer) - The company's estimated turnover.
- **employees** (Integer) - The number of employees in the company.
- **addresses** (Array) - A list of company addresses.
  - **address_line_1** (String) - The first line of the address.
  - **address_line_2** (String) - The second line of the address.
  - **town** (String) - The town or city.
  - **county** (String) - The county or region.
  - **postcode** (String) - The postal code.
  - **country_code** (String) - The country code.
- **active_directors** (Array) - A list of active directors.
  - **name** (String) - The name of the director.
  - **date_of_birth** (String) - The director's date of birth (ISO 8601 format).
  - **appointed_date** (String) - The date the director was appointed (ISO 8601 format).
  - **nationality** (String) - The director's nationality.
- **credit_score** (Integer) - The company's credit score.
- **credit_limit** (Integer) - The company's credit limit.
- **website** (String) - The company's website URL.
- **telephone_number** (String) - The company's telephone number.
- **email** (String) - The company's email address.
- **sic07_descriptions** (Array) - List of Standard Industrial Classification 2007 descriptions.

#### Response Example
```json
{
  "data": {
    "company": {
      "id": 123,
      "company_id": "GB12345678",
      "company_name": "Example Limited",
      "company_number": "12345678",
      "rfa_rating": "THREE_RED_FLAGS",
      "rfa_rating_score": 65.5,
      "incorporation_date": "2007-12-03T10:15:30Z",
      "turnover": 1500000,
      "estimated_turnover": 1500000,
      "employees": 45,
      "addresses": [
        {
          "address_line_1": "123 Business Street",
          "address_line_2": "Suite 100",
          "town": "London",
          "county": "Greater London",
          "postcode": "SW1A 1AA",
          "country_code": "GBR"
        }
      ],
      "active_directors": [
        {
          "name": "John Smith",
          "date_of_birth": "1975-06-15T00:00:00Z",
          "appointed_date": "2010-01-01T00:00:00Z",
          "nationality": "British"
        }
      ],
      "credit_score": 75,
      "credit_limit": 50000,
      "website": "www.example.com",
      "telephone_number": "+44 20 1234 5678",
      "email": "info@example.com",
      "sic07_descriptions": ["Management consultancy activities"]
    }
  }
}
```
```

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

### Create Identity Verification Check (GraphQL Mutation)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Initiates a new identity verification check, including options for document, address, and AML verification. Requires a CheckRequestInput object. Returns details of the created check, including a URL to start the verification process.

```graphql
mutation idCreateCheck($checkRequest: CheckRequestInput) {
  idCreateCheck(checkRequest: $checkRequest) {
    id
    reference
    checkType
    user {
      forename
      surname
      email
      dateOfBirth
    }
    checkStartUrl
    createdDate
    result {
      id
      status
      completedDate
    }
    statuses {
      status
      created
    }
    verificationTypes {
      verificationType
      isRequired
    }
  }
}
```

```json
{
  "checkRequest": {
    "reference": "CHECK-2024-001",
    "checkType": "KNOW_YOUR_CLIENT",
    "user": {
      "forename": "John",
      "surname": "Doe",
      "email": "john.doe@example.com",
      "dateOfBirth": "1985-05-15",
      "mobile": "+447700900000"
    },
    "options": {
      "requireDocumentVerification": true,
      "requireAddressVerification": true,
      "requireAmlCheck": true
    }
  }
}
```

```json
{
  "data": {
    "idCreateCheck": {
      "id": 123,
      "reference": "CHECK-2024-001",
      "checkType": "KNOW_YOUR_CLIENT",
      "user": {
        "forename": "John",
        "surname": "Doe",
        "email": "john.doe@example.com",
        "dateOfBirth": "1985-05-15T00:00:00Z"
      },
      "checkStartUrl": "https://verify.redflagalert.net/check/abc123",
      "createdDate": "2024-01-15T10:30:00Z",
      "result": null,
      "statuses": [
        {
          "status": "PENDING",
          "created": "2024-01-15T10:30:00Z"
        }
      ],
      "verificationTypes": [
        {
          "verificationType": "DOCUMENT",
          "isRequired": true
        },
        {
          "verificationType": "ADDRESS",
          "isRequired": true
        },
        {
          "verificationType": "AML",
          "isRequired": true
        }
      ]
    }
  }
}
```

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

### ID Check Status - GraphQL Query Variables

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Provides example variables for the 'idCheck' GraphQL query. It specifies the ID of the identity check to retrieve.

```json
{
  "id": 123
}
```

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

### Get Comprehensive Company Report (GraphQL)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Generates a detailed company report, including financial statements, corporate structure, and AML results, by providing a 'CompanyReportRequestInput'. This query is useful for in-depth company analysis.

```graphql
query companyReport($reportRequest: CompanyReportRequestInput) {
  companyReport(reportRequest: $reportRequest) {
    id
    company_id
    company_name
    rfa_rating_summary
    rfa_rating
    rfa_rating_breakdown {
      rating
      score
      factors {
        name
        impact
      }
    }
    corporate_structure {
      company_id
      company_name
      relationship
      percentage_held
    }
    beneficial_owners {
      name
      nationality
      date_of_birth
      percentage_held
    }
    profit_loss {
      year_end_date
      turnover
      gross_profit
      operating_profit
    }
    balance_sheet {
      year_end_date
      total_assets
      total_liabilities
      net_worth
    }
  }
}
```

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

### JSON: Search Companies Request Payload

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON payload for the 'companies' query, demonstrating how to specify search parameters such as skip, take, filtering criteria ('where'), sorting ('order'), and country code. Used to retrieve a paginated list of companies.

```json
{
  "skip": 0,
  "take": 10,
  "where": {
    "company_name": {
      "contains": "Limited"
    }
  },
  "order": [
    {
      "company_name": "ASC"
    }
  ],
  "countryCode": "GBR"
}
```

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

### JSON: Refresh Token Request Payload

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Example JSON payload for the signInRefresh mutation, containing the refresh token. This request is used to obtain a new access token and extend the user's session.

```json
{
  "refreshToken": "refresh_token_string"
}
```

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

### Portfolio Management API

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Endpoints for managing investment portfolios, including creation and adding companies.

```APIDOC
## MUTATION createPortfolio

### Description
Create a new portfolio for monitoring companies with custom trigger events and notifications.

### Method
MUTATION

### Endpoint
/

### Parameters
#### Request Body
- **portfolio** (CreatePortfolioInput) - Required - Portfolio details
  - **name** (String) - Required - Name of the portfolio
  - **description** (String) - Optional - Description of the portfolio
  - **isPrivate** (Boolean) - Optional - Whether the portfolio is private
  - **portfolioType** (String) - Optional - Type of the portfolio (e.g., MONITORING)

### Request Example
```json
{
  "portfolio": {
    "name": "High Risk Companies",
    "description": "Portfolio monitoring companies with high risk ratings",
    "isPrivate": true,
    "portfolioType": "MONITORING"
  }
}
```

### Response
#### Success Response (200)
- **id** (Int) - Unique identifier for the created portfolio
- **name** (String) - Name of the portfolio
- **description** (String) - Description of the portfolio
- **isPrivate** (Boolean) - Privacy status of the portfolio
- **accountId** (String) - Identifier for the account associated with the portfolio
- **accountEmail** (String) - Email of the account owner
- **portfolioType** (String) - Type of the portfolio
- **notifications** (Array<Notification>) - List of notifications associated with the portfolio
  - **id** (String)
  - **isActive** (Boolean)
  - **notificationType** (String)
- **triggerEvents** (Array<TriggerEvent>) - List of trigger events for the portfolio
  - **eventId** (String)
  - **isImmediate** (Boolean)
  - **isActive** (Boolean)
- **totalCompaniesCount** (Int) - Number of companies currently in the portfolio

#### Response Example
```json
{
  "data": {
    "createPortfolio": {
      "id": 123,
      "name": "High Risk Companies",
      "description": "Portfolio monitoring companies with high risk ratings",
      "isPrivate": true,
      "accountId": "account_123",
      "accountEmail": "user@example.com",
      "portfolioType": "NONE",
      "notifications": [],
      "triggerEvents": [],
      "totalCompaniesCount": 0
    }
  }
}
```

## MUTATION addCompanyToPortfolio

### Description
Add a company to an existing portfolio with optional notes.

### Method
MUTATION

### Endpoint
/

### Parameters
#### Request Body
- **companyPortfolio** (CompanyPortfolioInput) - Required - Details of the company to add to the portfolio
  - **companyId** (Int) - Required - The ID of the company to add
  - **portfolioId** (Int) - Required - The ID of the portfolio to add the company to
  - **notes** (String) - Optional - Notes regarding the addition of the company

### Request Example
```json
{
  "companyPortfolio": {
    "companyId": 123,
    "portfolioId": 456,
    "notes": "Added for quarterly review"
  }
}
```

### Response
#### Success Response (200)
- **companyId** (Int) - The ID of the company added
- **portfolioId** (Int) - The ID of the portfolio the company was added to
- **notes** (String) - Notes associated with the addition
- **portfolio** (Portfolio) - Details of the portfolio
  - **id** (Int)
  - **name** (String)
- **portfolioEvents** (Array<PortfolioEvent>) - Events related to the portfolio
  - **eventId** (String)
  - **eventDate** (String)
  - **notes** (String)
- **accountEmail** (String) - Email of the account owner
- **createdTime** (String) - Timestamp of when the company was added
- **id** (Int) - Unique identifier for this entry
- **company** (Company) - Details of the company added
  - **company_name** (String)
  - **company_number** (String)
  - **rfa_rating** (String)

#### Response Example
```json
{
  "data": {
    "addCompanyToPortfolio": [
      {
        "companyId": 123,
        "portfolioId": 456,
        "notes": "Added for quarterly review",
        "portfolio": {
          "id": 456,
          "name": "High Risk Companies"
        },
        "portfolioEvents": [
          {
            "eventId": "ADDED",
            "eventDate": "2024-01-15T10:30:00Z",
            "notes": "Company added to portfolio"
          }
        ],
        "accountEmail": "user@example.com",
        "createdTime": "2024-01-15T10:30:00Z",
        "id": 789,
        "company": {
          "company_name": "Example Limited",
          "company_number": "12345678",
          "rfa_rating": "THREE_RED_FLAGS"
        }
      }
    ]
  }
}
```
```

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

### Create Portfolio Mutation (GraphQL)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

This GraphQL mutation allows for the creation of a new portfolio. It accepts a 'CreatePortfolioInput' object containing details like name, description, and type, and returns the created portfolio's ID, name, and associated notification and trigger event configurations. This is essential for setting up company monitoring groups.

```graphql
mutation createPortfolio($portfolio: CreatePortfolioInput) {
  createPortfolio(portfolio: $portfolio) {
    id
    name
    description
    isPrivate
    accountId
    accountEmail
    portfolioType
    notifications {
      id
      isActive
      notificationType
    }
    triggerEvents {
      eventId
      isImmediate
      isActive
    }
    totalCompaniesCount
  }
}
```

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

### List User Portfolios (GraphQL)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Retrieves a list of portfolios for the authenticated user, supporting filtering, sorting, and pagination. Requires authentication. Returns portfolio details, page information, and total count.

```graphql
query portfolios(
  $skip: Int,
  $take: Int,
  $where: PortfolioFilterInput,
  $order: [PortfolioSortInput!]
) {
  portfolios(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
    items {
      id
      name
      description
      isPrivate
      portfolioType
      totalCompaniesCount
      lastEventTime
      lastEventType
    }
    totalCount
  }
}
```

```json
{
  "skip": 0,
  "take": 10
}
```

```json
{
  "data": {
    "portfolios": {
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false
      },
      "items": [
        {
          "id": 123,
          "name": "High Risk Companies",
          "description": "Portfolio monitoring companies with high risk ratings",
          "isPrivate": true,
          "portfolioType": "NONE",
          "totalCompaniesCount": 15,
          "lastEventTime": "2024-01-15T10:30:00Z",
          "lastEventType": "RATING_CHANGE"
        }
      ],
      "totalCount": 987
    }
  }
}
```

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

### Get ID Check Status

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Retrieves the current status and detailed results of an identity verification check using its ID.

```APIDOC
## Get ID Check Status

### Description
Retrieve the current status and results of an identity verification check.

### Method
GET (Implicitly via GraphQL query)

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **id** (Int!) - Required - The unique identifier for the ID check.

### Request Example
```json
{
  "id": 123
}
```

### Response
#### Success Response (200)
- **data.idCheck** (Object) - Contains the details of the ID check.
  - **id** (Int) - The ID of the check.
  - **reference** (String) - A reference string for the check.
  - **checkType** (String) - The type of check performed (e.g., KNOW_YOUR_CLIENT).
  - **user** (Object) - User associated with the check.
    - **forename** (String)
    - **surname** (String)
    - **email** (String)
  - **result** (Object) - The verification result details.
    - **id** (Int)
    - **status** (String) - The status of the verification (e.g., COMPLETE, PENDING).
    - **completedDate** (String) - The date and time the check was completed.
    - **documentVerificationResult** (Object)
      - **result** (String) - The result of document verification (e.g., PASS, FAIL).
      - **additionalInformation** (String)
    - **addressVerificationResult** (Object)
      - **result** (String) - The result of address verification.
      - **matchType** (String) - The type of address match.
    - **amlResult** (Object)
      - **result** (String) - The result of AML check.
      - **status** (String) - The status of AML check.
      - **riskLevel** (String) - The risk level associated with AML.
      - **matches** (Array) - List of AML matches.
        - **name** (String)
        - **matchType** (String)
        - **sources** (Array)
          - **name** (String)
          - **types** (Array)
  - **statuses** (Array) - A history of statuses for the check.
    - **status** (String)
    - **created** (String) - Timestamp of the status change.

#### Response Example
```json
{
  "data": {
    "idCheck": {
      "id": 123,
      "reference": "CHECK-2024-001",
      "checkType": "KNOW_YOUR_CLIENT",
      "user": {
        "forename": "John",
        "surname": "Doe",
        "email": "john.doe@example.com"
      },
      "result": {
        "id": 456,
        "status": "COMPLETE",
        "completedDate": "2024-01-15T11:30:00Z",
        "documentVerificationResult": {
          "result": "PASS",
          "additionalInformation": "All documents verified successfully"
        },
        "addressVerificationResult": {
          "result": "PASS",
          "matchType": "EXACT_MATCH"
        },
        "amlResult": {
          "result": "PASS",
          "status": "NO_MATCH",
          "riskLevel": "LOW",
          "matches": []
        }
      },
      "statuses": [
        {
          "status": "PENDING",
          "created": "2024-01-15T10:30:00Z"
        },
        {
          "status": "COMPLETE",
          "created": "2024-01-15T11:30:00Z"
        }
      ]
    }
  }
}
```
```

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

### Request File Export - GraphQL Mutation

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Initiates a data export request, allowing specification of API query, variables, export type, column selection, and a description. Returns details about the created export request.

```graphql
mutation fileExportRequest($fileExportRequest: FileExportRequestInput) {
  fileExportRequest(fileExportRequest: $fileExportRequest) {
    id
    status
    columnSelection
    resultSelection
    apiQuery
    variables
    exportType
    description
    totalResults
    etaSeconds
    createdDate
    completedDate
    downloadLocation
    acknowledged
  }
}
```

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

### Create Portfolio Request Payload (JSON)

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

A sample JSON payload for the 'createPortfolio' mutation. It defines the properties of the new portfolio, such as its name, a descriptive text, privacy settings, and the type of portfolio (e.g., 'MONITORING'). This payload is sent to the GraphQL server to initiate portfolio creation.

```json
{
  "portfolio": {
    "name": "High Risk Companies",
    "description": "Portfolio monitoring companies with high risk ratings",
    "isPrivate": true,
    "portfolioType": "MONITORING"
  }
}
```

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

### List User Portfolios

Source: https://context7.com/context7/graphql_redflagalert_net_spectaql/llms.txt

Retrieve all portfolios for the authenticated user with filtering and pagination capabilities.

```APIDOC
## List User Portfolios

### Description
Retrieve all portfolios for the authenticated user with filtering and pagination.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **skip** (Int) - Optional - Number of portfolios to skip.
- **take** (Int) - Optional - Number of portfolios to retrieve.
- **where** (PortfolioFilterInput) - Optional - Filtering criteria for portfolios.
- **order** (PortfolioSortInput!) - Optional - Sorting criteria for portfolios.

#### Request Body
```json
{
  "query": "\nquery portfolios($skip: Int, $take: Int, $where: PortfolioFilterInput, $order: [PortfolioSortInput!]!) {\n  portfolios(skip: $skip, take: $take, where: $where, order: $order) {\n    pageInfo {\n      hasNextPage\n      hasPreviousPage\n    }\n    items {\n      id\n      name\n      description\n      isPrivate\n      portfolioType\n      totalCompaniesCount\n      lastEventTime\n      lastEventType\n    }\n    totalCount\n  }\n}",
  "variables": {
    "skip": 0,
    "take": 10
  }
}
```

### Response
#### Success Response (200)
- **data.portfolios.pageInfo.hasNextPage** (Boolean) - Indicates if there are more pages.
- **data.portfolios.pageInfo.hasPreviousPage** (Boolean) - Indicates if there are previous pages.
- **data.portfolios.items** (Array<Object>) - List of portfolio objects.
  - **id** (Int) - Unique identifier for the portfolio.
  - **name** (String) - Name of the portfolio.
  - **description** (String) - Description of the portfolio.
  - **isPrivate** (Boolean) - Whether the portfolio is private.
  - **portfolioType** (String) - Type of the portfolio.
  - **totalCompaniesCount** (Int) - Total number of companies in the portfolio.
  - **lastEventTime** (String) - Timestamp of the last event.
  - **lastEventType** (String) - Type of the last event.
- **data.portfolios.totalCount** (Int) - Total count of portfolios.

#### Response Example
```json
{
  "data": {
    "portfolios": {
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false
      },
      "items": [
        {
          "id": 123,
          "name": "High Risk Companies",
          "description": "Portfolio monitoring companies with high risk ratings",
          "isPrivate": true,
          "portfolioType": "NONE",
          "totalCompaniesCount": 15,
          "lastEventTime": "2024-01-15T10:30:00Z",
          "lastEventType": "RATING_CHANGE"
        }
      ],
      "totalCount": 987
    }
  }
}
```
```
Tokens:
Raw