API fromu (FROMU)

API for client verification against FROMU lists.

The service provides methods for bulk and individual verification of clients against lists of organizations and individuals associated with terrorism or proliferation of weapons of mass destruction, compiled in accordance with UN Security Council decisions.

Verification Results for All Clients

Method	URI	Description
`GET\|HEAD`	`/api/maintenance/fromu/report/make`	Create fromu report
`GET\|HEAD`	`/api/fromu/all-clients/result/files`	Get list of FROMU result files
`GET\|HEAD`	`/api/fromu/all-clients/result/file/{filename}`	Download FROMU result file
`GET\|HEAD`	`/api/fromu/all-clients/result/list`	Get list of FROMU results
`GET\|HEAD`	`/api/fromu/all-clients/result/qty`	Get FROMU results count

Individual Client Verifications

Method	URI	Description
`GET\|HEAD`	`/api/fromu/client/{client_id}/check`	Get client verification information in FROMU
`POST`	`/api/fromu/client/{client_id}/check`	Start new client verification in FROMU
`GET\|HEAD`	`/api/fromu/client/{client_id}/status`	Show current client status by ID in FROMU
`GET\|HEAD`	`/api/fromu/record/{fromuId}`	Get FROMU record

API Methods Description

Verification Results for All Clients

Create fromu report

GET|HEAD /api/maintenance/fromu/report/make

Description

Methods are designed to create a report in the RFM system based on FROMU list verification data. The method is used to generate analytical reports on verification results, monitor system efficiency, and prepare data for external systems.

Request Examples

GET /api/maintenance/fromu/report/make

Successful Response Example

json

{
  "status": "ok", // Operation execution status ("ok" on success)
  "timestamp": 1755006198000, // Response timestamp in milliseconds
  "data": null // Response data (null, as the method only starts the report creation process)
}

Get list of FROMU result files

GET|HEAD /api/fromu/all-clients/result/files

Description

The method returns a list of all available files with FROMU verification results. Files contain results of bulk client verifications in the FROMU system.

Request Example

GET /api/fromu/all-clients/result/files

Successful Response Example

json

{
  "status": "ok", // Response status
  "timestamp": 1754139352000, // Response timestamp
  "data": [
    // Array of result file names
    "2023-10-13_131543.xlsx", // File from 13.10.2023 13:15:43
    "2023-10-17_125710.xlsx", // File from 17.10.2023 12:57:10
    "2023-10-18_113003.xlsx", // File from 18.10.2023 11:30:03
    "2023-10-18_113027.xlsx", // File from 18.10.2023 11:30:27
    "2023-10-18_113509.xlsx", // File from 18.10.2023 11:35:09
    "2023-10-19_093038.xlsx", // File from 19.10.2023 09:30:38
    "2023-10-20_065838.xlsx", // File from 20.10.2023 06:58:38
    "2023-10-20_124748.xlsx", // File from 20.10.2023 12:47:48
    "2023-10-20_124853.xlsx", // File from 20.10.2023 12:48:53
    "2023-10-20_132313.xlsx", // File from 20.10.2023 13:23:13
    "2023-10-20_173216.xlsx", // File from 20.10.2023 17:32:16
    "2023-11-29_103455.xlsx", // File from 29.11.2023 10:34:55
    "2023-11-29_103704.xlsx", // File from 29.11.2023 10:37:04
    "2023-11-29_103827.xlsx", // File from 29.11.2023 10:38:27
    "2025-05-05_132331.xlsx" // File from 05.05.2025 13:23:31
  ]
}

Download FROMU result file

GET|HEAD /api/fromu/all-clients/result/file/{filename}

Description

The method allows downloading a specific file with FROMU verification results by its name. The file contains detailed information about bulk client verification results. The filename must exactly match the list from the GET /api/fromu/all-clients/result/files method

Request Parameters

{filename} (string, required) — filename for download (e.g.: "2023-10-13_131543.xlsx").

Request Example

GET /api/fromu/all-clients/result/file/2023-10-13_131543.xlsx

Successful Response Example

\\\\\

Get list of FROMU results

GET|HEAD /api/fromu/all-clients/result/list

Description

The method returns a list of all client verification results in the FROMU system. Each record contains the client's verification history, current status, and identifiers.

Request Example

GET /api/fromu/all-clients/result/list

Successful Response Example

json

{
  "status": "ok", // Response status
  "timestamp": 1754139770000, // Response timestamp
  "data": [
    // Array of verification results
    {
      "checkLog": [
        // Client verification history
        {
          "found": true, // Verification result - found
          "date": "2025-02-25T14:57:27+00:00" // Verification date and time
        },
        {
          "found": true, // Verification result - found
          "date": "2025-02-25T15:09:17+00:00" // Verification date and time
        },
        {
          "found": true, // Verification result - found
          "date": "2025-03-24T11:26:09+00:00" // Verification date and time
        },
        {
          "found": true, // Verification result - found
          "date": "2025-07-14T07:47:02+00:00" // Verification date and time
        }
      ],
      "clientId": 1163, // Client ID
      "currentStatus": 1, // Current client status (1 - found, 0 - not found)
      "num": 6908488, // Record number
      "fromu_id": 6908488 // Record ID in FROMU system
    }
  ]
}

Analysis of verification history for client ID 1163:

25.02.2025: Client found in FROMU system
24.03.2025: Client remains in FROMU system
23.04.2025: Client remains in FROMU system
05.05.2025: Client remains in FROMU system
07.05.2025: Client remains in FROMU system
23.05.2025: Client remains in FROMU system
28.05.2025: Client remains in FROMU system
04.06.2025: Client remains in FROMU system
14.07.2025: Client remains in FROMU system

Current status: Client is in FROMU system (currentStatus: 1)

Notes

The method returns the complete verification history for all clients
Each record contains detailed information about client verifications
currentStatus reflects the current status at the time of the last verification
fromu_id corresponds to the identifier in the FROMU system

Get FROMU results count

GET|HEAD /api/fromu/all-clients/result/qty

Description

The method returns the total number of clients found in the FROMU system. Shows statistics on verification results for all clients.

Request Example

GET /api/fromu/all-clients/result/qty

Successful Response Example

json

{
  "status": "ok", // Response status
  "timestamp": 1754140070000, // Response timestamp
  "data": {
    "count": 1 // Number of clients found in FROMU system
  }
}

Individual Client Verifications

Get client verification information in FROMU

GET|HEAD /api/fromu/client/{client_id}/check

Description

The method returns current information about client verification in the FROMU system. Shows the client's current status at the time of the last verification.

Request Parameters

{client_id} (integer, required) — unique client identifier.

Request Example

GET /api/fromu/client/1163/check

Successful Response Example

json

{
  "status": "ok", // Response status
  "timestamp": 1754140267000, // Response timestamp
  "data": {
    "found": "found", // Verification result - client found in FROMU system
    "status": "FOUND" // Client status - found in FROMU system
  }
}

Start new client verification in FROMU

POST /api/fromu/client/{client_id}/check

Description

The method starts a new client verification in the FROMU system and returns the current result. Unlike the GET method, this method forcibly updates the client's status.

Request Parameters

{client_id} (integer, required) — unique client identifier.

Request Example

POST /api/fromu/client/1162/check

Successful Response Example

json

{
  "status": "ok", // Response status
  "timestamp": 1754140468000, // Response timestamp
  "data": {
    "found": "not found", // Verification result - client not found in FROMU system
    "status": "NOT_FOUND" // Client status - not found in FROMU system
  }
}

Show current client status by ID

GET|HEAD /api/fromu/client/{client_id}/status

Description

The method returns detailed information about the client's status in the FROMU system, including complete verification history. Shows the client's current status and all previous verifications with dates.

Request Parameters

{client_id} (integer, required) — unique client identifier.

Request Example

GET /api/fromu/client/1162/status

Successful Response Example

json

{
  "status": "ok", // Response status
  "timestamp": 1754150985000, // Response timestamp
  "data": {
    "clientId": "1162", // Client ID
    "checkLog": [
      // Client verification history
      {
        "found": false, // Verification result - not found
        "date": "2025-02-25T14:57:27+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-02-25T15:09:18+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-02-25T17:50:14+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-04-23T08:39:46+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-04-23T08:47:09+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-05-05T13:22:07+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-05-05T14:40:13+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-05-07T10:03:02+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-05-23T06:46:50+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-05-28T13:36:17+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-06-04T15:12:54+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-07-14T07:47:03+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-08-02T13:14:28+00:00" // Verification date and time
      },
      {
        "found": false, // Verification result - not found
        "date": "2025-08-02T15:57:15+00:00" // Verification date and time
      }
    ],
    "currentStatus": false, // Current client status (false - not found, true - found)
    "fromu_id": 0, // Record ID in FROMU system (0 if not found)
    "lastCheck": "2025-08-02T15:57:15+00:00" // Last verification date and time
  }
}

Analysis of verification history for client ID 1162:

25.02.2025: Client not found in FROMU system
23.04.2025: Client not found in FROMU system
05.05.2025: Client not found in FROMU system
07.05.2025: Client not found in FROMU system
23.05.2025: Client not found in FROMU system
28.05.2025: Client not found in FROMU system
04.06.2025: Client not found in FROMU system
14.07.2025: Client not found in FROMU system
02.08.2025: Client not found in FROMU system

Current status: Client is not in FROMU system (currentStatus: false)

API fromu (FROMU) ​

Verification Results for All Clients ​

Individual Client Verifications ​

API Methods Description ​

Verification Results for All Clients ​

Create fromu report ​

Get list of FROMU result files ​

Download FROMU result file ​

Get list of FROMU results ​

Get FROMU results count ​

Individual Client Verifications ​

Get client verification information in FROMU ​

Start new client verification in FROMU ​

Show current client status by ID ​

API fromu (FROMU)

Verification Results for All Clients

Individual Client Verifications

API Methods Description

Verification Results for All Clients

Create fromu report

Get list of FROMU result files

Download FROMU result file

Get list of FROMU results

Get FROMU results count

Individual Client Verifications

Get client verification information in FROMU

Start new client verification in FROMU

Show current client status by ID