Detailed information on endpoints

An API (Application Programming Interface) is a set of rules that allows different software applications to communicate with each other.

An endpoint (API endpoint) is a specific address within an API that enables data retrieval or submission.

For example, when you open a banking app and instantly see your account balance, it's because your phone sends a request to the bank's server through a specific address – this address is the endpoint. The server then fetches your balance information and returns it to your device.

In simple terms, an endpoint is like a door leading to a room where data is stored. Each door grants access to a specific room, and you can only open the doors for which you have the right key.

Each YouScore endpoint provides a specific set of data. For instance, the /v1/usr/ endpoint, when queried with a company registration code (EDRPOU code), returns details about legal entities sourced from the Unified State Register of legal entities, individual entrepreneurs, and public organisations (USR).

For more information on available modules and endpoints, refer to Swagger or access the API documentation, which is available in HTML and PDF formats for download via Swagger.

Swagger is an interactive API documentation tool that allows users to browse the list of available endpoints directly in a web browser. It provides a detailed overview of each endpoint, including example responses, data structures, and request parameters. It even allows you to test API functionality within the interface.

To test YouScore, navigate to Swagger, enter your API key*, and send a few requests to see how the endpoints work in practice.

*An API key is a unique identifier used to access the API, similar to a login and password. A test API key can be obtained from your account manager.

• Data refers to raw information from public registers, such as EDRPOU codes, company names, addresses, and contact details.
• Analytics consists of expert-processed insights compiled by YouControl specialists. This includes recommended due diligence levels for assessing a company's reliability, its affiliation with financial-industrial groups, and whether it appears on sanctions lists.
• Custom data falls outside the standard dataset and is available for an additional fee. Examples include tracking newly registered businesses and individual entrepreneurs.