Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Service for obtaining information on changing the SIM card identification number (IMSI) by mobile phone number.

...

Info

The report contains the following components:

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"simCheck": {

"phone": "Mobile phone number in +380999999999 format"

},

"reqlng": "Search criteria language (code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Information on SIM card reissue ' - 38",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Step name",

"stm": "Step start stamp date",

"ftm": "Step finish stamp date"

}

},

"error": {

"errtype": "Error code (code from ref.0)",

"errtext": "Error text (value from ref.0)"

},

"reqinfo": {

"reqid": "Outgoing request ID generated by UBKI"

},

"billing": {

"balance": {

"value": "Total assets",

"date": "Date",

"time": "Time"

},

"billdetails": {

"freemon": "Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"freemonref": "Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

"comp": {

"simCheck": {

"fphoneNumber": "Mobile phone number in +380999999999 format",

"changed": "Numerical indicating the presence of a SIM card reissue (-1/0/1)",

"changedref": "Text indication of the presence of a SIM card reissue (code from ref.61)",

"operator": "Operator name",

"respDateTime": "Date and time of receipt of data from the operator",

"deep": "SIM card replacement check period (in days) (5-30)"

},

"id": "59",

"descr": "Sim-card reissue information"

}

}

}

Request XML

Expand
title body:

<?xml version="1.0" encoding="utf-8"?>

<doc>

<ubki sessid="

Сесійний ключ (отримуємо із API авторизації

Session key (obtained from the authorization API)">

<req_envelope descr="

Конверт запиту

Request envelope">

<req_xml descr="

Об'єкт запиту

Request object">

<!--

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

Request parameters -->

<request version="1.0" reqtype="

Код шаблону (Код із дов

Template code (code from ref.49): '

Інформація про перевипуск sim-карти

Information on SIM card reissue ' - 38" reqreason="

Мета надання запиту (Код із дов

Request objective (code from ref.24)">

<!--

Параметри, що описують критерії пошуку

Parameters describing search criteria-->

<i reqlng="

Мова критеріїв пошуку (Код із дов

Search criteria language (code from ref.23)">

<!--

Параметри пошуку

Search options -->

<simCheck phone="

Номер мобільного телефону у форматі

Mobile phone number in +380999999999 format" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<!-- Блок системної інформації System information part -->

<tech>

<trace>

<step name="Найменування крокуStep name" stm="Дата штамп старту крокуStep start stamp date" ftm="Дата штамп фінішу крокуStep finish stamp date">

<!-- Блок trace містить метрики таймінгу кроків формування компонентів The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<error errtype="Код помилки (Код із довError code (code from ref.0)" errtext="Текст помилки (Значення із довError text (value from ref.0)">

</error>

<reqinfo reqid="Вихідний ІД запиту, згенерований УБКІOutgoing request ID generated by UBKI">

</reqinfo>

<!-- Блок інформації щодо поточного стану рахунку припейд Information about the current status of the prepaid account part-->

<billing>

<balance value="Сума балансуTotal assets" date="ДатаDate" time="ЧасTime" />

<billdetails freemon="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)"

freemonref="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"/>

</billing>

</tech>

<!-- Інформація про перевипуск sim-карти "Sim-card reissue information" -->

<comp id="59" descr="Інформація про перевипуск sim-картиSim-card reissue information">

<simCheck fphoneNumber="Номер мобільного телефону у форматі Mobile phone number in +380999999999 format"

changed="Цифрове позначення наявності перевипуску sim-картиNumerical indicating the presence of a SIM card reissue (-1/0/1)"

changedref="Текстове позначення наявності перевипуску sim-карти (Значення із довText indication of the presence of a SIM card reissue (code from ref.61)"

operator="Назва оператораOperator name"

respDateTime="Дата і час отримання даних від оператораDate and time of receipt of data from the operator"

deep="Період, протягом якого проводиться перевірка заміни SIM-карти (в добахSIM card replacement check period (in days) (5-30)" />

</comp>

</ubkidata>

Приклад

Request

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"simCheck": {
								"phone": "+380971321122"
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "38",
						"reqreason": "2"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-08-29 10:58:30.222",
					"ftm": "2022-08-29 10:58:31.554"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002461406"
			}
		},
		"comp": {
			"simCheck": {
				"fphoneNumber": "+380971321122",
				"changed": "1",
				"changedref": "The SIM card was reissued",
				"operator": "Kyivstar",
				"respDateTime": "2022-08-29T10:58:30.307969357",
				"deep": "5"
			},
			"id": "59",
			"descr": "Sim-card reissue information"
		}
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="
1E4EA4075EC549D787501F75B000005B
EDF4309796114D6D9B8365370DA2DEE9">
    <req_
envelope descr="Конверт запиту">
envelope>
      <req_
xml descr="Об'єкт запиту">
xml>
        
<request version="1.0" reqtype="38" reqreason="2">
          <i reqlng="
1
4">
            <simCheck phone="+380971321122" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-0108-1129 1110:5358:3630.662222" ftm="2022-0108-1129 1110:5358:3631.916554" />
        </trace>
        <reqinfo reqid="req2#000002020220req2#000002461406" />
    </tech>
    <comp id="59" descr="ІнформаціяSim-card про перевипуск sim-картиreissue information">
        <simCheck fphoneNumber="+380971321122" changed="1" changedref="Перевипуск sim-карти проводивсяThe SIM card was reissued" operator="Kyivstar" respDateTime="2022-0108-11T1129T10:5358:3630.775701307969357" deep="5" />
    </comp>
</ubkidata>

Test URL

https://test.ubki.ua/b2_api_xml/ubki/xml

Test data

Перевипуск sim-карти не проводивсяThe sim card was not reissued

  • simCheck phone= ”+380962134234”

  • simCheck phone= ”+380662134234”

  • simCheck phone= ”+380981224895”

  • simCheck phone= ”+380732144444”

  • simCheck phone= ”+380506630641”

Перевипуск sim-карти проводивсяThe sim card was reissued

  • simCheck phone= ”+380981220000”

  • simCheck phone= ”+380971321122”

...