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.

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
Authorizations
Query parameters
employeeIdstringOptional
Body
innstringOptional
firstNamestringOptional
lastNamestringOptional
durationinteger · int32Optional
phoneNumberstringOptional
categoryTypestring[]Optional
Responses
200
Returns Success
post
POST /api/v1/Application/create-application HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 109

{
  "inn": "text",
  "firstName": "text",
  "lastName": "text",
  "duration": 1,
  "phoneNumber": "text",
  "categoryType": [
    "text"
  ]
}
{
  "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
Authorizations
Path parameters
idstringRequired
Responses
200
Returns Success
get
GET /api/v1/Application/get-application-by-id/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "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-06-26T18:56:22.570Z",
  "providedAt": "2025-06-26T18:56:22.570Z",
  "revokedAt": "2025-06-26T18:56:22.570Z",
  "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
Authorizations
Query parameters
applicationNumberstringOptional
Responses
200
Returns Success
get
GET /api/v1/Application/get-application-by-application-number HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "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-06-26T18:56:22.570Z",
  "providedAt": "2025-06-26T18:56:22.570Z",
  "revokedAt": "2025-06-26T18:56:22.570Z",
  "status": "text",
  "documentProvide": "text",
  "documentRevoke": "text",
  "comment": "text",
  "revokedBy": "text",
  "employeeName": "text",
  "employeePosition": "text",
  "isAllowed": true
}

Last updated

Was this helpful?