1. Потрібно отримати ключ API розробника для тестування. Нехай це буде — API_KEY
  2. Якщо у вашій системі вже є встановлене поле ІПН - отримайте дані про фоп за допомогою функції /fop (code) — https://opendatabot.com/api/v2/fop/1111111111?apiKey=API_KEY
  3. Далі з /fop (code) ми отримуємо правильне ПІБ українською мовою — "full_name": "Матящук Микола Олександрович"
  4. Далі з /fop (code) беремо "full_name": "Матящук Микола Олександрович" і через функцію / person отримуємо дані про суди, аліменти, розшук — https://opendatabot.com/api/v2/person?apiKey=API_KEY&pib=Матящук Микола Олександрович&region_id=3 Додатковий ідентифікатор для судів - регіон (людина судиться там, де прописана), для розшуку - дата народження.

Коди регіонів

  1. Через / penalties / {code} по ІПН отримуємо усі виконавчі провадження, де людина боржник — https://opendatabot.com/api/v2/penalties/ХХХХХХХХХХ?apiKey=API_KEY

Этап онбордінга

Якщо немає ІПН, точка входу - ПІБ

  1. Через функцію / person по ПІБ отримуємо дані про суди, аліменти, розшук — https://opendatabot.com/api/v2/person?apiKey=t5MfhcqZpDYK-70722-8076a9c98c85a03cba8634e7744777c5&pib=Матящук Микола Олександрович&region_id=3

Додатковий ідентифікатор для судів - регіон (людина зазвичай судять там, де прописана), для розшуку - дата народження.

Якщо база ведеться російською мовою, поле ПІБ має бути редагований для введення ПІБ українською мовою. Рекомендуємо також показати повідомлення "Щоб перевірити людину, введіть ПІБ українською"

  1. Далі по ПІБ та даті народження отримуємо виконавчі провадження (борги)— https://opendatabot.com/api/v2/penalties?apiKey=API_KEY&first_name=Віктор&last_name=Янукович&middle_name=Федорович&birth_date=1950-07-09

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/165d7d6f-d9b7-49b2-8f0d-c64e0b38cdf0/Untitled.png

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/b377bec1-c1a4-4b33-b9f2-0e17a82696a7/Untitled.png

Этап оффера

Просимо ІПН для перевірки даних про фоп, а також подальшого моніторингу

  1. Перевірте дані про фоп Отримайте дані про фоп за допомогою функції / fop (code) — https://opendatabot.com/api/v2/fop/1111111111?apiKey=API_KEY
  2. Поставте фоп на моніторинг за допомогою / subscriptions — пример подписки по ИНН

Опендатабот буде повідомляти його про такі зміни: