For Data Сonsumers

In this section, you will find information on how to integrate with the service for providing legal consent for the transfer and processing of personal data.

Disclaimer: The development team is working diligently, and the documentation will be updated with each new release.

This functionality is available only on the territory of the Kyrgyz Republic.

Before you start you need to get an Authorization Token(Bearer). Please talk to our team to obtain the token.

If you need to get a consent from user, you need to create an application first. To do that you need to make a POST request.

Create application

POST/api/v1/Application/create-application

Authorization

Bearer

Query parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

innstring

firstNamestring

lastNamestring

durationinteger (int32)

phoneNumberstring

categoryTypearray of string

Response

200400401403404415

Returns Success

Body

text/plainapplication/jsontext/json

codeinteger (int32)

The HTTP Status Code

Example: 200

messageany

The Message from response

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/Application/create-application', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <apiKey>",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "categoryType": [
        null
      ]
    }),
});
const data = await response.json();

Response

200

{
  "code": 200,
  "message": null
}

Once the application is created, you must wait for the user to provide their official consent. While waiting you might request status of application.

Get application by id

GET/api/v1/Application/get-application-by-id/{id}

Authorization

Bearer

Path parameters

id*string

Response

200400401403404415

Returns Success

Body

text/plainapplication/jsontext/json

idstring (uuid)

applicationNumberstring

innstring

firstNamestring

lastNamestring

phoneNumberstring

durationinteger (int32)

frontImagestring

backImagestring

faceImagestring

categoryTypearray of string

requesterIdstring (uuid)

createdAtstring (date-time)

providedAtstring (date-time)

revokedAtstring (date-time)

statusstring

documentProvidestring

documentRevokestring

commentstring

revokedBystring

employeeNamestring

employeePositionstring

isAllowedboolean

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/Application/get-application-by-id/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <apiKey>"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "applicationNumber": "text",
  "inn": "text",
  "firstName": "text",
  "lastName": "text",
  "phoneNumber": "text",
  "duration": 1,
  "frontImage": "text",
  "backImage": "text",
  "faceImage": "text",
  "categoryType": [
    "text"
  ],
  "requesterId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-05T09:58:31.660Z",
  "providedAt": "2025-02-05T09:58:31.660Z",
  "revokedAt": "2025-02-05T09:58:31.660Z",
  "status": "text",
  "documentProvide": "text",
  "documentRevoke": "text",
  "comment": "text",
  "revokedBy": "text",
  "employeeName": "text",
  "employeePosition": "text",
  "isAllowed": true
}

Also you can get appliction by its application number.

Get application by appliction number

GET/api/v1/Application/get-application-by-application-number

Authorization

Bearer

Query parameters

Response

200400401403404415

Returns Success

Body

text/plainapplication/jsontext/json

idstring (uuid)

applicationNumberstring

innstring

firstNamestring

lastNamestring

phoneNumberstring

durationinteger (int32)

frontImagestring

backImagestring

faceImagestring

categoryTypearray of string

requesterIdstring (uuid)

createdAtstring (date-time)

providedAtstring (date-time)

revokedAtstring (date-time)

statusstring

documentProvidestring

documentRevokestring

commentstring

revokedBystring

employeeNamestring

employeePositionstring

isAllowedboolean

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/Application/get-application-by-application-number', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <apiKey>"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "applicationNumber": "text",
  "inn": "text",
  "firstName": "text",
  "lastName": "text",
  "phoneNumber": "text",
  "duration": 1,
  "frontImage": "text",
  "backImage": "text",
  "faceImage": "text",
  "categoryType": [
    "text"
  ],
  "requesterId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-05T09:58:31.660Z",
  "providedAt": "2025-02-05T09:58:31.660Z",
  "revokedAt": "2025-02-05T09:58:31.660Z",
  "status": "text",
  "documentProvide": "text",
  "documentRevoke": "text",
  "comment": "text",
  "revokedBy": "text",
  "employeeName": "text",
  "employeePosition": "text",
  "isAllowed": true
}