Card Issuance Application

Method for creating a card issuance application. Used to submit questionnaire data.

URL

Method: POST

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

Request parameters

Name	Required	Type	Comment
`request_id`	yes	string	Card issuance application identifier on the merchant's side.
`additional_data`	yes	json	JSON object for passing application data.
∟ `name`	yes	string	Customer's first name
∟ `last_name`	yes	string	Customer's last name
∟ `surname`	yes	string	Customer's patronymic
∟ `sex`	yes	int	Sex. `Sex` dictionary
∟ `birth_day`	yes	datetime	Date of birth in `YYYY-MM-DD` format
∟ `born_country`	yes	int	Country of birth. `Countries` dictionary
∟ `born_place`	yes	string	Place of birth: city
∟ `citizenship`	yes	int	Citizenship. `Countries` dictionary
∟ `changefio`	yes	int	Whether the full name has changed, `1` – yes, `0` – no
∟ `previousname`	no	string	Previous full name. Required if `1` is passed in `changefio`.
∟ `idresident`	yes	int	Residency. 1 - resident, 2 - non-resident
∟ `inn`	no	int	INN (taxpayer ID)
∟ `is_another_grajd`	yes	int	Are you a citizen/resident of a country other than Russia or the Customs Union member states? `1` – yes, `0` – no.
∟ `document_type`	yes/no	int	Document type (migration card/residence permit). Required if the citizenship field value is other than `1`. Values: `1` — migration card, `2` — document confirming the client's right to stay (reside) in Russia, `3` — both documents.
∟ `migratory_series`	yes/no	string	Migration card series. Becomes required if `document_type` is `1` or `3`.
∟ `migratory_number`	yes/no	string	Migration card number. Becomes required if `document_type` is `1` or `3`.
∟ `migratory_from`	yes/no	string	Migration card stay start date in `YYYY-MM-DD` format. Becomes required if `document_type` is `1` or `3`.
∟ `migratory_exp`	yes/no	string	Migration card stay end date in `YYYY-MM-DD` format. Becomes required if `document_type` is `1` or `3`.
∟ `residence_series`	yes/no	string	Document series (residence permit). Becomes required if `document_type` is `2` or `3`.
∟ `residence_number`	yes/no	string	Document number (residence permit). Becomes required if `document_type` is `2` or `3`.
∟ `residence_issue`	yes/no	string	Name of the institution that issued the residence permit. Becomes required if `document_type` is `2` or `3`.
∟ `residence_issue_from`	yes/no	string	Residence permit validity start date in `YYYY-MM-DD` format. Becomes required if `document_type` is `2` or `3`.
∟ `residence_issue_exp`	yes/no	string	Residence permit validity end date in `YYYY-MM-DD` format. Becomes required if `document_type` is `2` or `3`.
∟ `docseries`	yes	string	Passport series
∟ `docnum`	yes	string	Passport number
∟ `docgive`	yes	string	Passport issuer
∟ `docgivedate`	yes	datetime	Passport issue date in `YYYY-MM-DD` format
∟ `depcode`	yes	string	Department code
∟ `country_reg`	yes	string	Country of registration. `Countries` dictionary
∟ `postindex_reg`	yes	string	Registration address postal code. KLADR
∟ `region_reg`	yes	string	Registration region. KLADR
∟ `district_reg`	yes	string	Registration district. KLADR
∟ `city_reg`	yes	string	Registration city. KLADR
∟ `settlement_reg`	yes	string	Registration locality. KLADR
∟ `street_reg`	yes	string	Registration street. KLADR
∟ `street_reg_ext`	yes	string	Street name extension. KLADR
∟ `housenumber_reg`	yes	string	Registration house number. KLADR
∟ `housecase_reg`	yes	string	Registration building/block number. KLADR
∟ `appartment_reg`	yes	string	Registration apartment. KLADR
∟ `id_time_reg`	yes	string	Registration time in this region, in `dd.mm.yyyy` format.
∟ `foreign_address_reg`	no	string	Foreign registration address, if there is no Russian one. Passed as a single string.
∟ `country_post`	yes	string	Postal address country. `Countries` dictionary
∟ `postindex_post`	yes	string	Postal address postal code. KLADR
∟ `region_post`	yes	string	Postal address region. KLADR
∟ `district_post`	yes	string	Postal address district. KLADR
∟ `city_post`	yes	string	Postal address city. KLADR
∟ `settlement_post`	yes	string	Postal address locality. KLADR
∟ `street_post`	yes	string	Postal address street. KLADR
∟ `street_post_ext`	yes	string	Street name extension. KLADR
∟ `housenumber_post`	yes	string	Postal address house number. KLADR
∟ `housecase_post`	yes	string	Postal address building/block number. KLADR
∟ `appartment_post`	yes	string	Postal address apartment. KLADR
∟ `foreign_adddress_post`	no	string	Foreign postal address, if there is no Russian one. Passed as a single string.
∟ `homephone`	no	string	Home phone number. Must start with "+7" and contain 12 characters. Russian phone numbers only (e.g., +74995553322).
∟ `mobilphone`	yes	string	Mobile phone number. The phone number must start with "+" and include a country code, or "+7". International and Russian numbers.
∟ `email`	no	string	Email address
∟ `pof_declare`	yes	string	Are you a foreign public official/close relative of a foreign public official? `1` – yes, `0` – no.
∟ `pof_fio`	no	string	Full name of the foreign public official (in full). Required if `pof_declare = 1`.
∟ `is_public_officer`	yes	string	Are you a public official/an official of a public international organization? `1` – yes, `0` – no.
∟ `codeword`	yes	string	Code word
∟ `idcard`	yes	string	Card identifier
∟ `currency`	yes	string	Top-up currency. Always value 3810.
∟ `amount`	yes	string	Top-up limit amount of the prepaid card, in rubles

Note

When submitting a card issuance application for a person who is not a citizen of the Russian Federation, a foreign passport must be indicated.

Example request

{
  "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"
  }
}

Request headers

Name	Data type	Required	Description
`X-Api-Key`	string	Yes	Unique shop identifier
`X-Signature`	string	Yes	Signature

The X-Signature signature is formed by concatenating X-Api-Key, request_body, and secret_key. A sha256 hash is computed from the resulting string:

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

request_body - the request body as a string form of the JSON object;
secret_key - the secret key found in the merchant's shop settings;

Response

Example response

200: OK - Application succeeded200: OK - Application declined, validation failed

{
  "id": 11,
  "created": "value",
  "status": "success",
  "request_id": "value",
  "remote_id": null,
  "error_message": null,
  "additional_data": {
    // request body
  }
}

{
  "id": 11,
  "created": "value",
  "status": "declined",
  "request_id": "value",
  "remote_id": null,
  "error_message": "Checks failed",
  "additional_data": {
    // request body
  }
}

Response parameters

Name	Type	Description
`id`	string	Application ID in the system
`status`	string	Application status
`request_id`	string	Merchant's application identifier
`remote_id`	string	Identifier on the provider's side
`created`	string	Application creation date (UTC)
`error_message`	string	Error message
`additional_data`	json	Submitted request body

status - application status:
- new - application created
- success - checks passed, the card can be issued
- declined - application declined, data must be corrected and a new application (questionnaire) submitted.

Dictionaries

Sex dictionary

Value	Description
0	No data
1	Male
2	Female
-1	Customer declined to provide

Countries dictionary

Value	Name	Country
1	Russia	RUSSIA
2	Aruba	ARUBA
3	Afghanistan	AFGHANISTAN
4	Angola	ANGOLA
5	Anguilla	ANGUILLA
6	Åland Islands	ELAND ISLANDS
7	Albania	ALBANIA
8	Andorra	ANDORRA
9	Netherlands Antilles	NETHERLANDS ANTILLES
10	United Arab Emirates	UNITED ARAB EMIRATES
11	Argentina	ARGENTINA
12	Armenia	ARMENIA
13	American Samoa	AMERICAN SAMOA
14	Antarctica	ANTARCTICA
15	French Southern Territories	FRENCH SOUTHERN TERRITORIES
16	Antigua and Barbuda	ANTIGUA AND BARBUDA
17	Australia	AUSTRALIA
18	Austria	AUSTRIA
19	Azerbaijan	AZERBAIJAN
20	Burundi	BURUNDI
21	Belgium	BELGIUM
22	Benin	BENIN
23	Burkina Faso	BURKINA FASO
24	Bangladesh	BANGLADESH
25	Bulgaria	BULGARIA
26	Bahrain	BAHRAIN
27	Bahamas	BAHAMAS
28	Bosnia and Herzegovina	BOSNIA AND HERZEGOWINA
29	Belarus	BELARUS
30	Belize	BELIZE
31	Bermuda	BERMUDA
32	Bolivia	BOLIVIA
33	Brazil	BRAZIL
34	Barbados	BARBADOS
35	Brunei Darussalam	BRUNEI DARUSSALAM
36	Bhutan	BHUTAN
37	Bouvet Island	BOUVET ISLAND
38	Botswana	BOTSWANA
39	Central African Republic	CENTRAL AFRICAN REPUBLIC
40	Canada	CANADA
41	Cocos (Keeling) Islands	COCOS (KEELING) ISLANDS
42	Switzerland	SWITZERLAND
43	Chile	CHILE
44	China	CHINA
45	Cote D'Ivoire	COTE D'IVOIRE
46	Cameroon	CAMEROON
47	Congo, Democratic Republic of	DEMOCRATIC REPUBLIC OF KONGO
48	Congo	CONGO
49	Cook Islands	COOK ISLANDS
50	Colombia	COLOMBIA
51	Comoros	COMOROS
52	Cape Verde	CAPE VERDE
53	Costa Rica	COSTA RICA
54	Cuba	CUBA
55	Christmas Island	CHRISTMAS ISLAND
56	Cayman Islands	CAYMAN ISLANDS
57	Cyprus	CYPRUS
58	Czech Republic	CZECH REPUBLIC
59	Germany	GERMANY
60	Djibouti	DJIBOUTI
61	Dominica	DOMINICA
62	Denmark	DENMARK
63	Dominican Republic	DOMINICAN REPUBLIC
64	Algeria	ALGERIA
65	Ecuador	ECUADOR
66	Egypt	EGYPT
67	Eritrea	ERITREA
68	Western Sahara	WESTERN SAHARA
69	Spain	SPAIN
70	Estonia	ESTONIA
71	Ethiopia	ETHIOPIA
72	Finland	FINLAND
73	Fiji	FIJI
74	Falkland Islands (Malvinas)	FALKLAND ISLANDS (MALVINAS)
75	France	FRANCE
76	Faroe Islands	FAROE ISLANDS
77	Micronesia, Federated States of	MICRONESIA, FEDERATED STATES OF
78	Gabon	GABON
79	United Kingdom	UNITED KINGDOM
80	Georgia	GEORGIA
81	Ghana	GHANA
82	Gibraltar	GIBRALTAR
83	Guinea	GUINEA
84	Guadeloupe	GUADELOUPE
85	Gambia	GAMBIA
86	Guinea-Bissau	GUINEA-BISSAU
87	Equatorial Guinea	EQUATORIAL GUINEA
88	Greece	GREECE
89	Grenada	GRENADA
90	Greenland	GREENLAND
91	Guatemala	GUATEMALA
92	French Guiana	FRENCH GUIANA
93	Guam	GUAM
94	Guyana	GUYANA
95	Hong Kong	HONG KONG
96	Heard Island and McDonald Islands	HEARD AND MC DONALD ISLANDS
97	Honduras	HONDURAS
98	Croatia	CROATIA (LOCAL NAME: HRVATSKA)
99	Haiti	HAITI
100	Hungary	HUNGARY
101	Indonesia	INDONESIA
102	India	INDIA
103	British Indian Ocean Territory	BRITISH INDIAN OCEAN TERRITORY
104	Ireland	IRELAND
105	Iran (Islamic Republic of)	IRAN (ISLAMIC REPUBLIC OF)
106	Iraq	IRAQ
107	Iceland	ICELAND
108	Israel	ISRAEL
109	Italy	ITALY
110	Jamaica	JAMAICA
111	Jordan	JORDAN
112	Japan	JAPAN
113	Kazakhstan	KAZAKHSTAN
114	Kenya	KENYA
115	Kyrgyzstan	KYRGYZSTAN
116	Cambodia	CAMBODIA
117	Kiribati	KIRIBATI
118	Saint Kitts and Nevis	SAINT KITTS AND NEVIS
119	Korea, Republic of	KOREA, REPUBLIC OF
120	Kuwait	KUWAIT
121	Lao People's Democratic Republic	LAO PEOPLE'S DEMOCRATIC REPUBLIC
122	Lebanon	LEBANON
123	Liberia	LIBERIA
124	Libyan Arab Jamahiriya	LIBYAN ARAB JAMAHIRIYA
125	Saint Lucia	SAINT LUCIA
126	Liechtenstein	LIECHTENSTEIN
127	Sri Lanka	SRI LANKA
128	Lesotho	LESOTHO
129	Lithuania	LITHUANIA
130	Luxembourg	LUXEMBOURG
131	Latvia	LATVIA
132	Macau	MACAU
133	Morocco	MOROCCO
134	Monaco	MONACO
135	Moldova, Republic of	MOLDOVA, REPUBLIC OF
136	Madagascar	MADAGASCAR
137	Maldives	MALDIVES
138	Mexico	MEXICO
139	Marshall Islands	MARSHALL ISLANDS
140	Macedonia, The Former Yugoslav Republic of	MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
141	Mali	MALI
142	Malta	MALTA
143	Myanmar	MYANMAR
144	Mongolia	MONGOLIA
145	Northern Mariana Islands	NORTHERN MARIANA ISLANDS
146	Mozambique	MOZAMBIQUE
147	Mauritania	MAURITANIA
148	Montserrat	MONTSERRAT
149	Martinique	MARTINIQUE
150	Mauritius	MAURITIUS
151	Malawi	MALAWI
152	Malaysia	MALAYSIA
153	Mayotte	MAYOTTE
154	Namibia	NAMIBIA
155	New Caledonia	NEW CALEDONIA
156	Niger	NIGER
157	Norfolk Island	NORFOLK ISLAND
158	Nigeria	NIGERIA
159	Nicaragua	NICARAGUA
160	Niue	NIUE
161	Netherlands	NETHERLANDS
162	Norway	NORWAY
163	Nepal	NEPAL
164	Nauru	NAURU
165	New Zealand	NEW ZEALAND
166	Oman	OMAN
167	Pakistan	PAKISTAN
168	Panama	PANAMA
169	Pitcairn	PITCAIRN
170	Peru	PERU
171	Philippines	PHILIPPINES
172	Palau	PALAU
173	Papua New Guinea	PAPUA NEW GUINEA
174	Poland	POLAND
175	Puerto Rico	PUERTO RICO
176	Korea, Democratic People's Republic of	KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF
177	Portugal	PORTUGAL
178	Paraguay	PARAGUAY
179	Palestine Territory, Occupied	PALESTINE TERRITORY
180	French Polynesia	FRENCH POLYNESIA
181	Qatar	QATAR
182	Reunion	REUNION
183	Romania	ROMANIA
184	Rwanda	RWANDA
185	Saudi Arabia	SAUDI ARABIA
186	Serbia and Montenegro	SERBIA AND CHERNOGORIYA
187	Sudan	SUDAN
188	Senegal	SENEGAL
189	Singapore	SINGAPORE
190	South Georgia and the South Sandwich Islands	SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
191	Saint Helena	ST. HELENA
192	Svalbard and Jan Mayen Islands	SVALBARD AND JAN MAYEN ISLANDS
193	Solomon Islands	SOLOMON ISLANDS
194	Sierra Leone	SIERRA LEONE
195	El Salvador	EL SALVADOR
196	San Marino	SAN MARINO
197	Somalia	SOMALIA
198	Saint Pierre and Miquelon	ST. PIERRE AND MIQUELON
199	Sao Tome and Principe	SAO TOME AND PRINCIPE
200	Suriname	SURINAME
201	Slovakia	SLOVAKIA (SLOVAK REPUBLIC)
202	Slovenia	SLOVENIA
203	Sweden	SWEDEN
204	Swaziland	SWAZILAND
205	Seychelles	SEYCHELLES
206	Syrian Arab Republic	SYRIAN ARAB REPUBLIC
207	Turks and Caicos Islands	TURKS AND CAICOS ISLANDS
208	Chad	CHAD
209	Togo	TOGO
210	Thailand	THAILAND
211	Tajikistan	TAJIKISTAN
212	Tokelau	TOKELAU
213	Turkmenistan	TURKMENISTAN
214	Timor-Leste	EAST TIMOR
215	Tonga	TONGA
216	Trinidad and Tobago	TRINIDAD AND TOBAGO
217	Tunisia	TUNISIA
218	Turkey	TURKEY
219	Tuvalu	TUVALU
220	Taiwan (China)	TAIWAN, PROVINCE OF CHINA
221	Tanzania, United Republic of	TANZANIA, UNITED REPUBLIC OF
222	Uganda	UGANDA
223	Ukraine	UKRAINE
224	United States Minor Outlying Islands	UNITED STATES MINOR OUTLYING ISLANDS
225	Uruguay	URUGUAY
226	United States	UNITED STATES OF AMERICA
227	Uzbekistan	UZBEKISTAN
228	Vatican City State (Holy See)	VATICAN CITY STATE (HOLY SEE)
229	Saint Vincent and the Grenadines	SAINT VINCENT AND THE GRENADINES
230	Venezuela	VENEZUELA
231	Virgin Islands, British	VIRGIN ISLANDS (BRITISH)
232	Virgin Islands, U.S.	VIRGIN ISLANDS (U.S.)
233	Vietnam	VIET NAM
234	Vanuatu	VANUATU
235	Wallis and Futuna Islands	WALLIS AND FUTUNA ISLANDS
236	Samoa	SAMOA
237	Yemen	YEMEN
238	South Africa	SOUTH AFRICA
239	Zambia	ZAMBIA
240	Zimbabwe	ZIMBABWE
482	Serbia	SERBIA
483	Montenegro	CHERNOGORIYA