### GET /compliance/kyc-protect/profiles/alerts/metrics

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules

No description

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

### GET /decisionEngine/instance/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide

Retrieves the configuration details for a specific decision engine instance identified by its GUID.

```APIDOC
## GET /decisionEngine/instance/{guid}

### Description
Returns the configuration for a specific decision engine instance that the user has permission to access.

### Method
GET

### Endpoint
/decisionEngine/instance/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the decision engine instance.

### Request Example
```
GET /decisionEngine/instance/guid-1234-abcd
```

### Response
#### Success Response (200)
- **configuration** (object) - The configuration details of the decision engine instance.
  - **name** (string) - The name of the instance.
  - **version** (string) - The version of the instance configuration.
  - **rules** (array) - An array of rules configured for the instance.

#### Response Example
```json
{
  "configuration": {
    "name": "Credit Risk Assessment",
    "version": "1.2.0",
    "rules": [
      {
        "id": "rule-001",
        "condition": "income > 50000 AND credit_score > 700",
        "action": "Approve"
      }
    ]
  }
}
```
```

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

### API Testing Environment Setup

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/access/gettingstarted

This section details how to set up and use API testing environments like Postman and Bruno, including importing API definitions and configuring authentication.

```APIDOC
## API Testing Environment Setup

### Description
This guide outlines how to set up API testing environments such as Postman and Bruno. It includes instructions for importing API definitions, setting base URLs, and configuring authentication methods to ensure successful API calls.

### Postman Setup
1. Set the base URL to the server name.
2. Create a script to update the token variable for subsequent endpoint calls.
3. Set the authentication to 'Inherit from Parent'.

### Bruno Setup
1. Set the base URL to the server name.
2. Create a script to update the token variable for subsequent endpoint calls:
   - In the collection settings, go to the "Auth" tab.
   - Choose the appropriate authentication method (e.g., OAuth 2.0, Bearer Token).
   - Configure the authentication details and set up a script to update the token variable using the `Pre-request Script` tab.
3. Set the authentication to ‘Inherit from Parent’ for each request in your collection by navigating to the request settings and selecting “Inherit from collection” in the “Auth” tab.
```

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

### API Testing Environments

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/gettingstarted

Guidance on how to test the API using various tools like Postman and Bruno, including setting up authentication.

```APIDOC
## API Testing

### Description
This section outlines the methods for testing the API, including using external tools like Postman and Bruno, and testing directly within the portal.

### Testing Environment Path
1.  **Choose an API Testing Environment:**
    *   Postman
    *   Bruno
    *   Other Service
2.  **Import the API Definition:** Download the OpenAPI definition (YAML or JSON) from the "API Documentation" tab.

### Postman Setup
-   Set the base URL to the server name.
-   Create a script in the "Pre-request Script" tab to update the token variable for subsequent endpoint calls.
-   Set authentication to "Inherit from Parent" at the collection level.

### Bruno Setup
-   Set the base URL to the server name.
-   Create a script in the "Pre-request Script" tab to update the token variable.
    *   In collection settings, go to the "Auth" tab.
    *   Choose authentication method (e.g., Bearer Token).
    *   Configure details and set up a script to update the token variable.
-   Set authentication to "Inherit from Parent" for each request.

### In-Portal Testing
1.  **Acquire Authenticate Token:**
    *   Select the Authenticate endpoint.
    *   Click "Try it".
    *   Select the environment (e.g., `Sandbox`).
    *   Enter `username` and `password` in the `requestBody`.
    *   Submit the request and copy the returned token.
2.  **Use Authenticate Variable:**
    *   Select the required endpoint and click "Try it".
    *   Go to the "Security" tab.
    *   Ensure the `Authorization` type is set to **JWT**.
    *   In the "Environments" tab, create or edit the `bearerToken_token` variable and paste the copied token value.
    *   The token will be used automatically for the request.
```

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

### GET /decisionEngine/decisionOutcome/{guid}

Source: https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/Check%26Decide/checkAndDecide_download=

Retrieves decision outcomes for a decision tree using a globally unique identifier (GUID).

```APIDOC
## GET /decisionEngine/decisionOutcome/{guid}

### Description
Returns decision outcomes which is set for decision tree.

### Method
GET

### Endpoint
/decisionEngine/decisionOutcome/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The globally unique identifier (GUID) to retrieve decision outcomes by.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **GetDecisionEngineDecisionOutcomeResponse** (object) - The decision outcome response.

#### Response Example
```json
{
  "example": "{\"outcome\": \"APPROVE\", \"score\": 0.95, \"rulesApplied\": [ \"rule1\", \"rule3\" ]}"
}
```
```

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

### API Description Versioning Example (OpenAPI)

Source: https://doc.creditsafe.com/connect-apis-catalog/information/versioningandchanges

This snippet shows an example of an OpenAPI description, specifically highlighting the `info.version` field. This field indicates the version of the API description itself, which may include updates to documentation, metadata, or descriptions, and is independent of the functional API version.

```yaml
openapi: 3.1.0
info:
  version: 1.12.4
```

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

### GET /decisionEngine/instance/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/instance-management/instanceconfiguration

Retrieves the configuration for a specific instance identified by its GUID. Supports filtering by contract category.

```APIDOC
## GET /decisionEngine/instance/{guid}

### Description
Returns instance user has permission to access.

### Method
GET

### Endpoint
/decisionEngine/instance/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - Get results by guid.

#### Query Parameters
- **category** (string) - Optional - Filters instance by contract category i.e., Bronze, Silver or Gold.

### Response
#### Success Response (200)
- **(Response fields not specified in the input)**

#### Error Responses
- **400 Bad Request**
  - **correlationId** (string) - A unique ID assigned to this request.
  - **message** (string)
  - **details** (string) - Provides further information on why the request was rejected
- **401 Unauthorized**
  - **error** (string)
- **403 Forbidden**
  - **message** (string) - Example: "Access forbidden"
- **404 Not Found**
  - **correlationId** (string) - A unique ID assigned to this request.
  - **message** (string)
  - **details** (string) - Provides further information on why the request was rejected
```

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

### GET /decisionEngine/decisionOutcome/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome

Retrieves the outcome of an executed decision, which is set for a decision tree. It requires a unique identifier (GUID) for the decision.

```APIDOC
## GET /decisionEngine/decisionOutcome/{guid}

### Description
Returns decision outcomes which is set for decision tree.

### Method
GET

### Endpoint
/decisionEngine/decisionOutcome/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the decision outcome.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **outcome** (string) - Description of the decision outcome.
- **details** (object) - Additional details about the decision outcome.

#### Response Example
```json
{
  "example": {
    "outcome": "Approved",
    "details": {
      "score": 85,
      "reason": "High credit score"
    }
  }
}
```
```

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

### Enable KYC Monitoring - Step 2: Add Profile to Monitoring

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/documentation/processflows/basicintegration

Adds a profile to the KYC monitoring service. This is a bulk operation.

```APIDOC
## POST /compliance/kyc-protect/kycMonitoring/profiles/bulk

### Description
Adds one or more profiles to the KYC monitoring service. Requires a `safeNumber` on the profile and is available for selected countries.

### Method
POST

### Endpoint
/compliance/kyc-protect/kycMonitoring/profiles/bulk

### Parameters
#### Request Body
- **profiles** (array of objects) - Required - A list of profiles to add to monitoring.
  - **safeNumber** (string) - Required - The safe number of the profile.
  - **countryCode** (string) - Required - The country code for the profile.
  - **profileId** (string) - Optional - A unique identifier for the profile.
```

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

### Example HTTP GET Request for Company Report

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/reportresponseoptions

This example demonstrates how to make an HTTP GET request to retrieve a company report, specifying the desired format using the 'Accept' header. It also includes an 'Authorization' header for authentication. The 'companyId' and 'accessToken' are placeholders.

```http
GET /company-report/{companyId}
Accept: application/json+pdf
Authorization: Bearer {accessToken}
```

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

### Enable KYC Monitoring - Step 1: Check Available Countries

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/documentation/processflows/basicintegration

Checks which countries are available for KYC monitoring.

```APIDOC
## GET /compliance/kyc-protect/lookup/kycMonitoring/countryCodes

### Description
Retrieves a list of country codes for which KYC monitoring is available.

### Method
GET

### Endpoint
/compliance/kyc-protect/lookup/kycMonitoring/countryCodes
```

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

### Verify Individual Summary GET Request

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/documentation/verify

This is an example HTTP GET request to the verify individual summary endpoint. It requires an individual ID and an optional reason for search parameter.

```http
GET /localSolutions/GB/verify/individual/{id}/summary?reasonForSearch=AM
```

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

### Enable KYC Monitoring - Step 3: Get Alerts by Profile

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/documentation/processflows/basicintegration

Retrieves alerts associated with a specific profile that is under KYC monitoring.

```APIDOC
## GET /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts

### Description
Retrieves all alerts for a given profile that is being monitored via KYC.

### Method
GET

### Endpoint
/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts

### Parameters
#### Path Parameters
- **profileId** (string) - Required - The ID of the profile to retrieve alerts for.
```

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

### GET /decisionEngine/decisionOutcome/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-outcome

Retrieves the outcome of an executed decision, including detailed results.

```APIDOC
## GET /decisionEngine/decisionOutcome/{guid}

### Description
Returns decision outcomes which is set for decision tree.

### Method
GET

### Endpoint
/decisionEngine/decisionOutcome/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the decision outcome.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **outcome** (string) - The outcome of the decision.
- **details** (object) - Detailed information about the decision outcome.
```

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

### Create a New Profile

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/documentation/processflows/basicintegration

Profiles are essential for grouping searches, monitoring, and maintaining audit trails. This code demonstrates the creation of a new profile with a name, type, and basic details.

```json
{
  "name": "Creditsafe Ltd",
  "type": "company",
  "details": {
    "legalName": "Creditsafe Ltd"
  }
}
```

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

### Example Individual Search Request

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/documentation/verify

This is an example of a GET request to the Execute Individual Search endpoint, demonstrating how to properly format the query parameters to search for an individual named Patrice Jones.

```http
GET /localSolutions/GB/verify/individual/directReport?firstName=Patrice&lastName=Jones&dateOfBirth=1980-01-01&postCode=CF83&address=123+Main+Street&reasonForSearch=AM
```

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

### GET /decisionEngine/instance/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/instanceconfiguration

Returns instance user has permission to access. Supports filtering by category.

```APIDOC
## GET /decisionEngine/instance/{guid}

### Description
Returns instance user has permission to access. Supports filtering by category.

### Method
GET

### Endpoint
/decisionEngine/instance/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - Get results by guid.

#### Query Parameters
- **category** (string) - Optional - Filters instance by contract category i.e., Bronze, Silver or Gold.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **correlationId** (string) - A unique ID assigned to this request.
- **message** (string)
- **details** (string) - Provides further information on why the request was rejected

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

#### Error Responses
- **400 Bad Request**
  - **correlationId** (string) - A unique ID assigned to this request.
  - **message** (string)
  - **details** (string) - Provides further information on why the request was rejected
- **401 Unauthorized**
  - **error** (string)
- **403 Forbidden**
  - **message** (string) - Example: "Access forbidden"
- **404 Not Found**
  - **correlationId** (string) - A unique ID assigned to this request.
  - **message** (string)
  - **details** (string) - Provides further information on why the request was rejected
```

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

### Process 1: Using Verify Via Company Search

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/documentation/verify

This process flow allows you to search for a company, check if Verify data is available for its directors, and then retrieve verification information.

```APIDOC
## GET /companies

### Description
Searches for companies based on provided criteria. This is the first step in Process Flow 1 to identify a company of interest.

### Method
GET

### Endpoint
/companies

### Parameters
#### Query Parameters
- **country** (string) - Required - The country code for the company search (e.g., GB).
- **name** (string) - Required - The name of the company to search for.

### Request Example
```http
GET /companies?country=GB&name=creditsafe
```

### Response
#### Success Response (200)
- **companies** (array) - A list of companies matching the search criteria.
  - **id** (string) - The unique identifier for the company.
  - **country** (string) - The country code of the company.
  - **regNo** (string) - The registration number of the company.
  - **safeNo** (string) - The Creditsafe safe number.
  - **name** (string) - The name of the company.
  - **address** (object) - The address of the company.
    - **simpleValue** (string) - The full address string.
    - **street** (string) - The street name.
    - **city** (string) - The city.
    - **postCode** (string) - The postal code.

#### Response Example
```json
{
    "companies": [
        {
            "id": "GB-0-12297233",
            "country": "GB",
            "regNo": "12297233",
            "safeNo": "UK17866117",
            "name": "CREDITSAFE SERVICES LIMITED",
            "address": {
                "simpleValue": "CASPIAN POINT ONE PIERHEAD STREET, CARDIFF, SOUTH GLAMORGAN, CF10 4PH",
                "street": "PIERHEAD STREET",
                "city": "CARDIFF",
                "postCode": "CF10 4PH"
            }
        }
    ]
}
```
```

```APIDOC
## GET /localSolutions/GB/verify/company/{id}

### Description
Checks if Verify data is available for a given company ID. If data is available, you can proceed to retrieve the company report.

### Method
GET

### Endpoint
/localSolutions/GB/verify/company/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the company (obtained from the company search).

#### Query Parameters
- **reasonForSearch** (string) - Required - The reason for the search. Use an ENUM value from the Verify Reason Codes.

### Request Example
```http
GET /localSolutions/GB/verify/company/GB-0-12297233?reasonForSearch=AM
```

### Response
#### Success Response (200)
- **companyId** (string) - The identifier of the company.
- **verifyMatch** (boolean) - Indicates if Verify data is available for the company's directors. `true` if available, `false` otherwise.

#### Response Example
```json
{
    "companyId": "GB-0-12297233",
    "verifyMatch": true
}
```

#### Outcomes
1. If `verifyMatch` is `false`, the process ends here.
2. If `verifyMatch` is `true`, continue to the next step to retrieve the company report.
```

```APIDOC
## GET /companies/{connectId}

### Description
Retrieves the company report, which includes the `Director Id` necessary for subsequent verification endpoints.

### Method
GET

### Endpoint
/companies/{connectId}

### Parameters
#### Path Parameters
- **connectId** (string) - Required - The unique Connect ID of the company (obtained from the company search or verify indicator).

### Request Example
```http
GET /companies/GB-0-12297233
```

### Response
#### Success Response (200)
- **directorId** (string) - The unique identifier for the company director.
- (Other company report details)

#### Response Example
```json
{
  "directorId": "director_id_123",
  "companyName": "Example Company",
  "registeredAddress": {
    "street": "123 Main St",
    "city": "Anytown",
    "postCode": "A1B 2C3"
  }
  // ... other fields
}
```
```

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

### Best Practices for Managing Rate Limits

Source: https://doc.creditsafe.com/connect-apis-catalog/information/ratelimiting

Recommendations for developers to effectively manage API rate limits and avoid disruptions.

```APIDOC
## Best Practices for Managing Rate Limits

### Description
Follow these guidelines to ensure your API usage remains within acceptable limits and to handle rate limiting responses gracefully.

### Practices

1.  **Monitor Response Headers**: 
    Pay close attention to response headers for information regarding remaining requests and potential upcoming limits.

2.  **Implement Retry Logic**: 
    If you encounter a `429 Too Many Requests` status code, implement a retry mechanism. Using exponential backoff is recommended to avoid overwhelming the API with repeated requests.

3.  **Optimize API Usage**: 
    Review your API interaction patterns. Consolidate multiple requests into fewer, more efficient calls where possible. Avoid making unnecessary or redundant API calls.
```

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

### GET /decisionEngine/decisionOutcome/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/documentation/editdecisionoutcomes

Retrieves the updated submission result for a given GUID. This endpoint should be called after any manual changes to verify that the updates have taken effect.

```APIDOC
## GET /decisionEngine/decisionOutcome/{guid}

### Description
This endpoint retrieves the updated submission result. It must also be called if any manual changes are made to ensure the updates take effect.

### Method
GET

### Endpoint
`/decisionEngine/decisionOutcome/{guid}`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the decision outcome to be retrieved.

### Response
#### Success Response (200)
- **correlationId** (string) - The unique identifier for the request.
- **includeInManualReview** (boolean) - Indicates if the decision is included in manual review.
- **decisionOutcomes** (object) - Contains the decision outcomes.
  - **items** (array) - A list of the applied decision outcomes.
    - **status** (integer) - The status code of the decision outcome.
    - **label** (string) - The label of the decision outcome.
    - **description** (string) - The description provided for the decision outcome.

#### Response Example
```json
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "includeInManualReview": true,
  "decisionOutcomes": {
    "items": [
      {
        "status": 1,
        "label": "Accepted",
        "description": "The decision has met all the required criteria and has been automatically accepted."
      }
    ]
  }
}
```
```

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

### GET /decisionEngine/{provenirId}/userDataFields

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decision-trees/userdatafields

Retrieves the user data fields defined for the specified decision tree GUID.

```APIDOC
## GET /decisionEngine/{provenirId}/userDataFields

### Description
Returns the user data fields defined for the given decision tree GUID.

### Method
GET

### Endpoint
/decisionEngine/{provenirId}/userDataFields

### Parameters
#### Path Parameters
- **provenirId** (string) - Required - The unique identifier of the decision tree.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **decisionEngineId** (string) - The unique reference for the decision tree.
- **fields** (array) - A list of user-input data fields that are supported by the provided decision tree.
  - **fields.orderIndex** (number) - Used to assist ordering of the user data fields on a UI.
  - **fields.label** (string) - The user-friendly label for the field for display on a UI.
  - **fields.paramName** (string) - The string value for the parameter to be used when calling the endpoint.
  - **fields.fieldType** (string) - The type of user data field. Enum: "Text", "Integer", "Dropdown"
  - **fields.mandatory** (boolean) - Flag to dictate whether the user data field is required.
  - **fields.dropdownDetails** (array, null) - Details for dropdown fields.
    - **fields.dropdownDetails.label** (string) - The user-friendly label for the drop-down option.
    - **fields.dropdownDetails.presentationOrder** (number) - Used to assist ordering of the drop-down options on a UI.
  - **fields.validation** (array, null) - Optional validation rules.
    - **fields.validation.validationType** (string) - The type of validation rule. Enum: "Regex Match", "Maximum", "Minimum", "Length", "Custom"
    - **fields.validation.validationValue** (string) - The value for the validation rule.
    - **fields.validation.description** (string) - A description for the validation rule.

#### Response Example (200)
{
  "decisionEngineId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  "fields": [
    {
      "orderIndex": 100,
      "label": "Product Type",
      "paramName": "productType",
      "fieldType": "Dropdown",
      "mandatory": true,
      "dropdownDetails": [
        {
          "label": "Product A",
          "presentationOrder": 100
        }
      ],
      "validation": null
    }
  ]
}

#### Error Response (400)
- **correlationId** (string) - A unique ID assigned to this request.
- **message** (string) - Error message.
- **details** (string) - Provides further information on why the request was rejected.

#### Error Response (401)
- **error** (string) - Authentication error.

```

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

### Create Profile

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect

Uses the name and type provided by the user to create a profile.

```APIDOC
## POST /compliance/kyc-protect/profiles

### Description
Uses the name and type provided by the user to create a profile.

### Method
POST

### Endpoint
/compliance/kyc-protect/profiles

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the profile.
- **type** (string) - Required - The type of the profile.

### Request Example
```json
{
  "name": "New Company Profile",
  "type": "Company"
}
```

### Response
#### Success Response (201 Created)
- **profileId** (string) - The unique identifier of the created profile.
- **name** (string) - The name of the created profile.
- **type** (string) - The type of the created profile.
- **createdAt** (string) - The timestamp when the profile was created.
- **modifiedAt** (string) - The timestamp when the profile was last modified.

#### Response Example
```json
{
  "profileId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "New Company Profile",
  "type": "Company",
  "createdAt": "2023-10-27T10:00:00Z",
  "modifiedAt": "2023-10-27T10:00:00Z"
}
```
```

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

### GET /listportfolioeventrules

Source: https://doc.creditsafe.com/connect-apis-catalog/changelog

Retrieves event rules for a portfolio in Global Monitoring. Example data for `param2` has been updated to boolean.

```APIDOC
## GET /listportfolioeventrules

### Description
Retrieves event rules configured for a specific portfolio within the Global Monitoring service. The example data for `param2` has been updated to reflect a boolean data type.

### Method
GET

### Endpoint
/listportfolioeventrules

### Parameters
#### Query Parameters
- **portfolioId** (string) - Required - The unique identifier of the portfolio.

### Response
#### Success Response (200)
- **eventRules** (array) - A list of event rules associated with the portfolio.
  - **ruleId** (string) - The unique identifier for the event rule.
  - **ruleName** (string) - The name of the event rule.
  - **parameters** (object) - Parameters associated with the event rule.
    - **param2** (boolean) - A boolean parameter used in event rule configurations.

#### Response Example
```json
{
  "eventRules": [
    {
      "ruleId": "RULE001",
      "ruleName": "High Volatility Event",
      "parameters": {
        "param0": "value0",
        "param1": "value1",
        "param2": true
      }
    }
  ]
}
```
```

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

### POST /compliance/kyc-protect/kycMonitoring/profiles/bulk

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancepostkycmonitoringprofilesbulk

Adds a list of profile IDs to the monitoring service.

```APIDOC
## POST /compliance/kyc-protect/kycMonitoring/profiles/bulk

### Description
Adds a list of profile/s to monitoring.

### Method
POST

### Endpoint
/compliance/kyc-protect/kycMonitoring/profiles/bulk

### Parameters
#### Request Body
- **items** (array) - Required - Provide the list of profile Id's in the array.

### Request Example
```json
{
  "items": [
    "profile_id_1",
    "profile_id_2"
  ]
}
```

### Response
#### Success Response (200)
- **failed** (array) - A list of profiles that failed to be added.
  - **failed.failedItem** (string) - Provides a list of failed profiles.
  - **failed.error** (object) - Expanded detail about the error on the listed profile.
    - **failed.error.type** (string)
    - **failed.error.title** (string)
    - **failed.error.status** (integer)
    - **failed.error.detail** (string)
    - **failed.error.instance** (string)
- **successful** (array) - A list of profiles that were successfully added.

#### Response Example (200)
```json
{
  "failed": [
    {
      "failedItem": "profile_id_3",
      "error": {
        "type": "string",
        "title": "string",
        "status": 0,
        "detail": "string",
        "instance": "string"
      }
    }
  ],
  "successful": [
    "profile_id_1",
    "profile_id_2"
  ]
}
```

#### Error Response (400)
- **correlationId** (string) - A unique ID assigned to this request.
- **message** (string) - The error message.
- **details** (string) - Provides further information on why the request was rejected.

#### Error Response (401)
- **error** (string) - Authentication error message.

#### Error Response (403)
- **message** (string) - Example: "Access forbidden"

#### Error Response (404)
- **correlationId** (string) - A unique ID assigned to this request.
- **message** (string) - The error message.
- **details** (string) - Provides further information on why the request was rejected.

#### Error Response (409)
- **correlationId** (string) - The unique identifier. (A UUID specified by RFC4122).
- **message** (string) - The error message.
- **details** (string) - Provides further information on why the request was rejected.

#### Error Response (502)
- **correlationId** (string) - A unique ID assigned to this request.
- **message** (string) - The error message.
- **details** (string) - Provides further information on why the request was rejected.
```

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

### API Testing Environment Path

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/protect/gettingstarted

This section outlines how to test the API using external tools like Postman or Bruno, including importing API definitions and setting up authentication.

```APIDOC
## API Testing Environment Path

### Description
Guides users on setting up external API testing tools like Postman or Bruno to interact with the Creditsafe API. It covers importing the API definition and configuring authentication.

### Steps
1. **Choose an API Testing Environment:** Select a tool such as Postman, Bruno, or another preferred service.
2. **Import the API Definition:** Download the API definition in YAML or JSON format from the 'API Documentation' tab and import it into your chosen tool.

### Postman Configuration
- Set the base URL to the server name.
- Create a script to update the token variable for subsequent endpoint calls.
- Set the authentication for the relevant endpoints to 'Inherit from Parent'.

### Bruno Configuration
- Set the base URL to the server name.
- Create a script to update the token variable for subsequent endpoint calls in the 'Pre-request Script' tab of the collection settings.
- Configure authentication in the 'Auth' tab (e.g., OAuth 2.0, Bearer Token) and set up a script to update the token variable.
- For each request, set the authentication to 'Inherit from collection' in the 'Auth' tab of the request settings.
```

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

### Verify Individual Full Information GET Request

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/documentation/verify

This is an example HTTP GET request to the verify individual full information endpoint. It requires an individual ID and an optional reason for search parameter. The response structure may vary.

```http
GET /localSolutions/GB/verify/individual/{id}/full?reasonForSearch=AM
```

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

### Authenticate

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/protect/protect

Supply username and password to generate an Authentication Token.

```APIDOC
## POST /authenticate

### Description
Supplies username and password to generate an Authentication Token.

### Method
POST

### Endpoint
/authenticate

### Parameters
#### Request Body
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.

### Request Example
{
  "username": "your_username",
  "password": "your_password"
}

### Response
#### Success Response (200)
- **token** (string) - The generated authentication token.

#### Response Example
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

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

### GET /listportfolioeventrulesbycountry

Source: https://doc.creditsafe.com/connect-apis-catalog/changelog

Retrieves event rules for a portfolio by country in Global Monitoring. Example data for `param2` has been updated to boolean.

```APIDOC
## GET /listportfolioeventrulesbycountry

### Description
Retrieves event rules configured for a specific portfolio, filtered by country, within the Global Monitoring service. The example data for `param2` has been updated to reflect a boolean data type.

### Method
GET

### Endpoint
/listportfolioeventrulesbycountry

### Parameters
#### Query Parameters
- **portfolioId** (string) - Required - The unique identifier of the portfolio.
- **countryCode** (string) - Required - The ISO 3166-1 alpha-2 country code.

### Response
#### Success Response (200)
- **eventRules** (array) - A list of event rules associated with the portfolio for the specified country.
  - **ruleId** (string) - The unique identifier for the event rule.
  - **ruleName** (string) - The name of the event rule.
  - **parameters** (object) - Parameters associated with the event rule.
    - **param2** (boolean) - A boolean parameter used in event rule configurations.

#### Response Example
```json
{
  "eventRules": [
    {
      "ruleId": "RULE002",
      "ruleName": "Market Trend Change",
      "parameters": {
        "param0": "value0",
        "param1": "value1",
        "param2": false
      }
    }
  ]
}
```
```

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

### POST /compliance/kyc-protect/searches/businesses/download

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/aml-screening-businesses/compliancekycsearchbusinessdownload

Initiates a business AML screening and provides a URL to download the resulting PDF file. The search consumes one credit.

```APIDOC
## POST /compliance/kyc-protect/searches/businesses/download

### Description
Initiates a business AML screening and provides a URL to download the resulting PDF file. The search consumes one credit.

### Method
POST

### Endpoint
/compliance/kyc-protect/searches/businesses/download

### Parameters
#### Request Body
- **countryCodes** (array) - Required - List of Two-letter country code ISO-3166-2.
- **threshold** (integer) - Required - Must be one of 75, 80, 85, 90, 95, or 100.
- **name** (string) - Required if FirstName and LastName are not provided - Max 200 characters allowed.
- **datasets** (array) - Required - Specifies which datasets will be searched (e.g., Politically Exposed Persons, Sanctioned, Insolvency, Averse Media, POI, Enforcement, State Owned Enterprises).

### Request Example
```json
{
  "countryCodes": ["US", "GB"],
  "threshold": 90,
  "name": "Google Inc",
  "datasets": ["SAN-CURRENT", "PEP by Association"]
}
```

### Response
#### Success Response (201)
- **downloadUrl** (string) - Url of the file to download.
- **fileName** (string) - Name of the file.
- **expiresAt** (string) - Date and time when the url will expire.
- **searchId** (string) - Id of the search.

#### Response Example
```json
{
  "downloadUrl": "https://example.com/downloads/abcdef123.pdf",
  "fileName": "Google_Inc_AML_Report.pdf",
  "expiresAt": "2023-10-27T10:00:00Z",
  "searchId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

#### Error Response (400)
- **correlationId** (string) - A unique ID assigned to this request.
- **message** (string) - Error message.
- **details** (string) - Provides further information on why the request was rejected.

#### Error Response (401)
- **error** (string) - Authentication error message.

#### Error Response (403)
- **message** (string) - Access forbidden message.
```

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

### PUT /decisionEngine/instance/{guid}

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/checkdecide/checkanddecide

Updates the configuration of an existing decision engine instance. Use GET to retrieve current configuration before updating.

```APIDOC
## PUT /decisionEngine/instance/{guid}

### Description
Update the instances information. You will need to call the GET endpoint to get the current configuration and then update the fields you want to change.

### Method
PUT

### Endpoint
/decisionEngine/instance/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the decision engine instance to update.

#### Request Body
- **configuration** (object) - The updated configuration details for the decision engine instance.
  - **name** (string) - Optional - The new name for the instance.
  - **rules** (array) - Optional - The updated list of rules for the instance.

### Request Example
```json
{
  "configuration": {
    "name": "Updated Credit Risk Assessment",
    "rules": [
      {
        "id": "rule-001",
        "condition": "income > 60000 AND credit_score > 720",
        "action": "Approve"
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the instance was updated successfully.

#### Response Example
```json
{
  "message": "Instance configuration updated successfully."
}
```
```

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

### Director Search Request - HTTP GET

Source: https://doc.creditsafe.com/connect-apis-catalog/product-catalog/localsolutions/documentation/verify

This example shows an HTTP GET request to the Director Search endpoint. It demonstrates how to query for company directors using parameters like country and first name. For more precise results, additional parameters such as last name and date of birth are recommended.

```http
GET /people?countries=GB&firstName=ExampleDirector

```