Верифікація номеру телефону

URI: api/v1/promotion/customer/verification

Метод використовується для верифікації карти за допомогою коду який отримано за допомогою метода Отримання коду підтвердження верифікації.

Запит виконується методом POST з тілом запиту у json форматі.

⚠️ Запит повинен містити заголовок Accept: application/json

інформація

Код верифікації діє протягом обмеженого часу

Параметри запиту

Ім'я	Тип	Обов'язковий	Опис
phone	string	Так	Номер телефону клієнта
code	string	Так	Код підтвердження

Приклад запиту

Запит: /api/v1/promotion/customer/verification

{
    "phone": "380991234567",
    "code": "198927"
}

Параметри відповіді

Ім'я	Тип	Опис
data	object	Дані клієнта
data.phone	string	Номер телефона клієнта
data.last_name	string	Прізвище клієнта
data.first_name	string	Ім'я клієнта
data.middle_name	string	Ім'я по батькові клієнта
data.city_name	string	Назва населеного пункту проживання клієнта
data.email	string	Адреса електронної пошти клієнта
data.birthday	string	Дата народження клієнта
data.gender	string	Стать клієнта: m - чоловік f - жінка
data.discount_card_number	string	Номер дисконтної картки клієнта
data.want_free_samples	boolean	Прапор згоди отримання безкоштовних зразків
data.contact_via_phone	boolean	Прапор згоди зв'язку через телефон
data.contact_via_sms	boolean	Прапор згоди зв'язку через СМС
data.contact_via_email	boolean	Прапор згоди зв'язку через електронну пошту
data.contact_via_messenger	boolean	Прапор згоди зв'язку через месенджери
data.agree_terms_conditions	boolean	Прапор згоди з правилами та умовами
data.phone_verified	boolean	Прапор підтвердження номера телефона клієнта
data.bonuses	float/double	Кількість бонусів на рахунку клієнта
data.type	object	Тип карти
data.type.id	string	ID типу карти
data.type.name	string	Назва типу карти
data.address	string	Адреса клієнта
data.address_post_code	string	Поштовий індекс клієнта
data.address_flat	string	Номер квартири/будинку клієнта
data.children	array	Список з роками народження дітей клієнта
data.loyalty	boolean	Прапор активної програми лояльності
data.loyalty_date	string	Строк дії програми лояльності

Приклад відповіді

Відповідь: /api/v1/promotion/customer/verification

{
  "data": {
    "phone": "380991234567",
    "last_name": "Шевченко",
    "first_name": "Тарас",
    "middle_name": "Григорович",
    "city_name": "Конотоп",
    "email": "[email protected]",
    "birthday": "16.07.1993",
    "gender": "m",
    "discount_card_number": "3809193080340",
    "want_free_samples": 1,
    "contact_via_phone": 1,
    "contact_via_sms": 1,
    "contact_via_email": 1,
    "contact_via_messenger": 1,
    "agree_terms_conditions": 1,
    "phone_verified": 1,
    "bonuses": 0,
    "type": {
      "id": null,
      "name": null
    },
    "address": null,
    "address_post_code": null,
    "address_flat": null,
    "children": [],
    "loyalty": false,
    "loyalty_date": null
  }
}

Приклади неуспішних відповідей

Код підтвердження не знайдено

{
    "message": "Verification code does not exists"
}

Код використаний

{
    "message": "Verification code is used"
}

Час дії коду закінчився

{
    "message": "Verification code is expired"
}