Scorechain API

https://tech-doc.api.scorechain.com/
Admin
Scorechain API provides cryptocurrency compliance, risk management, and transaction monitoring tools...
Tokens:197,390
Snippets:653
Trust Score:9.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Entity Wallets Retrieval (API Request Example)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This example demonstrates how to call the API to get the wallets of an entity. It requires an entity ID and optionally accepts a list of blockchains.

```bash
curl -X GET \
  'https://api.scorechain.com/v1/entities/{entityId}/wallets?blockchain=BITCOIN&blockchain=ETHEREUM' \
  -H 'accept: application/json' \
  -H 'Authorization: ApiKey YOUR_API_KEY'
```

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

### Example: Get Full Analysis of an Ethereum Address (ETH + Coins)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON example shows how to perform a 'FULL' analysis on an Ethereum address, including both ETH and other ERC-20 tokens. It sets 'objectType' to 'ADDRESS', provides a sample Ethereum 'objectId', specifies 'ETHEREUM' for 'blockchain', and leaves 'coin' as 'ALL' to include all relevant coins.

```JSON
{
  "analysisType": "FULL",
  "objectType": "ADDRESS",
  "objectId": "0xabcdef1234567890abcdef1234567890abcdef12",
  "blockchain": "ETHEREUM",
  "coin": "ALL"
}
```

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

### Example: Get Assigned Analysis of a BTC Address Wallet

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON example requests an 'ASSIGNED' analysis for the wallet associated with a Bitcoin address. It specifies 'WALLET' as the 'objectType', a sample Bitcoin address as 'objectId', and 'BITCOIN' as the 'blockchain'. The 'coin' parameter is set to 'MAIN' for analysis of the primary coin.

```JSON
{
  "analysisType": "ASSIGNED",
  "objectType": "WALLET",
  "objectId": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "blockchain": "BITCOIN",
  "coin": "MAIN"
}
```

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

### Example: Get Incoming Analysis of a BTC Transaction

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON example demonstrates how to request an 'INCOMING' analysis for a specific Bitcoin transaction. It specifies the transaction hash as the 'objectId' and 'BITCOIN' as the 'blockchain'. The 'coin' parameter is set to 'MAIN' to indicate analysis of the primary coin on the blockchain.

```JSON
{
  "analysisType": "INCOMING",
  "objectType": "TRANSACTION",
  "objectId": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
  "blockchain": "BITCOIN",
  "coin": "MAIN"
}
```

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

### Get Risk Indicators Response Example

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example of a JSON response when retrieving configured risk indicators. It returns a list of indicators, each with an ID, type, and parameters including threshold.

```json
[
  {
    "id": 42,
    "type": "ENTITY_TYPE",
    "parameters": {
      "referenceId": 51,
      "referenceName": "ATM",
      "threshold": 30
    }
  }
]
```

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

### Example: Get BAT Incoming Analysis of an Ethereum Address

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON example illustrates a request for an 'INCOMING' analysis focused on the Basic Attention Token (BAT) for a given Ethereum address. It specifies 'ADDRESS' as the 'objectType', the Ethereum address as 'objectId', and 'ETHEREUM' as the 'blockchain'. The 'coin' parameter is set to '0x0d8775f51dc534c9cd7804801090997d4562b558' (the contract address for BAT on Ethereum).

```JSON
{
  "analysisType": "INCOMING",
  "objectType": "ADDRESS",
  "objectId": "0x1234567890abcdef1234567890abcdef12345678",
  "blockchain": "ETHEREUM",
  "coin": "0x0d8775f51dc534c9cd7804801090997d4562b558"
}
```

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

### Get Wallet Activity Timeseries (JSON Response Sample)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example JSON response for the 'Get Wallet Activity Timeseries' endpoint. Includes current balance, timeseries data for asset rates, balance, transactions, and amounts sent/received, along with total activity figures.

```JSON
{
  "currentBalance": 1.5,
  "series": {
    "assetRatesUsd": [
      [
        1520294400000,
        3000
      ]
    ],
    "balance": [
      [
        1520294400000,
        1.5
      ]
    ],
    "numberOfTransactions": [
      [
        1520294400000,
        2
      ]
    ],
    "amountReceived": [
      [
        1520294400000,
        1.5
      ]
    ],
    "amountSent": [
      [
        1520294400000,
        0
      ]
    ]
  },
  "total": {
    "numberOfTransactions": 42,
    "amountReceived": 1.5,
    "amountSent": 0
  }
}
```

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

### GET Change Request API - Example Request

Source: https://tech-doc.api.scorechain.com/index

Example of how to call the GET /changeRequests/{changeRequestId} endpoint to retrieve details of a specific change request. This requires a valid change request ID as a path parameter.

```http
GET https://api.scorechain.com/v1/changeRequests/65c20670-f7e5-430a-a73f-ad87612483a9
```

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

### Get Wallet Transactions (JSON Response Sample)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example JSON response for the 'Get Wallet Transactions' endpoint, including metadata and a list of transaction items. Each item contains transaction hash, date, and operations details.

```JSON
{
  "_metadata": {
    "count": 50,
    "offset": 0,
    "limit": 50,
    "total": 60
  },
  "items": [
    {
      "hash": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
      "date": 1645692176,
      "operations": [
        {
          "type": "string",
          "coin": {
            "id": 1,
            "name": "Bitcoin",
            "symbol": "BTC",
            "blockchain": "ARBITRUMONE",
            "chainId": null,
            "decimals": 8,
            "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mPkzzn1HwAEHQJG7JthAAAAAABJRU5ErkJggg==",
            "isDeprecated": false
          },
          "amount": 0,
          "amountUsd": 0,
          "counterparties": [
            {
              "address": "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy",
              "entity": {
                "id": 42,
                "name": "Blocktrade.com",
                "type": "ATM",
                "typeId": 102,
                "score": 1,
                "countries": [
                  "string"
                ],
                "comment": "Lorem ipsum",
                "description": "Lorem ipsum"
              }
            }
          ]
        }
      ]
    }
  ]
}
```

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

### Entity Wallet Addresses Retrieval (API Request Example)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This example shows how to retrieve all addresses belonging to a specific wallet (blockchain) for a given entity. It supports pagination with offset and limit parameters.

```bash
curl -X GET \
  'https://api.scorechain.com/v1/entities/{entityId}/wallets/{blockchain}/addresses?offset=0&limit=20' \
  -H 'accept: application/json' \
  -H 'Authorization: ApiKey YOUR_API_KEY'
```

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

### Example Report Response (JSON)

Source: https://tech-doc.api.scorechain.com/index

Example JSON response for a successfully created report. It mirrors the request structure and includes metadata about the report generation process.

```json
{
  "_metadata": {
    "count": 50,
    "offset": 0,
    "limit": 50,
    "total": 60
  },
  "items": [
    {
      "id": 42,
      "blockchain": "ARBITRUMONE",
      "reportType": "TX_KYT",
      "mailNotification": false,
      "parameters": {
        "hash": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
        "currency": "EUR"
      },
      "status": "IN_QUEUE",
      "files": [
        {
          "mimeType": "application/pdf",
          "path": "TX_KYT_XXXXXXXX.csv"
        }
      ],
      "target": {
        "id": "17mmd6HfhkFB2kLy2GBbWenn48YJf7mGwg",
        "type": "ADDRESS",
        "name": "Apache.org donations"
      },
      "creationDate": 1645692176,
      "completionDate": 1645692176,
      "author": {
        "mail": "john.smith@scorechain.com",
        "firstname": "John",
        "lastname": "Smith",
        "role": "Tech admin"
      }
    }
  ]
}
```

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

### Create Report Example (JSON)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example JSON payload for creating a report. This includes specifying the blockchain, report type, mail notification preference, and transaction parameters like hash and currency.

```json
{
  "blockchain": "ARBITRUMONE",
  "reportType": "TX_KYT",
  "mailNotification": false,
  "parameters": {
    "hash": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
    "currency": "EUR"
  }
}
```

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

### Get User History API - Query Parameters

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This example shows how to query the user management history endpoint. The 'offset' parameter allows skipping a number of records, and the 'limit' parameter restricts the number of results returned. These are useful for pagination and retrieving specific subsets of the audit trail.

```http
GET /v1/users/history?offset=20&limit=10 HTTP/1.1
Host: api.scorechain.com

```

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

### 2FA OTP Challenge (JSON)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example JSON response containing an OTP challenge, which is required to enable two-factor authentication. This challenge is used with the PATCH /me endpoint to complete the 2FA setup process.

```json
{
  "challenge": "bCV4WiB93rDJwtTL5VntTf8Za4RsZZvQ"
}
```

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

### Retrieve Lists with Filtering - API Example

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This example demonstrates how to retrieve a paginated list of address lists, filtering by type, severity, name, and user email. It includes query parameters for pagination (offset, limit) and response structure for paginated results.

```json
{
  "_metadata": {
    "count": 50,
    "offset": 0,
    "limit": 50,
    "total": 60
  },
  "items": [
    {
      "id": 42,
      "type": "CUSTOMER_PORTFOLIO",
      "name": "My list",
      "riskAnalysisNote": "Lorem ipsum",
      "numberOfAddresses": 123,
      "severity": "LOW_RISK",
      "score": 1,
      "creationDate": 1645692176,
      "scenarios": [
        {
          "id": "cf7ca2b3-22ba-489b-b38b-6ec140538c6f",
          "name": "High value withdrawals"
        }
      ],
      "author": {
        "mail": "john.smith@scorechain.com",
        "firstname": "John",
        "lastname": "Smith",
        "role": "Tech admin"
      }
    }
  ]
}
```

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

### Callback Payload Example

Source: https://tech-doc.api.scorechain.com/index

This is an example of the JSON payload received by your webhook URL when a risk scenario is triggered.

```APIDOC
## Callback Payload Example

### Description
This JSON object represents the data structure of a callback payload sent to a configured webhook URL when a risk scenario is triggered by a transaction.

### Content Type
application/json

### Payload Structure
- **id** (string) - Unique ID of the alert.
- **date** (integer) - Timestamp of when the alert was generated (Unix epoch time).
- **status** (string) - The current status of the alert (e.g., "OPEN", "CLOSED").
- **riskLevel** (string) - The risk level assigned to the triggered scenario.
- **transactionHash** (string) - The hash of the transaction that triggered the alert.
- **addressHash** (string) - The blockchain address involved in the transaction.
- **blockchain** (string) - The blockchain network where the transaction occurred.
- **actionStatus** (string) - The status of the action taken on the alert (e.g., "REPORTED").
- **scenario** (object) - Information about the triggered risk scenario.
  - **id** (string) - Unique ID of the scenario.
  - **name** (string) - Name of the scenario.
  - **type** (string) - Type of the scenario (e.g., "STANDARD").
- **item** (object) - Information about the item associated with the scenario (e.g., address, list).
  - **id** (string) - Unique ID of the item.
  - **displayName** (string) - Human-readable name of the item.
  - **link** (string) - A link to view the item within the Scorechain platform.
- **customerRefId** (string) - Optional customer reference ID.
- **custodyTxId** (string) - Optional custody transaction ID.
- **custodyIsTxFrozen** (boolean) - Indicates if the transaction is frozen in custody.
- **isObsolete** (boolean) - Indicates if the alert is obsolete.
- **isActionObsolete** (boolean) - Indicates if the action taken on the alert is obsolete.
- **isOngoingTimeWindow** (boolean) - Indicates if the alert falls within an ongoing time window.
- **assignee** (object) - Information about the user assigned to handle the alert.
  - **mail** (string) - Email address of the assignee.
  - **firstname** (string) - First name of the assignee.
  - **lastname** (string) - Last name of the assignee.
  - **role** (string) - Role of the assignee.
- **details** (array) - Specific details about the rule that was triggered.
  - **rule** (object) - Information about the triggered rule.
    - **name** (string) - Name of the rule.
    - **amount** (number) - The threshold amount for the rule.
    - **currency** (string) - The currency for the rule amount.
  - **value** (number) - The actual value that triggered the rule.

### Example Payload
```json
{
  "id": "ef2d452a-21f7-453f-832e-4ca676129099",
  "date": 1645692176,
  "status": "OPEN",
  "riskLevel": "LOW_RISK",
  "transactionHash": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
  "addressHash": "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy",
  "blockchain": "BITCOIN",
  "actionStatus": "REPORTED",
  "scenario": {
    "id": "cf7ca2b3-22ba-489b-b38b-6ec140538c6f",
    "name": "High value withdrawals",
    "type": "STANDARD"
  },
  "item": {
    "id": "46217b4c-7b7b-4742-abc4-627a2866fe68",
    "displayName": "My customers",
    "link": "/lists/customers-portfolio/42"
  },
  "customerRefId": "ff14d2bb-c99a-4b69-b250-723fe415b42e",
  "custodyTxId": "7362bcb6-151b-46ee-88c8-a9b0448e2aea",
  "custodyIsTxFrozen": false,
  "isObsolete": false,
  "isActionObsolete": false,
  "isOngoingTimeWindow": false,
  "assignee": {
    "mail": "john.smith@scorechain.com",
    "firstname": "John",
    "lastname": "Smith",
    "role": "Tech admin"
  },
  "details": [
    {
      "rule": {
        "name": "TX_GTE_FIAT_AMOUNT",
        "amount": 10000,
        "currency": "EUR"
      },
      "value": 12000
    }
  ]
}
```
```

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

### Retrieve Specific Entity by ID

Source: https://tech-doc.api.scorechain.com/index

This endpoint retrieves a single, specific entity based on its unique ID. The entity ID can be obtained from the GET /entities endpoint. The response contains the full details of the requested entity.

```bash
GET https://api.scorechain.com/v1/entities/{entityId}
```

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

### Example: Scoring of NFT #7736 of Collection BoredApeYatchClub

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON example demonstrates how to get the risk scoring for a specific NFT item. It sets 'objectType' to 'NFT_ITEM', 'objectId' to the format '[contract_address]:[token_id]', and specifies the 'blockchain'. In this case, it targets NFT #7736 from the Bored Ape Yacht Club collection on Ethereum.

```JSON
{
  "analysisType": "FULL",
  "objectType": "NFT_ITEM",
  "objectId": "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D:7736",
  "blockchain": "ETHEREUM"
}
```

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

### POST /users

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Creates a new user in your company.

```APIDOC
## POST /users

### Description
This endpoint creates a new user in your company.

### Method
POST

### Endpoint
`/users`

### Authorizations
_ApiKeyAuth_

### Parameters
#### Request Body
(Details for user creation request body would be specified here, e.g., username, email, role, etc.)

### Responses
(Success and error responses for user creation would be detailed here.)
```

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

### User Profile Data (JSON)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example JSON response showing user profile information, including contact details, role, 2FA status, permissions, preferences, company information, and license details. This data is typically returned when fetching user profile information.

```json
{
  "mail": "john.smith@scorechain.com",
  "firstname": "John",
  "lastname": "Smith",
  "role": "Tech admin",
  "is2FaEnabled": true,
  "permissions": [
    "UM_ROLES_WRITE"
  ],
  "preferences": [
    {
      "key": "WALKTHROUGH_STEP_1",
      "value": "OK"
    }
  ],
  "company": {
    "name": "Scorechain",
    "address": "Street no5",
    "zip": "12345",
    "city": "Paris",
    "country": "France",
    "maximumNumberOfUser": 12,
    "policies": {
      "security": {
        "inactivityLogoutTime": 1440,
        "is2FAMandatory": true
      }
    },
    "users": [
      {
        "mail": "john.smith@scorechain.com",
        "firstname": "John",
        "lastname": "Smith",
        "role": "Tech admin",
        "activated": true,
        "createdAt": 1519750988
      }
    ],
    "license": {
      "name": "Standard license",
      "credits": {
        "consumed": 42,
        "limit": 1000
      },
      "featureConsumption": {
        "checks": {
          "consumed": 10,
          "limit": 100000
        },
        "reports": {
          "consumed": 123,
          "limit": 5000
        },
        "lists": {
          "created": 5,
          "limit": 10000
        }
      },
      "includedFeatures": {
        "regulationInfo": true,
        "caseManager": true,
        "investigationTool": true,
        "apiKeys": true,
        "riskAlertScenarios": true,
        "fourEyesReview": true
      }
    },
    "custodyIntegrations": [
      {
        "name": "FIREBLOCKS",
        "isEnabled": true
      }
    ],
    "alertSystemVersion": 1
  }
}
```

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

### GET / - Search blockchain information and workspace data

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This endpoint helps you easily retrieve addresses, transactions, entities, and data from your workspace, including lists, address labels, cases, and investigations. You should provide at least 3 characters to start a search.

```APIDOC
## GET /search

### Description
Searches for blockchain information and workspace data, including addresses, transactions, entities, cases, investigations, labels, and lists. Requires at least 3 characters for the query.

### Method
GET

### Endpoint
https://api.scorechain.com/v1/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query. (3-255 characters)
- **type** (string) - Optional - Filters the search to return only one type of item. Enum: "ADDRESSES", "TRANSACTIONS", "ENTITIES", "CASES", "INVESTIGATIONS", "LABELS", "LISTS". If used, all other item types in the response will be null.
- **hasActivity** (boolean|null) - Optional - Filters addresses to only include those with blockchain activity. (NullableBoolean)
- **offset** (integer) - Optional - The number of items to skip before starting to collect the result set. Only usable when 'type' is specified. Default: 0. (>= 0)
- **limit** (integer) - Optional - The maximum number of items to retrieve. Only usable when 'type' is specified. Default: 10. (1-50)

### Request Example
```json
{
  "example": "GET /v1/search?q=bitstamp&type=ADDRESSES&limit=50"
}
```

### Response
#### Success Response (200)
- **addresses** (object|null) - Information about addresses matching the query.
- **transactions** (object|null) - Information about transactions matching the query.
- **entities** (object|null) - Information about entities matching the query.
- **cases** (object|null) - Information about cases matching the query.
- **investigations** (object|null) - Information about investigations matching the query.
- **labels** (object|null) - Information about labels matching the query.
- **lists** (object|null) - Information about lists matching the query.

*(Note: The structure of each object (addresses, transactions, etc.) would detail fields relevant to that type, similar to other list endpoints, including potential _metadata and items fields if 'type' is specified.)*

#### Error Responses
- **400** Invalid parameter input from the user
- **401** Client has not been identified and is then unauthorized
- **500** An error occurred on the server
```

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

### JSON Response Sample (List of Roles)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON array contains a list of user roles, including their unique IDs, names, and associated permissions. It provides a detailed view of role configurations.

```json
[
  {
    "id": "65c20670-f7e5-430a-a73f-ad87612483a9",
    "name": "Tech admin",
    "permissions": [
      {
        "id": "UM_ROLES_WRITE"
      }
    ]
  }
]
```

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

### GET /exchangeRates - Get fiat exchange rates

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This endpoint provides fiat exchange rates of supported currencies against USD.

```APIDOC
## GET /exchangeRates

### Description
Retrieves current fiat exchange rates for supported currencies against USD.

### Method
GET

### Endpoint
https://api.scorechain.com/v1/exchangeRates

### Parameters
None

### Request Example
```json
{
  "example": "GET /v1/exchangeRates"
}
```

### Response
#### Success Response (200)
- **[CurrencyCode]** (number) - The exchange rate of the currency against USD.

#### Response Example (200)
```json
{
  "AUD": 1.31875,
  "BRL": 4.652703,
  "CAD": 1.249405,
  "CHF": 0.93099,
  "CNY": 6.366703,
  "EUR": 0.917699,
  "GBP": 0.764815,
  "HKD": 7.83845,
  "ILS": 3.21974,
  "JPY": 123.875502,
  "KRW": 1218.144971,
  "MXN": 19.994615,
  "NOK": 8.76145,
  "NZD": 1.439725,
  "PLN": 4.270956,
  "RUB": 84.126496,
  "SEK": 9.44179,
  "SGD": 1.360435,
  "TRY": 14.718498,
  "USD": 1
}
```

#### Error Responses
- **401** Client has not been identified and is then unauthorized
- **500** An error occurred on the server
```

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

### POST /lists

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Creates a new list with specified properties. Requires API Key authentication.

```APIDOC
## POST /lists

### Description
Creates a new list with specified properties. Requires API Key authentication.

### Method
POST

### Endpoint
/lists

### Request Body
- **type** (string) - Required - The type of the list. Allowed values: "CUSTOMER_PORTFOLIO", "BLOCKLIST", "SAFELIST", "PRIVATE_LIST".
- **name** (string) - Required - The name of the list. Maximum 50 characters.
- **riskAnalysisNote** (string) - Optional - A description or note for risk analysis. Maximum 2048 characters.
- **score** (integer) - Optional - A score associated with the list. Must be between 1 and 100.

### Request Example
```json
{
  "type": "CUSTOMER_PORTFOLIO",
  "name": "My list",
  "riskAnalysisNote": "Lorem ipsum",
  "score": 1
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the created list.
- **type** (string) - The type of the created list.
- **name** (string) - The name of the created list.
- **riskAnalysisNote** (string) - The risk analysis note for the list.
- **numberOfAddresses** (integer) - The number of addresses associated with the list.
- **severity** (string) - The severity level of the list (e.g., "LOW_RISK").
- **score** (integer) - The score associated with the list.
- **creationDate** (integer) - The UTC Unix timestamp when the list was created.
- **scenarios** (array) - A list of associated scenarios.
  - **id** (string) - The ID of the scenario.
  - **name** (string) - The name of the scenario.
- **author** (_object_) - Information about the author of the list.
  - **mail** (string) - The email address of the author.
  - **firstname** (string) - The first name of the author.
  - **lastname** (string) - The last name of the author.
  - **role** (string) - The role of the author.

#### Error Responses
- **400** - Invalid parameter input from the user.
- **401** - Client has not been identified and is then unauthorized.
- **403** - Maximum number of allowed lists reached or missing permissions.
- **409** - A list already exists with the same name.
- **500** - An error occurred on the server.

### Response Example (200)
```json
{
  "id": 42,
  "type": "CUSTOMER_PORTFOLIO",
  "name": "My list",
  "riskAnalysisNote": "Lorem ipsum",
  "numberOfAddresses": 123,
  "severity": "LOW_RISK",
  "score": 1,
  "creationDate": 1645692176,
  "scenarios": [
    {
      "id": "cf7ca2b3-22ba-489b-b38b-6ec140538c6f",
      "name": "High value withdrawals"
    }
  ],
  "author": {
    "mail": "john.smith@scorechain.com",
    "firstname": "John",
    "lastname": "Smith",
    "role": "Tech admin"
  }
}
```
```

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

### POST /cases

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Creates a new case in the system.

```APIDOC
## POST /cases

### Description
This endpoint lets you create a new case.

### Method
POST

### Endpoint
https://api.scorechain.com/v1/cases

### Parameters
#### Request Body
- **name** (string) - Required - The name of the case.
- **isSharedWithCompany** (boolean) - Optional - Whether the case is shared with other accounts of your company.
- **status** (string) - Optional - Enum: "OPEN", "PENDING", "IN_PROGRESS", "CLOSED" - The status of the case.
- **assigneeMail** (string) - Optional - The email address of the assignee.

### Request Example
```json
{
  "name": "2.232 BTC of stolen funds",
  "isSharedWithCompany": true,
  "status": "OPEN",
  "assigneeMail": "john.smith@scorechain.com"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the case.
- **name** (string) - The name of the case.
- **isSharedWithCompany** (boolean) - Indicates if the case is shared with the company.
- **status** (string) - The current status of the case.
- **creationDate** (integer) - The timestamp when the case was created.
- **lastUpdateDate** (integer) - The timestamp when the case was last updated.
- **author** (object) - Information about the case author.
  - **mail** (string) - The email address of the author.
  - **firstname** (string) - The first name of the author.
  - **lastname** (string) - The last name of the author.
  - **role** (string) - The role of the author.
- **assignee** (object) - Information about the case assignee.
  - **mail** (string) - The email address of the assignee.
  - **firstname** (string) - The first name of the assignee.
  - **lastname** (string) - The last name of the assignee.
  - **role** (string) - The role of the assignee.

#### Error Response (400)
Invalid parameter input from the user.

#### Error Response (401)
Client has not been identified and is then unauthorized.

#### Error Response (403)
Feature not authorized by role or license.

#### Error Response (500)
An error occurred on the server.

### Response Example (200)
```json
{
  "id": 42,
  "name": "2.232 BTC of stolen funds",
  "isSharedWithCompany": true,
  "status": "OPEN",
  "creationDate": 1645692176,
  "lastUpdateDate": 1645692176,
  "author": {
    "mail": "john.smith@scorechain.com",
    "firstname": "John",
    "lastname": "Smith",
    "role": "Tech admin"
  },
  "assignee": {
    "mail": "john.smith@scorechain.com",
    "firstname": "John",
    "lastname": "Smith",
    "role": "Tech admin"
  }
}
```
```

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

### GET /coins/{coinId} - Get a specific coin

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This endpoint provides information and the icon associated with a specific coin, identified by its ID.

```APIDOC
## GET /coins/{coinId}

### Description
Retrieves detailed information and the icon for a specific coin using its unique identifier.

### Method
GET

### Endpoint
https://api.scorechain.com/v1/coins/{coinId}

### Parameters
#### Path Parameters
- **coinId** (integer) - Required - The unique identifier of the coin.

### Request Example
```json
{
  "example": "GET /v1/coins/1"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the coin.
- **name** (string) - The name of the coin.
- **symbol** (string) - The symbol of the coin.
- **blockchain** (string) - The blockchain the coin is associated with.
- **chainId** (string|null) - The chain ID, if applicable.
- **decimals** (integer) - The number of decimal places for the coin.
- **icon** (string) - A base64 encoded string of the coin's icon.
- **isDeprecated** (boolean) - Indicates if the coin is deprecated.

#### Response Example (200)
```json
{
  "id": 1,
  "name": "Bitcoin",
  "symbol": "BTC",
  "blockchain": "ARBITRUMONE",
  "chainId": null,
  "decimals": 8,
  "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mPkzzn1HwAEHQJG7JthAAAAAABJRU5ErkJggg==",
  "isDeprecated": false
}
```

#### Error Responses
- **400** Missing required parameter
- **401** Client has not been identified and is then unauthorized
- **404** Coin not found
- **500** An error occurred on the server
```

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

### GET /reports/{reportId}

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Retrieves a specific report by its technical ID. The report ID can be found by calling the GET /reports endpoint.

```APIDOC
## GET /reports/{reportId}

### Description
This endpoint retrieves a specific report.

### Method
GET

### Endpoint
/v1/reports/{reportId}

### Parameters
#### Path Parameters
- **reportId** (integer) - Required - The technical id of the report that can be found at GET /reports.

### Responses
#### Success Response (200)
The asked report.

#### Response Example (200)
```json
{
  "blockchain": "ARBITRUMONE",
  "reportType": "TX_KYT",
  "mailNotification": false,
  "parameters": {
    "hash": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
    "currency": "EUR"
  }
}
```

#### Error Responses
- **400** - Invalid parameter input from the user.
- **401** - Client has not been identified and is then unauthorized.
- **403** - Current role does not grant permission.
- **404** - Report not found.
- **500** - An error occurred on the server.
```

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

### JSON Response Sample (Created Role)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON object represents a newly created role, including its ID, name, and assigned permissions. It confirms the successful creation of the role.

```json
{
  "id": "65c20670-f7e5-430a-a73f-ad87612483a9",
  "name": "Tech admin",
  "permissions": [
    {
      "id": "UM_ROLES_WRITE"
    }
  ]
}
```

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

### Example: Scoring of BoredApeYatchClub NFT Collection

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This JSON example shows how to request a risk scoring for an entire NFT collection. It sets 'objectType' to 'NFT_COLLECTION', 'objectId' to the collection's contract address, and specifies the 'blockchain'. This example targets the Bored Ape Yacht Club collection on Ethereum.

```JSON
{
  "analysisType": "FULL",
  "objectType": "NFT_COLLECTION",
  "objectId": "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  "blockchain": "ETHEREUM"
}
```

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

### System Status (JSON)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

Example JSON response detailing the system status for supported blockchains, including synchronization status and the latest block information. This is useful for monitoring the health and sync status of the Scorechain platform with various blockchain networks.

```json
{
  "timestamp": 1645692176,
  "blockchains": [
    {
      "blockchain": "ARBITRUMONE",
      "syncStatus": "SYNCED",
      "unsyncedBlocks": 0,
      "latestBlock": {
        "height": 728519,
        "hash": "000000000000000000035539deb5bd6aed8bef00fbb4d4cea89940dcc6caf95d"
      }
    }
  ]
}
```

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

### Get Address Information (GET)

Source: https://tech-doc.api.scorechain.com/index

Retrieves detailed information about a specific blockchain address, including associated entities, labels, and risk assessments. Requires an API key for authorization.

```openapi
paths:
  /blockchains/{blockchain}/addresses/{address}:
    get:
      summary: Get an address information
      description: Get an address of a specific blockchain with related information
      operationId: getAddressInfo
      parameters:
        - name: blockchain
          in: path
          required: true
          schema:
            type: string
            enum: ["ARBITRUMONE", "AVALANCHE", "BASE", "BITCOIN", "BITCOINCASH", "BLAST", "BSC", "DASH", "DOGECOIN", "ETHEREUM", "INK", "LITECOIN", "MANTLE", "OPTIMISM", "POLYGON", "RIPPLE", "SOLANA", "STELLAR", "TEZOS", "TON", "TRON"]
        - name: address
          in: path
          required: true
          schema:
            type: string
            example: "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy"
      responses:
        '200':
          description: The data linked to an address like label, lists and cases
          content:
            application/json:
              schema:
                type: object
                properties:
                  hash:
                    type: string
                    example: "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy"
                  subAccount:
                    type: object
                    properties:
                      hash:
                        type: string
                        example: "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy"
                      coin:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: "Bitcoin"
                          symbol:
                            type: string
                            example: "BTC"
                          blockchain:
                            type: string
                            example: "ARBITRUMONE"
                          chainId:
                            type: integer
                            nullable: true
                          decimals:
                            type: integer
                            example: 8
                          icon:
                            type: string
                            example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mPkzzn1HwAEHQJG7JthAAAAAABJRU5ErkJggg=="
                          isDeprecated:
                            type: boolean
                            example: false
                  entity:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 42
                      name:
                        type: string
                        example: "Blocktrade.com"
                      type:
                        type: string
                        example: "ATM"
                      referenceAddress:
                        type: string
                        example: "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy"
                      aiDetails:
                        nullable: true
                      countries:
                        type: array
                        items:
                          type: string
                        example: ["Luxembourg"]
                      riskAssessment:
                        type: object
                        properties:
                          score:
                            type: integer
                            example: 75
                          severity:
                            type: string
                            example: "LOW_RISK"
                      comment:
                        type: string
                        example: "Reported by third party XXX"
                  wallet:
                    type: object
                    properties:
                      numberOfAddresses:
                        type: integer
                        example: 64
                  customRiskAssessment:
                    type: object
                    properties:
                      score:
                        type: integer
                        example: 75
                      severity:
                        type: string
                        example: "LOW_RISK"
                      origin:
                        type: string
                        example: "CUSTOM_ENTITY"
                      justification:
                        type: string
                        example: "Justification on why we lowered the score"
                  parentEntity:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 42
                      name:
                        type: string
                        example: "Blocktrade.com"
                      type:
                        type: string
                        example: "ATM"
                      referenceAddress:
                        type: string
                        example: "31oSGBBNrpCiENH3XMZpiP6GTC4tad4bMy"
                      aiDetails:
                        nullable: true
                  isBookmarked:
                    type: boolean
                    example: false
                  label:
                    nullable: true
                  lists:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 42
                        type:
                          type: string
                          example: "CUSTOMER_PORTFOLIO"
                        name:
                          type: string
                          example: "My list"
                        score:
                          type: integer
                          example: 42
                        addressId:
                          type: integer
                          example: 84
                  cases:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 42
                        name:
                          type: string
                          example: "string"
                  scenarios:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "cf7ca2b3-22ba-489b-b38b-6ec140538c6f"
                        name:
                          type: string
                          example: "High value withdrawals"
                  firstActivityDate:
                    type: integer
                    example: 1645692176
                  lastActivityDate:
                    type: integer
                    example: 1645692176
        '400':
          description: Invalid parameter input from the user
        '401':
          description: Client has not been identified and is then unauthorized
        '500':
          description: An error occurred on the server
      servers:
        - url: https://api.scorechain.com/v1

```

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

### Create Report Request Sample

Source: https://tech-doc.api.scorechain.com/index

This JSON object represents a sample request for creating a report. It includes details such as the blockchain, report type, email notification preference, and specific parameters like hash and currency.

```json
{
  "blockchain": "ARBITRUMONE",
  "reportType": "TX_KYT",
  "mailNotification": false,
  "parameters": {
    "hash": "3420f85d75c82d4200afb5d39067a02a29b6c48b371f266d37d59a4abcc2e96a",
    "currency": "EUR"
  }

}
```

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

### Add Multiple Addresses to List Response Sample (JSON)

Source: https://tech-doc.api.scorechain.com/index_tag/Introduction

This snippet demonstrates a successful response (200 OK) after attempting to add multiple addresses in bulk. It provides counts of successful additions and failures.

```json
{
  "success": 12,
  "failure": 0,
  "failureDetails": {
    "alreadyInSameList": 0,
    "alreadyInScoredList": 0,
    "duplicatesInInput": 0,
    "userError": 0,
    "serverError": 0
  }
}
```
Tokens:
Raw