HIA order type

EBICS Client user shares the public keys for identification and authentication and encryption with the bank through the HIA order type.




HIA is an upload key management order type. HIA is used to transmit user public certificates for identification and authentication, and encryption to enable the user to initiate transactions with the bank. The order data is compressed and base64-encoded.


Table 1. HIA parameters
Parameter Description and value
HostID The bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the bank's system.
HostUrlAlias When configuring a bank profile, you can specify multiple host URLs and set one host URL as the default. If you want to send a request to a host URL that is not the default URL, then, specify a value for this parameter.
PartnerID The partner ID associated with the user ID.
UserID Unique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
SystemID User ID of the technical user. The HIA order type can be submitted by a technical user who is a delegate of the non-techncial or human user. Hence, the value of the UserID is the same as the value of the systemID.
orderIdPrefix EBICS Client allocates a unique order ID to each order based on the bank, user ID, and the order type. The client generates the order ID as per EBICS specifications. The order ID is a 4-digit alphanumeric ID. You can specify the first character of the order ID. The second, third, and fourth characters of the order ID are alphanumeric in an ascending order (A-Z or 0-9).

This parameter is used with EBICS protocol version H003 only.

SecurityMedium A 4-digit security number in the 0100 to 0499 range. The value cannot be changed for INI, HIA, and HPB order types.
OrderType The order type of the order you are submitting. In this case, HIA is the order type.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"