AML.point – це обліково-реєструюча система, призначена для зберігання, обліку та моніторингу платежів компанії, її контрагентів, укладених договорів, та ведення звітності.
AML.point AРI – це інтерфейс, що дозволяє взаємодіяти з платформою AML. point за допомогою спеціальних запитів. Використання цих запитів дозволяє виконати безліч дій, наприклад, отримати список всіх контрактів, створити контрагента, оновити фінансову операцію тощо. І це все можна зробити без безпосередньої взаємодії з графічним інтерфейсом платформи AML.point.
В цьому документі зібрана вся інформація, необхідна для інтеграції платформи AML.point з вашим програмним забезпеченням чи веб-сайтом. Тут містяться дані про ресурси, особливості формування запитів, опис відповідей. Крім цього, тут представлені приклади запитів та відповідей, для кращого розуміння АРІ. Документ корисний для розробників І технічних спеціалістів, які будуть проводити інтеграцію.
Список понять, що використовуються в цьому документі:
Робота AML.point АРІ побудована за всіма принципами REST – архітектурного стилю, який передбачає використання певних HTTP-запитів для того, щоб зробити конкретну дію. Запити мають попередньо визначені URLs, що ведуть до ресурсів з якими і буде виконана певна дія. Більше інформації про REST API можна знайти в цій статті.
AML.point АРІ дозволяє працювати з такими ресурсами:
AML.point має два сервери для прийому HTTP-запитів: https://amlpoint.com.ua/ (основний, підходить для постійної роботи) та https://demo.amlpoint.com.ua/ (рекомендований для використання на тестовому періоді). Всі ресурси на обох серверах ідентичні.
Відповідно до принципів REST API всі запити на https://amlpoint.com.ua/[resource] дозволяють проводити певну дію зі всім списком елементів цього ресурсу, а запити відправлені на https://amlpoint.com.ua/[resource]/{ID} дозволяють проводити дію із елементом ресурсу що має конкретний ID
.
Всі АРІ-запити вимагають авторизованого доступу. Для авторизації в системі та отримання прав на маніпуляцію з ресурсами, в заголовку необхідно вказати: Authorization: Bearer (токен доступу)
. Про те, як отримати токен доступу, описано в розділі Авторизація.
AML.point API приймає PUT
і POST
методи з тілами запиту формату JSON. Тому для таких типів запиту використовуйте заголовок Content type: application/json
. Система повертає відповіді також у форматі JSON. Отже, не забудьте додати заголовок Accept:application/json
в запит.
AML.point API використовує стандартні HTTP статус-коди, щоб показати результат запиту. Кожна відповідь містить певне числове значення, що відображає статус-код, та поле з більш детальним поясненням відповіді. Успішні запити маркуються кодом в діапазоні 200-202
. Про проблеми з обробкою запиту (наприклад, не було вказано необхідні параметри або були допущені неточності в посиланні на сервер) говорять статус-коди в діапазоні 400-499
. Про помилки на стороні сервера AML.point свідчать статус-коди в діапазоні 500-599
.
З детальною інформацією про всі HTTP статус-коди можна ознайомитися в цій статті.
Якщо при створенні запиту ви отримали неуспішну відповідь, ознайомтеся із таблицею нижче.
HTTP-код | Опис | Причини | Рекомендації |
---|---|---|---|
401 | Запит не авторизовано | токен відсутній або вказаний невірно | перевірити наявність та коректність токена в запиті |
403 | Не вистачає прав | обмежені права на виконання певного запиту | виконати запит від імені іншого користувача |
404 | Не знайдено | сервер не може знайти ресурс по вказаному ID | перевірити правильність ID ресурсу |
406 | Не вистачає даних | некоректні параметри виділених полів | перевірити правильність параметрів полів |
Перед початком роботи з AML.point, створіть акаунт в системі:
Примітка: вказуйте номер телефону та пошту співробітника, який буде відповідальний за керування роботою в системі.
Надалі під час входу в систему необхідно також вказати код, який система відправить на пошту.
Щоб отримати доступ до AML.point АРІ та користуватися всіма його функціями, необхідно пройти авторизацію. Сам процес авторизації базується на використанні спеціального ключа – Bearer token
, який відкриває доступ до ресурсів АРІ та дозволяє проводити певні маніпуляції із ними.
Для отримання Bearer token
, виконайте вхід в систему AML point і, будучи в ній, відкрийте Dev. tools. Перейдіть у вкладку Applications, далі Local Storage.
Щоб отримати доступ до ресурсів, в заголовку вказуйте ваш Bearer token
.
Термін дії токена – 60 хв. Після завершення цього періоду, доступ до ресурсів закривається і система автоматично вилогінює користувача із платформи. Для продовження роботи з АРІ, необхідно пройти процедуру заново та отримати новий токен.
Зверніть увагу: ваш Bearer token є секретним, адже він надає доступ до приватних даних. Не діліться токеном з іншими та не розкривайте його у публічно доступних місцях такий як форуми, GiTHub, браузери, додатки, соціальні мережі.
AML.point АРІ використовує два види токенів для авторизації запитів:
Для підтвердження прав користування AML.point АРІ, отриманий токен постійного доступу передають в заголовку.
Постійний токен наділяє користувача такими ж правами і можливостями роботи в АРІ, як і тимчасовий. Після завершення терміну дії постійного токену варто згенерувати новий. Функціонал AML.point АРІ дозволяє користувачу мати кілька токенів постійного доступу.
Зверніть увагу: як і тимчасовий токен, токен постійного доступу є секретною інформацією, тому тримайте його в надійному місці та не розголошуйте нікому.
Використовуйте цей ресурс для генерації токена постійного доступу. В цьому випадку, запит на створення токена з постійним доступом відбувається з використанням тимчасового токена, який вказується в заголовку. А вже після отримання постійного токена, його можна використовувати для подальшої роботи з іншими ресурсами. Придумайте назву токена та передайте його в тілі запиту. АРІ поверне постійний токен та його деталі (ID, назву, дату створення та дату завершення терміну його дії).
name required | string <= 255 назва токену постійного доступу |
{- "name": "Персональний токен"
}
{- "data": {
- "access_token": "eyJ0eXAiOiJKV1QiLCJhbfciOiJSUzIpNiJ9.eyohdWQiOiI5NDc4ZjA3ZC05YTQ4LTQ3ZDktOWZkMC05ZmM4YWU3NmI2NDIiLCJqdGkiOiIyODkxOTJlY2UxMGJlOGM5ZGJkZjIzYTFjNDM1NmE4MTk0MjJmMTEyZDI4YTFiY2E1ZGZiOTU2ZTY5NmYxYjc3ZGU3ZTgxMjZiZDljNTBhMyIsImlhdCI6MTY2MDEzMzE3Mi43ODQzNDUsIm5iZiI6MTY2MDEzMzE3Mi43ODQzNSwiZXhwIjoxNzIzMjkxNTcyLjczNjQ1MSwic3ViIjoiMWUxNmY0OWMtZGFkMS00NzhkLTljZjItNDgyZDM3YmM4ZWQyIiwic2NvcGVzIjpbXX0.JlU2xIiIc9xh_U9zUZVKxZOYsJ6CuFQWuhOS7gYcdY-z2CRHJGHIdCoQQvr19ULNdKOqKYYQVOy3ffiH7Kx30HmhjUJUKMlGeRF205NsMn2LRUB53u8tCaXGTKKMVJXQseO9p7fNjNH9C52BSGAtlg1eziJFSceRb-dnY-qUAWuaDUYFEQ-vQ2kGxCf2Z5pIM1CFzUIhay6qJOCxyNab5Qt29juSZG1riORR2KuMnHzJqRD6ETiHQ2MPe63nf5HNbUgkOQuG9zBawU3t3H3-uywn51llgOQOf5wIFCPBBaCR4oKpfmW_IgzEYcqrl-Cqcf4_1fapZ6DFs4xnpL81s7uXXzu8tnhvyfld0ALdDthDfcbwKBSApl81C6gy15ucTWYUwFqhZfPYwDNR_W9B4ENFLX0huNcTeVprQaj1fZd9Hi4MrwIK9Oa3f_7L0ThcvJgco4O1cuKJk3zkv__XKmPZnIkVUYmFNlosRWuHJwnniC0zwtcmnyhYOXa8UhDdoJA7ksPW5bat9onrTQpgpPpDc3DhK3BWJXos-Nqmm6KKPFhwtOoKzdf3AVZ52Zx_4GqnGQk3_heR-dYsFFwmXQubIeltWUmdjG4Ds2vC4owQE2MY2ccZmd8DFKqOJAsFuhpBdCJndcyhV21XwyKqfdKgs22ZxpJ2IfyF3MOqgXE",
- "token": {
- "id": "289192ece10be8c9dbdf24a1c4356a819422f112d28a1bca5dfb956e697f1b77de7e8126bа9c30a3",
- "name": "Персональний доступ",
- "created_at": "2022-08-01T15:06:12+03:00",
- "expires_at": "2024-08-01T15:06:12+03:00"
}
}
}
Цей ресурс повертає список всіх постійних токенів, які є в наявності в користувача. Токени, термін дії яких завершився, в цьому списку не відображаються, оскільки вони одразу видаляються з бази.
{- "data": [
- {
- "id": "289192ece10be8c9dbdf23a1c4356a819422f112d28a1bca5dfb956e696f1b77de7e8126bа9c30a3",
- "name": "Персональний доступ",
- "created_at": "2022-08-01T15:06:12+03:00",
- "expires_at": "2024-08-01T15:06:12+03:00"
}, - {
- "id": "5cf5fb9628e2fe98d0c03e34ea33088b37e4337f83d2c0969ac9eb31ef99af162a52e415425d1b56",
- "name": "Додатковий доступ",
- "created_at": "2022-08-01T15:29:51+03:00",
- "expires_at": "2022-08-01T16:29:51+03:00"
}
]
}
Ресурс дозволяє видалити певний токен постійного доступу до АРІ (наприклад, у випадках, коли в цілях безпеки потрібно провести заміну ключів доступу).
В параметрах шляху вказуйте ID токену, що бажаєте видалити. Статус-код 204
означатиме успішне видалення токена.
id required | string унікальний ідентифікатор постійного токену |
{- "message": "Unauthenticated."
}
Ця функціональність АРІ відкриває доступ до профілів суб'єктів первинного фінансового моніторингу. Компанія заводить цей профіль з метою подання звітності та забезпечення фінансового моніторингу.
У відповіді ви знайдете загальну інформацію про компанію, наприклад, її назву, ЄДРПОУ, телефон, email. Окрім цього, тут можна переглянути вид послуги, що надає компанія, ПІБ осіб, відповідальних за фінансовий моніторинг, дані банківського акаунту. Одна компанія може мати кілька профілів СПФМ.
Цей ресурс повертає список профілів СПФМ компанії і детальну інформацію по кожному із них.
{- "data": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПАТ \"Перша модель\"",
- "short_name": "Перша модель",
- "alias": "company-1",
- "usreou_code": "12345678",
- "phone_support": "+380440000000",
- "site": "example.com",
- "head_last_name": "Тарасенко",
- "head_first_name": "Тарас",
- "head_middle_name": "Тарасович",
- "head_date": "2022-11-09",
- "head_number": "12",
- "head_position": "CEO",
- "responsible_last_name": "Петренко",
- "responsible_first_name": "Петро",
- "responsible_middle_name": "Петрович",
- "responsible_date": "2022-11-08",
- "responsible_number": "10",
- "responsible_position": "Фінансовий директор",
- "deputy_responsible_last_name": "Андрієнко",
- "deputy_responsible_first_name": "Андрій",
- "deputy_responsible_middle_name": "Андрійович",
- "deputy_responsible_date": "2022-11-07",
- "deputy_responsible_number": "13",
- "deputy_responsible_position": "Старший економіст",
- "code": {
- "id": "2b06d815-0853-4698-9d76-55148acf7b16",
- "name": "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент",
- "type": "null",
- "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": [ ],
- "type": {
- "id": "818d50bc-f57f-49ca-8623-9e26a54bbccc",
- "name": "Юридична особа"
}
}
]
}
Ресурси цієї функціональності АРІ дозволяють працювати з контрагентами. В системі AML.point для кожного контрагенту створюється його картка. В ній міститься основна інформація про контрагента, наприклад, назва компанії чи підприємства, форма власності, ЄДРПОУ, дата реєстрації, юридичний статус компанії, номер телефону. Уповноважена за фінансовий моніторинг особа здійснює перевірку контрагентів на предмет наявності необхідних ліцензій, зв'язків з країною-агресором, терористичними угрупуваннями, приналежності до осіб компанії до санкційних списків тощо. Результати перевірки фіксуються в картці контрагента.
За допомогою цього ресурсу відбувається створення картки контрагента. Оскільки в системі AML.point контрагенти можуть мати різний юридичний тип, набір параметрів запиту та відповіді можуть дещо відрізнятися.
type required | string Default: "legal-person" юридичний тип контрагента (див. довідник) |
usreou_code required | string^[\d]{8}$ код ЄДРПОУ |
financial_model_id required | string ID профілю СПФМ обов'язково вказувати лише якщо наявні кілька профілів СПФМ |
iban | string or null <iban> ^UA\d{8}[A-Z0-9]{19}$ номер банківського рахунку контрагента |
is_terrorist | boolean or null додати ознаку "терорист" |
has_sanctions | boolean or null додати ознаку "має санкції" |
{- "type": "legal-person",
- "usreou_code": "38657536",
- "iban": "UA123405670000000026001234567",
- "financial_model_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "is_terrorist": false,
- "has_sanctions": true
}
{- "data": {
- "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": "ТОВ Аметист",
- "full_legal_name": "Товариство з обмеженою відповідальністю 'Аметист'",
- "short_legal_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",
- "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,
- "public_measures": null,
- "is_terrorist": false,
- "is_terrorist_description": null,
- "has_sanctions": true,
- "sanctions_description": "співпадіння із списками РНБО",
- "is_aggressor": true,
- "is_aggressor_description": "особа має громадянство рф",
- "has_separate_units": false,
- "has_parent_company": false,
- "is_nonprofit": false,
- "nonprofit_description": null,
- "risk_limitation": null,
- "other_risk_limitations": 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": "м.Київ, проспект Леся Курбаса",
- "old_position": null,
- "position": {
- "id": "d0857ea2-faab-41fa-a4f2-dc7454c0f692",
- "name": "директор",
- "value": "director"
}, - "authority_basis": "Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": false,
- "ended_at": false
}
], - "representatives": [ ],
- "parent_companies": [ ],
- "owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "0987654321",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "owner_part": "66.7",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_name": "СЕМЕНОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "1234512345",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12",
- "owner_part": "33.3",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}
], - "beneficial_owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "birthday": "1986-07-18",
- "itn_code": "0987654321",
- "country": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "citizenship": "Україна",
- "influence_basis": "частка статутного капіталу 66,7",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": null,
- "ended_at": null
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_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,
- "is_isei_verified": null,
- "isei_verification": null
}, - "risk_management": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "activity_content": "сервіс бронювання та продажу квитків на культурно-видовищні заходи",
- "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",
- "deleted_at": null,
- "non_resident_code": null,
- "country": null,
- "registration_authority": null,
- "registration_certificate": null,
- "contracts": [ ],
- "last_name": null,
- "first_name": null,
- "middle_name": null,
- "document": {
- "id": "7d1d896d-b9b2-405c-9a6f-5b53aace85b8",
- "number": "5103493",
- "series": "CT",
- "issued_date": "2020-10-01",
- "issued_by": "Деснянським РУ ГУ МВС",
- "photo_date": "2020-10-01",
- "usdr_code": "00000000-00000",
- "citizenship": "Українець",
- "status_date": "2020-10-01",
- "birthday": "2000-10-01",
- "birthplace": "Україна",
- "valid_date": "2032-10-01",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Паспорт громадянина України",
- "value": "passport"
}, - "status": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Знайдено в реєстрі МВС, або ДМС (без статусу).",
- "value": "nullable"
}
}, - "jobs": null,
- "is_public": null,
- "is_terrorist": false,
- "has_sanctions": true,
- "histories": [ ],
- "financial_assessments": [ ],
- "jobs_state": null,
- "financial_model": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПАТ \"Перша модель\"",
- "short_name": "Перша модель",
- "alias": "company-1",
- "usreou_code": "12345678",
- "phone_support": "+380440000000",
- "site": "example.com",
- "head_last_name": "Тарасенко",
- "head_first_name": "Тарас",
- "head_middle_name": "Тарасович",
- "head_date": "2022-11-09",
- "head_number": "12",
- "head_position": "CEO",
- "responsible_last_name": "Петренко",
- "responsible_first_name": "Петро",
- "responsible_middle_name": "Петрович",
- "responsible_date": "2022-11-08",
- "responsible_number": "10",
- "responsible_position": "Фінансовий директор",
- "deputy_responsible_last_name": "Андрієнко",
- "deputy_responsible_first_name": "Андрій",
- "deputy_responsible_middle_name": "Андрійович",
- "deputy_responsible_date": "2022-11-07",
- "deputy_responsible_number": "13",
- "deputy_responsible_position": "Старший економіст",
- "code": {
- "id": "2b06d815-0853-4698-9d76-55148acf7b16",
- "name": "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент",
- "type": null,
- "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": [ ],
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Юридична особа"
}
}
}
}
Цей ресурс призначений для оновлення ідентифікаційних даних контрагента. В параметрах шляху передавайте ID
контрагента,
для якого варто внести зміни. Набір параметрів тіла запиту та відповіді залежить від типу контрагента.
id required | string унікальний ідентифікатор контрагента |
name | string or null <= 255 назва контрагента |
property_form_id | string or null <uuid> унікальний ідентифікатор форми власності (див. довідник) |
state_id | string or null <uuid> унікальний ідентифікатор юридичного стану (див. довідник) |
status_id | string or null <uuid> унікальний ідентифікатор статусу ділових відносин (див. довідник) |
state_registration_date | string or null <date> дата запису контрагента в ЄДРПОУ |
state_registration_number | string or null^(\d{17}(\d{2})?)$ номер запису контрагента в ЄДРПОУ |
postal_code | string or null^[\d]{5}$ поштовий індекс контрагента |
city | string or null <= 255 населений пункт контрагента |
address | string or null <= 255 адреса |
mfo | string or null^[\d]{6}$ код МФО банку контрагента |
bank | string or null <= 255 банк, в якому відкрито рахунок |
iban | string or null <iban> ^UA\d{8}[A-Z0-9]{19}$ номер банківського рахунку |
phone | string or null <phone> корпоративний номер телефону |
string or null <email> корпоративна пошта | |
is_terrorist | boolean or null додати ознаку "терорист" |
has_sanctions | boolean or null додати ознаку "має санкції" |
{- "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",
- "is_terrorist": false,
- "has_sanctions": true
}
{- "data": {
- "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": "ТОВ Аметист",
- "full_legal_name": "Товариство з обмеженою відповідальністю 'Аметист'",
- "short_legal_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",
- "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,
- "public_measures": null,
- "is_terrorist": false,
- "is_terrorist_description": null,
- "has_sanctions": true,
- "sanctions_description": "співпадіння із списками РНБО",
- "is_aggressor": true,
- "is_aggressor_description": "особа має громадянство рф",
- "has_separate_units": false,
- "has_parent_company": false,
- "is_nonprofit": false,
- "nonprofit_description": null,
- "risk_limitation": null,
- "other_risk_limitations": 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": "м.Київ, проспект Леся Курбаса",
- "old_position": null,
- "position": {
- "id": "d0857ea2-faab-41fa-a4f2-dc7454c0f692",
- "name": "директор",
- "value": "director"
}, - "authority_basis": "Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": false,
- "ended_at": false
}
], - "representatives": [ ],
- "parent_companies": [ ],
- "owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "0987654321",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "owner_part": "66.7",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_name": "СЕМЕНОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "1234512345",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12",
- "owner_part": "33.3",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}
], - "beneficial_owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "birthday": "1986-07-18",
- "itn_code": "0987654321",
- "country": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "citizenship": "Україна",
- "influence_basis": "частка статутного капіталу 66,7",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": null,
- "ended_at": null
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_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,
- "is_isei_verified": null,
- "isei_verification": null
}, - "risk_management": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "activity_content": "сервіс бронювання та продажу квитків на культурно-видовищні заходи",
- "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",
- "deleted_at": null,
- "non_resident_code": null,
- "country": null,
- "registration_authority": null,
- "registration_certificate": null,
- "contracts": [ ],
- "last_name": null,
- "first_name": null,
- "middle_name": null,
- "document": {
- "id": "7d1d896d-b9b2-405c-9a6f-5b53aace85b8",
- "number": "5103493",
- "series": "CT",
- "issued_date": "2020-10-01",
- "issued_by": "Деснянським РУ ГУ МВС",
- "photo_date": "2020-10-01",
- "usdr_code": "00000000-00000",
- "citizenship": "Українець",
- "status_date": "2020-10-01",
- "birthday": "2000-10-01",
- "birthplace": "Україна",
- "valid_date": "2032-10-01",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Паспорт громадянина України",
- "value": "passport"
}, - "status": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Знайдено в реєстрі МВС, або ДМС (без статусу).",
- "value": "nullable"
}
}, - "jobs": null,
- "is_public": null,
- "is_terrorist": false,
- "has_sanctions": true,
- "histories": [ ],
- "financial_assessments": [ ],
- "jobs_state": null,
- "financial_model": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПАТ \"Перша модель\"",
- "short_name": "Перша модель",
- "alias": "company-1",
- "usreou_code": "12345678",
- "phone_support": "+380440000000",
- "site": "example.com",
- "head_last_name": "Тарасенко",
- "head_first_name": "Тарас",
- "head_middle_name": "Тарасович",
- "head_date": "2022-11-09",
- "head_number": "12",
- "head_position": "CEO",
- "responsible_last_name": "Петренко",
- "responsible_first_name": "Петро",
- "responsible_middle_name": "Петрович",
- "responsible_date": "2022-11-08",
- "responsible_number": "10",
- "responsible_position": "Фінансовий директор",
- "deputy_responsible_last_name": "Андрієнко",
- "deputy_responsible_first_name": "Андрій",
- "deputy_responsible_middle_name": "Андрійович",
- "deputy_responsible_date": "2022-11-07",
- "deputy_responsible_number": "13",
- "deputy_responsible_position": "Старший економіст",
- "code": {
- "id": "2b06d815-0853-4698-9d76-55148acf7b16",
- "name": "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент",
- "type": null,
- "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": [ ],
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Юридична особа"
}
}
}
}
Використовуйте цей ресурс щоб ознайомитися із деталями конкретного контрагента. В параметрах шляху не забудьте передати унікальний ідентифікатор.
id required | string унікальний ідентифікатор контрагента |
{- "data": {
- "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": "ТОВ Аметист",
- "full_legal_name": "Товариство з обмеженою відповідальністю 'Аметист'",
- "short_legal_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",
- "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,
- "public_measures": null,
- "is_terrorist": false,
- "is_terrorist_description": null,
- "has_sanctions": true,
- "sanctions_description": "співпадіння із списками РНБО",
- "is_aggressor": true,
- "is_aggressor_description": "особа має громадянство рф",
- "has_separate_units": false,
- "has_parent_company": false,
- "is_nonprofit": false,
- "nonprofit_description": null,
- "risk_limitation": null,
- "other_risk_limitations": 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": "м.Київ, проспект Леся Курбаса",
- "old_position": null,
- "position": {
- "id": "d0857ea2-faab-41fa-a4f2-dc7454c0f692",
- "name": "директор",
- "value": "director"
}, - "authority_basis": "Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": false,
- "ended_at": false
}
], - "representatives": [ ],
- "parent_companies": [ ],
- "owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "0987654321",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "owner_part": "66.7",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_name": "СЕМЕНОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "1234512345",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12",
- "owner_part": "33.3",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}
], - "beneficial_owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "birthday": "1986-07-18",
- "itn_code": "0987654321",
- "country": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "citizenship": "Україна",
- "influence_basis": "частка статутного капіталу 66,7",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": null,
- "ended_at": null
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_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,
- "is_isei_verified": null,
- "isei_verification": null
}, - "risk_management": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "activity_content": "сервіс бронювання та продажу квитків на культурно-видовищні заходи",
- "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",
- "deleted_at": null,
- "non_resident_code": null,
- "country": null,
- "registration_authority": null,
- "registration_certificate": null,
- "contracts": [ ],
- "last_name": null,
- "first_name": null,
- "middle_name": null,
- "document": {
- "id": "7d1d896d-b9b2-405c-9a6f-5b53aace85b8",
- "number": "5103493",
- "series": "CT",
- "issued_date": "2020-10-01",
- "issued_by": "Деснянським РУ ГУ МВС",
- "photo_date": "2020-10-01",
- "usdr_code": "00000000-00000",
- "citizenship": "Українець",
- "status_date": "2020-10-01",
- "birthday": "2000-10-01",
- "birthplace": "Україна",
- "valid_date": "2032-10-01",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Паспорт громадянина України",
- "value": "passport"
}, - "status": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Знайдено в реєстрі МВС, або ДМС (без статусу).",
- "value": "nullable"
}
}, - "jobs": null,
- "is_public": null,
- "is_terrorist": false,
- "has_sanctions": true,
- "histories": [ ],
- "financial_assessments": [ ],
- "jobs_state": null,
- "financial_model": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПАТ \"Перша модель\"",
- "short_name": "Перша модель",
- "alias": "company-1",
- "usreou_code": "12345678",
- "phone_support": "+380440000000",
- "site": "example.com",
- "head_last_name": "Тарасенко",
- "head_first_name": "Тарас",
- "head_middle_name": "Тарасович",
- "head_date": "2022-11-09",
- "head_number": "12",
- "head_position": "CEO",
- "responsible_last_name": "Петренко",
- "responsible_first_name": "Петро",
- "responsible_middle_name": "Петрович",
- "responsible_date": "2022-11-08",
- "responsible_number": "10",
- "responsible_position": "Фінансовий директор",
- "deputy_responsible_last_name": "Андрієнко",
- "deputy_responsible_first_name": "Андрій",
- "deputy_responsible_middle_name": "Андрійович",
- "deputy_responsible_date": "2022-11-07",
- "deputy_responsible_number": "13",
- "deputy_responsible_position": "Старший економіст",
- "code": {
- "id": "2b06d815-0853-4698-9d76-55148acf7b16",
- "name": "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент",
- "type": null,
- "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": [ ],
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Юридична особа"
}
}
}
}
Використовуючи цей ресурс, можна видалити контрагента із системи.
В параметрах шляху потрібно передати ID
контрагента, якого бажаєте видалити. Відповідь 204
означатиме успішне видалення.
id required | string унікальний ідентифікатор контрагента |
{- "message": "Unauthenticated."
}
З використанням цього ресурсу можна відновити попередньо видалену картку контрагента. Після відновлення, вона знову з'явиться в системі AML.point.
Обов'язково в параметрах шляху передавайте ID
контрагента, якого потрібно відновити.
id required | string унікальний ідентифікатор контрагента |
{- "data": {
- "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": "ТОВ Аметист",
- "full_legal_name": "Товариство з обмеженою відповідальністю 'Аметист'",
- "short_legal_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",
- "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,
- "public_measures": null,
- "is_terrorist": false,
- "is_terrorist_description": null,
- "has_sanctions": true,
- "sanctions_description": "співпадіння із списками РНБО",
- "is_aggressor": true,
- "is_aggressor_description": "особа має громадянство рф",
- "has_separate_units": false,
- "has_parent_company": false,
- "is_nonprofit": false,
- "nonprofit_description": null,
- "risk_limitation": null,
- "other_risk_limitations": 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": "м.Київ, проспект Леся Курбаса",
- "old_position": null,
- "position": {
- "id": "d0857ea2-faab-41fa-a4f2-dc7454c0f692",
- "name": "директор",
- "value": "director"
}, - "authority_basis": "Протокол №1 від 01.04.2012, наказ № 1-К від 01.04.2012",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": false,
- "ended_at": false
}
], - "representatives": [ ],
- "parent_companies": [ ],
- "owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "0987654321",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "owner_part": "66.7",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_name": "СЕМЕНОВИЧ",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Юридична особа",
- "value": "legal-person"
}, - "code": "1234512345",
- "address": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА , будинок 2, квартира 12",
- "owner_part": "33.3",
- "started_at": null,
- "ended_at": null,
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "country_of_registration": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab002",
- "name": {
- "alfa-code2": "UA",
- "alfa-code3": "UKR",
- "short-name": "Україна",
- "fullname": "Україна",
- "name_en": "Ukraine"
}, - "value": "804"
}
}
], - "beneficial_owners": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПЕТРЕНКО ПЕТРО ПЕТРОВИЧ",
- "last_name": "ПЕТРЕНКО",
- "first_name": "ПЕТРО",
- "middle_name": "ПЕТРОВИЧ",
- "birthday": "1986-07-18",
- "itn_code": "0987654321",
- "country": "Україна, 03000, місто Київ, ВУЛИЦЯ ЯКУБА КОЛОСА, будинок 9, квартира 12",
- "citizenship": "Україна",
- "influence_basis": "частка статутного капіталу 66,7",
- "is_public": false,
- "is_terrorist": false,
- "has_sanctions": false,
- "started_at": null,
- "ended_at": null
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "СЕМЕНКО СЕМЕН СЕМЕНОВИЧ",
- "last_name": "СЕМЕНКО",
- "first_name": "СЕМЕН",
- "middle_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,
- "is_isei_verified": null,
- "isei_verification": null
}, - "risk_management": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "activity_content": "сервіс бронювання та продажу квитків на культурно-видовищні заходи",
- "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",
- "deleted_at": null,
- "non_resident_code": null,
- "country": null,
- "registration_authority": null,
- "registration_certificate": null,
- "contracts": [ ],
- "last_name": null,
- "first_name": null,
- "middle_name": null,
- "document": {
- "id": "7d1d896d-b9b2-405c-9a6f-5b53aace85b8",
- "number": "5103493",
- "series": "CT",
- "issued_date": "2020-10-01",
- "issued_by": "Деснянським РУ ГУ МВС",
- "photo_date": "2020-10-01",
- "usdr_code": "00000000-00000",
- "citizenship": "Українець",
- "status_date": "2020-10-01",
- "birthday": "2000-10-01",
- "birthplace": "Україна",
- "valid_date": "2032-10-01",
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Паспорт громадянина України",
- "value": "passport"
}, - "status": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab001",
- "name": "Знайдено в реєстрі МВС, або ДМС (без статусу).",
- "value": "nullable"
}
}, - "jobs": null,
- "is_public": null,
- "is_terrorist": false,
- "has_sanctions": true,
- "histories": [ ],
- "financial_assessments": [ ],
- "jobs_state": null,
- "financial_model": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "ПАТ \"Перша модель\"",
- "short_name": "Перша модель",
- "alias": "company-1",
- "usreou_code": "12345678",
- "phone_support": "+380440000000",
- "site": "example.com",
- "head_last_name": "Тарасенко",
- "head_first_name": "Тарас",
- "head_middle_name": "Тарасович",
- "head_date": "2022-11-09",
- "head_number": "12",
- "head_position": "CEO",
- "responsible_last_name": "Петренко",
- "responsible_first_name": "Петро",
- "responsible_middle_name": "Петрович",
- "responsible_date": "2022-11-08",
- "responsible_number": "10",
- "responsible_position": "Фінансовий директор",
- "deputy_responsible_last_name": "Андрієнко",
- "deputy_responsible_first_name": "Андрій",
- "deputy_responsible_middle_name": "Андрійович",
- "deputy_responsible_date": "2022-11-07",
- "deputy_responsible_number": "13",
- "deputy_responsible_position": "Старший економіст",
- "code": {
- "id": "2b06d815-0853-4698-9d76-55148acf7b16",
- "name": "Прийняття суб’єктом первинного фінансового моніторингу коштів від особи, яка погоджується на отримання процентів за депозитом, нижчих за процентну ставку, що встановлена у банку на поточний момент",
- "type": null,
- "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": [ ],
- "type": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Юридична особа"
}
}
}
}
За допомогою ресурсів цієї функціональності, ви зможете керувати договорами. В AML.point кожен договір має окрему картку, де вказані головні його деталі. Тут містяться дані про ПІБ керівника компанії контрагента, номер договору, дата його укладення, його тип, деталі здійснення платежу. Реальний документ договору з печатками та підписами завантажується в систему AML.point в картку договору.
Використовуйте цей ресурс для створення договору. В параметрах шляху вкажіть ID
контрагента,
договір з яким потрібно створити. В тілі запиту необхідно передати основні деталі договору.
id required | string унікальний ідентифікатор контрагента |
issued_date required | string <date-time> дата укладання договору |
number required | string <= 255 номер договору |
type_id required | string <uuid> унікальний ідентифікатор типу договору (див. довідник) |
internal_fee | number or null <float> внутрішня комісія |
internal_fee_comment | string or null <= 255 коментар до внутрішньої комісії |
external_fee | number or null <float> зовнішня комісія |
external_fee_comment | string or null <= 255 коментар до зовнішньої комісії |
payment_destination_note | string or null <= 255 опис коду призначення платежу |
payout_destination_note | string or null <= 255 опис коду призначення виплати |
state_id | string or null <uuid> унікальний ідентифікатор статусу договору (див. довідник) |
payout_period_id | string or null <uuid> унікальний іддентифікатор періоду виплати (див. довідник) |
payment_destination_code_id required | string or null <uuid> унікальний ідентифікатор коду призначення платежу - F108 (див. довідник) параметр обов'язкий для договорів з операціями на прийом коштів |
payout_destination_code_id required | string or null <uuid> унікальний ідентифікатор коду призначення виплати - F108 (див. довідник) параметр обов'язкий для договорів з операціями на виплату коштів |
auto_payout | boolean or null Дозволити автоматичне формування виплат |
last_name | string or null <= 255 прізвище |
first_name | string or null <= 255 ім’я |
middle_name | string or null <= 255 по-батькові |
{- "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": "Тарасенко",
- "first_name": "Тарас",
- "middle_name": "Тарасович"
}
{- "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": 1,
- "external_fee_comment": null,
- "payment_destination_note": null,
- "payout_destination_note": null,
- "deleted_at": "2022-08-08T17:22:32+03:00",
- "type": {
- "id": "9a761dd4-5f57-45e6-8e57-dbd39dbbd82e",
- "name": "Договір про переказ коштів (виплата)",
- "value": "type2"
}, - "state": {
- "id": "f061245c-f59b-459a-a55d-3211e949fe68",
- "name": "Діючий",
- "value": "0"
}, - "counterpart": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "КОМПАНІЯ \"Перша",
- "usreou_code": "12345678",
- "itn_code": null,
- "code": "12345678",
- "non_resident_code": "755487",
- "bank": "АТ \"Банк\"",
- "iban": "UA012345000000000000001234567",
- "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "type_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "risk_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "is_public": false,
- "publicity_type_id": null,
- "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}
}, - "payment_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет",
- "value": "33"
}, - "payout_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Виплата виграшів гравцям азартних ігор казино в мережі Інтернет",
- "value": "45"
}, - "payment_methods": [
- {
- "id": "b000000b-d000-000f-a00f-00c0000000e0",
- "name": "ЕПЗ",
- "value": "epz"
}
], - "payment_directions": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Some12345"
}
], - "payout_period": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "По понеділкам",
- "value": "byMonday"
}, - "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}, - "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "ended_at": null
}
}
Цей ресурс дозволяє оновити договір. Наприклад, можна змінити ПІБ керівника компанії-контрагента, платіжний метод, % комісії за надання послуг. В параметрах шляху необхідно передавати ID
договору,
який бажаєте оновити, а в тілі запиту вказувати нові деталі договору.
id required | string унікальний ідентифікатор договору |
issued_date required | string <date-time> дата укладання договору |
internal_fee required | number or null <float> внутрішня комісія |
internal_fee_comment | string or null <= 255 коментар до внутрішньої комісії |
external_fee required | number or null <float> зовнішня комісія |
external_fee_comment | string or null <= 255 коментар до зовнішньої комісії |
payment_destination_note | string or null <= 255 опис коду призначення платежу |
payout_destination_note | string or null <= 255 опис коду призначення виплати |
state_id | string or null <uuid> унікальний ідентифікатор статусу договору (див. довідник) |
payout_period | string or null <uuid> унікальний іддентифікатор періоду виплати (див. довідник) |
payment_methods | Array of arrays or null or null унікальний ідентифікатор платіжних методів (див. довідник) |
last_name | string or null <= 255 прізвище |
first_name | string or null <= 255 ім’я |
middle_name | string or null <= 255 по-батькові |
ended_at | string <date-time> дата закінчення договору |
{- "issued_date": "2022-06-13",
- "internal_fee": "1.0",
- "internal_fee_comment": null,
- "external_fee": "2.1",
- "external_fee_comment": null,
- "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": "Тарасенко",
- "first_name": "Ігор",
- "middle_name": "Павлович"
}
{- "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": 1,
- "external_fee_comment": null,
- "payment_destination_note": null,
- "payout_destination_note": null,
- "deleted_at": "2022-08-08T17:22:32+03:00",
- "type": {
- "id": "9a761dd4-5f57-45e6-8e57-dbd39dbbd82e",
- "name": "Договір про переказ коштів (виплата)",
- "value": "type2"
}, - "state": {
- "id": "f061245c-f59b-459a-a55d-3211e949fe68",
- "name": "Діючий",
- "value": "0"
}, - "counterpart": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "КОМПАНІЯ \"Перша",
- "usreou_code": "12345678",
- "itn_code": null,
- "code": "12345678",
- "non_resident_code": "755487",
- "bank": "АТ \"Банк\"",
- "iban": "UA012345000000000000001234567",
- "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "type_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "risk_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "is_public": false,
- "publicity_type_id": null,
- "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}
}, - "payment_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет",
- "value": "33"
}, - "payout_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Виплата виграшів гравцям азартних ігор казино в мережі Інтернет",
- "value": "45"
}, - "payment_methods": [
- {
- "id": "b000000b-d000-000f-a00f-00c0000000e0",
- "name": "ЕПЗ",
- "value": "epz"
}
], - "payment_directions": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Some12345"
}
], - "payout_period": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "По понеділкам",
- "value": "byMonday"
}, - "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}, - "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "ended_at": null
}
}
Цей ресурс повертає картку договору з усіма його деталями.
В параметрах шляху не забудьте передати ID
договору, інформація про який вас цікавить.
id required | string унікальний ідентифікатор договору |
{- "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": 1,
- "external_fee_comment": null,
- "payment_destination_note": null,
- "payout_destination_note": null,
- "deleted_at": "2022-08-08T17:22:32+03:00",
- "type": {
- "id": "9a761dd4-5f57-45e6-8e57-dbd39dbbd82e",
- "name": "Договір про переказ коштів (виплата)",
- "value": "type2"
}, - "state": {
- "id": "f061245c-f59b-459a-a55d-3211e949fe68",
- "name": "Діючий",
- "value": "0"
}, - "counterpart": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "КОМПАНІЯ \"Перша",
- "usreou_code": "12345678",
- "itn_code": null,
- "code": "12345678",
- "non_resident_code": "755487",
- "bank": "АТ \"Банк\"",
- "iban": "UA012345000000000000001234567",
- "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "type_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "risk_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "is_public": false,
- "publicity_type_id": null,
- "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}
}, - "payment_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет",
- "value": "33"
}, - "payout_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Виплата виграшів гравцям азартних ігор казино в мережі Інтернет",
- "value": "45"
}, - "payment_methods": [
- {
- "id": "b000000b-d000-000f-a00f-00c0000000e0",
- "name": "ЕПЗ",
- "value": "epz"
}
], - "payment_directions": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Some12345"
}
], - "payout_period": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "По понеділкам",
- "value": "byMonday"
}, - "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}, - "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "ended_at": null
}
}
Якщо виникла необхідність видалити договір, то таку дію можна зробити за допомогою цього ресурсу. Після видалення, контракт більше не буде відображатися в системі AML.point.
В параметрах шляху необхідно передавати ID
договору. Відповідь 204
означатиме успішне видалення договору.
id required | string унікальний ідентифікатор договору |
{- "message": "Unauthenticated."
}
Цей ресурс дозволяє відновити договір, що був попередньо видалений з системи AML.point.
В параметрах шляху потрібно передавати ID
договору, який бажаєте відновити.
id required | string унікальний ідентифікатор договору |
{- "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": 1,
- "external_fee_comment": null,
- "payment_destination_note": null,
- "payout_destination_note": null,
- "deleted_at": "2022-08-08T17:22:32+03:00",
- "type": {
- "id": "9a761dd4-5f57-45e6-8e57-dbd39dbbd82e",
- "name": "Договір про переказ коштів (виплата)",
- "value": "type2"
}, - "state": {
- "id": "f061245c-f59b-459a-a55d-3211e949fe68",
- "name": "Діючий",
- "value": "0"
}, - "counterpart": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "КОМПАНІЯ \"Перша",
- "usreou_code": "12345678",
- "itn_code": null,
- "code": "12345678",
- "non_resident_code": "755487",
- "bank": "АТ \"Банк\"",
- "iban": "UA012345000000000000001234567",
- "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "type_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "risk_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "is_public": false,
- "publicity_type_id": null,
- "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}
}, - "payment_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Оплата ставок гравцями для участі в азартних іграх казино в мережі Інтернет",
- "value": "33"
}, - "payout_destination_code": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Виплата виграшів гравцям азартних ігор казино в мережі Інтернет",
- "value": "45"
}, - "payment_methods": [
- {
- "id": "b000000b-d000-000f-a00f-00c0000000e0",
- "name": "ЕПЗ",
- "value": "epz"
}
], - "payment_directions": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Some12345"
}
], - "payout_period": {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "По понеділкам",
- "value": "byMonday"
}, - "financial_model": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e0",
- "name": "Онікс",
- "alias": "Onix",
- "code": {
- "id": "b00f000b-d0e0-000f-a00f-00c00cd000e1",
- "name": "Платіжна організація",
- "value": 3210
}
}, - "last_name": "Тарасов",
- "first_name": "Ігор",
- "middle_name": "Павлович",
- "ended_at": null
}
}
Ця функціональність АРІ використовується для реєстрації фінансових операцій в системі AML.point. Необхідно реєструвати успішні платежі прийому та виплат коштів, а також ті, що були заблоковані внаслідок приналежності власника карти до списку терористів, підсанкційних чи публічних осіб. Ресурси цього АРІ отримують інформацію про операції з платіжних провайдерів та передають в систему AML.point. Тут можна переглянути ідентифікаційні дані отримувача та платника, суму операцій, платіжний метод, призначення платежу, ІР тощо. В існуючу операцію є можливість внесення змін. Інформація про операції є основою фінансового моніторингу та подання звітності до НБУ.
Цей ресурс дозволяє реєструвати в системі нові успішні фінансові операції, згідно з договором. Відповідь 202
означатиме, що дані прийняті в обробку і невдовзі операція буде зареєстрована в системі.
paysystem_id required | string <= 255 унікальний ідентифікатор операції у вашій системі |
paysystem_name required | string <= 255 назва платіжної системи |
type required | string Enum: "registerPayment" "ptks" "cash" "epz" "other" "sdbo" платіжні методи (див. довідник). Пояснення типів:
|
terminal_id | string or null <= 100 віртуальний ID терміналу банку |
terminal_name required | string <= 100 назва віртуального терміналу банку |
auth_code | string or null <= 100 код авторизації операції, отриманий від банку |
registry_reference_number | string or null <= 100 РРН-код операції, отриманий від банку |
mcc | string or null <= 4 код категорії мерчанта або mcc-терміналу, по якому пройшла операція |
required | OperationCard (object) or OperationContract (object) узагальнений об'єкт, що відображає деталі платника |
required | OperationCard (object) or OperationContract (object) or OperationFinancialModel (object) узагальнений об'єкт, що відображає деталі отримувача |
amount required | number <float> загальна сума операції (включно із комісією) |
original_amount required | number <float> сума платежу |
payout_amount | number <float> сума виплати/відшкодування мерчанту |
fee_external_amount | number <float> зовнішня комісія |
fee_internal_amount | number <float> внутрішня комісія |
currency required | string Value: "UAH" валюта операції |
initiator_ip | string <ip> ІР, з якого операція була проведена |
initiator_email | string <email> пошта платника в системі, де він створює платіж |
initiator_account_number | string <= 100 ідентифікатор платника в системі, де він створює платіж |
order_description required | string <= 1024 призначення платежу |
received_at | string <date-time> дата та час взаєморозрахунку з банком |
processed_at required | string <date-time> дата та час коли операція отримала фінальний статус в платіжній системі, де вона проводилася |
country | string Value: "UKR" код країни, де була випущена карта платника |
payee_is_public | boolean приналежність отримувача до публічних осіб |
payer_is_public | boolean приналежність платника до публічних осіб |
{- "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": "Павленко",
- "first_name": "Вадим",
- "middle_name": "Вікторович"
}, - "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_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
}
{- "code": 400,
- "description": {
- "paysystem_id": [
- "validation.required"
]
}
}
Використовуйте цей ресурс щоб внести зміни в існуючу операцію. В тілі запиту передавайте ті дані, які бажаєте оновити. Відповідь 202
означатиме, що дані прийняті в обробку і невдовзі операція буде оновлена.
paysystem_id required | string <= 255 унікальний ідентифікатор операції у вашій системі |
amount | number <float> загальна сума операції (включно з комісією) |
original_amount | number <float> сума платежу |
payout_amount | number <float> сума виплати/відшкодування мерчанту |
fee_external_amount | number <float> зовнішня комісія |
fee_internal_amount | number <float> внутрішня комісія |
currency | string Value: "UAH" валюта операції |
received_at | string дата та час формування операції |
{- "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"
}
{- "code": 400,
- "description": {
- "pcurrency": [
- "validation.required"
]
}
}
Цей ресурс відповідає за реєстрацію операції, що була заблокована внаслідок приналежності особи до списку терористів, публічних чи підсанкційних осіб.
Відповідь 202
означатиме, що дані прийняті в обробку і невдовзі операція буде зареєстрована в системі.
paysystem_id required | string <= 255 унікальний ідентифікатор операції у вашій системі |
paysystem_name required | string <= 255 назва платіжної системи |
type required | string Enum: "registerPayment" "epz" "ptks" "cash" "other" "sdbo" платіжні методи (див. довідник). Пояснення типів:
|
terminal_name required | string <= 100 назва віртуального терміналу банку |
required | OperationCard (object) or OperationContract (object) узагальнений об'єкт, що відображає деталі платника |
required | OperationCard (object) or OperationContract (object) or OperationFinancialModel (object) узагальнений об'єкт, що відображає деталі отримувача |
amount required | number <float> загальна сума операції (включно із комісією) |
currency required | string Value: "UAH" валюта операції |
initiator_ip | string <ip> ІР, з якого операція була проведена |
initiator_email | string <email> пошта платника в системі, де він створює платіж |
initiator_account_number | string <= 100 ідентифікатор платника в системі, де він створює платіж |
order_description required | string <= 1024 примітка |
reason required | string <= 1000 причина блокування операції |
processed_at required | string <date-time> дата та час коли операція отримала фінальний статус в платіжній системі, де вона проводилася |
{- "paysystem_id": "paysystem_operation_abc_1",
- "paysystem_name": "amlsystem",
- "type": "epz",
- "terminal_name": "The terminal name.",
- "payer": {
- "type": "card",
- "card_number": "516874******9472",
- "card_hash": "87b0f0788f101f0b11d1d179",
- "last_name": "Павленко",
- "first_name": "Вадим",
- "middle_name": "Вікторович"
}, - "payee": {
- "type": "contract",
- "contract_id": "0ca00000-a000-000e-0d0f-0d0d00bab000"
}, - "amount": 999999.9999,
- "currency": "UAH",
- "initiator_ip": "1.1.1.1",
- "initiator_account_number": "307546162244",
- "order_description": "Invoice for the order #78453.",
- "reason": "Match with RNBOU list.",
- "processed_at": "2022-06-08T11:18:51+0000"
}
{- "code": 400,
- "description": {
- "paysystem_id": [
- "validation.required"
]
}
}
Для зручної систематизації та класифікації різних об'єктів АРІ, в системі AML.point створені довідники двох видів:
внутрішні – розроблені для опису значень внутрішніх параметрів. Наприклад, типів платіжних систем, форм власності, юридичних станів, організаційно-правових форм, статусів договору;
зовнішні – дублюють значення параметрів з довідників НБУ F108 та H020, що використовуються для подання статистичної звітності.
По суті, кожен довідник – це окремий об'єкт певного ресурсу з масивом можливих значень.
Для роботи з довідниками доступний лише метод GET
.
Цей ресурс повертає список кодів фінансових послуг відповідно до довідника H020. Отримані значення із цього довідника використовують для подання статистичної звітності до НБУ.
{- "data": [
- {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Торгівля валютними цінностями",
- "value": "03"
}, - {
- "id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
- "name": "Переказ коштів",
- "value": "08"
}
]
}
Ресурс повертає список юридичних типів контрагента.
{- "data": [
- {
- "id": "a062189a-5897-4028-92fc-006c7ce40cf6",
- "name": "Орган влади (ОВ)",
- "value": "government-unit"
}, - {
- "id": "5a99f0d5-1460-4a96-9f2a-5d626a42d885",
- "name": "Фізична особа-підприємець (ФОП)",
- "value": "individual-entrepreneur"
}
]
}
Використовуйте цей ресурс, щоб переглянути форми власності контрагента. Довідник актуальний для юридичних осіб.
{- "data": [
- {
- "id": "dab5f0f1-dc1e-4ff5-90f8-a672fae58eb1",
- "name": "Приватна",
- "value": "1"
}, - {
- "id": "865e9942-0a18-4c9f-a85c-2f14edfb5d5c",
- "name": "Недержавна",
- "value": "2"
}
]
}
Використовуючи цей ресурс, ви отримаєте список можливих організаційно-правових форм.
{- "data": [
- {
- "id": "78e0ab4d-28b9-4d16-b0e7-d404720f40ec",
- "name": "АКЦІОНЕРНЕ ТОВАРИСТВО",
- "value": "230"
}, - {
- "id": "0996d8c4-f369-4c56-ab94-aa887972031b",
- "name": "ІНДИВІДУАЛЬНЕ ПІДПРИЄМСТВО",
- "value": "191"
}
]
}
Ресурс дозволяє переглянути статус ділових відносин контрагента.
{- "data": [
- {
- "id": "8200c9df-0c8d-4f40-9967-02b926ae322e",
- "name": "Неактивний",
- "value": "2"
}, - {
- "id": "a57b2cd3-d456-455b-8d19-4c23cc6ffcfa",
- "name": "Активний",
- "value": "1"
}
]
}
За допомогою цього ресурсу, ви можете ознайомитися із можливими юридичними станами контрагента.
{- "data": [
- {
- "id": "6eb876fa-3571-4562-9286-076f35995d56",
- "name": "В стані припинення",
- "value": "5"
}, - {
- "id": "30f354bd-7bed-4762-b8ad-87201f370dae",
- "name": "Не перебуває в процесі припинення, свідоцтво про державну реєстрацію недійсне",
- "value": "6"
}
]
}
Використовуючи цей ресурс, ви можете переглянути список типів публічних осіб.
{- "data": [
- {
- "id": "8d4f3d12-10fa-4d54-bbeb-53d0703e636d",
- "name": "Національні публічні діячі",
- "value": "1"
}, - {
- "id": "846ecb925-9076-446f-bc70-b7pc91a16d23",
- "name": "Діячі, що виконують публічні функції в міжнародних організаціях",
- "value": "5"
}
]
}
Використовуючи цей ресурс, ви отримаєте список можливих типів документа, що посвідчують особу.
{- "data": [
- {
- "id": "96293b02-230a-4b93-843f-58208e123ad1",
- "name": "Паспорт громадянина України",
- "value": "passport"
}, - {
- "id": "38553c43-01c8-4a8b-9361-353fdf0af8ff",
- "name": "Посвідка на тимчасове проживання",
- "value": "tempResidencePermit"
}
]
}
Ресурс дозволяє переглянути статуси документа, що посвідчує особу.
{- "data": [
- {
- "id": "41a91615-6883-429f-8eb2-366aee509a75,",
- "name": "Втрачено",
- "value": "lost"
}, - {
- "id": "0c74cf81-37fb-4b11-b6b2-96873d4fa03c,",
- "name": "Викрадений,",
- "value": "stolen"
}
]
}
Цей ресурс дозволяє переглянути можливі статуси ідентифікації та верифікації контрагента.
{- "data": [
- {
- "id": "f1802d52-6a14-48e3-a9da-9f0ec1301d2b",
- "name": "Ідентифікація не завершена",
- "value": "1"
}, - {
- "id": "7ae4867c-e11b-4066-ad2d-5a6ae784709d",
- "name": "Потребує уточнення інформації",
- "value": "2"
}
]
}
Ресурс повертає список систем оподаткування контрагента.
{- "data": [
- {
- "id": "7cb3e32e-cc1a-9f96-9003-1e47f6596f5a",
- "name": "Спрощена 2 група",
- "value": "2"
}, - {
- "id": "0ca01332-2df6-4d39-a34d-baa0e620482f",
- "name": "Спрощена 3 група",
- "value": "3"
}
]
}
Ресурс дозволяє переглянути список видів діяльності контрагента.
{- "data": [
- {
- "id": "b912b7b1-73ac-44ad-a200-cdd16f091bd2",
- "name": "Виробництво взуття",
- "value": "15.20"
}, - {
- "id": "1482674f-2e77-43bd-60f7-53f87cb5fe32",
- "name": "Лісозаготівлі",
- "value": "02.20"
}
]
}
Цей ресурс повертає список рівнів ризику контрагента.
{- "data": [
- {
- "id": "7e7fe933-da31-48ef-a331-a3716c797f4a",
- "name": "Низький",
- "value": "low"
}, - {
- "id": "7732d781-5e8f-4a03-bf70-39076b6a07ee",
- "name": "Неприйнятно високий",
- "value": "extremelyHight"
}
]
}
Ресурс повертає масив оцінок відповідності фінансових операцій контрагента змісту його діяльності.
{- "data": [
- {
- "id": "7157f686-0a30-438e-ae8f-3f6d1d03a4fa",
- "name": "Фінансові операції відповідають змісту діяльності",
- "value": "1"
}, - {
- "id": "9f86cb61-027d-4d12-8a11-dfbfe8d1beb2",
- "name": "Фінансові операції не відповідають змісту діяльностіний",
- "value": "2"
}
]
}
Ресурс повертає масив оцінок відповідності фінансових операцій контрагента його фінансовому стану.
{- "data": [
- {
- "id": "73057919-2cef-4d8e-b7a4-dfd5ccb69209",
- "name": "Фінансові операції відповідають фінансовому стану",
- "value": "1"
}, - {
- "id": "d0d4ef79-84ac-4e00-8449-48c2f4bee501",
- "name": "Фінансові операції не відповідають фінансовому стану",
- "value": "2"
}
]
}
Цей ресурс надає список можливих типів договорів.
{- "data": [
- {
- "id": "9a761dd4-5f57-45e6-8e57-dbd39dbbd82e",
- "name": "Договір про переказ коштів (виплата)",
- "value": "type2"
}, - {
- "id": "44b4647e-8773-46b9-a1e2-e4f49e9aa1a1",
- "name": "Договір про співробітництво",
- "value": "type5"
}
]
}
Ресурс повертає список статусів договору.
{- "data": [
- {
- "id": "f061245c-f59b-459a-a55d-3211e949fe68",
- "name": "Діючий",
- "value": "0"
}, - {
- "id": "101cf877-b873-426c-9bff-8a2a26c9c1ad",
- "name": "Призупинений",
- "value": "1"
}
]
}
Цей ресурс повертає масив кодів призначення платежу відповідно до довідника F108. Отримані значення із цього довідника використовують для подання звітності до НБУ.
{- "data": [
- {
- "id": "c5cd26bf-574d-4d61-9c7a-9a9553c44c14",
- "name": "Страхові платежі",
- "value": "03"
}, - {
- "id": "56dea329-853c-40e3-ba4f-8de6bce7e556",
- "name": "Погашення кредиту",
- "value": "07"
}
]
}
За допомогою цього ресурсу можна переглянути список можливих періодів виплат згідно з договором.
{- "data": [
- {
- "id": "56428c32-2ff7-4b9e-ae27-265db0221bfd",
- "name": "Кожний другий день",
- "value": "even"
}, - {
- "id": "af33c8c3-c490-464d-b030-51e3d9262abe",
- "name": "Кожну неділю",
- "value": "byWeekly"
}
]
}
Цей ресурс повертає масив можливих платіжних методів.
{- "data": [
- {
- "id": "b426966b-d498-437f-a35f-36c6714943e2",
- "name": "ЕПЗ",
- "value": "epz"
}, - {
- "id": "3516c0f6-f191-4381-9e78-63ed84db3a4a",
- "name": "Готівка",
- "value": "cash"
}
]
}
Ресурс повертає масив видів платіжних систем.
{- "data": [
- {
- "id": "3516c0f7-f191-4381-9e78-63ed84db3a4a",
- "name": "Western Union",
- "value": "03"
}, - {
- "id": "4f2974b-2fc6-44f5-8c61-b98442a0c97d",
- "name": "INTELEXPRESS",
- "value": "25"
}
]
}