Заявка на выпуск карты

Метод создания заявки на выпуск карты. Используется для передачи анкетных данных.

URL

Метод: POST

Production: https://api.baas.kvell.group/v1/issue-card/applications
Stage: https://api.baas.stage.kvell.group/v1/issue-card/applications

Параметры запроса

Название	Обязательность	Тип	Комментарий
`request_id`	да	string	Идентификатор заявки на выпуск карты на стороне мерчанта.
`additional_data`	да	json	JSON-объект для передачи данных заявки.
∟ `name`	да	string	Имя клиента
∟ `last_name`	да	string	Фамилия клиента
∟ `surname`	да	string	Отчество клиента
∟ `sex`	да	int	Пол. Справочник `Sex`
∟ `birth_day`	да	datetime	Дата рождения в формате `YYYY-MM-DD`
∟ `born_country`	да	int	Страна рождения. Справочник `Countries`
∟ `born_place`	да	string	Место рождения: город
∟ `citizenship`	да	int	Гражданство. Справочник `Countries`
∟ `changefio`	да	int	Менялись ли ФИО, `1` – да, `0` – нет
∟ `previousname`	нет	string	Предыдущее ФИО. Обязательное, если в `changefio` передано `1`.
∟ `idresident`	да	int	Резидентность. 1-резидент, 2 - не резидент
∟ `inn`	нет	int	ИНН
∟ `is_another_grajd`	да	int	Являетесь ли Вы гражданином/резидентом стран, отличных от России и стран-членов Таможенного союза? `1` – да, `0` – нет.
∟ `document_type`	да/нет	int	Тип документа (миграционная карта/ВНЖ). Обязательно для заполнения, если в поле citizenship значение отличное от `1`. Значения: `1` — миграционная карта, `2` — документ, подтверждающий право Клиента на пребывание (проживание) в РФ, `3` — оба документа.
∟ `migratory_series`	да/нет	string	Серия миграционной карты. Становится обязательным, если в поле document_type передано значение `1` или `3`.
∟ `migratory_number`	да/нет	string	Номер миграционной карты. Становится обязательным, если в поле document_type передано значение `1` или `3`.
∟ `migratory_from`	да/нет	string	Дата начала срока пребывания по миграционной карте в формате `YYYY-MM-DD. Становится обязательным, если в поле document_type передано значение`1`или`3`.
∟ `migratory_exp`	да/нет	string	Дата окончания срока пребывания по миграционной карте в формате `YYYY-MM-DD`. Становится обязательным, если в поле document_type передано значение `1` или `3`.
∟ `residence_series`	да/нет	string	Серия документа (вид на жительство). Становится обязательным, если в поле document_type передано значение `2` или `3`.
∟ `residence_number`	да/нет	string	Номер документа (вид на жительство). Становится обязательным, если в поле document_type передано значение `2` или `3`.
∟ `residence_issue`	да/нет	string	Наименование учреждения, выдавшего вид на жительство. Становится обязательным, если в поле document_type передано значение `2` или `3`.
∟ `residence_issue_from`	да/нет	string	Дата начала действия документа (вид на жительство) в формате `YYYY-MM-DD`. Становится обязательным, если в поле document_type передано значение `2` или `3`.
∟ `residence_issue_exp`	да/нет	string	Дата окончания действия документа (вид на жительство) в формате `YYYY-MM-DD`. Становится обязательным, если в поле document_type передано значение `2` или `3`.
∟ `docseries`	да	string	Серия паспорта
∟ `docnum`	да	string	Номер паспорта
∟ `docgive`	да	string	Кем выдан паспорт
∟ `docgivedate`	да	datetime	Дата выдачи паспорта в формате `YYYY-MM-DD`
∟ `depcode`	да	string	Код подразделения
∟ `country_reg`	да	string	Страна регистрации. Справочник `Countries`
∟ `postindex_reg`	да	string	Индекс адреса регистрации. КЛАДР
∟ `region_reg`	да	string	Регион регистрации. КЛАДР
∟ `district_reg`	да	string	Район регистрации. КЛАДР
∟ `city_reg`	да	string	Город регистрации. КЛАДР
∟ `settlement_reg`	да	string	Населенный пункт регистрации. КЛАДР
∟ `street_reg`	да	string	Улица регистрации. КЛАДР
∟ `street_reg_ext`	да	string	Расширение названия улицы. КЛАДР
∟ `housenumber_reg`	да	string	Номер дома регистрации. КЛАДР
∟ `housecase_reg`	да	string	Корпус дома регистрации. КЛАДР
∟ `appartment_reg`	да	string	Квартира регистрации. КЛАДР
∟ `id_time_reg`	да	string	Время регистрации в данном регионе в формате `dd.mm.yyyy`.
∟ `foreign_address_reg`	нет	string	Иностранный адрес регистрации, если нет российского. Передается одной строкой.
∟ `country_post`	да	string	Страна почтового адреса. Справочник `Countries`
∟ `postindex_post`	да	string	Индекс почтового адреса. КЛАДР
∟ `region_post`	да	string	Регион почтового адреса. КЛАДР
∟ `district_post`	да	string	Район почтового адреса. КЛАДР
∟ `city_post`	да	string	Город почтового адреса. КЛАДР
∟ `settlement_post`	да	string	Населенный пункт почтового адреса. КЛАДР
∟ `street_post`	да	string	Улица почтового адреса. КЛАДР
∟ `street_post_ext`	да	string	Расширение названия улицы. КЛАДР
∟ `housenumber_post`	да	string	Номер дома почтового адреса. КЛАДР
∟ `housecase_post`	да	string	Корпус дома почтового адреса. КЛАДР
∟ `appartment_post`	да	string	Квартира почтового адреса. КЛАДР
∟ `foreign_adddress_post`	нет	string	Иностранный почтовый адрес, если нет российского. Передается одной строкой.
∟ `homephone`	нет	string	Домашний номер телефона. Должен начинаться с «+7» и содержать в себе 12 символов. Только Российские номера телефонов (Например, +74995553322).
∟ `mobilphone`	да	string	Мобильный номер телефона. Номер телефона должен начинаться с «+» и содержать код страны, или «+7». Международные и Российские номера.
∟ `email`	нет	string	Адрес электронной почты
∟ `pof_declare`	да	string	Являетесь ли Вы иностранным публичным должностным лицом/близким родственником иностранного публичного должностного лица. `1` – да, `0` – нет.
∟ `pof_fio`	нет	string	ФИО иностранного публичного должностного лица (полностью). Обязательное, если `pof_declare = 1`.
∟ `is_public_officer`	да	string	Являетесь ли Вы публичным должностным лицом/должностным лицом публичной международной организации. `1` – да, `0` – нет.
∟ `codeword`	да	string	Кодовое слово
∟ `idcard`	да	string	Идентификатор карты
∟ `currency`	да	string	Валюта пополнения. Всегда значение 3810.
∟ `amount`	да	string	Сумма лимита пополняемой ППК в рублях

Примечание

При подачи заявки на оформление карты лицом не имеющим гражданство РФ указывается иностранный паспорт.

Пример запроса

{
  "request_id": "string",
  "additional_data": {
    "last_name": "string",
    "name": "string",
    "surname": "string",
    "sex": "int",
    "birth_day": "datetime",
    "born_country": "int",
    "born_place": "string",
    "citizenship": "int",
    "changefio": "int",
    "idresident": "int",
    "is_another_grajd": "int",
    "docseries": "string",
    "docnum": "string",
    "docgive": "string",
    "docgivedate": "string",
    "depcode": "string",
    "country_reg": "string",
    "postindex_reg": "string",
    "region_reg": "string",
    "district_reg": "string",
    "city_reg": "string",
    "settlement_reg": "string",
    "street_reg": "string",
    "street_reg_ext": "string",
    "housenumber_reg": "string",
    "housecase_reg": "string",
    "appartment_reg": "string",
    "id_time_reg": "string",
    "country_post": "string",
    "postindex_post": "string",
    "region_post": "string",
    "district_post": "string",
    "city_post": "string",
    "settlement_post": "string",
    "street_post": "string",
    "street_post_ext": "string",
    "housenumber_post": "string",
    "housecase_post": "string",
    "appartment_post": "string",
    "mobilphone": "string",
    "pof_declare": "string",
    "is_public_officer": "string",
    "codeword": "string",
    "idcard": "string",
    "amount": "string"
  }
}

Заголовки запроса

Название	Тип данных	Обязательно	Описание
`X-Api-Key`	string	Да	Уникальный идентификатор магазина
`X-Signature`	string	Да	Подпись

Подпись X-Signature формируется конкатенацией X-Api-Key, request_body и secret_key. Формируется sha256 от полученной строки:

sha256({X-Api-Key}{request_body}{secret_key})

request_body - тело запроса в формате строки от json-объекта;
secret_key - секретный ключ, который находится в настройках магазина мерчанта;

Ответ запроса

Пример ответа

200: OK - Заявка прошла успешно200: OK - Заявка отклонена, валидация не пройдена

{
  "id": 11,
  "created": "value",
  "status": "success",
  "request_id": "value",
  "remote_id": null,
  "error_message": null,
  "additional_data": {
    // тело запроса
  }
}

{
  "id": 11,
  "created": "value",
  "status": "declined",
  "request_id": "value",
  "remote_id": null,
  "error_message": "Проверки не пройдены",
  "additional_data": {
    // тело запроса
  }
}

Параметры ответа

Название	Тип	Описание
`id`	string	ID заявки в системе
`status`	string	Статус заявки
`request_id`	string	Идентификатор заявки мерчанта
`remote_id`	string	Идентификатор на стороне провайдера
`created`	string	Дата создания заявки по UTC
`error_message`	string	Сообщение ошибки
`additional_data`	json	Переданное тело запроса

status - статус заявки:
- new - заявка создана
- success - проверка пройдена, можно выпустить карту
- declined - заявка отклонена, необходимо поправить данные и сформировать новую заявку (анкету).

Справочники

Cправочник Sex

Значение	Описание
0	Нет данных
1	Мужской
2	Женский
-1	Клиент отказ.пред

Справочник Countries

Значение	Название	Country
1	Россия	RUSSIA
2	Аруба	ARUBA
3	Афганистан	AFGHANISTAN
4	Ангола	ANGOLA
5	Ангилья	ANGUILLA
6	Эландские острова	ELAND ISLANDS
7	Албания	ALBANIA
8	Андорра	ANDORRA
9	Нидерландские Антилы	NETHERLANDS ANTILLES
10	Объединенные Арабские Эмираты	UNITED ARAB EMIRATES
11	Аргентина	ARGENTINA
12	Армения	ARMENIA
13	Американское Самоа	AMERICAN SAMOA
14	Антарктида	ANTARCTICA
15	Французские Южные территории	FRENCH SOUTHERN TERRITORIES
16	Антигуа и Барбуда	ANTIGUA AND BARBUDA
17	Австралия	AUSTRALIA
18	Австрия	AUSTRIA
19	Азербайджан	AZERBAIJAN
20	Бурунди	BURUNDI
21	Бельгия	BELGIUM
22	Бенин	BENIN
23	Буркина-Фасо	BURKINA FASO
24	Бангладеш	BANGLADESH
25	Болгария	BULGARIA
26	Бахрейн	BAHRAIN
27	Багамы	BAHAMAS
28	Босния и Герцеговина	BOSNIA AND HERZEGOWINA
29	Беларусь	BELARUS
30	Белиз	BELIZE
31	Бермуды	BERMUDA
32	Боливия	BOLIVIA
33	Бразилия	BRAZIL
34	Барбадос	BARBADOS
35	Бруней-Даруссалам	BRUNEI DARUSSALAM
36	Бутан	BHUTAN
37	Остров Буве	BOUVET ISLAND
38	Ботсвана	BOTSWANA
39	Центрально-Африканская Республика	CENTRAL AFRICAN REPUBLIC
40	Канада	CANADA
41	Кокосовые (Килинг) острова	COCOS (KEELING) ISLANDS
42	Швейцария	SWITZERLAND
43	Чили	CHILE
44	Китай	CHINA
45	Кот д'Ивуар	COTE D'IVOIRE
46	Камерун	CAMEROON
47	Конго, демократическая республика	DEMOCRATIC REPUBLIC OF KONGO
48	Конго	CONGO
49	Острова Кука	COOK ISLANDS
50	Колумбия	COLOMBIA
51	Коморы	COMOROS
52	Кабо-Верде	CAPE VERDE
53	Коста-Рика	COSTA RICA
54	Куба	CUBA
55	Остров Рождества	CHRISTMAS ISLAND
56	Острова Кайман	CAYMAN ISLANDS
57	Кипр	CYPRUS
58	Чешская Республика	CZECH REPUBLIC
59	Германия	GERMANY
60	Джибути	DJIBOUTI
61	Доминика	DOMINICA
62	Дания	DENMARK
63	Доминиканская Республика	DOMINICAN REPUBLIC
64	Алжир	ALGERIA
65	Эквадор	ECUADOR
66	Египет	EGYPT
67	Эритрея	ERITREA
68	Западная Сахара	WESTERN SAHARA
69	Испания	SPAIN
70	Эстония	ESTONIA
71	Эфиопия	ETHIOPIA
72	Финляндия	FINLAND
73	Фиджи	FIJI
74	Фолклендские острова (Мальвинские)	FALKLAND ISLANDS (MALVINAS)
75	Франция	FRANCE
76	Фарерские острова	FAROE ISLANDS
77	Микронезия, федеративные штаты	MICRONESIA, FEDERATED STATES OF
78	Габон	GABON
79	Соединенное Королевство	UNITED KINGDOM
80	Грузия	GEORGIA
81	Гана	GHANA
82	Гибралтар	GIBRALTAR
83	Гвинея	GUINEA
84	Гваделупа	GUADELOUPE
85	Гамбия	GAMBIA
86	Гвинея-Бисау	GUINEA-BISSAU
87	Экваториальная Гвинея	EQUATORIAL GUINEA
88	Греция	GREECE
89	Гренада	GRENADA
90	Гренландия	GREENLAND
91	Гватемала	GUATEMALA
92	Французская Гвиана	FRENCH GUIANA
93	Гуам	GUAM
94	Гайана	GUYANA
95	Гонконг	HONG KONG
96	Остров Херд и острова Макдональд	HEARD AND MC DONALD ISLANDS
97	Гондурас	HONDURAS
98	Хорватия	CROATIA (LOCAL NAME: HRVATSKA)
99	Гаити	HAITI
100	Венгрия	HUNGARY
101	Индонезия	INDONESIA
102	Индия	INDIA
103	Британская территория в Индийском океане	BRITISH INDIAN OCEAN TERRITORY
104	Ирландия	IRELAND
105	Иран, исламская республика	IRAN (ISLAMIC REPUBLIC OF)
106	Ирак	IRAQ
107	Исландия	ICELAND
108	Израиль	ISRAEL
109	Италия	ITALY
110	Ямайка	JAMAICA
111	Иордания	JORDAN
112	Япония	JAPAN
113	Казахстан	KAZAKHSTAN
114	Кения	KENYA
115	Киргизия	KYRGYZSTAN
116	Камбоджа	CAMBODIA
117	Кирибати	KIRIBATI
118	Сент-Китс и Невис	SAINT KITTS AND NEVIS
119	Корея, республика	KOREA, REPUBLIC OF
120	Кувейт	KUWAIT
121	Лаосская Народно-Демократическая Республика	LAO PEOPLE'S DEMOCRATIC REPUBLIC
122	Ливан	LEBANON
123	Либерия	LIBERIA
124	Ливийская Арабская Джамахирия	LIBYAN ARAB JAMAHIRIYA
125	Сент-Люсия	SAINT LUCIA
126	Лихтенштейн	LIECHTENSTEIN
127	Шри-Ланка	SRI LANKA
128	Лесото	LESOTHO
129	Литва	LITHUANIA
130	Люксембург	LUXEMBOURG
131	Латвия	LATVIA
132	Макао	MACAU
133	Марокко	MOROCCO
134	Монако	MONACO
135	Молдова, республика	MOLDOVA, REPUBLIC OF
136	Мадагаскар	MADAGASCAR
137	Мальдивы	MALDIVES
138	Мексика	MEXICO
139	Маршалловы Острова	MARSHALL ISLANDS
140	Македония, бывшая Югославская Республика	MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
141	Мали	MALI
142	Мальта	MALTA
143	Мьянма	MYANMAR
144	Монголия	MONGOLIA
145	Северные Марианские острова	NORTHERN MARIANA ISLANDS
146	Мозамбик	MOZAMBIQUE
147	Мавритания	MAURITANIA
148	Монтсеррат	MONTSERRAT
149	Мартиника	MARTINIQUE
150	Маврикий	MAURITIUS
151	Малави	MALAWI
152	Малайзия	MALAYSIA
153	Майотта	MAYOTTE
154	Намибия	NAMIBIA
155	Новая Каледония	NEW CALEDONIA
156	Нигер	NIGER
157	Остров Норфолк	NORFOLK ISLAND
158	Нигерия	NIGERIA
159	Никарагуа	NICARAGUA
160	Ниуэ	NIUE
161	Нидерланды	NETHERLANDS
162	Норвегия	NORWAY
163	Непал	NEPAL
164	Науру	NAURU
165	Новая Зеландия	NEW ZEALAND
166	Оман	OMAN
167	Пакистан	PAKISTAN
168	Панама	PANAMA
169	Питкерн	PITCAIRN
170	Перу	PERU
171	Филиппины	PHILIPPINES
172	Палау	PALAU
173	Папуа-Новая Гвинея	PAPUA NEW GUINEA
174	Польша	POLAND
175	Пуэрто-Рико	PUERTO RICO
176	Корея, народно-демократическая республика	KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF
177	Португалия	PORTUGAL
178	Парагвай	PARAGUAY
179	Палестинская территория, оккупированная	PALESTINE TERRITORY
180	Французская Полинезия	FRENCH POLYNESIA
181	Катар	QATAR
182	Реюньон	REUNION
183	Румыния	ROMANIA
184	Руанда	RWANDA
185	Саудовская Аравия	SAUDI ARABIA
186	Сербия и Черногория	SERBIA AND CHERNOGORIYA
187	Судан	SUDAN
188	Сенегал	SENEGAL
189	Сингапур	SINGAPORE
190	Южная Джорджия и Южные Сандвичевы острова	SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
191	Святая Елена	ST. HELENA
192	Шпицберген и Ян Майен	SVALBARD AND JAN MAYEN ISLANDS
193	Соломоновы Острова	SOLOMON ISLANDS
194	Сьерра-Леоне	SIERRA LEONE
195	Эль-Сальвадор	EL SALVADOR
196	Сан-Марино	SAN MARINO
197	Сомали	SOMALIA
198	Сент-Пьер и Микелон	ST. PIERRE AND MIQUELON
199	Сан-Томе и Принсипи	SAO TOME AND PRINCIPE
200	Суринам	SURINAME
201	Словакия	SLOVAKIA (SLOVAK REPUBLIC)
202	Словения	SLOVENIA
203	Швеция	SWEDEN
204	Свазиленд	SWAZILAND
205	Сейшелы	SEYCHELLES
206	Сирийская Арабская Республика	SYRIAN ARAB REPUBLIC
207	Острова Теркс и Кайкос	TURKS AND CAICOS ISLANDS
208	Чад	CHAD
209	Того	TOGO
210	Таиланд	THAILAND
211	Таджикистан	TAJIKISTAN
212	Токелау	TOKELAU
213	Туркмения	TURKMENISTAN
214	Тимор-Лесте	EAST TIMOR
215	Тонга	TONGA
216	Тринидад и Тобаго	TRINIDAD AND TOBAGO
217	Тунис	TUNISIA
218	Турция	TURKEY
219	Тувалу	TUVALU
220	Тайвань (Китай)	TAIWAN, PROVINCE OF CHINA
221	Танзания, объединенная республика	TANZANIA, UNITED REPUBLIC OF
222	Уганда	UGANDA
223	Украина	UKRAINE
224	Малые Тихоокеанские Отдаленные острова Соединенных Штатов	UNITED STATES MINOR OUTLYING ISLANDS
225	Уругвай	URUGUAY
226	Соединенные Штаты	UNITED STATES OF AMERICA
227	Узбекистан	UZBEKISTAN
228	Папский Престол (Государство - город Ватикан)	VATICAN CITY STATE (HOLY SEE)
229	Сент-Винсент и Гренадины	SAINT VINCENT AND THE GRENADINES
230	Венесуэла	VENEZUELA
231	Виргинские острова, Британские	VIRGIN ISLANDS (BRITISH)
232	Виргинские острова, США	VIRGIN ISLANDS (U.S.)
233	Вьетнам	VIET NAM
234	Вануату	VANUATU
235	Уоллис и Футуна	WALLIS AND FUTUNA ISLANDS
236	Самоа	SAMOA
237	Йемен	YEMEN
238	Южная Африка	SOUTH AFRICA
239	Замбия	ZAMBIA
240	Зимбабве	ZIMBABWE
482	Сербия	SERBIA
483	Черногория	CHERNOGORIYA