openapi: 3.0.0 info: title: AML.point contact: {} version: 1.9.5 servers: - url: https://amlpoint.com.ua variables: {} - url: https://demo.amlpoint.com.ua variables: {} paths: /api-docs/v1/login: post: tags: - Auth summary: Отримати код двофакторної авторизації. requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Authorization' required: true responses: '200': description: '' content: application/json: example: codeSent: true '403': description: '' content: application/json: examples: expired_password: summary: Пароль прострочений value: code: 403 description: - Пароль прострочений і повинен бути замінений! '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: email: - validation.required password: - validation.required wrong_data: summary: Невірні дані value: code: 406 description: - Невірний логін або пароль. deprecated: false /api-docs/v1/2fa: post: tags: - Auth summary: Отримати токен авторизації. requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/TwoFactorAuthorization' required: true responses: '200': description: '' content: application/json: example: success: >- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NDc4ZjA3ZC05YTQ4LTQ3ZDktOWZkMC05ZmM4YWU3NmI2NDIiLCJqdGkiOiJiNmNlMDljNzlhZmY4ZjUyZTlhZWU4NzM3MWU4ZDgwMGM0N2Q3MGZjMTEyYWFhNzQ1OTJlZDRhY2U1NjM1NjdjODNlN2NiNzgzYmM2MjdhZSIsImlhdCI6MTY1MTE2NDY2OC43MTkxNTYsIm5iZiI6MTY1MTE2NDY2OC43MTkxNzgsImV4cCI6MTY1MTE2ODI2OC42MzIyMzksInN1YiI6IjVhMjAzYWU4LWE2ZjQtNDU3NS1iZTVlLWViNTEwMGQwNTBmZiIsInNjb3BlcyI6W119.nRWQK32tjeXDM66IhySAVlE_1qM3daehBu8P4_w24ruybfijt1ZcYibEfi-9w_evKVvHiMaP-1XljPEpfv7_goxATG8DOccoHQJqSol0Mbiqtvvqd8pN39RE3PQ-ynFpzdgv_0uFtzj89BDLnHUsp9Hd3iZ2hBMu2oF7pFLezoFOzpaoWG_fgmWCqpKgEvJvIr_pVlN61x6jUd2cKv52R7PGOJE9sWvhNwAHnvrVLFcjoRaeIxvPuBGaSABSUaEvzEcgtrpzWzp87Syic2QsW9WVn1b0HZvu1N41ToZjf3FBmI1dO5jw8a8CGBs1iFvsptSdiWw5f5feeuEXpqHD8nV8VxDFujc18LHXSv4HX6k0aaj6ZNuc5N32b54OiamLPlIuyfkOBSqsq0_CsBht4e9uL5EHa5qBSg5FKGurQO5M7BXZfPUzbcvMkauPFyma2eSqUCmcrrmOAdcYTyqmw_fMjao7hT6-91GtE04RcDstjMnZrNPCN3ezFNxKyvtTfcxAU-CxF50aCMh_x58r4nRSxsEaV_DRLZmcPiE8-CVvO5jphOYLi8PlNo7Cscjp2jWAJEArOne8TFB6KDrt0g-rELa3Kxb_o7O2MOL0EAXbfO5Y81fKDzShBlA3dOYCvA85MNkAkUonQYUkJla7BSZHywDwC1fY9NPz-_DaMD8 '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: email: - validation.required password: - validation.required code: - validation.required wrong_data: summary: Невірні дані value: code: 406 description: - Невірний логін або пароль. wrong_2fa: summary: Невірний код value: code: 406 description: 2fa: Невірний код авторизації. /api-docs/v1/logout: get: tags: - Auth summary: Видалити токен та закінчити сеанс. security: - bearerAuth: [] responses: '200': description: '' content: application/json: example: success: true '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/users/me/personal-access-tokens: post: tags: - User summary: Створити довгостроковий персональний маркер доступу (термін дії 2 роки). security: - bearerAuth: [] requestBody: description: '' content: application/json: schema: required: - name type: object properties: name: type: string maximum: 255 example: name: Маркер доступу для створення нового контрагента. required: true responses: '200': description: '' content: application/json: example: data: access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NDc4ZjA3ZC05YTQ4LTQ3ZDktOWZkMC05ZmM4YWU3NmI2NDIiLCJqdGkiOiIyODkxOTJlY2UxMGJlOGM5ZGJkZjIzYTFjNDM1NmE4MTk0MjJmMTEyZDI4YTFiY2E1ZGZiOTU2ZTY5NmYxYjc3ZGU3ZTgxMjZiZDljNTBhMyIsImlhdCI6MTY2MDEzMzE3Mi43ODQzNDUsIm5iZiI6MTY2MDEzMzE3Mi43ODQzNSwiZXhwIjoxNzIzMjkxNTcyLjczNjQ1MSwic3ViIjoiMWUxNmY0OWMtZGFkMS00NzhkLTljZjItNDgyZDM3YmM4ZWQyIiwic2NvcGVzIjpbXX0.JlU2xIiIc9xh_U9zUZVKxZOYsJ6CuFQWuhOS7gYcdY-z2CRHJGHIdCoQQvr19ULNdKOqKYYQVOy3ffiH7Kx30HmhjUJUKMlGeRF205NsMn2LRUB53u8tCaXGTKKMVJXQseO9p7fNjNH9C52BSGAtlg1eziJFSceRb-dnY-qUAWuaDUYFEQ-vQ2kGxCf2Z5pIM1CFzUIhay6qJOCxyNab5Qt29juSZG1riORR2KuMnHzJqRD6ETiHQ2MPe63nf5HNbUgkOQuG9zBawU3t3H3-uywn51llgOQOf5wIFCPBBaCR4oKpfmW_IgzEYcqrl-Cqcf4_1fapZ6DFs4xnpL81s7uXXzu8tnhvyfld0ALdDthDfcbwKBSApl81C6gy15ucTWYUwFqhZfPYwDNR_W9B4ENFLX0huNcTeVprQaj1fZd9Hi4MrwIK9Oa3f_7L0ThcvJgco4O1cuKJk3zkv__XKmPZnIkVUYmFNlosRWuHJwnniC0zwtcmnyhYOXa8UhDdoJA7ksPW5bat9onrTQpgpPpDc3DhK3BWJXos-Nqmm6KKPFhwtOoKzdf3AVZ52Zx_4GqnGQk3_heR-dYsFFwmXQubIeltWUmdjG4Ds2vC4owQE2MY2ccZmd8DFKqOJAsFuhpBdCJndcyhV21XwyKqfdKgs22ZxpJ2IfyF3MOqgXE token: id: 289192ece10be8c9dbdf23a1c4356a819422f112d28a1bca5dfb956e696f1b77de7e8126bd9c50a3 name: Маркер доступу для створення нового контрагента. scopes: [] created_at: 2022-08-01T15:06:12+03:00 expires_at: 2024-08-01T15:06:12+03:00 '401': description: '' content: application/json: example: message: Unauthenticated. '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required get: tags: - User summary: Отримати список персональних маркерів доступу. security: - bearerAuth: [] responses: '200': description: 'Список персональних маркерів доступу' content: application/json: schema: properties: data: type: array nullable: true example: - id: 289192ece10be8c9dbdf23a1c4356a819422f112d28a1bca5dfb956e696f1b77de7e8126bd9c50a3 name: Маркер доступу для створення нового контрагента. scopes: [] created_at: 2022-08-01T15:06:12+03:00 expires_at: 2024-08-01T15:06:12+03:00 - id: 5cf5fb9628e2fe98d0c03e34ea33088b37e4337f83d2c0969ac9eb31ef99af162a52e415425d1b56 name: AML.point Login. scopes: [] created_at: 2022-08-01T15:29:51+03:00 expires_at: 2022-08-01T16:29:51+03:00 '401': description: '' content: application/json: example: message: Unauthenticated. /api-docs/v1/users/me/personal-access-tokens/{id}: delete: tags: - User summary: Видалити маркер доступу. security: - bearerAuth: [] parameters: - name: id in: path description: ID маркера доступу required: true schema: type: string responses: '204': description: '' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found /api-docs/v1/forgot-password: post: tags: - User summary: Отримати на пошту інструкції для відновлення пароля. requestBody: description: '' content: application/json: schema: required: - email type: object properties: email: type: string format: email example: email: example@example.com required: true responses: '200': description: '' content: application/json: example: status: passwords.sent '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: email: - validation.required wrong_data: summary: Невірні дані value: code: 406 description: email: - The selected email is invalid. /api-docs/v1/reset-password: post: tags: - User summary: Встановлення нового паролю з отриманим для відновлення пароля токеном. requestBody: description: '' content: application/json: schema: required: - token - email - password - password_confirmation type: object properties: token: type: string email: type: string format: email password: type: string password_confirmation: type: string example: token: >- 4e4c21d8c19ea841b7aca0889982bca793656b89c9ce68270542ecda4975a401 email: example@example.com password: new_password password_confirmation: new_password required: true responses: '200': description: '' content: application/json: example: success: >- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NDc4ZjA3ZC05YTQ4LTQ3ZDktOWZkMC05ZmM4YWU3NmI2NDIiLCJqdGkiOiJiNmNlMDljNzlhZmY4ZjUyZTlhZWU4NzM3MWU4ZDgwMGM0N2Q3MGZjMTEyYWFhNzQ1OTJlZDRhY2U1NjM1NjdjODNlN2NiNzgzYmM2MjdhZSIsImlhdCI6MTY1MTE2NDY2OC43MTkxNTYsIm5iZiI6MTY1MTE2NDY2OC43MTkxNzgsImV4cCI6MTY1MTE2ODI2OC42MzIyMzksInN1YiI6IjVhMjAzYWU4LWE2ZjQtNDU3NS1iZTVlLWViNTEwMGQwNTBmZiIsInNjb3BlcyI6W119.nRWQK32tjeXDM66IhySAVlE_1qM3daehBu8P4_w24ruybfijt1ZcYibEfi-9w_evKVvHiMaP-1XljPEpfv7_goxATG8DOccoHQJqSol0Mbiqtvvqd8pN39RE3PQ-ynFpzdgv_0uFtzj89BDLnHUsp9Hd3iZ2hBMu2oF7pFLezoFOzpaoWG_fgmWCqpKgEvJvIr_pVlN61x6jUd2cKv52R7PGOJE9sWvhNwAHnvrVLFcjoRaeIxvPuBGaSABSUaEvzEcgtrpzWzp87Syic2QsW9WVn1b0HZvu1N41ToZjf3FBmI1dO5jw8a8CGBs1iFvsptSdiWw5f5feeuEXpqHD8nV8VxDFujc18LHXSv4HX6k0aaj6ZNuc5N32b54OiamLPlIuyfkOBSqsq0_CsBht4e9uL5EHa5qBSg5FKGurQO5M7BXZfPUzbcvMkauPFyma2eSqUCmcrrmOAdcYTyqmw_fMjao7hT6-91GtE04RcDstjMnZrNPCN3ezFNxKyvtTfcxAU-CxF50aCMh_x58r4nRSxsEaV_DRLZmcPiE8-CVvO5jphOYLi8PlNo7Cscjp2jWAJEArOne8TFB6KDrt0g-rELa3Kxb_o7O2MOL0EAXbfO5Y81fKDzShBlA3dOYCvA85MNkAkUonQYUkJla7BSZHywDwC1fY9NPz-_DaMD8 '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: token: - validation.required email: - validation.required password: - validation.required wrong_data: summary: Невірні дані value: code: 406 description: email: - The selected email is invalid. password: - validation.regex /api-docs/v1/reset-expired-password: post: tags: - User summary: Зміна простроченого паролю. requestBody: description: '' content: application/json: schema: required: - email - old_password - new_password - password_confirmation type: object properties: email: type: string format: email old_password: type: string new_password: type: string password_confirmation: type: string example: email: example@example.com old_password: old_password new_password: new_password new_password_confirmation: new_password required: true responses: '200': description: '' content: application/json: example: status: passwords.reset '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: email: - validation.required old_password: - validation.required new_password: - validation.required wrong_data: summary: Невірні дані value: code: 406 description: email: - The selected email is invalid. wrong_old_password: summary: Невірний пароль value: code: 406 errors: old_password: Невірний пароль. /api-docs/v1/register: post: tags: - User summary: Реєстрація нового клієнта. requestBody: description: '' content: application/json: schema: required: - usreou_code - phone - email - password type: object properties: usreou_code: type: string email: type: string format: email phone: type: string format: phone password: type: string example: usreou_code: '12345678' email: example@example.com phone: '+380440000000' password: password required: true responses: '200': description: '' content: application/json: example: success: >- eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NDc4ZjA3ZC05YTQ4LTQ3ZDktOWZkMC05ZmM4YWU3NmI2NDIiLCJqdGkiOiJiNmNlMDljNzlhZmY4ZjUyZTlhZWU4NzM3MWU4ZDgwMGM0N2Q3MGZjMTEyYWFhNzQ1OTJlZDRhY2U1NjM1NjdjODNlN2NiNzgzYmM2MjdhZSIsImlhdCI6MTY1MTE2NDY2OC43MTkxNTYsIm5iZiI6MTY1MTE2NDY2OC43MTkxNzgsImV4cCI6MTY1MTE2ODI2OC42MzIyMzksInN1YiI6IjVhMjAzYWU4LWE2ZjQtNDU3NS1iZTVlLWViNTEwMGQwNTBmZiIsInNjb3BlcyI6W119.nRWQK32tjeXDM66IhySAVlE_1qM3daehBu8P4_w24ruybfijt1ZcYibEfi-9w_evKVvHiMaP-1XljPEpfv7_goxATG8DOccoHQJqSol0Mbiqtvvqd8pN39RE3PQ-ynFpzdgv_0uFtzj89BDLnHUsp9Hd3iZ2hBMu2oF7pFLezoFOzpaoWG_fgmWCqpKgEvJvIr_pVlN61x6jUd2cKv52R7PGOJE9sWvhNwAHnvrVLFcjoRaeIxvPuBGaSABSUaEvzEcgtrpzWzp87Syic2QsW9WVn1b0HZvu1N41ToZjf3FBmI1dO5jw8a8CGBs1iFvsptSdiWw5f5feeuEXpqHD8nV8VxDFujc18LHXSv4HX6k0aaj6ZNuc5N32b54OiamLPlIuyfkOBSqsq0_CsBht4e9uL5EHa5qBSg5FKGurQO5M7BXZfPUzbcvMkauPFyma2eSqUCmcrrmOAdcYTyqmw_fMjao7hT6-91GtE04RcDstjMnZrNPCN3ezFNxKyvtTfcxAU-CxF50aCMh_x58r4nRSxsEaV_DRLZmcPiE8-CVvO5jphOYLi8PlNo7Cscjp2jWAJEArOne8TFB6KDrt0g-rELa3Kxb_o7O2MOL0EAXbfO5Y81fKDzShBlA3dOYCvA85MNkAkUonQYUkJla7BSZHywDwC1fY9NPz-_DaMD8 '406': description: '' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: usreou_code: - validation.required email: - validation.required phone: - validation.required password: - validation.required /api-docs/v1/users: get: tags: - User summary: Перелік користувачів. security: - bearerAuth: [] responses: '200': description: 'Масив користувачів' content: application/json: schema: properties: data: type: array nullable: true items: $ref: "#/components/schemas/User" example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 tenant: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' email: example@example.com phone: '+380440000000' role: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner permissions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create counterpart - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view counterpart financial_models: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 '401': description: '' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. deprecated: false post: tags: - User summary: Створити користувача. security: - bearerAuth: [] requestBody: description: '' content: application/json: schema: required: - email - role_id type: object properties: email: type: string format: email phone: type: string format: phone role_id: type: string format: uuid financial_models: type: array items: type: string format: uuid example: email: example@example.com phone: '+380440000000' role_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 financial_models: - 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '201': description: 'Успішно створено користувача' content: application/json: schema: properties: data: $ref: "#/components/schemas/User" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 tenant: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' email: example@example.com phone: '+380440000000' role: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner permissions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create counterpart - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view counterpart financial_models: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '406': description: 'Не вистачає даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: email: - validation.required role_id: - validation.required already_exists: summary: Вже є користувач з такою поштою value: code: 406 description: email: - "Цей email вже використовується." deprecated: false /api-docs/v1/users/me: get: tags: - User summary: Переглянути себе як користувача. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: $ref: "#/components/schemas/User" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 tenant: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' email: example@example.com phone: '+380440000000' role: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner permissions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create counterpart - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view counterpart financial_models: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/users/financial-models: get: tags: - User summary: Переглянути свої (користувача) профілі СПФМ. security: - bearerAuth: [] responses: '200': description: 'Масив профілей СПФМ' content: application/json: schema: properties: data: type: array nullable: true items: $ref: "#/components/schemas/FinancialModel" example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 is_active: true usreou_code: "12345678" license: №123 phone_support: '+380440000000' email_support: example@example.com site: example.com iban: "UA012345000000000000001234567" mfo: "123456" bank: "ПАТ Перший БАНК" account_owner: ПАТ "Перша модель" description: "Перша модель" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/users/{id}: get: tags: - User summary: Переглянути користувача. security: - bearerAuth: [] parameters: - name: id in: path description: ID користувача required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: properties: data: $ref: "#/components/schemas/User" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 tenant: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' email: example@example.com phone: '+380440000000' role: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner permissions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create counterpart - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view counterpart financial_models: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false put: tags: - User summary: Оновити користувача. security: - bearerAuth: [] parameters: - name: id in: path description: ID користувача required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - email - role_id type: object properties: email: type: string format: email phone: type: string format: phone role_id: type: string format: uuid financial_models: type: array items: type: string format: uuid example: email: example@example.com phone: '+380440000000' role_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 financial_models: - 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '200': description: 'Успішно оновлено користувача' content: application/json: schema: properties: data: $ref: "#/components/schemas/User" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 tenant: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' email: example@example.com phone: '+380440000000' role: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner permissions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create counterpart - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view counterpart financial_models: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не вистачає даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: email: - validation.required role_id: - validation.required deprecated: false delete: tags: - User summary: Видалити користувача. security: - bearerAuth: [] parameters: - name: id in: path description: ID користувача required: true schema: type: string format: uuid responses: '204': description: 'Успішно видалено користувача' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/financial-models: get: tags: - Financial Models summary: Перелік профілей СПФМ. security: - bearerAuth: [] responses: '200': description: 'Масив профілей СПФМ' content: application/json: schema: properties: data: type: array nullable: true items: $ref: "#/components/schemas/FinancialModel" example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" short_name: "Перша модель" alias: financialModel1 usreou_code: "12345678" phone_support: '+380440000000' email_support: example@example.com site: example.com head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code: id: "2b06d815-0853-4698-9d76-55148acf7b16" type: "financial-model-codes" name: "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент" value: "102" risk: null accounts: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 iban: UA012345000000000000001234567 bank: ПАТ Перший БАНК bank_code: 123456 stamps: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 user_added_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 created_at: 2022-12-21T11:18:51+0000 h020: [] licenses: [] '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. deprecated: false post: tags: - Financial Models summary: Створити профіль СПФМ. security: - bearerAuth: [] requestBody: description: '' content: application/json: schema: required: - name - usreou_code - iban - bank properties: name: type: string maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' license: type: string maximum: 255 nullable: true phone_support: type: string format: phone nullable: true email_support: type: string format: phone nullable: true site: type: string format: uri nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' bank: type: string maximum: 255 head_last_name: type: string maximum: 255 nullable: true head_first_name: type: string maximum: 255 nullable: true head_middle_name: type: string maximum: 255 nullable: true head_date: type: string nullable: true head_number: type: string maximum: 255 nullable: true head_position: type: string maximum: 255 nullable: true responsible_last_name: type: string maximum: 255 nullable: true responsible_first_name: type: string maximum: 255 nullable: true responsible_middle_name: type: string maximum: 255 nullable: true responsible_date: type: string nullable: true responsible_number: type: string maximum: 255 nullable: true responsible_position: type: string maximum: 255 nullable: true deputy_responsible_last_name: type: string maximum: 255 nullable: true deputy_responsible_first_name: type: string maximum: 255 nullable: true deputy_responsible_middle_name: type: string maximum: 255 nullable: true deputy_responsible_date: type: string nullable: true deputy_responsible_number: type: string maximum: 255 nullable: true deputy_responsible_position: type: string maximum: 255 nullable: true code_id: type: string nullable: true example: name: ПАТ "Перша модель" usreou_code: "12345678" license: №123 phone_support: '+380440000000' email_support: example@example.com site: example.com iban: "UA012345000000000000001234567" bank: "ПАТ Перший БАНК" head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code_id: "2b06d815-0853-4698-9d76-55148acf7b16" required: true responses: '201': description: 'Успішно створено профіль СПФМ' content: application/json: schema: properties: data: $ref: "#/components/schemas/FinancialModel" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" short_name: "Перша модель" alias: financialModel1 usreou_code: "12345678" phone_support: '+380440000000' email_support: example@example.com site: example.com iban: "UA012345000000000000001234567" bank: "ПАТ Перший БАНК" head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code: id: "2b06d815-0853-4698-9d76-55148acf7b16" type: "financial-model-codes" name: "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент" value: "102" risk: null accounts: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 iban: UA012345000000000000001234567 bank: ПАТ Перший БАНК bank_code: 123456 h020: [] licenses: [] stamps: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 user_added_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 created_at: 2022-12-21T11:18:51+0000 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '406': description: 'Не вистачає даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required usreou_code: - validation.required iban: - validation.required bank: - validation.required already_exists: summary: Вже є профіль СПФМ з таким кодом ЄДРПОУ value: code: 406 description: usreou_code: - "Цей usreou code вже використовується." deprecated: false /api-docs/v1/financial-models/{id}: get: tags: - Financial Models summary: Переглянути профіль СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: properties: data: $ref: "#/components/schemas/FinancialModel" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" short_name: "Перша модель" alias: financialModel1 usreou_code: "12345678" license: №123 phone_support: '+380440000000' email_support: example@example.com site: example.com iban: "UA012345000000000000001234567" bank: "ПАТ Перший БАНК" head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code: id: "2b06d815-0853-4698-9d76-55148acf7b16" type: "financial-model-codes" name: "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент" value: "102" risk: null accounts: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 iban: UA012345000000000000001234567 bank: ПАТ Перший БАНК bank_code: 123456 stamps: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 user_added_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 created_at: 2022-12-21T11:18:51+0000 h020: - id: 37488ab3-957d-4e21-a75c-98fc195987c7 name: Залучення фінансових активів із зобов’язанням щодо наступного їх повернення value: 04 licenses: - id: 37488ab3-957d-4e21-a75c-98fc195987c7 name: Ліцензія №1 від 01.01.2022 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false put: tags: - Financial Models summary: Оновити профіль СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - name properties: name: type: string maximum: 255 phone_support: type: string format: phone nullable: true email_support: type: string format: phone nullable: true site: type: string format: uri nullable: true head_last_name: type: string maximum: 255 nullable: true head_first_name: type: string maximum: 255 nullable: true head_middle_name: type: string maximum: 255 nullable: true head_date: type: string nullable: true head_number: type: string maximum: 255 nullable: true head_position: type: string maximum: 255 nullable: true responsible_last_name: type: string maximum: 255 nullable: true responsible_first_name: type: string maximum: 255 nullable: true responsible_middle_name: type: string maximum: 255 nullable: true responsible_date: type: string nullable: true responsible_number: type: string maximum: 255 nullable: true responsible_position: type: string maximum: 255 nullable: true deputy_responsible_last_name: type: string maximum: 255 nullable: true deputy_responsible_first_name: type: string maximum: 255 nullable: true deputy_responsible_middle_name: type: string maximum: 255 nullable: true deputy_responsible_date: type: string nullable: true deputy_responsible_number: type: string maximum: 255 nullable: true deputy_responsible_position: type: string maximum: 255 nullable: true code_id: type: string nullable: true h020: type: array format: uuid nullable: true example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" short_name: "Перша модель" alias: financialModel1 phone_support: '+380440000000' email_support: example@example.com site: example.com head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code_id: "2b06d815-0853-4698-9d76-55148acf7b16" h020: ["2b06d815-0853-4698-9d76-55148acf7b16", "2b06d815-0853-4698-9d76-55148acf7b15"] required: true responses: '200': description: 'Успішно оновлено профіль СПФМ' content: application/json: schema: properties: data: $ref: "#/components/schemas/FinancialModel" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" short_name: "Перша модель" alias: financialModel1 usreou_code: "12345678" license: №123 phone_support: '+380440000000' email_support: example@example.com site: example.com iban: "UA012345000000000000001234567" bank: "ПАТ Перший БАНК" head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code: id: "2b06d815-0853-4698-9d76-55148acf7b16" type: "financial-model-codes" name: "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент" value: "102" risk: null accounts: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 iban: UA012345000000000000001234567 bank: ПАТ Перший БАНК bank_code: 123456 stamps: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 user_added_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 created_at: 2022-12-21T11:18:51+0000 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не вистачає даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required iban: - validation.required bank: - validation.required usreou_code: - validation.required deprecated: false delete: tags: - Financial Models summary: Видалити профіль СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid responses: '204': description: 'Успішно видалено профіль СПФМ' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '424': description: 'Запит викликав помилку' content: application/json: example: message: Неможливо видалити СПФМ, є активні договори deprecated: false /api-docs/v1/financial-models/{id}/account: post: tags: - Financial Models summary: Додавання рахунку у профіль СПФМ security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - iban properties: iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' bank: type: string maximum: 255 nullable: true bank_code: type: string pattern: '^\d{6}$' nullable: true example: iban: UA012345000000000000001234567 bank: null bank_code: null required: true responses: '200': description: 'Успішно додано рахунок у профіль СПФМ' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/FinancialModel" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не пройдено валiдацiю value: code: 406 description: iban: - validation.required not_unique_data: summary: Рахунок вже використовується. value: code: 406 description: iban: - validation.unique /api-docs/v1/financial-models/account/{id}: put: tags: - Financial Models summary: Оновити дані рахунку профіля СПФМ security: - bearerAuth: [] parameters: - name: id in: path description: ID рахунку required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: bank: type: string maximum: 255 nullable: true bank_code: type: string pattern: '^\d{6}$' nullable: true example: bank: 'ПАТ Банк' bank_code: '123456' required: true responses: '200': description: 'Успішно оновлено рахунок профілю СПФМ' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/FinancialModel" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не пройдено валiдацiю value: code: 406 description: bank_code: - validation.max delete: tags: - Financial Models summary: Видалити рахунок у профілю СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID рахунку у профілю СПФМ required: true schema: type: string format: uui responses: '200': description: 'Успішно видалено' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. last_account: summary: Видалення заборонено value: code: 403 description: Видалення заборонено. Профіль СПФМ повинен мати хоча б 1 рахунок '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/financial-models/{id}/license: post: tags: - Financial Models summary: Додавання ліцензії у профіль СПФМ security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - name properties: name: type: string maximum: 255 example: name: Ліцензія №1 від 01.01.2022 required: true responses: '200': description: 'Успішно додано ліцензію у профіль СПФМ' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/FinancialModel" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не пройдено валiдацiю value: code: 406 description: name: - validation.required not_unique_data: summary: Ліцензія вже використовується. value: code: 406 description: name: - validation.unique /api-docs/v1/financial-models/license/{id}: put: tags: - Financial Models summary: Оновити дані ліцензії профіля СПФМ security: - bearerAuth: [] parameters: - name: id in: path description: ID ліцензії required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: name: type: string maximum: 255 example: name: 'Ліцензія №1 від 01.01.2022' required: true responses: '200': description: 'Успішно оновлено ліцензію профілю СПФМ' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/FinancialModel" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не пройдено валiдацiю value: code: 406 description: name: - validation.max delete: tags: - Financial Models summary: Видалити ліцензію у профілі СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID ліцензії у профілі СПФМ required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/financial-models/{id}/stamps: get: tags: - Financial Models summary: Отримати перелік печаток профілю СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: properties: data: type: array nullable: true items: $ref: "#/components/schemas/FinancialModelStampData" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false post: tags: - Financial Models summary: Завантажити файл печатки профілю СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID профілю СПФМ required: true schema: type: string format: uuid requestBody: description: '' content: multipart/form-data: schema: type: object properties: stamp: type: string format: binary required: true responses: '200': description: 'Успішно завантажено файл' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/FinancialModel" '400': description: 'Не має файлів для завантаження' content: application/json: example: No image to upload. '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: Виникла помилка при додаванні печатки. Зображення має бути формату .jpg або .jpeg, бути не більше 300 Кб, ширина від 300 до 2000 пікселів та висота від 200 до 1000 пікселів. content: application/json: examples: no_data: summary: 'Не пройдено валiдацiю' value: code: 406 description: stamp: - validation.max /api-docs/v1/stamps/{id}: get: tags: - Financial Models summary: Отримати файл печатки профілю СПФМ. security: - bearerAuth: [] parameters: - name: id in: path description: ID печатки required: true schema: type: string format: uuid responses: '200': description: '' content: image/jpeg: schema: type: string format: binary example: stamp.jpeg '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/contracts: post: tags: - Contracts summary: Створити контракт. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: oneOf: - $ref: "#/components/schemas/ContractPropertyInsurance" - $ref: "#/components/schemas/ContractReinsurance" - $ref: "#/components/schemas/ContractLiabilityInsurance" - $ref: "#/components/schemas/ContractLifeInsurance" - $ref: "#/components/schemas/ContractMedicalInsurance" - $ref: "#/components/schemas/ContractOfOSCPVV" - $ref: "#/components/schemas/ContractFinancialLeasing" - $ref: "#/components/schemas/ContractOperatingLease" - $ref: "#/components/schemas/ContractOnCooperation" - $ref: "#/components/schemas/ContractWithThePaymentSystem" - $ref: "#/components/schemas/ContractFundTransferPaymentAndReceipt" - $ref: "#/components/schemas/ContractFundTransferPayment" - $ref: "#/components/schemas/ContractOnTransferOfFundsReception" required: true responses: '201': description: 'Успішно створено контракт' content: application/json: schema: $ref: "#/components/schemas/OldContract" example: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractNumber: '12345' counterpart_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractType: type2 status: 0 CEO: Тарас Тарасович Тарасенко internalFeeRate: 1 internalFeeRateComment: null externalFeeRate: 0 externalFeeRateComment: null payoutPeriod: null payoutAuto: false f108: 0 f108Note: null payoutf108: 33 payoutf108Note: null issuedDate: '2022-07-13' created_at: '2022-07-13T11:31:32+03:00' updated_at: '2022-07-13T11:33:27+03:00' paymentMethod: - epz - sdbo - registerPayment - other alias: - id: '1234' - id: '23455' bank: first1 last_name: Last Name first_name: First Name middle_name: Middle Name counterpart: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 counterpartType: individual-entrepreneur legalForm: '910' fullName: Тарас Тарасович Тарасенко typeOfOwnership: null phone: '+380440000000' email: example@example.com birthDay: '2020-08-05' state: 1 created: '2020-04-29T14:13:31+03:00' updated: '2021-02-22T15:45:26+02:00' billing: edrpou: '3312312555' mfo: '123456' bank: MyOwnCreditBank settlementAccount: UA999999999999999999999999999 stateRegistration: date: '2222-02-21T22:00:00.000000Z' number: '0000000000000000001' location: postalCode: '12367' city: Kyiv address: some_address doc: citizenship: Укр type: passport number: НЕ 9493 issuedDate: '2020-07-31' issuedBy: Some state organ photoDate: '2020-08-08' eddr: 00000000-00000 activityEvaluation: [] stateEvaluation: [] executiveDepth: null relationToPublicPersons: false publicity_date: null publicity_type: null clientIncludedList: false hasSeparateUnit: false hasParentCompany: false clientCharityNonprofit: false publicRelationDescription: null clientIncludedListDesc: null clientCharityNonprofitDesc: null riskLimitation: null clientRepresentative: [] propertyParticipant: [] ownershipStructure: [] beneficiary: [] separateUnit: [] parentCompany: [] activityContent: null site: null relationshipType: null staffNum: 0 inDepthExamination: null financialState: taxSystem: null maxPermisVolume: 0 netProfit: 0 revenue: 0 authorisedCapital: registered: '0' paid: '0' activityType: [] licences: [] crimeRiskLevel: [] identificationStatus: 0 identificationDate: null establishingBusinessRelationsDate: null videoVerificationDate: null videoVerificationMethod: null stoppingBusinessRelationsDate: null stoppingBusinessRelations: null ending_relations_date: null assetFreezeDate: null assetUnfreezeDate: null clarificationDate: null responsiblePerson: null clarificationTask: null clarificationTaskStartDate: null clarificationTaskEndDate: null birthplace: null work: null temporary_stay: null client_services: null country: null registration_authority: null registration_certificate: null contract: [] '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Помилка даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: financial_model_id: - validation.required issued_date: - validation.required not_unique: summary: Контракт з таким номером вже існує value: code: 406 description: Вже існує договір з номером 123 /api-docs/v1/contracts: get: tags: - Contracts summary: Перелік контрактів. security: - bearerAuth: [] parameters: - name: page in: query description: Cторінка запиту schema: type: integer example: 1 - name: count in: query description: Кількість запитів на сторінці schema: type: integer example: 20 - name: "filter[issuedDate@gte]" in: query description: Фільтрація за датою укладання договору більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[issuedDate@lte]" in: query description: Фільтрація за датою укладання договору менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[type@where]" description: Фільтрація за значенням типу договору за довідником in: query schema: type: string example: type1 - name: "filter[type@whereIn]" description: Фільтрація за значеннями типу договору за довідником in: query schema: type: string example: '&filter[type@whereIn][0]=type1&filter[type@whereIn][1]=type2' - name: "filter[id@where]" description: Фільтрація за ID контракту in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[number@where]" description: Фільтрація за номером договору in: query schema: type: string example: 123 - name: "filter[counterpartId@where]" description: Фільтрація за ID контрагента in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[status@where]" description: Фільтрація за значенням статусу контракту за довідником in: query schema: type: integer example: 0 - name: "filter[financialModel@where]" description: Фільтрація за аліасом профілю СПФМ in: query schema: type: string example: first1 - name: "filter[financialModel@whereIn]" description: Фільтрація за аліасами профілей СПФМ in: query schema: type: string example: '&filter[financialModel@whereIn][0]=first1&filter[financialModel@whereIn][1]=first2' - name: "filter[alias@where]" description: Фільтрація за аліасом in: query schema: type: string example: some_alias - name: "filter[destinationCode@where]" description: Фільтрація за значенням Коду призначення платежу/виплати за довідником in: query schema: type: string example: 31 - name: "filter[paymentDestinationCodeId@where]" description: Фільтрація за Id кодом призначення платежу (F108) in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[payoutDestinationCodeId@where]" description: Фільтрація за Id кодом призначення виплати (F108) in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 responses: '200': description: 'Масив контрактів' content: application/json: schema: properties: data: type: array nullable: true items: $ref: "#/components/schemas/OldContract" links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' example: data: - _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractNumber: '12345' counterpart_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractType: type2 status: 0 CEO: Тарас Тарасович Тарасенко internalFeeRate: 1 internalFeeRateComment: null externalFeeRate: 0 externalFeeRateComment: null payoutPeriod: null payoutAuto: false f108: 0 f108Note: null payoutf108: 33 payoutf108Note: null issuedDate: '2022-07-13' created_at: '2022-07-13T11:31:32+03:00' updated_at: '2022-07-13T11:33:27+03:00' paymentMethod: - epz - sdbo - registerPayment - other alias: - id: '1234' - id: '23455' bank: first1 last_name: Last Name first_name: First Name middle_name: Middle Name counterpart: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 counterpartType: individual-entrepreneur legalForm: '910' fullName: Тарас Тарасович Тарасенко typeOfOwnership: null phone: '+380440000000' email: example@example.com birthDay: '2020-08-05' state: 1 created: '2020-04-29T14:13:31+03:00' updated: '2021-02-22T15:45:26+02:00' billing: edrpou: '3312312555' mfo: '123456' bank: MyOwnCreditBank settlementAccount: UA999999999999999999999999999 stateRegistration: date: '2222-02-21T22:00:00.000000Z' number: '0000000000000000001' location: postalCode: '12367' city: Kyiv address: some_address doc: citizenship: Укр type: passport number: НЕ 9493 issuedDate: '2020-07-31' issuedBy: Some state organ photoDate: '2020-08-08' eddr: 00000000-00000 activityEvaluation: [] stateEvaluation: [] executiveDepth: null relationToPublicPersons: false publicity_date: null publicity_type: null clientIncludedList: false hasSeparateUnit: false hasParentCompany: false clientCharityNonprofit: false publicRelationDescription: null clientIncludedListDesc: null clientCharityNonprofitDesc: null riskLimitation: null clientRepresentative: [] propertyParticipant: [] ownershipStructure: [] beneficiary: [] separateUnit: [] parentCompany: [] activityContent: null site: null relationshipType: null staffNum: 0 inDepthExamination: null financialState: taxSystem: null maxPermisVolume: 0 netProfit: 0 revenue: 0 authorisedCapital: registered: '0' paid: '0' activityType: [] licences: [] crimeRiskLevel: [] identificationStatus: 0 identificationDate: null establishingBusinessRelationsDate: null videoVerificationDate: null videoVerificationMethod: null stoppingBusinessRelationsDate: null stoppingBusinessRelations: null ending_relations_date: null assetFreezeDate: null assetUnfreezeDate: null clarificationDate: null responsiblePerson: null clarificationTask: null clarificationTaskStartDate: null clarificationTaskEndDate: null birthplace: null work: null temporary_stay: null client_services: null country: null registration_authority: null registration_certificate: null contract: [] links: first: https://amlpoint.com.ua/api-docs/v1/contracts?page=1 last: https://amlpoint.com.ua/api-docs/v1/contracts?page=38 prev: null next: https://amlpoint.com.ua/api-docs/v1/contracts?page=2 meta: current_page: 1 from: 1 last_page: 38 links: - url: null label: pagination.previous active: false - url: http://127.0.0.1/api/v1/contracts?page=1 label: '1' active: true - url: http://127.0.0.1/api/v1/contracts?page=2 label: '2' active: false - url: http://127.0.0.1/api/v1/contracts?page=2 label: pagination.next active: false path: http://127.0.0.1/api/v1/contracts per_page: 20 to: 20 total: 38 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. deprecated: false /api-docs/v1/contracts/{id}: get: tags: - Contracts summary: Переглянути картку контракту. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: properties: data: $ref: "#/components/schemas/Contract" example: data: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 number: 12345 issued_date: '2022-07-18' ceo: Тарасов Ігор Павлович internal_fee: 2.4 internal_fee_comment: виплати 1% external_fee: 0 external_fee_comment: null auto_payout: true payment_destination_note: null payout_destination_note: null last_name: Last Name first_name: First Name middle_name: Middle Name counterpart: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: 'КОМПАНІЯ "Перша"' usreou_code: '12345678' itn_code: null bank: АТ "Банк" iban: UA012345000000000000001234567 payment_destination_code: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет value: '33' payout_destination_code: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Виплата виграшів гравцям азартних ігор казино в мережі Інтернет value: '45' payout_period: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: По понеділкам value: byMonday state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Діючий value: '0' type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Договір про переказ коштів (прийом+виплата) value: type3 payment_directions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Some12345 financial_model: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТОВ "Перша" alias: first1 payment_methods: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ЕПЗ value: epz - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СДБО value: sdbo - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Реєстрові платежі (Безнал + Реестр) value: registerPayment '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false put: tags: - Contracts summary: Оновити контракт. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - issued_date - internal_fee - external_fee properties: issued_date: type: string format: date-time internal_fee: type: number format: float internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_methods: description: Платіжні методи з довiдника (ids) type: array items: type: string format: uuid last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-06-13' ceo: Some name internal_fee: 1.0 internal_fee_comment: null external_fee: 0 external_fee_comment: null auto_payout: false payment_destination_note: null payout_destination_note: null state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_period_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_methods: - 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name required: true responses: '200': description: 'Успішно оновлено контракт' content: application/json: schema: $ref: "#/components/schemas/OldContract" example: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractNumber: '12345' counterpart_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractType: type2 status: 0 CEO: Тарас Тарасович Тарасенко internalFeeRate: 1 internalFeeRateComment: null externalFeeRate: 0 externalFeeRateComment: null payoutPeriod: null payoutAuto: false f108: 0 f108Note: null payoutf108: 33 payoutf108Note: null issuedDate: '2022-07-13' created_at: '2022-07-13T11:31:32+03:00' updated_at: '2022-07-13T11:33:27+03:00' paymentMethod: - epz - sdbo - registerPayment - other alias: - id: '1234' - id: '23455' bank: first1 last_name: Тарасенко first_name: Тарас middle_name: Тарасович counterpart: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 counterpartType: individual-entrepreneur legalForm: '910' fullName: Тарас Тарасович Тарасенко typeOfOwnership: null phone: '+380440000000' email: example@example.com birthDay: '2020-08-05' state: 1 created: '2020-04-29T14:13:31+03:00' updated: '2021-02-22T15:45:26+02:00' billing: edrpou: '3312312555' mfo: '123456' bank: MyOwnCreditBank settlementAccount: UA999999999999999999999999999 stateRegistration: date: '2222-02-21T22:00:00.000000Z' number: '0000000000000000001' location: postalCode: '12367' city: Kyiv address: some_address doc: citizenship: Укр type: passport number: НЕ 9493 issuedDate: '2020-07-31' issuedBy: Some state organ photoDate: '2020-08-08' eddr: 00000000-00000 activityEvaluation: [] stateEvaluation: [] executiveDepth: null relationToPublicPersons: false publicity_date: null publicity_type: null clientIncludedList: false hasSeparateUnit: false hasParentCompany: false clientCharityNonprofit: false publicRelationDescription: null clientIncludedListDesc: null clientCharityNonprofitDesc: null riskLimitation: null clientRepresentative: [] propertyParticipant: [] ownershipStructure: [] beneficiary: [] separateUnit: [] parentCompany: [] activityContent: null site: null relationshipType: null staffNum: 0 inDepthExamination: null financialState: taxSystem: null maxPermisVolume: 0 netProfit: 0 revenue: 0 authorisedCapital: registered: '0' paid: '0' activityType: [] licences: [] crimeRiskLevel: [] identificationStatus: 0 identificationDate: null establishingBusinessRelationsDate: null videoVerificationDate: null videoVerificationMethod: null stoppingBusinessRelationsDate: null stoppingBusinessRelations: null ending_relations_date: null assetFreezeDate: null assetUnfreezeDate: null clarificationDate: null responsiblePerson: null clarificationTask: null clarificationTaskStartDate: null clarificationTaskEndDate: null birthplace: null work: null temporary_stay: null client_services: null country: null registration_authority: null registration_certificate: null contract: [] '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не вистачає даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: internal_fee: - validation.required external_fee: - validation.required delete: tags: - Contracts summary: Видалити контракт. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту required: true schema: type: string format: uuid responses: '204': description: 'Успішно видалено контракт' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/contracts/{id}/restore: post: tags: - Contracts summary: Відновити контракт. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту required: true schema: type: string format: uuid responses: '200': description: 'Успішно відновлено контракт' content: application/json: example: auto_payout: false ceo: null deleted_at: null external_fee: null external_fee_comment: null first_name: null id: "542de4ac-e730-4a5d-85d5-75c5452f67a6" internal_fee: null internal_fee_comment: null issued_date: "2022-09-20" last_name: null middle_name: null number: "111111111" payment_destination_note: null payout_destination_note: null '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/contracts/{id}/payment-directions: post: tags: - Contracts summary: Додати або видалити платіжний напрямок операцій по контракту. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: type: array nullable: true items: type: string example: ['1234','5678'] required: true responses: '200': description: 'Успішно оновлено контракт' content: application/json: schema: $ref: "#/components/schemas/OldContract" example: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractNumber: '12345' counterpart_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractType: type2 status: 0 CEO: Тарас Тарасович Тарасенко internalFeeRate: 1 internalFeeRateComment: null externalFeeRate: 0 externalFeeRateComment: null payoutPeriod: null payoutAuto: false f108: 0 f108Note: null payoutf108: 33 payoutf108Note: null issuedDate: '2022-07-13' created_at: '2022-07-13T11:31:32+03:00' updated_at: '2022-07-13T11:33:27+03:00' paymentMethod: - epz - sdbo - registerPayment - other alias: - id: '1234' - id: '23455' bank: first1 last_name: Тарасенко first_name: Тарас middle_name: Тарасович counterpart: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 counterpartType: individual-entrepreneur legalForm: '910' fullName: Тарас Тарасович Тарасенко typeOfOwnership: null phone: '+380440000000' email: example@example.com birthDay: '2020-08-05' state: 1 created: '2020-04-29T14:13:31+03:00' updated: '2021-02-22T15:45:26+02:00' billing: edrpou: '3312312555' mfo: '123456' bank: MyOwnCreditBank settlementAccount: UA999999999999999999999999999 stateRegistration: date: '2222-02-21T22:00:00.000000Z' number: '0000000000000000001' location: postalCode: '12367' city: Kyiv address: some_address doc: citizenship: Укр type: passport number: НЕ 9493 issuedDate: '2020-07-31' issuedBy: Some state organ photoDate: '2020-08-08' eddr: 00000000-00000 activityEvaluation: [] stateEvaluation: [] executiveDepth: null relationToPublicPersons: false publicity_date: null publicity_type: null clientIncludedList: false hasSeparateUnit: false hasParentCompany: false clientCharityNonprofit: false publicRelationDescription: null clientIncludedListDesc: null clientCharityNonprofitDesc: null riskLimitation: null clientRepresentative: [] propertyParticipant: [] ownershipStructure: [] beneficiary: [] separateUnit: [] parentCompany: [] activityContent: null site: null relationshipType: null staffNum: 0 inDepthExamination: null financialState: taxSystem: null maxPermisVolume: 0 netProfit: 0 revenue: 0 authorisedCapital: registered: '0' paid: '0' activityType: [] licences: [] crimeRiskLevel: [] identificationStatus: 0 identificationDate: null establishingBusinessRelationsDate: null videoVerificationDate: null videoVerificationMethod: null stoppingBusinessRelationsDate: null stoppingBusinessRelations: null ending_relations_date: null assetFreezeDate: null assetUnfreezeDate: null clarificationDate: null responsiblePerson: null clarificationTask: null clarificationTaskStartDate: null clarificationTaskEndDate: null birthplace: null work: null temporary_stay: null client_services: null country: null registration_authority: null registration_certificate: null contract: [] '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Платіжний напрямок вже використовується' content: application/json: examples: no_data: summary: 'Платіжний напрямок вже використовується' value: code: 406 description: Помилка, цей id 1234 вже використовується договором:0ca00000-a000-000e-0d0f-0d0d00bab000 /api-docs/v1/contracts/counterparts: get: tags: - Counterparts summary: Перелік контрагентів із скороченими даними. security: - bearerAuth: [] responses: '200': description: 'Масив контрагентів' content: application/json: schema: properties: data: type: array nullable: true items: $ref: "#/components/schemas/ShortCounterpart" example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: '"Контрагент.ЮА"' last_name: null first_name: null middle_name: null usreou_code: '12345678' itn_code: null non_resident_code: null '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/contracts/export: get: tags: - Contracts summary: Замовити перелік контрактів на пошту. security: - bearerAuth: [] parameters: - name: "filter[issuedDate@gte]" in: query description: Фільтрація за датою укладання договору більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[issuedDate@lte]" in: query description: Фільтрація за датою укладання договору менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[type@where]" description: Фільтрація за значенням типу договору за довідником in: query schema: type: string example: type1 - name: "filter[type@whereIn]" description: Фільтрація за значеннями типу договору за довідником in: query schema: type: string example: '&filter[type@whereIn][0]=type1&filter[type@whereIn][1]=type2' - name: "filter[id@where]" description: Фільтрація за ID контракту in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[number@where]" description: Фільтрація за номером договору in: query schema: type: string example: 123 - name: "filter[counterpartId@where]" description: Фільтрація за ID контрагента in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[status@where]" description: Фільтрація за значенням статусу контракту за довідником in: query schema: type: integer example: 0 - name: "filter[financialModel@where]" description: Фільтрація за аліасом профілю СПФМ in: query schema: type: string example: first1 - name: "filter[financialModel@whereIn]" description: Фільтрація за аліасами профілей СПФМ in: query schema: type: string example: '&filter[financialModel@whereIn][0]=first1&filter[financialModel@whereIn][1]=first2' - name: "filter[alias@where]" description: Фільтрація за аліасом in: query schema: type: string example: some_alias - name: "filter[paymentDestinationCodeId@where]" description: Фільтрація за Id кодом призначення платежу (F108) in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[payoutDestinationCodeId@where]" description: Фільтрація за Id кодом призначення виплати (F108) in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 responses: '200': description: 'Вислано перелік контрактів на пошту' content: application/json: schema: properties: success: type: string example: success: Export contracts job was created and file will be delivered via email. '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. deprecated: false /api-docs/v1/counterparts: get: tags: - Counterparts summary: Перелік контрагентів. security: - bearerAuth: [] parameters: - name: page in: query description: Cторінка запиту schema: type: integer example: 1 - name: count in: query description: Кількість запитів на сторінці schema: type: integer example: 20 - name: "filter[id@where]" description: Фільтрація за ID контрагенту in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[id@whereIn]" description: Фільтрація за IDs контрагентів, лише перераховані in: query schema: type: string example: '&filter[id@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[id@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[id@whereNotIn]" description: Фільтрація за IDs контрагентів, крім перерахованих in: query schema: type: string example: '&filter[id@whereNotIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[id@whereNotIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[type@whereIn]" description: Фільтрація за id типів контрагентів за довідником in: query schema: type: string example: '&filter[type@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[type@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[state@whereIn]" description: Фільтрація за id статусу контрагента за довідником in: query schema: type: string example: '&filter[state@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[state@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[usreou@where]" description: Фільтрація контрагента за ЄДРПОУ/РНОКПП/Кодом нерезидента in: query schema: type: string maximum: 255 example: 12345678 - name: "filter[fullName@like]" description: Фільтрація контрагентів по назві in: query schema: type: string maximum: 255 example: товариство - name: "filter[created@gte]" in: query description: Фільтрація за датою створення контрагента більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[created@lte]" in: query description: Фільтрація за датою створення контрагента менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[crimeRiskLevel@where]" description: Фільтрація за значенням рівня ризику з довідника in: query schema: type: string example: low - name: "filter[identificationStatus@where]" description: Фільтрація за значенням статусу ідентифікації з довідника in: query schema: type: string example: 0 - name: "filter[identificationStatus@whereIn]" description: Фільтрація за id статусів ідентифікації з довідника in: query schema: type: string example: '&filter[identificationStatus@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[identificationStatus@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[identificationDate@gte]" in: query description: Фільтрація за датою ідентифікації контрагента більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[identificationDate@lte]" in: query description: Фільтрація за датою ідентифікації контрагента менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[legalForm@where]" description: Фільтрація за значенням організаційно-правової форми з довідника in: query schema: type: string example: 230 - name: "filter[contractType@where]" description: Фільтрація за значенням типу договору з довідника in: query schema: type: string example: type1 - name: "filter[financialModels@whereIn]" description: Фільтрація за id профілю СПФМ in: query schema: type: string example: '&filter[financialModels@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[financialModels@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[isPublic@where]" description: Фільтрація за належністю до публічних осіб, до осіб, близьких або пов'язаних з публічними особами in: query schema: type: boolean example: true - name: "filter[crimeRiskLevel@whereIn]" description: Фільтрація за id рівнів ризику з довідника in: query schema: type: string example: '&filter[crimeRiskLevel@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[crimeRiskLevel@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[crimeRiskLevel@gte]" in: query description: Фільтрація за датою встановленого рівня ризику контрагента більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[crimeRiskLevel@lte]" in: query description: Фільтрація за датою встановленого рівня ризику контрагента менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[where@contracts]" description: Фільтрація контрагентів за вкладеним фільтром кнтрактів in: query schema: type: string example: '&filter[where@contracts][сreated@lte]=2022-07-19' - name: "filter[currentCrimeRiskLevel@whereIn]" description: Фільтрація за поточним id рівнів ризику з довідника in: query schema: type: string example: '&filter[currentCrimeRiskLevel@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[currentCrimeRiskLevel@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[destinationCode@where]" description: Фільтрація за значенням Коду призначення платежу/виплати за довідником на пов'язаних контрактах in: query schema: type: string example: 31 responses: '200': description: 'Масив контрагентів' content: application/json: schema: properties: data: type: array nullable: true items: allOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. deprecated: false post: tags: - Counterparts summary: Створити контрагента. security: - bearerAuth: [] requestBody: description: 'Різний набір даних в залежності від типу контрагента' content: application/json: schema: oneOf: - $ref: "#/components/schemas/CreateCounterpartLegalPerson" - $ref: "#/components/schemas/CreateCounterpartGovernment" - $ref: "#/components/schemas/CreateCounterpartSeparateUnit" - $ref: "#/components/schemas/CreateCounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CreateCounterpartIndividual" - $ref: "#/components/schemas/CreateCounterpartIndividualNonResident" - $ref: "#/components/schemas/CreateCounterpartLegalNonResident" required: true responses: '201': description: 'Успішно створено контрагента' content: application/json: schema: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '406': description: 'Помилка даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: usreou_code: - validation.required not_unique: summary: Контрагент з таким номером вже існує value: code: 406 description: Вже існує контрагент з ЄДРПОУ 12345678 /api-docs/v1/counterparts/export: get: tags: - Counterparts summary: Замовити перелік контрагентів на пошту. security: - bearerAuth: [] parameters: - name: "filter[id@where]" description: Фільтрація за ID контрагенту in: query schema: type: string format: uuid example: 0ca00000-a000-000e-0d0f-0d0d00bab000 - name: "filter[id@whereIn]" description: Фільтрація за IDs контрагентів, лише перераховані in: query schema: type: string example: '&filter[id@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[id@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[id@whereNotIn]" description: Фільтрація за IDs контрагентів, крім перерахованих in: query schema: type: string example: '&filter[id@whereNotIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[id@whereNotIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[type@whereIn]" description: Фільтрація за id типів контрагентів за довідником in: query schema: type: string example: '&filter[type@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[type@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[state@whereIn]" description: Фільтрація за id статусу контрагента за довідником in: query schema: type: string example: '&filter[state@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[state@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[usreou@where]" description: Фільтрація контрагента за ЄДРПОУ/РНОКПП/Кодом нерезидента in: query schema: type: string maximum: 255 example: 12345678 - name: "filter[fullName@like]" description: Фільтрація контрагентів по назві in: query schema: type: string maximum: 255 example: товариство - name: "filter[created@gte]" in: query description: Фільтрація за датою створення контрагента більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[created@lte]" in: query description: Фільтрація за датою створення контрагента менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[crimeRiskLevel@where]" description: Фільтрація за значенням рівня ризику з довідника in: query schema: type: string example: low - name: "filter[identificationStatus@where]" description: Фільтрація за значенням статусу ідентифікації з довідника in: query schema: type: string example: 0 - name: "filter[identificationStatus@whereIn]" description: Фільтрація за id статусів ідентифікації з довідника in: query schema: type: string example: '&filter[identificationStatus@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[identificationStatus@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[identificationDate@gte]" in: query description: Фільтрація за датою ідентифікації контрагента більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[identificationDate@lte]" in: query description: Фільтрація за датою ідентифікації контрагента менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[legalForm@where]" description: Фільтрація за значенням організаційно-правової форми з довідника in: query schema: type: string example: 230 - name: "filter[contractType@where]" description: Фільтрація за значенням типу договору з довідника in: query schema: type: string example: type1 - name: "filter[financialModels@whereIn]" description: Фільтрація за id профілю СПФМ in: query schema: type: string example: '&filter[financialModels@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[financialModels@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[isPublic@where]" description: Фільтрація за належністю до публічних осіб, до осіб, близьких або пов'язаних з публічними особами in: query schema: type: boolean example: true - name: "filter[crimeRiskLevel@whereIn]" description: Фільтрація за id рівнів ризику з довідника in: query schema: type: string example: '&filter[crimeRiskLevel@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[crimeRiskLevel@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' - name: "filter[crimeRiskLevel@gte]" in: query description: Фільтрація за датою встановленого рівня ризику контрагента більше ніж schema: type: string format: date example: 2022-07-01 - name: "filter[crimeRiskLevel@lte]" in: query description: Фільтрація за датою встановленого рівня ризику контрагента менше ніж schema: type: string format: date example: 2022-07-19 - name: "filter[where@contracts]" description: Фільтрація контрагентів за вкладеним фільтром кнтрактів in: query schema: type: string example: '&filter[where@contracts][сreated@lte]=2022-07-19' - name: "filter[currentCrimeRiskLevel@whereIn]" description: Фільтрація за поточним id рівнів ризику з довідника in: query schema: type: string example: '&filter[currentCrimeRiskLevel@whereIn][0]=0ca00000-a000-000e-0d0f-0d0d00bab000&filter[currentCrimeRiskLevel@whereIn][1]=0ca00000-a000-000e-0d0f-0d0d00bab000' responses: '200': description: 'Вислано перелік контрагентів на пошту' content: application/json: schema: properties: success: type: string example: success: Export counterparts job was created and file will be delivered via email. '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. deprecated: false /api-docs/v1/counterparts/{id}: get: tags: - Counterparts summary: Переглянути картку контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false put: tags: - Counterparts summary: Оновити контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: 'Різний набір даних в залежності від типу контрагента' content: application/json: schema: oneOf: - $ref: "#/components/schemas/UpdateCounterpartLegalPerson" - $ref: "#/components/schemas/UpdateCounterpartGovernment" - $ref: "#/components/schemas/UpdateCounterpartSeparateUnit" - $ref: "#/components/schemas/UpdateCounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/UpdateCounterpartIndividual" - $ref: "#/components/schemas/UpdateCounterpartIndividualNonResident" - $ref: "#/components/schemas/UpdateCounterpartLegalNonResident" required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не вистачає даних' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid responses: '204': description: 'Успішно видалено контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/restore: post: tags: - Counterparts summary: Відновити контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid responses: '200': description: 'Успішно відновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/documents: post: tags: - Counterparts summary: Створити документ контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: content: application/json: schema: oneOf: - $ref: "#/components/schemas/CreatePassportDocument" - $ref: "#/components/schemas/CreatePassportIdDocument" - $ref: "#/components/schemas/CreateDefaultDocument" required: true responses: '200': description: 'Успішно створено документ контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/documents/{id}: put: tags: - Counterparts summary: Оновити документ контрагента та запчастин. security: - bearerAuth: [] parameters: - name: id in: path description: ID документа required: true schema: type: string format: uuid requestBody: content: application/json: schema: oneOf: - $ref: "#/components/schemas/UpdatePassportDocument" - $ref: "#/components/schemas/UpdatePassportIdDocument" - $ref: "#/components/schemas/UpdateDefaultDocument" required: true responses: 200: description: 'Успішно оновлено документ контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false delete: tags: - Counterparts summary: Видалити документ контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID документа required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено документ контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/clarification: put: tags: - Counterparts summary: Оновити частину контрагента, що стосується вкладки Вивчення клієнта. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: executive_depth: type: string maximum: 255 nullable: true description: Дані про виконавчий орган is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами. publicity_date: type: string format: date nullable: true description: Дата виявлення належності до публічних осіб publicity_type_id: type: string format: uuid nullable: true description: Id типу публічного діяча з довiдника is_public_description: type: string maximum: 255 nullable: true description: Коментарi до виявлення належності до публічних осіб is_terrorist: type: boolean nullable: true description: Клієнт включений до Переліку осіб, пов'язаних із здійсненням терористичної діяльності. is_terrorist_description: type: string maximum: 255 nullable: true description: Коментарi щодо включення до Переліку осіб, пов'язаних із здійсненням терористичної діяльності. has_sanctions: type: boolean nullable: true description: Клієнт включений до Переліку осіб стосовно яких застосовано міжнародні санкції. sanctions_description: type: string maximum: 255 nullable: true description: Коментарi щодо включення до Переліку осіб стосовно яких застосовано міжнародні санкції. is_aggressor: type: boolean nullable: true description: Клієнт має зв'язки з країною-агресором. is_aggressor_description: type: string maximum: 1000 nullable: true description: Коментарi щодо зв'язкiв з країною-агресором. is_nonprofit: type: boolean nullable: true description: Клієнт є благодійною/неприбутковою організацією. nonprofit_description: type: string maximum: 255 nullable: true description: Коментарi щодо перебування благодійною/неприбутковою організацією. risk_limitation: type: string maximum: 1000 description: Заходи для обмеження ризику використання з метою легалізації (відмивання) доходів, одержаних злочинним шляхом, або фінансування тероризму чи фінансування розповсюдження зброї масового знищення. example: executive_depth: директор is_public: true publicity_date: '2013-04-01' publicity_type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 is_public_description: Медведчук is_terrorist: false is_terrorist_description: null has_sanctions: true sanctions_description: Рішення РНБО is_aggressor: true is_aggressor_description: Громадянин РФ is_nonprofit: false nonprofit_description: null risk_limitation: null required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: sanctions_description: - validation.max:5000 /api-docs/v1/counterparts/{id}/representatives: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується Ідентифікаційних даних представника клієнта (за наявності таких осіб). Створення особи security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - last_name - first_name properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true residence: type: string maximum: 255 nullable: true description: Місце проживання або перебування в Україні position: type: string maximum: 255 nullable: true description: Посада authority_basis: type: string maximum: 255 nullable: true description: Підстава повноважень is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: last_name: ТАРАСЕНКО first_name: ТАРАС middle_name: ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required /api-docs/v1/representatives/{id}: put: tags: - Counterparts summary: Оновити ідентифікаційні дані представника клієнта security: - bearerAuth: [] parameters: - name: id in: path description: ID представника required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - last_name - first_name properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true residence: type: string maximum: 255 nullable: true description: Місце проживання або перебування в Україні position: type: string maximum: 255 nullable: true description: Посада authority_basis: type: string maximum: 255 nullable: true description: Підстава повноважень is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: last_name: ТАРАСЕНКО first_name: ТАРАС middle_name: ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити представника контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID представника required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено представника контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/representatives/{id}/documents: post: tags: - Counterparts summary: Створити документ для ідентифікаційних даних представника клієнта контрагента. security: - bearerAuth: [ ] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: content: application/json: schema: oneOf: - $ref: "#/components/schemas/CreatePassportDocument" - $ref: "#/components/schemas/CreatePassportIdDocument" - $ref: "#/components/schemas/CreateDefaultDocument" required: true responses: '200': description: 'Успішно створено документ контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/property-commanders: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується Ідентифікаційних даних особи, яка має право розпоряджатися рахунками та/або майном. Створення особи security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - last_name - first_name properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true residence: type: string maximum: 255 nullable: true description: Місце проживання або перебування в Україні position: type: string maximum: 255 nullable: true description: Посада authority_basis: type: string maximum: 255 nullable: true description: Підстава повноважень is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: last_name: ТАРАСЕНКО first_name: ТАРАС middle_name: ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required /api-docs/v1/property-commanders/{id}: put: tags: - Counterparts summary: Оновити ідентифікаційні дані особи, яка має право розпоряджатися рахунками та/або майном security: - bearerAuth: [] parameters: - name: id in: path description: ID розпорядника required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - last_name - first_name properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true residence: type: string maximum: 255 nullable: true description: Місце проживання або перебування в Україні position: type: string maximum: 255 nullable: true description: Посада authority_basis: type: string maximum: 255 nullable: true description: Підстава повноважень is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: last_name: ТАРАСЕНКО first_name: ТАРАС middle_name: ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити розпорядника контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID розпорядника required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено представника контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/property-commanders/{id}/documents: post: tags: - Counterparts summary: Створити документ для ідентифікаційних даних особи, яка має право розпоряджатися рахунками та/або майном. security: - bearerAuth: [ ] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: content: application/json: schema: oneOf: - $ref: "#/components/schemas/CreatePassportDocument" - $ref: "#/components/schemas/CreatePassportIdDocument" - $ref: "#/components/schemas/CreateDefaultDocument" required: true responses: '200': description: 'Успішно створено документ контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/owners: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується даних особи, яка має пряме володіння із зазначенням частки. Створення особи security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: oneOf: - $ref: "#/components/schemas/OwnerLegalPerson" - $ref: "#/components/schemas/OwnerIndividual" required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required /api-docs/v1/owners/{id}: put: tags: - Counterparts summary: Оновити ідентифікаційні дані особи, яка має пряме володіння із зазначенням частки security: - bearerAuth: [] parameters: - name: id in: path description: ID власника required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: oneOf: - $ref: "#/components/schemas/OwnerLegalPerson" - $ref: "#/components/schemas/OwnerIndividual" required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити власника майном контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID власника required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено власника майном контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/beneficial-owners: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується даних про фізичну особу, що є кінцевими бенефіціарним власником (контролером). Створення особи security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - last_name - first_name properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові nullable: true birthday: type: string format: date nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true country: type: string maximum: 255 nullable: true description: Країна проживання citizenship: type: string maximum: 255 nullable: true description: Країна громадянства influence_basis: type: string maximum: 255 nullable: true description: Підстава впливу is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required /api-docs/v1/beneficial-owners/{id}: put: tags: - Counterparts summary: Оновити ідентифікаційні дані про фізичну особу, що є кінцевими бенефіціарним власником (контролером) security: - bearerAuth: [] parameters: - name: id in: path description: ID бенефіціара required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - last_name - first_name properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові nullable: true birthday: type: string format: date nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true country: type: string maximum: 255 nullable: true description: Країна проживання citizenship: type: string maximum: 255 nullable: true description: Країна громадянства influence_basis: type: string maximum: 255 nullable: true description: Підстава впливу is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити бенефіціара контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID бенефіціара required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено бенефіціара контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/separate-units: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується даних про Підрозділи. Створення Підрозділу security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - name - usreou_code properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'ЄДРПОУ' example: name: Підрозділ ТОВ usreou_code: '12345678' required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити всі підрозділи. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено всі підрозділи контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/separate-units/{id}: put: tags: - Counterparts summary: Оновити дані про підрозділ security: - bearerAuth: [] parameters: - name: id in: path description: ID підрозділа required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - name - usreou_code properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'ЄДРПОУ' example: name: Підрозділ ТОВ usreou_code: '12345678' required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити підрозділ контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID підрозділу required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено підрозділ контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/parent-companies: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується даних про материнську компанію. Створення компанії security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - name - usreou_code properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'ЄДРПОУ' example: name: Головний ТОВ usreou_code: '12345678' required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити всі підрозділи. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено всі материнські компанії контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/parent-companies/{id}: put: tags: - Counterparts summary: Оновити дані про материнську компанію security: - bearerAuth: [] parameters: - name: id in: path description: ID материнської компанії required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - name - usreou_code properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'ЄДРПОУ' example: name: Головний ТОВ usreou_code: '12345678' required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити материнську компанію контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID материнської компанії required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено материнську компанію контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/risk-management: put: tags: - Counterparts summary: Оновити частину контрагента, що стосується вкладки Управління ризиками. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: activity_content: type: string maximum: 1000 description: 'Зміст діяльності' nullable: true client_services: type: string maximum: 1000 description: Види послуг, якими користується клієнт nullable: true site: type: string format: url maximum: 255 description: Веб-сайт nullable: true business_purpose: type: string maximum: 1000 description: 'Мета та характер ділових відносин' nullable: true depth_examination: type: string maximum: 1000 description: 'Заходи щодо здійснення поглибленої перевірки' nullable: true staff_number: type: integer description: Кількість працівників nullable: true fund_registered: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Зареєстрований cтатутний капітал nullable: true fund_paid: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Сплачений cтатутний капітал nullable: true projected_amount: type: number format: float pattern: '^\d+(\.\d{1,2})?$' readOnly: true description: Прогнозний обсяг, тис. грн nullable: true net_profit: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Чистий прибуток/збиток, тис. грн nullable: true revenue: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Дохід/виручка від реалізації продукції (товарів, робіт, послуг), тис. грн nullable: true tax_system_id: type: string format: uuid nullable: true description: Id cистеми оподаткування контрагента з довiдника activities: description: Масив Id видів діяльності контрагента з довiдника type: array nullable: true items: type: string format: uuit description: Id виду діяльності контрагента з довiдника example: activity_content: сервіс бронювання та продажу квитків на культурно-видовищні заходи site: https://example.com.ua business_purpose: договірні відносини з надання послуг з переказу коштів staff_number: 1 fund_registered: '70000' fund_paid: '70000' depth_examination: null projected_amount: '5000' net_profit: '0' revenue: '1241245' client_services: null tax_system_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activities: - 0ca00000-a000-000e-0d0f-0d0d00bab000 - 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: business_purpose: - validation.max:1000 /api-docs/v1/counterparts/{id}/licenses: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується ліцензії, дозволу на право здійснення певних операцій. Створення ліцензії security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - number - issued_by properties: number: type: string maximum: 255 description: 'Серія та номер ліцензії/дозволу' issued_by: type: string maximum: 255 description: Ким виданий validity_date: type: string format: date nullable: true description: Термін дії example: number: '122311' issued_by: '39706018' validity_date: '2022-07-25' required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: number: - validation.required /api-docs/v1/licenses/{id}: put: tags: - Counterparts summary: Оновити дані про ліцензію, дозвіл на право здійснення певних операцій security: - bearerAuth: [] parameters: - name: id in: path description: ID ліцензії required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: number: type: string maximum: 255 description: 'Серія та номер ліцензії/дозволу' issued_by: type: string maximum: 255 description: Ким виданий validity_date: type: string format: date nullable: true description: Термін дії example: number: '122311' issued_by: '39706018' validity_date: '2022-07-25' required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: name: - validation.required delete: tags: - Counterparts summary: Видалити ліцензію контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID ліцензії required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено ліцензію контрагента' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/crime-risks/create: get: tags: - Counterparts summary: Отримати критерії рівнів ризику проведення фінансових операцій з легалізації кримінальних доходів/фінансування тероризму. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: example: - title: 1. Критерії за типом клієнта groups: - title: 1.1. Критерії ризику, що зумовлені комерційною чи особистою діяльністю клієнта або його КБВ criteria: - label: 1.1.2.14. Діяльність, пов'язана з віртуальними активами (є постачальником послуг, пов'язаних з обігом віртуальних активів). name: one_one_two_fourteen_criterion value: false disabled: false - label: 1.1.5. Попередня діяльність та професійний досвід клієнта суттєво відрізняються від того, що клієнт планує здійснювати, використовуючи послуги установи. name: one_one_five_criterion value: false disabled: false - title: 1.2. Критерії ризику, що зумовлені особливостями, пов'язаними із правовою формою заснування, структурою власності та поведінкою клієнта criteria: - label: 1.2.1. - 1.2.9. інші; name: one_two_one_to_one_two_nine_criterion value: false disabled: false - label: 1.2.10. наявна інформація про клієнта дає підстави підозрювати, що клієнт може бути компанією-оболонкою; name: one_two_ten_criterion value: false disabled: false - label: 1.2.10.1. - 1.2.10.1.4. інші репутаційні критерії; name: one_two_ten_one_to_one_two_ten_one_four_criterion value: false disabled: false - label: 1.2.10.1.5. наявність інформації про відкриті кримінальні провадження з розслідування злочинів у сфері господарської діяльності щодо власника істотної участі / контролера або юридичної особи, її керівника; name: one_two_ten_one_five_criterion value: false disabled: false - label: 1.2.10.1.6. наявність інформації про вплив та координацію дій третіми особами на прийняття рішень КБВ стосовно господарської діяльності юридичної особи; name: one_two_ten_one_six_criterion value: false disabled: false - label: 1.2.10.1.8. наявна інформація про неодноразове обмеження прав власника істотної участі / контролера юридичної особи та/або самої юридичної особи щодо розпоряджання грошовими коштами, розміщеними на його/її рахунку(ах); name: one_two_ten_one_eight_criterion value: false disabled: false - label: 1.2.10.2.1. - 1.2.10.2.3. інші реєстраційні критерії; name: one_two_ten_two_one_to_one_two_ten_two_three_criterion value: false disabled: false - label: 1.2.10.2.4. наявність інформації про реєстрацію юридичної особи за викраденими, втраченими документами або документами осіб, які померли або яких не існує; name: one_two_ten_two_four_criterion value: false disabled: false - label: 1.2.10.3. операційні критерії. name: one_two_ten_three_criterion value: false disabled: false - title: 1.3. Критерії ризику, що зумовлені репутацією клієнта, його КБВ або вигодоодержувача(вигодонабувача) за його договором страхування життя criteria: - label: 1.3.1. наявна негативна інформація про нього в офіційних та/або публічних джерелах, що свідчить про можливий зв'язок із тероризмом або іншою кримінальною/незаконною діяльністю; name: one_three_one_criterion value: false disabled: false - label: 1.3.2. його кошти заморожені або заарештовані у зв'язку з кримінальними провадженнями, пов'язаними із ВК/ФТ; name: one_three_two_criterion value: false disabled: false - label: 1.3.3. установа неодноразово інформувала СУО про фінансові операції клієнта у зв'язку із своїми підозрами. name: one_three_three_criterion value: false disabled: false - title: 2. Критерії за типом послуги groups: - title: 2.1. Клієнт використовує послугу, яка має такі ознаки criteria: - label: 2.1.1. сприяє анонімності клієнта (наприклад, електронні гроші, наперед оплачені картки); name: two_one_one_criterion value: false disabled: false - label: 2.1.2. є складним(ою) з огляду на можливість відстеження операції [зокрема перекази, що здійснюються із залученням великої кількості посередників, "швидкі" електронні послуги (міжнародні операції, що виконуються електронними грошима)]; name: two_one_two_criterion value: false disabled: false - label: 2.1.3. проведення фінансових операцій на незвично великі суми (або загальний оборот), що є невластивим для відомої установі діяльності клієнта; name: two_one_three_criterion value: false disabled: false - label: 2.1.4. інструкції щодо проведення фінансової операції надаються третьою стороною, яка не є стороною ділових відносин; name: two_one_four_criterion value: false disabled: false - label: 2.1.6. можливість здійснювати складні масштабні операції з великою кількістю залучених учасників; name: two_one_six_criterion value: false disabled: false - title: 3. Географічні критерії groups: - title: 3.1. Клієнт (КБВ клієнта) мають походження, реєстрацію, резидентність, громадянство, місцезнаходження, здійснюють діяльнсть або має суттєві особисті або ділові зв'язки у державах (на територіях) criteria: - label: 3.1.1. що віднесені Кабінетом Міністрів України до переліку офшорних зон; name: three_one_one_criterion value: false disabled: false - label: 3.1.2. що віднесені до переліку держав, що не виконують рекомендації FATF (чорний список); name: three_one_two_criterion value: false disabled: false - label: 3.1.3. що мають стратегічні недоліки у сфері ПВК/ФТ відповідно до заяв FATF (сірий список); name: three_one_three_criterion value: false disabled: false - label: 3.1.4. що визначені Європейською комісією як країни із слабкими режимами ПВК/ФТ; name: three_one_four_criterion value: false disabled: false - label: 3.1.5. яким притаманний підвищений ризик корупції; name: three_one_five_criterion value: false disabled: false - label: 3.1.6. яким притаманний підвищений ризик фінансування тероризму. name: three_one_six_criterion value: false disabled: false - title: 4. Критерії відповідно до каналу постачання послуг groups: - title: 4.1. Використання новітніх каналів продажу або дистанційної ідентифікації criteria: - label: 4.1.1. до процесу ідентифікації та верифікації клієнта залучені агенти, що не є СПФМ; name: four_one_one_criterion value: false disabled: false - label: 4.1.2. установа використала інструмент покладання для ідентифікації та верифікації клієнта (представника клієнта); name: four_one_two_criterion value: false disabled: false - label: 4.1.3. надання фінансових послуг ґрунтується на технологічних рішеннях, що певним чином обмежують можливості установи в частині управління процесом, оперативності прийняття рішень. name: four_one_three_criterion value: false disabled: false - title: 5. Застосування заходів ризик-орієнтованого підходу criteria: - label: 5.1. на підставі комплексного вивчення інформації, отриманої в ході реалізації заходів НПК - низький; name: five_one_criterion value: false disabled: false - label: 5.2. на підставі комплексного вивчення інформації, отриманої в ході реалізації заходів НПК - середній; name: five_two_criterion value: false disabled: false - label: 5.3. на підставі комплексного вивчення інформації, отриманої в ході реалізації заходів НПК - високий; name: five_three_criterion value: false disabled: false - label: 5.4. на підставі комплексного вивчення інформації, отриманої в ході реалізації заходів НПК - неприйнятно високий. name: five_four_criterion value: false disabled: false '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/counterparts/{id}/crime-risks: post: tags: - Counterparts summary: Створити Рівень ризику проведення фінансових операцій з легалізації кримінальних доходів/фінансування тероризму. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - date properties: date: type: string format: date description: Дата встановлення ризику one_one_two_fourteen_criterion: type: boolean description: Критерій ризику one_one_five_criterion: type: boolean description: Критерій ризику one_two_one_to_one_two_nine_criterion: type: boolean description: Критерій ризику one_two_ten_criterion: type: boolean description: Критерій ризику one_two_ten_one_to_one_two_ten_one_four_criterion: type: boolean description: Критерій ризику one_two_ten_one_five_criterion: type: boolean description: Критерій ризику one_two_ten_one_six_criterion: type: boolean description: Критерій ризику one_two_ten_one_eight_criterion: type: boolean description: Критерій ризику one_two_ten_two_one_to_one_two_ten_two_three_criterion: type: boolean description: Критерій ризику one_two_ten_two_four_criterion: type: boolean description: Критерій ризику one_two_ten_three_criterion: type: boolean description: Критерій ризику one_three_one_criterion: type: boolean description: Критерій ризику one_three_two_criterion: type: boolean description: Критерій ризику one_three_three_criterion: type: boolean description: Критерій ризику two_one_one_criterion: type: boolean description: Критерій ризику two_one_two_criterion: type: boolean description: Критерій ризику two_one_three_criterion: type: boolean description: Критерій ризику two_one_four_criterion: type: boolean description: Критерій ризику two_one_six_criterion: type: boolean description: Критерій ризику three_one_one_criterion: type: boolean description: Критерій ризику three_one_two_criterion: type: boolean description: Критерій ризику three_one_three_criterion: type: boolean description: Критерій ризику three_one_four_criterion: type: boolean description: Критерій ризику three_one_five_criterion: type: boolean description: Критерій ризику three_one_six_criterion: type: boolean description: Критерій ризику four_one_one_criterion: type: boolean description: Критерій ризику four_one_two_criterion: type: boolean description: Критерій ризику four_one_three_criterion: type: boolean description: Критерій ризику example: date: '2022-07-26' one_one_two_fourteen_criterion: false one_one_five_criterion: false one_two_one_to_one_two_nine_criterion: false one_two_ten_criterion: false one_two_ten_one_to_one_two_ten_one_four_criterion: false one_two_ten_one_five_criterion: false one_two_ten_one_six_criterion: false one_two_ten_one_eight_criterion: false one_two_ten_two_one_to_one_two_ten_two_three_criterion: false one_two_ten_two_four_criterion: false one_two_ten_three_criterion: false one_three_one_criterion: false one_three_two_criterion: false one_three_three_criterion: false two_one_one_criterion: false two_one_two_criterion: false two_one_three_criterion: false two_one_four_criterion: false two_one_six_criterion: false three_one_one_criterion: false three_one_two_criterion: false three_one_three_criterion: false three_one_four_criterion: false three_one_five_criterion: false three_one_six_criterion: false four_one_one_criterion: false four_one_two_criterion: false four_one_three_criterion: false required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: date: - validation.required /api-docs/v1/crime-risks/{id}: delete: tags: - Counterparts summary: Видалити рівень ризику. security: - bearerAuth: [] parameters: - name: id in: path description: ID рівня ризику required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено рівень ризику' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/activity-evaluations: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується оцінки відповідності фін.операцій контрагента змісту його діяльності. Створення оцінки security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - date_at - start_at - end_at - evaluation_result properties: date_at: type: string format: date description: Дата оцінки start_at: type: string format: date description: Період оцінки з end_at: type: string format: date description: Період оцінки до evaluation_result_id: type: string format: uuid description: Id типу оцінки відповідності фін.операцій контрагента змісту його діяльності з довiдника example: date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: date_at: - validation.required /api-docs/v1/activity-evaluations/{id}: put: tags: - Counterparts summary: Оновити дані про оцінку відповідності фін.операцій клієнта змісту його діяльності та у разі невідповідності – вжиті заходи щодо з’ясування суті та мети проведення фін.операцій security: - bearerAuth: [] parameters: - name: id in: path description: ID оцінки required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: date_at: type: string format: date description: Дата оцінки start_at: type: string format: date description: Період оцінки з end_at: type: string format: date description: Період оцінки до evaluation_result_id: type: string format: uuid description: Id типу оцінки відповідності фін.операцій контрагента змісту його діяльності з довiдника example: date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: date_at: - validation.required delete: tags: - Counterparts summary: Видалити оцінку відповідності фін.операцій клієнта змісту його діяльності та у разі невідповідності – вжиті заходи щодо з’ясування суті та мети проведення фін.операцій. security: - bearerAuth: [] parameters: - name: id in: path description: ID ліцензії required: true schema: type: string format: uuid responses: '200': description: 'Успішно видалено' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/state-evaluations: post: tags: - Counterparts summary: Оновити частину контрагента, що стосується оцінки відповідності фін.операцій контрагента фінансовому стану з довiдника. Створення оцінки security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: required: - date_at - start_at - end_at - evaluation_result properties: date_at: type: string format: date description: Дата оцінки start_at: type: string format: date description: Період оцінки з end_at: type: string format: date description: Період оцінки до evaluation_result_id: type: string format: uuid description: Id типу оцінки відповідності фін.операцій контрагента фінансовому стану з довiдника з довiдника example: date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: date_at: - validation.required /api-docs/v1/state-evaluations/{id}: put: tags: - Counterparts summary: Оновити дані про оцінку відповідності фін.операцій контрагента фінансовому стану security: - bearerAuth: [] parameters: - name: id in: path description: ID оцінки required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: date_at: type: string format: date description: Дата оцінки start_at: type: string format: date description: Період оцінки з end_at: type: string format: date description: Період оцінки до evaluation_result_id: type: string format: uuid description: Id типу оцінки відповідності фін.операцій контрагента фінансовому стану з довiдника example: date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: summary: Не вистачає даних value: code: 406 description: date_at: - validation.required delete: tags: - Counterparts summary: Видалити оцінку відповідності фін.операцій контрагента фінансовому стану. security: - bearerAuth: [] parameters: - name: id in: path description: ID оцінки відповідності фін.операцій контрагента фінансовому стану required: true schema: type: string format: uui responses: '200': description: 'Успішно видалено' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/counterparts/{id}/profile-maintain: put: tags: - Counterparts summary: Оновити частину контрагента, що стосується вкладки Ведення анкети. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: application/json: schema: properties: identification_status_id: description: Id Статусу ідентифікації з довідника type: string format: uuid nullable: true identification_date: description: Дата ідентификації type: string format: date nullable: true establishing_relations_date: description: Дата встановлення ділових відносин type: string format: date nullable: true video_verification_date: description: Дата проведення верифікації type: string format: date nullable: true video_verification_method: type: string maximum: 255 description: Спосіб проведення верифікації nullable: true stop_relations_date: description: Дата відмови від установлення /підтримання ділових (договірних) відносин nullable: true type: string format: date stop_relations_comment: type: string maximum: 255 description: Коментар щодо відмови від установлення /підтримання ділових (договірних) відносин nullable: true asset_freeze_date: description: Дата замороження активів type: string format: date nullable: true asset_unfreeze_date: description: Дата розмороження активів type: string format: date nullable: true clarification_date: description: Дата уточнення інформації type: string format: date nullable: true responsible_person: type: string maximum: 255 nullable: true description: Особа, відповідальна за здійснення ідентифікації та верифікації клієнта clarification_task: type: string maximum: 1000 nullable: true description: Задача на уточнення staging_date: description: Дата постановки задачі на уточнення type: string format: date nullable: true completion_date: description: Дата виконання задачі на уточнення type: string format: date nullable: true ending_relations_date: description: Дата завершення ділових відносин type: string format: date nullable: true example: identification_status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 identification_date: '2022-02-08' establishing_relations_date: '2022-02-08' video_verification_date: '2022-01-21' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: Контролер О.Ю. clarification_task: null staging_date: null completion_date: null ending_relations_date: null required: true responses: '200': description: 'Успішно оновлено контрагента' content: application/json: schema: properties: data: oneOf: - $ref: "#/components/schemas/CounterpartLegalPerson" - $ref: "#/components/schemas/CounterpartGovernment" - $ref: "#/components/schemas/CounterpartSeparateUnit" - $ref: "#/components/schemas/CounterpartIndividualEntrepreneur" - $ref: "#/components/schemas/CounterpartIndividual" - $ref: "#/components/schemas/CounterpartIndividualNonResident" - $ref: "#/components/schemas/CounterpartLegalNonResident" '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: example: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '406': description: 'Не пройдено валiдацiю' content: application/json: examples: no_data: value: code: 406 description: clarification_task: - validation.max:1000 /api-docs/v1/counterparts/{id}/{format}: get: tags: - Counterparts summary: Друкувати картку контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контрагента required: true schema: type: string format: uuid - name: format in: path description: Фомат файла required: true schema: type: string enum: [pdf, docx] responses: '200': description: '' content: text/html: schema: type: string format: binary example: some_file.pdf '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '403': description: 'Не вистачає прав' content: application/json: examples: no_data: summary: Не вистачає прав value: code: 403 description: This action is unauthorized. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false /api-docs/v1/file/{id}: get: tags: - File Upload summary: Отримати перелік файлів підкріплених до картки контракту/контрагента або скачати файл по назві. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту або ID контрагента required: true schema: type: string format: uuid - name: name in: query description: Назва файлу schema: type: string example: some_file.docx responses: '200': description: '' content: application/json: schema: type: array nullable: true items: type: string example: ['1.xls','2.csv','3.docx'] text/html: schema: type: string format: binary '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found deprecated: false post: tags: - File Upload summary: Завантажити файл, який стосується картки контракту чи картки контрагента. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту або ID контрагента required: true schema: type: string format: uuid requestBody: description: '' content: multipart/form-data: schema: type: object properties: files: type: array items: type: string format: binary required: true responses: '200': description: 'Успішно завантажено файл' content: application/json: schema: type: string example: success '400': description: 'Не має файлів для завантаження' content: application/json: example: No files. '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '500': description: 'Помилка пiд час завантаження файла' content: application/json: example: "Error save file: some_filename" delete: tags: - File Upload summary: Видалити файл. security: - bearerAuth: [] parameters: - name: id in: path description: ID контракту required: true schema: type: string format: uuid - name: name in: query description: Назва файлу required: true schema: type: string example: some_file.docx responses: '200': description: 'Успішно видалено файл' content: application/json: example: "Success" '400': description: 'Назва файлу не вказана' content: application/json: example: Param name is empty '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. '404': description: 'Не знайдено' content: application/json: examples: no_data: summary: 'Не знайдено' value: code: 404 description: Not Found '500': description: 'Помилка пiд час видалення файла' content: application/json: example: "Error delete file: some_filename" deprecated: false /api-docs/v1/financial-risk: get: tags: - Financial Risk summary: Перевірити фінансовий ризик. security: - bearerAuth: [] parameters: - in: query name: first_name required: true schema: type: string - in: query name: last_name required: true schema: type: string - in: query name: middle_name required: true schema: type: string responses: 200: description: 'Результат перевірки на санкції РНБО, по списку терористів, належність до публічних осіб' content: application/json: example: { rnbou_match: true, terrorist_list_match: false, public_person_match: false } 400: description: '' content: application/json: example: code: 400, description: { first_name: [ validation.required ], last_name: [ validation.required ], middle_name: [ validation.required ] } /api-aggs/v1/operations: post: tags: - Operations summary: Створити нову операцію. security: - bearerAuth: [ ] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Operation' responses: 202: description: 'Дані прийняті в обробку.' content: application/json: example: "status": 202 "detail": "Data of the operation was added to the queue for the next stage of processing and adding it to the database." "title": "Data accepted." 400: description: '' content: application/json: example: code: 400 description: { paysystem_id: [ "validation.required" ] } put: tags: - Operations summary: Оновити операцію. security: - bearerAuth: [ ] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OperationUpdate' responses: 202: description: 'Дані прийняті в обробку.' content: application/json: example: "status": 202 "detail": "Data of the operation was added to the queue for the next stage of processing and updating it to the database." "title": "Data accepted." 400: description: '' content: application/json: example: code: 400 description: { paysystem_id: [ "validation.required" ] } /api-aggs/v1/declined-payments: post: tags: - Operations summary: Створити нову заблоковану операцію. security: - bearerAuth: [ ] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeclinedPayment' responses: 202: description: 'Дані прийняті в обробку.' content: application/json: example: "status": 202 "detail": "Data of the declined payment was added to the queue for the next stage of processing and adding it to the database." "title": "Data accepted." 400: description: '' content: application/json: example: code: 400, description: { paysystem_operation_id: [ "validation.required" ] } /api-docs/v1/roles: get: tags: - Dictionary summary: Довідник ролей користувачів. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/Role' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: guest '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/operation-destination-code: get: tags: - Dictionary summary: Довідник кодів призначення платежу. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/PaymentDestinationCode' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Виплата переказів готівкою value: '29' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/contract-payment-methods: get: tags: - Dictionary summary: Довідник платіжних методів контракту. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/PaymentMethod' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ЕПЗ value: epz '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/contract-statuses: get: tags: - Dictionary summary: Довідник статусів контракту. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/ContractState' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Діючий value: '0' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/contract-types: get: tags: - Dictionary summary: Довідник типів контракту. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/ContractType' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Договір про переказ коштів (прийом) value: type1 '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/contract-payout-periods: get: tags: - Dictionary summary: Довідник періодів виплати по контракту. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/PayoutPeriod' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Кожний другий день value: even '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-types: get: tags: - Dictionary summary: Довідник типів контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/CounterpartType' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Юридична особа (ЮО) value: legal-person '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-document-types: get: tags: - Dictionary summary: Довідник типів документів. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/DocumentType' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Паспорт громадянина України value: passport '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-document-statuses: get: tags: - Dictionary summary: Довідник статусів документа контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/DocumentStatus' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Втрачено value: lost '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-states: get: tags: - Dictionary summary: Довідник юридичних станів контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/CounterpartState' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: 'Не перебуває в процесі припинення' value: '3' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-statuses: get: tags: - Dictionary summary: Довідник станів ділових відносин контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/CounterpartStatus' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: 'Новый' value: '0' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-crime-risk-levels: get: tags: - Dictionary summary: Довідник рівнів ризику контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/CrimeRiskLevel' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-identification-statuses: get: tags: - Dictionary summary: Довідник станів ідентифікації контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/CounterpartIdentificationStatus' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-evaluation-options: get: tags: - Dictionary summary: >- Довідник оцінка відповідності фін.операцій контрагента змісту його діяльності. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/ActivityEvaluationOption' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фінансові операції відповідають змісту діяльності value: '1' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-evaluation-option-states: get: tags: - Dictionary summary: >- Довідник оцінки відповідності фін.операцій контрагента його фінансовому стану. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/StateEvaluationOption' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фінансові операції відповідають фінансовому стану value: '1' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-tax-systems: get: tags: - Dictionary summary: Довідник систем оподаткувань контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/TaxSystem' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Загальна value: '1' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-activity: get: tags: - Dictionary summary: Довідник видів діяльності контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/CounterpartActivity' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Видання комп'ютерних ігор value: '58.21' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-legal-forms: get: tags: - Dictionary summary: Довідник організаційно-правових форм контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/LegalForm' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: АДВОКАТСЬКЕ БЮРО value: '281' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/counterpart-property-forms: get: tags: - Dictionary summary: Довідник форм власності контрагента. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/PropertyForm' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Приватна value: '1' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/operation-nbu-paysystems: get: tags: - Dictionary summary: Довідник платіжних систем НБУ. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/Paysystem' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Western Union value: '03' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/clarification-publicity-types: get: tags: - Dictionary summary: Довідник кодів типу публічного діяча. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/PublicityType' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Національні публічні діячі value: '1' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false /api-docs/v1/dictionary/financial-model-h020: get: tags: - Dictionary summary: Довідник кодів фінансової моделі H020. security: - bearerAuth: [] responses: '200': description: '' content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/FinancialModelH020' example: data: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Залучення фінансових активів із зобов’язанням щодо наступного їх повернення value: '04' '401': description: 'Не авторизований запит' content: application/json: example: message: Unauthenticated. deprecated: false components: schemas: Authorization: required: - email - password type: object properties: email: type: string format: email password: type: string example: email: example@example.com password: password TwoFactorAuthorization: required: - email - password - code type: object properties: email: type: string format: email password: type: string code: type: string example: email: example@example.com password: password code: '123456' Tenant: description: 'Зареєстрована компанія' type: object required: - id - name - alias - is_active - owner_id - usreou_code properties: id: type: string format: uuid name: type: string maximum: 255 alias: type: string maximum: 16 readOnly: true is_active: type: boolean owner_id: type: string format: uuid usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах системи' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' Role: description: 'Роль кристувача з довідника' type: object required: - id - name properties: id: type: string format: uuid name: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner Permission: description: 'Дозвіл на дії' type: object required: - id - name properties: id: type: string format: uuid name: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user FinancialModelShort: description: 'Скорочений профіль СПФМ' type: object required: - id - name - alias properties: id: type: string format: uuid name: type: string maximum: 255 alias: type: string maximum: 255 readOnly: true example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 FinancialModelAccount: description: 'Рахунок профілю СПФМ' type: object required: - id - iban properties: id: type: string format: uuid iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' bank: type: string maximum: 255 nullable: true bank_code: type: string pattern: '^\d{6}$' nullable: true example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 iban: UA012345000000000000001234567 bank: ПАТ Перший БАНК bank_code: 123456 FinancialModelStampData: description: 'Печатка профілю СПФМ' type: object required: - id - user_added_idd - created_at properties: id: type: string format: uuid user_added_idd: type: string format: uuid created_at: type: string format: date-time example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 user_added_idd: 0ca00000-a000-000e-0d0f-0d0d00bab000 created_at: "2022-12-21T11:18:51+0000" FinancialModel: description: 'Профіль СПФМ' type: object required: - id - name - alias - usreou_code - iban - bank - accounts properties: id: type: string format: uuid name: type: string maximum: 255 short_name: type: string maximum: 255 alias: type: string maximum: 255 readOnly: true usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' phone_support: type: string format: phone nullable: true email_support: type: string format: phone nullable: true site: type: string format: uri nullable: true head_last_name: type: string maximum: 255 nullable: true head_first_name: type: string maximum: 255 nullable: true head_middle_name: type: string maximum: 255 nullable: true head_date: type: string nullable: true head_number: type: string maximum: 255 nullable: true head_position: type: string maximum: 255 nullable: true responsible_last_name: type: string maximum: 255 nullable: true responsible_first_name: type: string maximum: 255 nullable: true responsible_middle_name: type: string maximum: 255 nullable: true responsible_date: type: string nullable: true responsible_number: type: string maximum: 255 nullable: true responsible_position: type: string maximum: 255 nullable: true deputy_responsible_last_name: type: string maximum: 255 nullable: true deputy_responsible_first_name: type: string maximum: 255 nullable: true deputy_responsible_middle_name: type: string maximum: 255 nullable: true deputy_responsible_date: type: string nullable: true deputy_responsible_number: type: string maximum: 255 nullable: true deputy_responsible_position: type: string maximum: 255 nullable: true code: type: object nullable: true allOf: - $ref: '#/components/schemas/FinancialModelCode' risk: type: object nullable: true allOf: - $ref: '#/components/schemas/FinancialModelRisk' accounts: type: array items: $ref: "#/components/schemas/FinancialModelAccount" h020: type: array items: $ref: "#/components/schemas/FinancialModelH020" licenses: type: array items: $ref: "#/components/schemas/FinancialModelLicense" stamps: type: array items: $ref: "#/components/schemas/FinancialModelStampData" example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" short_name: "Перша модель" alias: financialModel1 usreou_code: "12345678" license: №123 phone_support: '+380440000000' email_support: example@example.com site: example.com head_last_name: null head_first_name: null head_middle_name: null head_date: "2022-11-09" head_number: null head_position: null responsible_last_name: null responsible_first_name: null responsible_middle_name: null responsible_date: null responsible_number: null responsible_position: null deputy_responsible_last_name: null deputy_responsible_first_name: null deputy_responsible_middle_name: null deputy_responsible_date: null deputy_responsible_number: null deputy_responsible_position: null code: id: "2b06d815-0853-4698-9d76-55148acf7b16" name: "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент" value: "102" risk: null accounts: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 iban: UA012345000000000000001234567 bank: ПАТ Перший БАНК bank_code: 123456 h020: - id: 37488ab3-957d-4e21-a75c-98fc195987c7 name: Залучення фінансових активів із зобов’язанням щодо наступного їх повернення value: 04 licenses: - id: 37488ab3-957d-4e21-a75c-98fc195987c7 name: Ліцензія №1 від 01.01.2022 stamps: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 user_added_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 created_at: 2022-12-21T11:18:51+0000 FinancialModelCode: description: 'Код СПФМ з довiдника' type: object properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Залучення фінансових активів із зобов’язанням щодо наступного їх повернення value: 04 FinancialModelRisk: description: 'Код СПФМ з довiдника' type: object properties: id: type: string format: uuid risks: type: array items: allOf: - $ref: '#/components/schemas/Risks' created_at: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 risks: Ризики описані в схемі ризиків created_at: "2022-11-07T13:57:04+02:00" FinancialModelH020: description: 'Код H020 з довiдника' type: object properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Залучення фінансових активів із зобов’язанням щодо наступного їх повернення value: 04 FinancialModelLicense: description: 'Ліцензії профіля СПФМ' type: object properties: id: type: string format: uuid name: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ліцензія №1 від 01.01.2022 Risks: description: 'Питання по ризикам' type: object properties: id: type: string format: uuid value: type: string maximum: 255 name: type: string maximum: 255 is_multiselect: type: boolean answers: type: array items: allOf: - $ref: '#/components/schemas/Answers' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 value: 501 name: "Чи наявні у небанківської установи внутрішні документи з питань фінансового моніторингу ?" is_multiselect": 0 answers: null Answers: description: 'Відпопіді на питання по ризикам' type: object properties: id: type: string format: uuid value: type: string maximum: 255 name: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Так (для НУ) value: 501 User: type: object required: - id - tenant - email - role properties: id: type: string format: uuid tenant: oneOf: - $ref: '#/components/schemas/Tenant' email: type: string format: email phone: type: string format: phone nullable: true role: oneOf: - $ref: '#/components/schemas/Role' permissions: type: array items: $ref: "#/components/schemas/Permission" financial_models: type: array items: $ref: "#/components/schemas/FinancialModelShort" example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 tenant: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Tenant name alias: tenant1 is_active: true owner_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 usreou_code: '12345678' email: example@example.com phone: '+380440000000' role: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: owner permissions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create counterpart - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create contract - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create declined payment - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view operation - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create financial model - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: create user - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: view counterpart financial_models: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша модель" alias: financialModel1 OperationCard: type: object properties: type: type: string enum: [card] card_number: type: string maximum: 19 minimum: 16 card_hash: type: string maximum: 64 minimum: 32 last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true required: - type - card_number - card_hash example: type: "card" card_number: "516874******9472" card_hash: 87b0f0788f101f0b11d1d1793deaedf74367b43f02035e2a191e530a9e41440c last_name: Smith first_name: John middle_name: Middle OperationContract: type: object properties: type: type: string enum: [contract] contract_id: type: string format: uuid required: - type - contract_id example: type: "contract" contract_id: "0ca00000-a000-000e-0d0f-0d0d00bab000" OperationFinancialModel: description: 'Виплата по договору на користь профіля СПФМ' type: object required: - type - financial_model_id - iban properties: type: type: string enum: [financial_model] financial_model_id: type: string format: uuid iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' example: type: "financial_model" financial_model_id: "0ca00000-a000-000e-0d0f-0d0d00bab000" iban: "UA012345000000000000001234567" Operation: type: object required: - paysystem_id - paysystem_name - type - terminal_name - payer - payee - amount - currency - order_description - processed_at properties: paysystem_id: type: string maximum: 255 paysystem_name: type: string maximum: 255 type: type: string enum: [registerPayment, epz, other, sdbo] terminal_id: type: string maximum: 100 nullable: true terminal_name: type: string maximum: 100 auth_code: type: string maximum: 100 nullable: true registry_reference_number: type: string maximum: 100 nullable: true mcc: type: string maximum: 4 nullable: true payer: oneOf: - $ref: '#/components/schemas/OperationCard' - $ref: '#/components/schemas/OperationContract' payee: oneOf: - $ref: '#/components/schemas/OperationCard' - $ref: '#/components/schemas/OperationContract' - $ref: '#/components/schemas/OperationFinancialModel' amount: type: number format: float original_amount: type: number format: float payout_amount: type: number format: float fee_external_amount: type: number format: float fee_internal_amount: type: number format: float currency: type: string enum: [UAH] initiator_ip: type: string format: ip initiator_email: type: string format: email initiator_account_number: type: string maximum: 100 order_description: type: string maximum: 1024 received_at: type: string format: date-time processed_at: type: string format: date-time country: type: string enum: [UKR] payee_is_public: type: boolean payer_is_public: type: boolean example: paysystem_id: "paysystem_operation_abc_1" paysystem_name: "amlsystem" type: "epz" terminal_id: "terminal_abc_2" terminal_name: "The terminal name." auth_code: "A0901" registry_reference_number: "11111111112" mcc: "9876" payer: { type: "card", card_number: "516874******9472", card_hash: 87b0f0788f101f0b11d1d1793deaedf74367b43f02035e2a191e530a9e41440c, last_name: Smith, first_name: John, middle_name: Middle } payee: { type: "contract", contract_id: "0ca00000-a000-000e-0d0f-0d0d00bab000" } amount: 999999.99 original_amount: 999999.99 fee_external_amount: 999999.99 fee_internal_amount: 999999.99 payout_amount: 999999.99 currency: "UAH" initiator_ip: "1.1.1.1" initiator_email: "example@example.com" initiator_account_number: "307546162244" order_description: "Invoice for the order #78453." received_at: "2022-06-08T11:18:51+0000" processed_at: "2022-06-08T11:18:51+0000" country: "UKR" payee_is_public: true payer_is_public: false OperationUpdate: type: object required: - paysystem_id properties: paysystem_id: type: string maximum: 255 amount: type: number format: float original_amount: type: number format: float payout_amount: type: number format: float fee_external_amount: type: number format: float fee_internal_amount: type: number format: float currency: type: string enum: [UAH] received_at: type: string format: date-time example: paysystem_id: "paysystem_operation_abc_1" amount: 999999.99 original_amount: 999999.99 fee_external_amount: 999999.99 fee_internal_amount: 999999.99 payout_amount: 999999.99 currency: "UAH" received_at: "2022-06-08T11:18:51+0000" DeclinedPayment: type: object required: - paysystem_id - paysystem_name - type - terminal_name - payer - payee - amount - currency - order_description - reason - processed_at properties: paysystem_id: type: string maximum: 255 paysystem_name: type: string maximum: 255 type: type: string enum: [registerPayment, epz, other, sdbo] terminal_name: type: string maximum: 100 payer: oneOf: - $ref: '#/components/schemas/OperationCard' - $ref: '#/components/schemas/OperationContract' payee: oneOf: - $ref: '#/components/schemas/OperationCard' - $ref: '#/components/schemas/OperationContract' - $ref: '#/components/schemas/OperationFinancialModel' amount: type: number format: float currency: type: string enum: [UAH] initiator_ip: type: string format: ip initiator_email: type: string format: email initiator_account_number: type: string maximum: 100 order_description: type: string maximum: 1024 reason: type: string maximum: 255 processed_at: type: string format: date-time example: paysystem_id: "paysystem_operation_abc_1" paysystem_name: "amlsystem" type: "epz" terminal_name: "The terminal name." payer: { type: "card", card_number: "516874******9472", last_name: Smith, first_name: John, middle_name: Middle, } payee: { type: "contract", contract_id: "0ca00000-a000-000e-0d0f-0d0d00bab000" } amount: 999999.9999 currency: "UAH" initiator_ip: "1.1.1.1" initiator_email: "example@example.com" initiator_account_number: "307546162244" order_description: "Invoice for the order #78453." processed_at: "2022-06-08T11:18:51+0000" reason: Match with RNBOU list. ShortCounterpart: description: 'Скорочена інформація по контрагенту' type: object required: - id properties: id: type: string format: uuid name: type: string maximum: 255 nullable: true last_name: type: string maximum: 255 nullable: true description: "Обов'язкове для фізичних осіб та нерезидентів" first_name: type: string maximum: 255 nullable: true description: "Обов'язкове для фізичних осіб та нерезидентів" middle_name: type: string maximum: 255 nullable: true description: "Обов'язкове для фізичних осіб та нерезидентів" usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах системи для резидентів юридичних осіб' nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'Унікальний РНОКПП в межах системи для резидентів ФОП' nullable: true non_resident_code: description: 'Унікальний код нерезидента в межах системи для нерезидентів' type: string maximum: 255 nullable: true example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: '"Контрагент.ЮА"' usreou_code: '12345678' itn_code: null non_resident_code: null CounterpartShortInfoInContract: description: 'Скорочена інформація по контрагенту у структурі контракту' type: object required: - id properties: id: type: string format: uuid name: type: string maximum: 255 nullable: true description: "Обов'язкове для фізичних осіб та нерезидентів" usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах системи для резидентів юридичних осіб' nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'Унікальний РНОКПП в межах системи для резидентів ФОП' nullable: true bank: type: string maximum: 255 nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПАТ "Перша компанія" usreou_code: "12345678" itn_code: null bank: "ПАТ Перший БАНК" iban: "UA012345000000000000001234567" ShortContract: description: 'Скорочена інформація по контракту у структурі контрагента' type: object required: - id - number properties: id: type: string format: uuid number: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 number: "12345678" Clarification: description: 'Частина картки контрагента, що відповідає за Вивчення клієнта' type: object required: - id properties: id: type: string format: uuid description: 'Id частини' executive_depth: type: string maximum: 255 nullable: true description: Дані про виконавчий орган is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами. publicity_date: type: string format: date nullable: true description: Дата виявлення належності до публічних осіб publicity_type: type: object nullable: true oneOf: - $ref: '#/components/schemas/PublicityType' is_public_description: type: string maximum: 255 nullable: true description: Коментарi до виявлення належності до публічних осіб is_terrorist: type: boolean nullable: true description: Клієнт включений до Переліку осіб, пов'язаних із здійсненням терористичної діяльності. is_terrorist_description: type: string maximum: 255 nullable: true description: Коментарi щодо включення до Переліку осіб, пов'язаних із здійсненням терористичної діяльності. has_sanctions: type: boolean nullable: true description: Клієнт включений до Переліку осіб стосовно яких застосовано міжнародні санкції. sanctions_description: type: string maximum: 255 nullable: true description: Коментарi щодо включення до Переліку осіб стосовно яких застосовано міжнародні санкції. is_aggressor: type: boolean nullable: true description: Клієнт має зв'язки з країною-агресором. is_aggressor_description: type: string maximum: 1000 nullable: true description: Коментарi щодо зв'язкiв з країною-агресором. has_separate_units: type: boolean nullable: true description: Наявність відокремлених підрозділів. has_parent_company: type: boolean nullable: true description: Наявність материнської компанії. is_nonprofit: type: boolean nullable: true description: Клієнт є благодійною/неприбутковою організацією. nonprofit_description: type: string maximum: 255 nullable: true description: Коментарi щодо перебування благодійною/неприбутковою організацією. risk_limitation: type: string maximum: 1000 description: Заходи для обмеження ризику використання з метою легалізації (відмивання) доходів, одержаних злочинним шляхом, або фінансування тероризму чи фінансування розповсюдження зброї масового знищення. property_commanders: type: array nullable: true items: oneOf: - $ref: '#/components/schemas/PropertyCommander' representatives: type: array nullable: true items: oneOf: - $ref: '#/components/schemas/Representative' parent_companies: type: array nullable: true items: oneOf: - $ref: '#/components/schemas/ParentCompany' separate_units: type: array nullable: true items: oneOf: - $ref: '#/components/schemas/SeparateUnit' owners: type: array nullable: true items: oneOf: - $ref: '#/components/schemas/OwnerIndividual' - $ref: '#/components/schemas/OwnerLegalPerson' beneficial_owners: type: array nullable: true items: oneOf: - $ref: '#/components/schemas/BeneficialOwner' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: директор is_public: false publicity_date: null publicity_type: null is_public_description: null is_terrorist: false is_terrorist_description: null has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: false nonprofit_description: null risk_limitation: null property_commanders: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" representatives: - id: 813de187-b9ad-4895-8996-10aa05ebf63a name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ itn_code: '1391938201' residence: Україна position: директор authority_basis: Збори is_public: false document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" parent_companies: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Материнська ТОВ usreou_code: '12345678' owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ code: '0987654321' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 owner_part: '66.7' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ code: '1234512345' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 owner_part: '33.3' beneficial_owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ birthday: '1983-07-01' itn_code: '1234512345' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 33,3 is_public: false separate_units: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Підрозділ ТОВ usreou_code: '12345678' ProfileMaintain: description: Частина картки контрагента, що відповідає за Ведення анкети type: object required: - id properties: id: type: string format: uuid description: 'Id частини' identification_status: description: Статус ідентифікації type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartIdentificationStatus' identification_date: description: Дата ідентификації type: string format: date nullable: true establishing_relations_date: description: Дата встановлення ділових відносин type: string format: date nullable: true video_verification_date: description: Дата проведення верифікації type: string format: date nullable: true video_verification_method: type: string maximum: 255 description: Спосіб проведення верифікації nullable: true stop_relations_date: description: Дата відмови від установлення /підтримання ділових (договірних) відносин nullable: true type: string format: date stop_relations_comment: type: string maximum: 255 description: Коментар щодо відмови від установлення /підтримання ділових (договірних) відносин nullable: true asset_freeze_date: description: Дата замороження активів type: string format: date nullable: true asset_unfreeze_date: description: Дата розмороження активів type: string format: date nullable: true clarification_date: description: Дата уточнення інформації type: string format: date nullable: true responsible_person: type: string maximum: 255 nullable: true description: Особа, відповідальна за здійснення ідентифікації та верифікації клієнта clarification_task: type: string maximum: 1000 nullable: true description: Задача на уточнення staging_date: description: Дата постановки задачі на уточнення type: string format: date nullable: true completion_date: description: Дата виконання задачі на уточнення type: string format: date nullable: true ending_relations_date: description: Дата завершення ділових відносин type: string format: date nullable: true example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 identification_status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' identification_date: '2022-02-08' establishing_relations_date: '2022-02-08' video_verification_date: '2022-01-21' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: Контролер О.Ю. clarification_task: null staging_date: null completion_date: null ending_relations_date: null ActivityEvaluation: description: 'Оцінка відповідності фін.операцій контрагента змісту його діяльності' type: object required: - id - date_at - start_at - end_at - evaluation_result properties: id: type: string format: uuid date_at: type: string format: date start_at: type: string format: date end_at: type: string format: date evaluation_result: type: object oneOf: - $ref: '#/components/schemas/ActivityEvaluationOption' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' StateEvaluation: description: 'Оцінка відповідності фін.операцій контрагента фінансовому стану' type: object required: - id - date_at - start_at - end_at - evaluation_result properties: id: type: string format: uuid date_at: type: string format: date start_at: type: string format: date end_at: type: string format: date evaluation_result: type: object oneOf: - $ref: '#/components/schemas/StateEvaluationOption' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' License: description: 'Ліцензії, дозволи на право здійснення певних операцій' type: object required: - id - number - issued_by - validity_date properties: id: type: string format: uuid description: 'Id' number: type: string maximum: 255 description: 'Серія та номер ліцензії/дозволу' issued_by: type: string maximum: 255 description: Ким виданий validity_date: type: string format: date description: Термін дії example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 number: '122311' issued_by: '39706018' validity_date: '2022-07-25' CrimeRisk: description: 'Рівень ризику проведення фінансових операцій з легалізації кримінальних доходів/фінансування тероризму.' type: object required: - id properties: id: type: string format: uuid description: 'Id' comment: type: string maximum: 255 nullable: true date: type: string format: date nullable: true risk_level: type: object nullable: true oneOf: - $ref: '#/components/schemas/CrimeRiskLevel' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: 1.1.2.11. Надання послуг, які важко документально підтвердити, що вони насправді були надані (наприклад, рекламні, маркетингові, консалтингові послуги, послуги з дослідження ринку). date: '2022-02-08' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low RiskManagement: description: 'Частина картки контрагента, що відповідає за Управління ризиками' type: object required: - id properties: id: type: string format: uuid description: 'Id частини' activity_content: type: string maximum: 1000 description: 'Зміст діяльності' nullable: true site: type: string format: url maximum: 255 description: Веб-сайт nullable: true business_purpose: type: string maximum: 1000 description: 'Мета та характер ділових відносин' nullable: true staff_number: type: integer description: Кількість працівників nullable: true fund_registered: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Зареєстрований cтатутний капітал nullable: true fund_paid: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Сплачений cтатутний капітал nullable: true depth_examination: type: string maximum: 1000 description: 'Заходи щодо здійснення поглибленої перевірки' nullable: true projected_amount: type: number format: float pattern: '^\d+(\.\d{1,2})?$' readOnly: true description: Прогнозний обсяг, тис. грн nullable: true net_profit: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Чистий прибуток/збиток, тис. грн nullable: true revenue: type: number format: float pattern: '^\d+(\.\d{1,2})?$' description: Дохід/виручка від реалізації продукції (товарів, робіт, послуг), тис. грн nullable: true client_services: type: string maximum: 1000 description: Види послуг, якими користується клієнт nullable: true tax_system: type: object nullable: true oneOf: - $ref: '#/components/schemas/TaxSystem' activities: type: array nullable: true items: allOf: - $ref: '#/components/schemas/CounterpartActivity' licenses: type: array nullable: true items: allOf: - $ref: '#/components/schemas/License' crime_risks: type: array nullable: true items: allOf: - $ref: '#/components/schemas/CrimeRisk' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: сервіс бронювання та продажу квитків на культурно-видовищні заходи site: https://example.com.ua business_purpose: договірні відносини з надання послуг з переказу коштів staff_number: 1 fund_registered: '70000' fund_paid: '70000' depth_examination: null projected_amount: '5000' net_profit: '0' revenue: '1241245' client_services: null tax_system: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Спрощена 3 група value: '3' activities: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Рекламні агентства value: '73.11' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Посередництво в розміщенні реклами в засобах масової інформації value: '73.12' licenses: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 number: '122311' issued_by: '39706018' validity_date: '2022-07-25' crime_risks: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: 1.1.2.11. Надання послуг, які важко документально підтвердити, що вони насправді були надані (наприклад, рекламні, маркетингові, консалтингові послуги, послуги з дослідження ринку). date: '2022-02-08' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low CounterpartLegalPerson: description: 'Картка контрагента юридичної особа (ЮО).' type: object required: - id - type - usreou_code - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid name: type: string maximum: 255 nullable: true type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' readOnly: true state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' updated_at: type: string format: date-time created_at: type: string format: date-time contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Юридична особа (ЮО) value: legal-person legal_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ value: '240' name: '"ТОВ ТОВ"' property_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Приватна value: '1' usreou_code: '38657536' itn_code: null state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Не перебуває в процесі припинення value: '3' status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Неактивный value: '2' state_registration_date: '2013-04-01' state_registration_number: '10234020000011234' postal_code: '03000' city: місто Київ address: Україна, 03000, місто Київ mfo: '123456' bank: АТ «Банк» iban: UA123405670000000026001234567 phone: '+380440000000' email: example@gmail.com document: null work: null temporary_stay: null contracts: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: директор is_public: false publicity_date: null publicity_type: null is_public_description: null is_terrorist: false is_terrorist_description: null has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: false nonprofit_description: null risk_limitation: null property_commanders: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ birthday: '1975-09-22' itn_code: '1234567890' document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false representatives: [] parent_companies: [] owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ code: '0987654321' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 owner_part: '66.7' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ code: '1234512345' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 owner_part: '33.3' beneficial_owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ birthday: '1983-07-01' itn_code: '1234512345' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 33,3 is_public: false separate_units: [] profile_maintain: identification_status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' identification_date: '2022-02-08' establishing_relations_date: '2022-02-08' video_verification_date: '2022-01-21' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: Контролер О.Ю. clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: сервіс бронювання та продажу квитків на культурно-видовищні заходи site: https://example.com.ua business_purpose: договірні відносини з надання послуг з переказу коштів staff_number: 1 fund_registered: '70000' fund_paid: '70000' depth_examination: null projected_amount: '5000' net_profit: '0' revenue: '1241245' client_services: null tax_system: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Спрощена 3 група value: '3' activities: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Рекламні агентства value: '73.11' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Посередництво в розміщенні реклами в засобах масової інформації value: '73.12' licenses: [] crime_risks: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: 1.1.2.11. Надання послуг, які важко документально підтвердити, що вони насправді були надані (наприклад, рекламні, маркетингові, консалтингові послуги, послуги з дослідження ринку). date: '2022-02-08' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low activity_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' state_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' has_receiving_contract: true has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-02-08T20:47:42+02:00' updated_at: '2022-07-08T17:22:32+03:00' non_resident_code: null country: null registration_authority: null registration_certificate: null CreateCounterpartLegalPerson: description: 'Параметри для створення юридичної особа (ЮО).' type: object required: - type - usreou_code - financial_model_id properties: type: type: string default: legal-person usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' example: type: legal-person usreou_code: '38657536' iban: UA123405670000000026001234567 financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartLegalPerson: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента юридичної особа (ЮО).' type: object properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 nullable: true property_form_id: type: string format: uuid nullable: true description: Id Форми власності з довiдника state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true example: name: '"ТОВ ТОВ"' property_form_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: '2013-04-01' state_registration_number: '10234020000011234' postal_code: '03000' city: місто Київ address: Україна, 03000, місто Київ mfo: '123456' bank: АТ «Банк» iban: UA123405670000000026001234567 phone: '+380440000000' email: example@gmail.com CounterpartGovernment: description: 'Картка контрагента Органу влади (ОВ).' type: object required: - id - type - usreou_code - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid name: type: string maximum: 255 nullable: true type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' readOnly: true state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' updated_at: type: string format: date-time created_at: type: string format: date-time example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Орган влади (ОВ) value: government-unit legal_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СУДОВА СИСТЕМА value: '415' name: 'Суд' property_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Державна value: '2' usreou_code: '38657536' itn_code: null contracts: null state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Не перебуває в процесі припинення value: '3' status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Неактивный value: '2' state_registration_date: '2013-04-01' state_registration_number: '10234020000011234' postal_code: '03000' city: місто Київ address: Україна, 03000, місто Київ mfo: '123456' bank: АТ «Банк» iban: UA123405670000000026001234567 phone: '+380440000000' email: example@gmail.com document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" work: null temporary_stay: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: директор is_public: false publicity_date: null publicity_type: null is_public_description: null is_terrorist: false is_terrorist_description: null has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: false nonprofit_description: null risk_limitation: null property_commanders: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ itn_code: '1234567890' document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false representatives: [] parent_companies: [] owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ code: '0987654321' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 owner_part: '66.7' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ code: '1234512345' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 owner_part: '33.3' beneficial_owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ birthday: '1983-07-01' itn_code: '1234512345' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 33,3 is_public: false separate_units: [] profile_maintain: identification_status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' identification_date: '2022-02-08' establishing_relations_date: '2022-02-08' video_verification_date: '2022-01-21' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: Контролер О.Ю. clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: сервіс бронювання та продажу квитків на культурно-видовищні заходи site: https://example.com.ua business_purpose: договірні відносини з надання послуг з переказу коштів staff_number: 1 fund_registered: '70000' fund_paid: '70000' depth_examination: null projected_amount: '5000' net_profit: '0' revenue: '1241245' client_services: null tax_system: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Спрощена 3 група value: '3' activities: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Рекламні агентства value: '73.11' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Посередництво в розміщенні реклами в засобах масової інформації value: '73.12' licenses: [] crime_risks: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: 1.1.2.11. Надання послуг, які важко документально підтвердити, що вони насправді були надані (наприклад, рекламні, маркетингові, консалтингові послуги, послуги з дослідження ринку). date: '2022-02-08' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low activity_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' state_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' has_receiving_contract: true has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-02-08T20:47:42+02:00' updated_at: '2022-07-08T17:22:32+03:00' non_resident_code: null country: null registration_authority: null registration_certificate: null CreateCounterpartGovernment: description: 'Параметри для створення Органу влади (ОВ).' type: object required: - type - usreou_code - financial_model_id properties: type: type: string default: government-unit usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' example: type: government-unit usreou_code: '38657536' iban: UA123405670000000026001234567 financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartGovernment: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента Органу влади (ОВ).' type: object properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 nullable: true property_form_id: type: string format: uuid nullable: true description: Id Форми власності з довiдника state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true example: name: 'Суд' property_form_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: '2013-04-01' state_registration_number: '10234020000011234' postal_code: '03000' city: місто Київ address: Україна, 03000, місто Київ mfo: '123456' bank: АТ «Банк» iban: UA123405670000000026001234567 phone: '+380440000000' email: example@gmail.com CounterpartSeparateUnit: description: 'Картка контрагента Відокремлений підрозділ (ВП).' type: object required: - id - type - usreou_code - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid name: type: string maximum: 255 nullable: true type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' readOnly: true state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' updated_at: type: string format: date-time created_at: type: string format: date-time contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Відокремлений підрозділ (ВП) value: separate-unit legal_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ДОЧІРНЄ ПІДПРИЄМСТВО value: '160' name: 'Філіал підприємства №1' property_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Приватна value: '1' usreou_code: '38657536' itn_code: null state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Не перебуває в процесі припинення value: '3' status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Неактивный value: '2' state_registration_date: '2013-04-01' state_registration_number: '10234020000011234' postal_code: '03000' city: місто Київ address: Україна, 03000, місто Київ mfo: '123456' bank: АТ «Банк» iban: UA123405670000000026001234567 phone: '+380440000000' email: example@gmail.com document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" work: null temporary_stay: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: директор is_public: false publicity_date: null publicity_type: null is_public_description: null is_terrorist: false is_terrorist_description: null has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: false nonprofit_description: null risk_limitation: null property_commanders: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ itn_code: '1234567890' document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false representatives: [] parent_companies: [] contracts: null owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ code: '0987654321' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 owner_part: '66.7' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ code: '1234512345' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 owner_part: '33.3' beneficial_owners: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СЕМЕНКО СЕМЕН СЕМЕНОВИЧ birthday: '1983-07-01' itn_code: '1234512345' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 33,3 is_public: false separate_units: [] profile_maintain: identification_status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' identification_date: '2022-02-08' establishing_relations_date: '2022-02-08' video_verification_date: '2022-01-21' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: Контролер О.Ю. clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: сервіс бронювання та продажу квитків на культурно-видовищні заходи site: https://example.com.ua business_purpose: договірні відносини з надання послуг з переказу коштів staff_number: 1 fund_registered: '70000' fund_paid: '70000' depth_examination: null projected_amount: '5000' net_profit: '0' revenue: '1241245' client_services: null tax_system: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Спрощена 3 група value: '3' activities: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Рекламні агентства value: '73.11' - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Посередництво в розміщенні реклами в засобах масової інформації value: '73.12' licenses: [] crime_risks: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: 1.1.2.11. Надання послуг, які важко документально підтвердити, що вони насправді були надані (наприклад, рекламні, маркетингові, консалтингові послуги, послуги з дослідження ринку). date: '2022-02-08' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low activity_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' state_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-08' start_at: '2022-02-08' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' has_receiving_contract: true has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-02-08T20:47:42+02:00' updated_at: '2022-07-08T17:22:32+03:00' non_resident_code: null country: null registration_authority: null registration_certificate: null CreateCounterpartSeparateUnit: description: 'Параметри для створення Відокремленого підрозділу (ВП).' required: - type - usreou_code - financial_model_id properties: type: type: string default: separate-unit usreou_code: type: string pattern: '^[\d]{8}$' description: 'Унікальний ЄДРПОУ в межах тенанта' financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' example: type: separate-unit usreou_code: '38657536' iban: UA123405670000000026001234567 financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartSeparateUnit: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента Відокремленого підрозділу (ВП).' type: object properties: name: type: string pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ maximum: 255 nullable: true property_form_id: type: string format: uuid nullable: true description: Id Форми власності з довiдника state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true example: name: 'Філіал' property_form_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: '2013-04-01' state_registration_number: '10234020000011234' postal_code: '03000' city: місто Київ address: Україна, 03000, місто Київ mfo: '123456' bank: АТ «Банк» iban: UA123405670000000026001234567 phone: '+380440000000' email: example@gmail.com CounterpartIndividualEntrepreneur: description: 'Картка контрагента Фізична особа-підприємець (ФОП)' type: object required: - id - type - itn_code - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' itn_code: type: string pattern: '^[\d]{10}$' description: 'Унікальний РНОКПП в межах тенанта' readOnly: true state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' updated_at: type: string format: date-time created_at: type: string format: date-time contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фізична особа-підприємець (ФОП) value: individual-entrepreneur legal_form: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПІДПРИЄМЕЦЬ-ФІЗИЧНА ОСОБА value: '910' last_name: ПЕТРЕНКО first_name: ГАЛИНА middle_name: ІГОРІВНА property_form: null usreou_code: null itn_code: '3210600123' state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Не перебуває в процесі припинення value: '3' state_registration_date: '2019-10-29' state_registration_number: '21190000000012345' postal_code: '03000' city: місто Івано-Франківськ address: Україна, 76493, Івано-Франківська обл., місто Івано-Франківськ mfo: '380805' bank: АТ «Банк», iban: UA123401230000000026003333444 phone: '+380440000000' email: example@gmail.com document: id: "7d1d896d-b9b2-405c-9a6f-5b53aace85b8" number: "3123433" series: "AT" issued_date: "2022-10-01" issued_by: "Деснянським РУ ГУ МВС" photo_date: "2022-10-01" usdr_code: "00000000-00000" citizenship: "Українець" status_date: "2022-10-01" birthday: "2022-10-01" birthplace: "Україна" valid_date: "2022-10-01" type: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Тимчасове посвідчення громадянина України" value: "tempCitizenCert" status: id: "d0857ea2-faab-41fa-a4f2-dc7454c0f697" name: "Втрачено" value: "lost" work: null temporary_stay: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: null is_public: false publicity_date: null publicity_type: null is_public_description: null is_terrorist: false is_terrorist_description: null has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: false nonprofit_description: null risk_limitation: null property_commanders: [] representatives: [] parent_companies: [] owners: [] beneficial_owners: [] separate_units: [] profile_maintain: identification_status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' identification_date: '2022-02-04' establishing_relations_date: '2022-02-04' video_verification_date: '2021-12-22' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: null clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: готельна діяльність site: https://example.com business_purpose: договірні відносини за надання послуг з переказу staff_number: 0 fund_registered: null fund_paid: null depth_examination: null projected_amount: '1500' net_profit: '0' revenue: '6794856' client_services: null tax_system: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Спрощена 2 група value: '2' activities: - id: 913c9b13-f364-4893-a8f1-e9422818c34c name: Діяльність засобів розміщування на період відпустки та іншого тимчасового проживання value: '55.20' licenses: [] crime_risks: - id: 57080cb7-c8ed-4d25-8bbb-f33cb3d96a7e comment: |- 1.1.1. Клієнт надає юридичні, консалтингові, бухгалтерські послуги або послуги із заснування суб'єктів господарювання та подальшого здійснення ними діяльності, відкриття рахунку в банку від., 1.1.2.11. Надання послуг, які важко документально підтвердити, що вони насправді були надані (наприклад, рекламні, маркетингові, консалтингові послуги, послуги з дослідження ринку). date: '2022-02-04' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low activity_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-04' start_at: '2022-02-04' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' state_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-04' start_at: '2022-02-04' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' has_receiving_contract: true has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-02-04T14:41:48+02:00' updated_at: '2022-02-04T14:55:51+02:00' non_resident_code: null country: null registration_authority: null registration_certificate: null contracts: null CreateCounterpartIndividualEntrepreneur: description: 'Параметри для створення контрагента Фізична особа-підприємець (ФОП)' required: - type - itn_code - financial_model_id properties: type: type: string default: individual-entrepreneur itn_code: type: string pattern: '^[\d]{10}$' description: 'Унікальний РНОКПП в межах тенанта' financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 nullable: true description: Прізвище ФОП first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 nullable: true description: Ім'я ФОП middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 nullable: true description: По батькові ФОП example: type: individual-entrepreneur itn_code: '3865753916' financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartIndividualEntrepreneur: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента Фізична особа-підприємець (ФОП)' type: object properties: last_name: type: string maximum: 255 pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ description: Прізвище ФОП first_name: type: string maximum: 255 pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ description: Ім'я ФОП middle_name: type: string maximum: 255 pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ description: По батькові ФОП state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true work: type: string maximum: 255 nullable: true description: Місце роботи, посада temporary_stay: type: string maximum: 255 nullable: true description: Місце тимчасового перебування на території України (для нерезидентів) example: last_name: ПЕТРЕНКО first_name: ГАЛИНА middle_name: ІГОРІВНА state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: '2019-10-29' state_registration_number: '21190000000012345' postal_code: '03000' city: місто Івано-Франківськ address: Україна, 76493, Івано-Франківська обл., місто Івано-Франківськ mfo: '380805' bank: АТ «Банк», iban: UA123401230000000026003333444 phone: '+380440000000' email: example@gmail.com work: null temporary_stay: null CounterpartIndividual: description: 'Картка контрагента Фізична особа (ФО)' type: object required: - id - last_name - first_name - middle_name - type - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid last_name: type: string maximum: 255 description: Прізвище first_name: type: string maximum: 255 description: Ім’я middle_name: type: string maximum: 255 description: По батькові type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' itn_code: type: string nullable: true pattern: '^[\d]{10}$' description: 'Унікальний РНОКПП в межах тенанта' readOnly: true state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true work: type: string maximum: 255 nullable: true description: Місце роботи, посада temporary_stay: type: string maximum: 255 nullable: true description: Місце тимчасового перебування на території України (для нерезидентів) clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' updated_at: type: string format: date-time created_at: type: string format: date-time contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фізична особа (ФО) value: individual legal_form: null last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ property_form: null usreou_code: null itn_code: '3210600123' state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Не перебуває в процесі припинення value: '3' state_registration_date: '2019-10-29' state_registration_number: '21190000000012345' postal_code: '03000' city: місто Івано-Франківськ address: Україна, 76493, Івано-Франківська обл., місто Івано-Франківськ mfo: '380805' bank: АТ «Банк», iban: UA123401230000000026003333444 phone: '+380440000000' email: example@gmail.com work: null temporary_stay: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: null is_public: false publicity_date: null publicity_type: null is_public_description: null is_terrorist: false is_terrorist_description: null has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: false nonprofit_description: null risk_limitation: null property_commanders: [] representatives: [] parent_companies: [] owners: [] beneficial_owners: [] separate_units: [] profile_maintain: identification_status: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' identification_date: '2022-02-04' establishing_relations_date: '2022-02-04' video_verification_date: '2021-12-22' video_verification_method: ондато stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: null clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: null site: https://example.com business_purpose: договірні відносини за надання послуг з переказу staff_number: 0 fund_registered: null fund_paid: null depth_examination: null projected_amount: '0' net_profit: '0' revenue: '0' client_services: null tax_system: null activities: [] licenses: [] crime_risks: [] activity_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-04' start_at: '2022-02-04' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' state_evaluations: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 date_at: '2022-02-04' start_at: '2022-02-04' end_at: '2022-03-31' evaluation_result: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Новий клієнт value: '0' has_receiving_contract: true has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-02-04T14:41:48+02:00' updated_at: '2022-02-04T14:55:51+02:00' non_resident_code: null country: null registration_authority: null registration_certificate: null contracts: null CreateCounterpartIndividual: description: 'Параметри для створення контрагента Фізична особа (ФО)' required: - type - itn_code - last_name - first_name - middle_name - financial_model_id properties: type: type: string default: individual financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' last_name: type: string maximum: 255 pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ description: Прізвище first_name: type: string maximum: 255 pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ description: Ім’я middle_name: type: string maximum: 255 pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ description: По батькові itn_code: type: string pattern: '^[\d]{10}$' description: 'Унікальний РНОКПП в межах тенанта' iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' example: type: individual last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartIndividual: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента Фізична особа (ФО)' type: object properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true work: type: string maximum: 255 nullable: true description: Місце роботи, посада temporary_stay: type: string maximum: 255 nullable: true description: Місце тимчасового перебування на території України (для нерезидентів) example: last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: '2019-10-29' state_registration_number: '21190000000012345' postal_code: '03000' city: місто Івано-Франківськ address: Україна, 76493, Івано-Франківська обл., місто Івано-Франківськ mfo: '380805' bank: АТ «Банк», iban: UA123401230000000026003333444 phone: '+380440000000' email: example@gmail.com work: null temporary_stay: null CounterpartIndividualNonResident: description: 'Картка контрагента Фізична особа(ФО) нерезидент' type: object required: - id - type - last_name - first_name - middle_name - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid last_name: type: string maximum: 255 description: Прізвище first_name: type: string maximum: 255 description: Ім’я middle_name: type: string maximum: 255 description: По батькові type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' non_resident_code: type: string maximum: 255 description: Унікальний код нерезидента в межах тенанта, якщо ім'я вже використовується nullable: true state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true work: type: string maximum: 255 nullable: true description: Місце роботи, посада temporary_stay: type: string maximum: 255 nullable: true description: Місце тимчасового перебування на території України (для нерезидентів) clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' updated_at: type: string format: date-time created_at: type: string format: date-time contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фізична особа(ФО) нерезидент value: individual-non-resident legal_form: null ast_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ property_form: null usreou_code: null itn_code: null state: null state_registration_date: null state_registration_number: null postal_code: null city: null address: null mfo: '320627' bank: АТ "КЛИМЕНБАНК" iban: UA123456270000026000013001234 phone: null email: null work: null temporary_stay: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: null is_public: null publicity_date: null publicity_type: null is_public_description: null is_terrorist: true is_terrorist_description: 28, 2020-01-17 00:00:00, Резолюції РБ ООН 1267 (1999) та 1989 (2011), SALIM, AHMAD, SALIM, HAMDAN, SALEM AHMED SALEM HAMDAN, SAQAR ALJAWADIC, SAQR AL-JADDAWI, SAQAR AL JADAWI has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: null nonprofit_description: null risk_limitation: null property_commanders: [] representatives: [] parent_companies: [] owners: [] beneficial_owners: [] separate_units: [] profile_maintain: identification_status: null identification_date: null establishing_relations_date: null video_verification_date: null video_verification_method: null stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: null clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: null site: null business_purpose: null staff_number: null fund_registered: null fund_paid: null depth_examination: null projected_amount: null net_profit: null revenue: null client_services: null tax_system: null activities: [] licenses: [] crime_risks: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: Має зв'язки з терористами. date: '2022-06-09' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Неприйнятно високий value: extremelyHight activity_evaluations: [] state_evaluations: [] has_receiving_contract: false has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-06-09T15:10:17+03:00' updated_at: '2022-07-07T16:43:09+03:00' non_resident_code: null country: null registration_authority: null registration_certificate: null contracts: null CreateCounterpartIndividualNonResident: description: 'Параметри для створення контрагента Фізична особа(ФО) нерезидент' required: - type - last_name - first_name - financial_model_id - non_resident_code properties: type: type: string default: individual-non-resident financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 nullable: true description: По батькові non_resident_code: type: string maximum: 255 nullable: true description: Унікальний код нерезидента в межах тенанта. Обовязковий, якщо ім'я вже використовується example: type: individual-non-resident last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ non_resident_code: some123 financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartIndividualNonResident: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента Фізична особа(ФО) нерезидент' type: object properties: last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Ім’я middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: По батькові state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата запису в ЄДРПОУ про проведення державної реєстрації' nullable: true state_registration_number: type: string pattern: '^(\d{17}(\d{2})?)$' description: 'Номер запису в ЄДРПОУ про проведення державної реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true work: type: string maximum: 255 nullable: true description: Місце роботи, посада temporary_stay: type: string maximum: 255 nullable: true description: Місце тимчасового перебування на території України (для нерезидентів) example: non_resident_code: code123 last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: '2019-10-29' state_registration_number: '21190000000012345' postal_code: '03000' city: місто Івано-Франківськ address: Україна, 76493, Івано-Франківська обл., місто Івано-Франківськ mfo: '380805' bank: АТ «Банк», iban: UA123401230000000026003333444 phone: '+380440000000' email: example@gmail.com work: SchweizBank temporary_stay: Україна CounterpartLegalNonResident: description: 'Картка контрагента Юридична особа (ЮО) нерезидент' type: object required: - id - type - name - clarification - profile_maintain - risk_management - created_at properties: id: type: string format: uuid name: type: string maximum: 255 type: type: object oneOf: - $ref: '#/components/schemas/CounterpartType' readOnly: true legal_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/LegalForm' readOnly: true property_form: type: object nullable: true oneOf: - $ref: '#/components/schemas/PropertyForm' state: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartState' status: type: object nullable: true oneOf: - $ref: '#/components/schemas/CounterpartStatus' non_resident_code: type: string maximum: 255 nullable: true description: Унікальний код нерезидента в межах тенанта, якщо ім'я вже використовується state_registration_date: type: string format: date description: 'Дата проведення реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true country: type: string maximum: 50 nullable: true description: Країна реєстрації registration_authority: type: string maximum: 255 nullable: true description: Орган реєстрації registration_certificate: type: string maximum: 255 nullable: true description: Реквізити свідоцтва про реєстрацію clarification: $ref: '#/components/schemas/Clarification' profile_maintain: $ref: '#/components/schemas/ProfileMaintain' risk_management: $ref: '#/components/schemas/RiskManagement' activity_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ActivityEvaluation' state_evaluations: type: array nullable: true items: allOf: - $ref: '#/components/schemas/StateEvaluation' updated_at: type: string format: date-time created_at: type: string format: date-time contracts: type: array nullable: true items: allOf: - $ref: '#/components/schemas/ShortContract' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Юридична особа (ЮО) нерезидент value: legal-non-resident legal_form: null name: AL-QAIDA IN THE ARABIAN PENINSULA (AQAP) property_form: null usreou_code: null itn_code: null state: null status: null state_registration_date: null state_registration_number: null postal_code: null city: null address: null mfo: null bank: null iban: null phone: null email: null work: null temporary_stay: null clarification: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 executive_depth: null is_public: null publicity_date: null publicity_type: null is_public_description: null is_terrorist: true is_terrorist_description: 165, 2016-07-02 00:00:00, Резолюції РБ ООН 1267 (1999), 1989 (2011) та 2253 , AL-QAIDA IN THE ARABIAN PENINSULA (AQAP), ANSAR AL-SHARI'A (AAS), AL-QAIDA OF JIHAD ORGANIZATION IN THE ARABIAN PENINSULA, AL-QAIDA IN THE SOUTH ARABIAN PENINSULA, AL-QAIDA IN YEMEN (AQY), AL-QAIDA ORGANIZATION IN THE ARABIAN PENINSULA (AQAP), TANZIM QA’IDAT AL-JIHAD FI JAZIRAT AL-ARAB has_sanctions: false sanctions_description: null is_aggressor: false is_aggressor_description: null has_separate_units: false has_parent_company: false is_nonprofit: null nonprofit_description: null risk_limitation: null property_commanders: [] representatives: [] parent_companies: [] owners: [] beneficial_owners: [] separate_units: [] profile_maintain: identification_status: null identification_date: null establishing_relations_date: null video_verification_date: null video_verification_method: null stop_relations_date: null stop_relations_comment: null asset_freeze_date: null asset_unfreeze_date: null clarification_date: null responsible_person: null clarification_task: null staging_date: null completion_date: null ending_relations_date: null risk_management: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 activity_content: null site: null business_purpose: null staff_number: null fund_registered: null fund_paid: null depth_examination: null projected_amount: null net_profit: null revenue: null client_services: null tax_system: null activities: [] licenses: [] crime_risks: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 comment: Має зв'язки з терористами. date: '2022-06-09' risk_level: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Неприйнятно високий value: extremelyHight activity_evaluations: [] state_evaluations: [] has_receiving_contract: false has_receiving_payment_contract: false has_payment_contract: false created_at: '2022-06-09T15:05:42+03:00' updated_at: '2022-06-09T15:06:35+03:00' non_resident_code: null country: null registration_authority: null registration_certificate: null contracts: null CreateCounterpartLegalNonResident: description: 'Параметри для створення контрагента Юридична особа (ЮО) нерезидент' required: - type - name - financial_model_id - non_resident_code properties: type: type: string default: legal-non-resident financial_model_id: type: string description: 'ID профілю спфм (обовʼязково, якщо у тенанта не один профіль СПФМ)' name: type: string pattern: ^(?:(?![ЁёЫыЪъЭэ])[\d\s\p{Cyrillic}"()'-]+|[\d\s\p{Latin}"()\'-]+)$/u maximum: 255 description: Повне найменування контрагента non_resident_code: type: string maximum: 255 description: Унікальний код нерезидента в межах тенанта, якщо назва вже використовується example: type: legal-non-resident name: SchweizBank non_resident_code: some123 financial_model_id: d32f749c-fd07-429a-a291-a686532d40fc UpdateCounterpartLegalNonResident: description: 'Параметри для оновлення вкладки Ідентифікаційні дані контрагента Юридична особа (ЮО) нерезидент' type: object properties: name: type: string pattern: ^(?:(?![ЁёЫыЪъЭэ])[\d\s\p{Cyrillic}"()'-]+|[\d\s\p{Latin}"()\'-]+)$/u maximum: 255 property_form_id: type: string format: uuid nullable: true description: Id Форми власності з довiдника state_id: type: string format: uuid nullable: true description: Id юридичного статусу з довiдника status_id: type: string format: uuid nullable: true description: Id статусу ділових відносин з довiдника state_registration_date: type: string format: date description: 'Дата проведення реєстрації' nullable: true postal_code: type: string pattern: '^[\d]{5}$' nullable: true city: type: string maximum: 255 nullable: true address: type: string maximum: 255 nullable: true mfo: type: string pattern: '^[\d]{6}$' description: 'Код МФО банка контрагента' nullable: true bank: type: string maximum: 255 description: 'Банк, в якому відкрито рахунок' nullable: true iban: type: string format: iban pattern: '^UA\d{8}[A-Z0-9]{19}$' nullable: true description: 'Номер рахунку' phone: type: string format: phone nullable: true email: type: string format: email nullable: true country: type: string maximum: 50 nullable: true description: Країна реєстрації registration_authority: type: string maximum: 255 nullable: true description: Орган реєстрації registration_certificate: type: string maximum: 255 nullable: true description: Реквізити свідоцтва про реєстрацію example: name: ZürcherBank property_form_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 status_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 state_registration_date: null country: Schweiz registration_authority: Zürcher registration_certificate: 123 postal_code: null city: null address: null mfo: null bank: null iban: null phone: null email: null Contract: description: 'Картка договору' type: object required: - id - number - issued_date - counterpart - financial_model - created_at properties: id: type: string format: uuid number: type: string maximum: 255 description: Номер договору issued_date: type: string format: date description: Дата укладання договору ceo: type: string maximum: 255 nullable: true description: Директор internal_fee: type: number format: float description: Внутрішня комісія (тариф, %) internal_fee_comment: type: string maximum: 255 nullable: true description: Внутрішня комісія коментар external_fee: type: number format: float description: Зовнішня комісія (тариф, %) external_fee_comment: type: string maximum: 255 nullable: true description: Зовнішня комісія коментар auto_payout: type: boolean nullable: true description: Дозволити автоматичне формування виплат payment_destination_note: type: string maximum: 255 nullable: true description: Опис коду призначення платежу payout_destination_note: type: string maximum: 255 nullable: true description: Опис коду призначення виплати updated_at: type: string format: date-time created_at: type: string format: date-time type: description: Тип договору з довiдника oneOf: - $ref: '#/components/schemas/ContractType' state: description: Статус договору з довiдника oneOf: - $ref: '#/components/schemas/ContractState' payout_period: description: Період виплати з довiдника oneOf: - $ref: '#/components/schemas/PayoutPeriod' nullable: true payment_methods: description: Платіжні методи з довiдника type: array items: $ref: '#/components/schemas/PaymentMethod' nullable: true counterpart: oneOf: - $ref: '#/components/schemas/CounterpartShortInfoInContract' payment_destination_code: description: Обов'язковий якщо по договору будуть операції на прийом коштів oneOf: - $ref: '#/components/schemas/PaymentDestinationCode' nullable: true payout_destination_code: description: Обов'язковий якщо по договору будуть операції на виплату коштів oneOf: - $ref: '#/components/schemas/PayoutDestinationCode' nullable: true payment_directions: type: array items: $ref: '#/components/schemas/PaymentDirection' nullable: true description: Псевдонім або alias financial_model: oneOf: - $ref: "#/components/schemas/FinancialModelShort" last_name: type: string maximum: 255 nullable: true description: Прізвище first_name: type: string maximum: 255 nullable: true description: Ім'я middle_name: type: string maximum: 255 nullable: true description: По батькові example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 number: 12345 issued_date: '2022-07-18' ceo: Тарасов Ігор Павлович internal_fee: 2.4 internal_fee_comment: виплати 1% external_fee: 0 external_fee_comment: null auto_payout: true payment_destination_note: null payout_destination_note: null counterpart: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: 'КОМПАНІЯ "Перша"' usreou_code: '12345678' itn_code: null bank: АТ "Банк" iban: UA012345000000000000001234567 payment_destination_code: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет value: '33' payout_destination_code: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Виплата виграшів гравцям азартних ігор казино в мережі Інтернет value: '45' payout_period: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: По понеділкам value: byMonday state: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Діючий value: '0' type: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Договір про переказ коштів (прийом+виплата) value: type3 payment_directions: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Some12345 financial_model: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТОВ "Перша" alias: first1 payment_methods: - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ЕПЗ value: epz - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: СДБО value: sdbo - id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Реєстрові платежі (Безнал + Реестр) value: registerPayment updated_at: '2022-07-18T11:33:27+03:00' created_at: '2022-07-18T11:33:27+03:00' last_name: Тарасенко first_name: Тарас middle_name: Тарасович OldContract: description: 'Стара схема картки договору' type: object required: - _id - contractNumber - counterpart_id - issuedDate - counterpart - financial_model - created_at properties: _id: type: string format: uuid contractNumber: type: string maximum: 255 counterpart_id: type: string format: uuid issuedDate: type: string format: date CEO: type: string maximum: 255 nullable: true contractType: description: Значення типу договору з довiдника type: string maximum: 255 status: description: Значення статусу договору з довiдника type: integer internalFeeRate: type: number format: float internalFeeRateComment: type: string maximum: 255 nullable: true externalFeeRate: type: number format: float externalFeeRateComment: type: string maximum: 255 nullable: true payoutAuto: type: boolean nullable: true payout_period: description: Значення періоду виплати з довiдника type: string maximum: 255 nullable: true f108Note: type: string maximum: 255 nullable: true payoutf108Note: type: string maximum: 255 nullable: true f108: description: Обов'язковий якщо по договору будуть операції на прийом коштів type: integer nullable: true payoutf108: description: Обов'язковий якщо по договору будуть операції на виплату коштів type: integer nullable: true updated_at: type: string format: date-time created_at: type: string format: date-time paymentMethod: description: Платіжні методи з довiдника type: array items: type: string enum: [registerPayment, epz, other, sdbo] alias: type: array items: $ref: '#/components/schemas/OldPaymentDirection' nullable: true bank: description: Alias профілю СПФМ type: string maximum: 255 counterpart: oneOf: - $ref: '#/components/schemas/OldCounterpart' last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractNumber: '12345' counterpart_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 contractType: type2 status: 0 CEO: Тарас Тарасович Тарасенко internalFeeRate: 1 internalFeeRateComment: null externalFeeRate: 0 externalFeeRateComment: null payoutPeriod: null payoutAuto: false f108: 0 f108Note: null payoutf108: 33 payoutf108Note: null issuedDate: '2022-07-13' created_at: '2022-07-13T11:31:32+03:00' updated_at: '2022-07-13T11:33:27+03:00' paymentMethod: - epz - sdbo - registerPayment - other alias: - id: '1234' - id: '23455' bank: first1 last_name: Тарасенко first_name: Тарас middle_name: Тарасович counterpart: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 counterpartType: individual-entrepreneur legalForm: '910' fullName: Тарас Тарасович Тарасенко typeOfOwnership: null phone: '+380440000000' email: example@example.com birthDay: '2020-08-05' state: 1 created: '2020-04-29T14:13:31+03:00' updated: '2021-02-22T15:45:26+02:00' billing: edrpou: '3312312555' mfo: '123456' bank: MyOwnCreditBank settlementAccount: UA999999999999999999999999999 stateRegistration: date: '2222-02-21T22:00:00.000000Z' number: '0000000000000000001' location: postalCode: '12367' city: Kyiv address: some_address doc: citizenship: Укр type: passport number: НЕ 9493 issuedDate: '2020-07-31' issuedBy: Some state organ photoDate: '2020-08-08' eddr: 00000000-00000 activityEvaluation: [] stateEvaluation: [] executiveDepth: null relationToPublicPersons: false publicity_date: null publicity_type: null clientIncludedList: false hasSeparateUnit: false hasParentCompany: false clientCharityNonprofit: false publicRelationDescription: null clientIncludedListDesc: null clientCharityNonprofitDesc: null riskLimitation: null clientRepresentative: [] propertyParticipant: [] ownershipStructure: [] beneficiary: [] separateUnit: [] parentCompany: [] activityContent: null site: null relationshipType: null staffNum: 0 inDepthExamination: null financialState: taxSystem: null maxPermisVolume: 0 netProfit: 0 revenue: 0 authorisedCapital: registered: '0' paid: '0' activityType: [] licences: [] crimeRiskLevel: [] identificationStatus: 0 identificationDate: null establishingBusinessRelationsDate: null videoVerificationDate: null videoVerificationMethod: null stoppingBusinessRelationsDate: null stoppingBusinessRelations: null ending_relations_date: null assetFreezeDate: null assetUnfreezeDate: null clarificationDate: null responsiblePerson: null clarificationTask: null clarificationTaskStartDate: null clarificationTaskEndDate: null birthplace: null work: null temporary_stay: null client_services: null country: null registration_authority: null registration_certificate: null contract: [] OldCounterpart: description: Старий формат картки контрагента' type: object example: _id: 0ca00000-a000-000e-0d0f-0d0d00bab000 counterpartType: individual-entrepreneur legalForm: '910' fullName: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ last_name: ТАРАСЕНКО first_name: ТАРАС middle_name: ТАРАСОВИЧ typeOfOwnership: null phone: '+380440000000' email: example@example.com birthDay: '2020-08-05' state: 1 created: '2020-04-29T14:13:31+03:00' updated: '2021-02-22T15:45:26+02:00' billing: edrpou: '3312312555' mfo: '123456' bank: MyOwnCreditBank settlementAccount: UA999999999999999999999999999 stateRegistration: date: '2222-02-21T22:00:00.000000Z' number: '0000000000000000001' location: postalCode: '12367' city: Kyiv address: some_address doc: citizenship: Укр type: passport number: НЕ 9493 issuedDate: '2020-07-31' issuedBy: Some state organ photoDate: '2020-08-08' eddr: 00000000-00000 activityEvaluation: [] stateEvaluation: [] executiveDepth: null relationToPublicPersons: false publicity_date: null publicity_type: null clientIncludedList: false hasSeparateUnit: false hasParentCompany: false clientCharityNonprofit: false publicRelationDescription: null clientIncludedListDesc: null clientCharityNonprofitDesc: null riskLimitation: null clientRepresentative: [] propertyParticipant: [] ownershipStructure: [] beneficiary: [] separateUnit: [] parentCompany: [] activityContent: null site: null relationshipType: null staffNum: 0 inDepthExamination: null financialState: taxSystem: null maxPermisVolume: 0 netProfit: 0 revenue: 0 authorisedCapital: registered: '0' paid: '0' activityType: [] licences: [] crimeRiskLevel: [] identificationStatus: 0 identificationDate: null establishingBusinessRelationsDate: null videoVerificationDate: null videoVerificationMethod: null stoppingBusinessRelationsDate: null stoppingBusinessRelations: null ending_relations_date: null assetFreezeDate: null assetUnfreezeDate: null clarificationDate: null responsiblePerson: null clarificationTask: null clarificationTaskStartDate: null clarificationTaskEndDate: null birthplace: null work: null temporary_stay: null client_services: null country: null registration_authority: null registration_certificate: null contract: [] PaymentDestinationCode: description: 'Код призначення платежу (F108) з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет value: "33" PayoutDestinationCode: description: 'Код призначення виплати (F108) з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Виплата виграшів гравцям азартних ігор казино в мережі Інтернет value: "45" CounterpartType: description: 'Тип контрагенту з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Юридична особа (ЮО) value: 'legal-person' CounterpartIdentificationStatus: description: 'Статус ідентифікації кнтрагента з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Ідентифікація та верифікація проведена value: '0' CounterpartActivity: description: 'Вид діяльності контрагента з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Видання комп'ютерних ігор value: '58.21' CounterpartState: description: 'Юридичний статус контрагенту з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Не перебуває в процесі припинення value: '3' CounterpartStatus: description: 'Статус ділових відносин контрагенту з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Неактивный value: '2' TaxSystem: description: 'Cистема оподаткування контрагента з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Загальна value: '1' ActivityEvaluationOption: description: 'Оцінка відповідності фін.операцій контрагента змісту його діяльності з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фінансові операції відповідають змісту діяльності value: '1' StateEvaluationOption: description: 'Оцінка відповідності фін.операцій контрагента фінансовому стану з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Фінансові операції відповідають фінансовому стану value: '1' ContractType: description: 'Тип договору з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Договір про переказ коштів (прийом+виплата) value: 'type3' Paysystem: description: 'Платіжна система з довiдника НБУ' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Western Union value: '03' PropertyForm: description: 'Тип власностi з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Приватна value: '1' LegalForm: description: 'Юридичний тип з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ value: '240' DocumentType: description: 'Тип документа з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Паспорт громадянина України value: passport DocumentStatus: description: 'Статус документа з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Втрачено value: lost PropertyCommander: description: 'Ідентифікаційні дані особи, яка має право розпоряджатися рахунками та/або майном' type: object required: - id - name properties: id: type: string format: uuid name: type: string maximum: 255 itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true residence: type: string maximum: 255 nullable: true description: Місце проживання або перебування в Україні position: type: string maximum: 255 nullable: true description: Посада authority_basis: type: string maximum: 255 nullable: true description: Підстава повноважень is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false Representative: description: 'Ідентифікаційні дані представника клієнта (за наявності таких осіб)' type: object required: - id - name properties: id: type: string format: uuid name: type: string maximum: 255 itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true residence: type: string maximum: 255 nullable: true description: Місце проживання або перебування в Україні position: type: string maximum: 255 nullable: true description: Посада authority_basis: type: string maximum: 255 nullable: true description: Підстава повноважень is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ТАРАСЕНКО ТАРАС ТАРАСОВИЧ itn_code: '1234567890' residence: м.Київ, проспект Леся Курбаса position: директор authority_basis: Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012 is_public: false ParentCompany: description: 'Материнська компанія' type: object required: - id - name - usreou_code properties: id: type: string format: uuid name: type: string maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'ЄДРПОУ' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Материнська ТОВ usreou_code: '12345678' SeparateUnit: description: 'Підрозділ' type: object required: - id - name - usreou_code properties: id: type: string format: uuid name: type: string maximum: 255 usreou_code: type: string pattern: '^[\d]{8}$' description: 'ЄДРПОУ' example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Підрозділ ТОВ usreou_code: '12345678' OwnerLegalPerson: description: 'Пряме володіння із зазначенням частки' type: object required: - id - name - type - code properties: id: type: string format: uuid type: type: string description: Тип особи name: type: string maximum: 255 pattern: ^([\\d\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ\"№()+.,'-]+|[\\d\\sA-z\"№()+.,'-]+)$ description: ПІБ/Назва code: pattern: '/(^[\d]{8}$)|(^[\d]{10}$)/' description: 'РНОКПП/код за ЄДРПОУ' nullable: true address: type: string maximum: 255 nullable: true description: Адреса реєстрації owner_part: type: string pattern: '(^100([.]0{1,2})?)$|(^\d{1,2}([.]\d{1,2})?)$' nullable: true description: Частка у капіталі example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ code: '0987654321' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 owner_part: '66.7' type: 'legal-person' OwnerIndividual: description: 'Пряме володіння із зазначенням частки' type: object required: - id - last_name - first_name - type properties: id: type: string format: uuid type: type: string description: Тип особи last_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: Прізвище first_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 description: І'мя middle_name: type: string pattern: ^([\\sйцукенгшщзхїґфивапролджєячсмітьбюЙЦУКЕНГШЩЗХЇҐФИВАПРОЛДЖЄЯЧСМІТЬБЮ()'-]+|[\\sA-z()'-]+)$ maximum: 255 nullable: true description: По батькові code: pattern: '/(^[\d]{8}$)|(^[\d]{10}$)/' description: 'РНОКПП/код за ЄДРПОУ' nullable: true address: type: string maximum: 255 nullable: true description: Адреса реєстрації owner_part: type: string pattern: '(^100([.]0{1,2})?)$|(^\d{1,2}([.]\d{1,2})?)$' nullable: true description: Частка у капіталі example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: ПЕТРЕНКО first_name: ПЕТРО middle_name: ПЕТРОВИЧ code: '0987654321' address: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 owner_part: '66.7' type: individual BeneficialOwner: description: 'Дані про фізичну особу, що є кінцевими бенефіціарним власником (контролером)' type: object required: - id - name properties: id: type: string format: uuid name: type: string maximum: 255 birthday: type: string format: date nullable: true itn_code: type: string pattern: '^[\d]{10}$' description: 'РНОКПП особи' nullable: true country: type: string maximum: 255 nullable: true description: Країна проживання citizenship: type: string maximum: 255 nullable: true description: Країна громадянства influence_basis: type: string maximum: 255 nullable: true description: Підстава впливу is_public: type: boolean nullable: true description: Належність до публічних осіб, до осіб, близьких або пов'язаних з публічними особами example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ birthday: '1986-07-18' itn_code: '0987654321' country: Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12 citizenship: Україна influence_basis: частка статутного капіталу 66,7 is_public: false PublicityType: description: 'Тип публічного діяча з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Національні публічні діячі value: '1' ContractState: description: 'Статус договору з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Діючий value: "0" PayoutPeriod: description: 'Період виплати з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: По понеділкам value: "byMonday" CrimeRiskLevel: description: 'Рівень ризику з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: Низький value: low PaymentMethod: description: 'Платіжний метод з довiдника' type: object required: - id - name - value properties: id: type: string format: uuid name: type: string maximum: 255 value: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: 'ЕПЗ' value: "epz" PaymentDirection: description: 'Платіжний напрямок по контракту' type: object required: - id - name properties: id: type: string format: uuid name: type: string maximum: 255 example: id: 0ca00000-a000-000e-0d0f-0d0d00bab000 name: 'SomeString' OldPaymentDirection: description: 'Стара схема платіжного напрямку по контракту' type: object required: - id properties: id: type: string maximum: 255 example: id: SomeString Links: description: '' type: object required: - first - last - next - prev properties: first: type: string format: url last: type: string format: url next: type: string format: url nullable: true prev: type: string format: url nullable: true Meta: description: '' type: object required: - current_page - from - last_page - path - per_page - to - total - links properties: current_page: type: integer from: type: integer last_page: type: integer path: type: string format: url per_page: type: integer to: type: integer total: type: integer links: type: array items: $ref: '#/components/schemas/MetaLinks' MetaLinks: description: '' type: object required: - url - label - active properties: url: type: string format: url nullable: true label: type: string active: type: boolean ContractOnTransferOfFundsReception: description: 'Договір про переказ коштів (прийом)' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractFundTransferPayment: description: 'Договір про переказ коштів (виплата)' required: - issued_date - number - type_id - payout_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractFundTransferPaymentAndReceipt: description: 'Договір про переказ коштів (прийом+виплата)' required: - issued_date - number - type_id - payout_destination_code_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractWithThePaymentSystem: description: 'Договір з платіжною системою' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractOnCooperation: description: 'Договір про співробітництво' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractOperatingLease: description: 'Договір операційного лізингу' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractFinancialLeasing: description: 'Договір фінансового лізингу' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractOfOSCPVV: description: 'Договір ОСЦПВВ' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractMedicalInsurance: description: 'Договір медичного страхування' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractLifeInsurance: description: 'Договір страхування життя' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractLiabilityInsurance: description: 'Договір страхування відповідальності' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractReinsurance: description: 'Договір перестрахування' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name ContractPropertyInsurance: description: 'Договір страхування майна' required: - issued_date - number - type_id - payment_destination_code_id properties: issued_date: type: string format: date-time number: type: string maximum: 255 type_id: description: Тип договору з довiдника (id) type: string format: uuid internal_fee: type: number format: float nullable: true internal_fee_comment: type: string maximum: 255 nullable: true external_fee: type: number format: float nullable: true external_fee_comment: type: string maximum: 255 nullable: true auto_payout: type: boolean nullable: true payment_destination_note: type: string maximum: 255 nullable: true payout_destination_note: type: string maximum: 255 nullable: true state_id: description: Статус договору з довiдника (id) type: string format: uuid nullable: true payout_period: description: Період виплати з довiдника (id) type: string format: uuid nullable: true payment_destination_code_id: description: Код призначення платежу (F108) з довiдника. Обов'язковий якщо по договору будуть операції на прийом коштів type: string format: uuid nullable: true payout_destination_code_id: description: Код призначення виплати (F108) з довiдника. Обов'язковий якщо по договору будуть операції на виплату коштів type: string format: uuid nullable: true last_name: type: string maximum: 255 nullable: true first_name: type: string maximum: 255 nullable: true middle_name: type: string maximum: 255 nullable: true example: issued_date: '2022-07-20' number: '1234' type_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payment_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 payout_destination_code_id: 0ca00000-a000-000e-0d0f-0d0d00bab000 last_name: Last Name first_name: First Name middle_name: Middle Name CreatePassportDocument: description: Створення паспорту громадянина України required: - type_id - number - series properties: type_id: type: string description: Тип документа з довідника (потрібно обрати паспорт) oneOf: - $ref: '#/components/schemas/DocumentType' number: type: string maximum: 6 minimum: 6 description: Номер документа series: type: string maximum: 2 minimum: 2 description: Серія документа birthday: type: string format: date nullable: true description: Дата народження birthplace: type: string maximum: 255 nullable: true description: Місце народження citizenship: type: string maximum: 255 nullable: true description: Громадянство issued_date: type: string format: date nullable: true description: Дата видачі паспорта issued_by: type: string maximum: 255 nullable: true description: Ким виданий паспорт photo_date: type: string format: date nullable: true description: Дата фото в паспорті example: type_id: c1fa8c54-2475-4079-9066-19a5ece78b20 number: 2341441 series: AT birthday: 2000-01-01 birthplace: місто Київ citizenship: Українець issued_date: 2014-01-01 issued_by: Деснянський РУГУ photo_date: 2014-01-01 CreatePassportIdDocument: description: Створення паспорту громадянина України (ІД картка) required: - type_id - number properties: type_id: type: string description: Тип документа з довідника (потрібно обрати ід картку) oneOf: - $ref: '#/components/schemas/DocumentType' number: type: string maximum: 9 minimum: 9 description: Номер документа birthday: type: string format: date nullable: true description: Дата народження birthplace: type: string maximum: 255 nullable: true description: Місце народження citizenship: type: string maximum: 255 nullable: true description: Громадянство issued_date: type: string format: date nullable: true description: Дата видачі паспорта issued_by: type: string maximum: 255 nullable: true description: Ким виданий паспорт usdr_code: type: string pattern: '/^[\d]{8}-[\d]{5}$/' nullable: true description: Унікальний номер запису в єдиному демографічному реєстрі valid_date: type: string format: date nullable: true description: Дата дії документу example: type_id: c1fa8c54-2475-4079-9066-19a5ece78b20 number: 2341441777 birthday: 2000-01-01 birthplace: місто Київ citizenship: Українець issued_date: 2014-01-01 issued_by: Деснянський РУГУ usdr_code: 12313213-12312 valid_date: 2024-01-01 CreateDefaultDocument: description: Створення інших документів окрім (поспорта та ІД картка) required: - type_id properties: type_id: type: string description: Тип документа з довідника (потрібно обрати інші типи окрім паспорта та ІД картки) oneOf: - $ref: '#/components/schemas/DocumentType' number: type: string maximum: 50 nullable: true description: Номер документа series: type: string maximum: 10 nullable: true description: Серія документа birthday: type: string format: date nullable: true description: Дата народження birthplace: type: string maximum: 255 nullable: true description: Місце народження citizenship: type: string maximum: 255 nullable: true description: Громадянство issued_date: type: string format: date nullable: true description: Дата видачі паспорта issued_by: type: string maximum: 255 nullable: true description: Ким виданий паспорт photo_date: type: string format: date nullable: true description: Дата фото в паспорті usdr_code: type: string pattern: '/^[\d]{8}-[\d]{5}$/' nullable: true description: Унікальний номер запису в єдиному демографічному реєстрі valid_date: type: string format: date nullable: true description: Дата дії документу example: type_id: c1fa8c54-2475-4079-9066-19a5ece78b20 number: 2341441 series: AT birthday: 2000-01-01 birthplace: місто Київ citizenship: Українець issued_date: 2014-01-01 issued_by: Деснянський РУГУ photo_date: 2014-01-01 usdr_code: 12313213-12312 valid_date: 2024-01-01 UpdatePassportDocument: description: Оновлення паспорту громадянина України required: - number - series properties: number: type: string maximum: 6 minimum: 6 description: Номер документа series: type: string maximum: 2 minimum: 2 description: Серія документа birthday: type: string format: date nullable: true description: Дата народження birthplace: type: string maximum: 255 nullable: true description: Місце народження citizenship: type: string maximum: 255 nullable: true description: Громадянство issued_date: type: string format: date nullable: true description: Дата видачі паспорта issued_by: type: string maximum: 255 nullable: true description: Ким виданий паспорт photo_date: type: string format: date nullable: true description: Дата фото в паспорті example: number: 2341441 series: AT birthday: 2000-01-01 birthplace: місто Київ citizenship: Українець issued_date: 2014-01-01 issued_by: Деснянський РУГУ photo_date: 2014-01-01 UpdatePassportIdDocument: description: Оновлення паспорту громадянина України (ІД картка) required: - number properties: number: type: string maximum: 9 minimum: 9 description: Номер документа birthday: type: string format: date nullable: true description: Дата народження birthplace: type: string maximum: 255 nullable: true description: Місце народження citizenship: type: string maximum: 255 nullable: true description: Громадянство issued_date: type: string format: date nullable: true description: Дата видачі паспорта issued_by: type: string maximum: 255 nullable: true description: Ким виданий паспорт usdr_code: type: string pattern: '/^[\d]{8}-[\d]{5}$/' nullable: true description: Унікальний номер запису в єдиному демографічному реєстрі valid_date: type: string format: date nullable: true description: Дата дії документу example: number: 2341441777 birthday: 2000-01-01 birthplace: місто Київ citizenship: Українець issued_date: 2014-01-01 issued_by: Деснянський РУГУ usdr_code: 12313213-12312 valid_date: 2024-01-01 UpdateDefaultDocument: description: Оновлення інших документів окрім (поспорта та ІД картка) properties: number: type: string maximum: 50 nullable: true description: Номер документа series: type: string maximum: 10 nullable: true description: Серія документа birthday: type: string format: date nullable: true description: Дата народження birthplace: type: string maximum: 255 nullable: true description: Місце народження citizenship: type: string maximum: 255 nullable: true description: Громадянство issued_date: type: string format: date nullable: true description: Дата видачі паспорта issued_by: type: string maximum: 255 nullable: true description: Ким виданий паспорт photo_date: type: string format: date nullable: true description: Дата фото в паспорті usdr_code: type: string pattern: '/^[\d]{8}-[\d]{5}$/' nullable: true description: Унікальний номер запису в єдиному демографічному реєстрі valid_date: type: string format: date nullable: true description: Дата дії документу example: number: 2341441 series: AT birthday: 2000-01-01 birthplace: місто Київ citizenship: Українець issued_date: 2014-01-01 issued_by: Деснянський РУГУ photo_date: 2014-01-01 usdr_code: 12313213-12312 valid_date: 2024-01-01 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT security: - bearerAuth: []