> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/namespaces/namespacecom__verifone__host.md). # com\_verifone\_host [Typedefs](#typedef-members) | [Enumerations](#enum-members) | | | | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | Typedefs | | | typedef uint8\_t | [key\_type\_t](#a2418ec606f68970a9ed5ddf6ede58a2f) | | typedef enum [com\_verifone\_host::pin\_entry\_type\_e](#a112cf2dddd5a504da9cb646fe6df856a) | [pin\_entry\_type\_t](#a8912bf5e7a5e7c3572234976755a39aa) | | typedef enum [com\_verifone\_host::pin\_block\_format\_e](#a9187fdfc7bd10fdf9a04181929e41693) | [pin\_block\_format\_t](#ad9cc247c205c1cbf74aae27e459c4ce9) | | | | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerations | | | enum |

key\_type\_e {
KEY\_TYPE\_\_INVALID\_E = -1, KEY\_TYPE\_TMK = 0, KEY\_TYPE\_PPK = 1, KEY\_TYPE\_MGK = 2,
KEY\_TYPE\_DEK = 3, KEY\_TYPE\_TCU\_PK = 4, KEY\_TYPE\_SPONSOR\_PK = 5, KEY\_TYPE\_SPONSOR\_MK = 6,
KEY\_TYPE\_SPONSOR\_KI = 7, KEY\_TYPE\_SEC\_ACQ\_KI = 8, KEY\_TYPE\_ACQUIRER\_MK = 9, KEY\_TYPE\_SEC\_ACQ\_MK = 10,
KEY\_TYPE\_ACQ\_SESSION\_KEYS = 11, KEY\_TYPE\_ENC\_KI\_FMT\_0 = 12, KEY\_TYPE\_ENC\_KI\_FMT\_1 = 13, KEY\_TYPE\_ENC\_KI\_FMT\_2 = 14,
KEY\_TYPE\_ENC\_PPID = 15, KEY\_TYPE\_ENC\_PPASN = 16, KEY\_TYPE\_KVC\_KIA = 17, KEY\_TYPE\_KVC\_KEK1 = 18,
KEY\_TYPE\_MVK = 19, KEY\_TYPE\_DDK = 20, KEY\_TYPE\_KEK = 21, KEY\_TYPE\_DUKPT = 22,
KEY\_TYPE\_CERT = 23, KEY\_TYPE\_DIRECT\_MK\_PLAIN = 24, KEY\_TYPE\_DIRECT\_MK\_ENC = 25, KEY\_TYPE\_DIRECT\_SYSK\_PLAIN = 26,
KEY\_TYPE\_DIRECT\_SYSK\_ENC = 27, KEY\_TYPE\_DELETE\_ALL\_KEYS = 28, KEY\_TYPE\_DELETE\_SYS\_KEY = 29, KEY\_TYPE\_DIRECT\_AUTHEX\_ENC = 30,
KEY\_TYPE\_DIRECT\_AUTHEX\_SYSK = 31, KEY\_TYPE\_DELETE\_ALL\_CUST\_KEYS = 32, KEY\_TYPE\_DIRECT\_CUSTOM\_ASYM = 33, KEY\_TYPE\_DIRECT\_CUSTOM\_ASYM\_SYSK = 34
}

| | enum |

pin\_entry\_type\_e {
PIN\_ENTRY\_TYPE\_\_INVALID\_E = -1, PIN\_ENTRY\_TYPE\_MANDATORY\_E = 0, PIN\_ENTRY\_TYPE\_OPTIONAL\_E = 1, PIN\_ENTRY\_TYPE\_OPTIONAL\_0LN\_PIN\_ENC\_E = 2,
PIN\_ENTRY\_TYPE\_OPTIONAL\_0LN\_PIN\_E = 3
}

| | enum |

pin\_block\_format\_e {
PIN\_BLOCK\_FORMAT\_\_INVALID\_E = -1, PIN\_BLOCK\_FORMAT\_ISO0\_E = 0, PIN\_BLOCK\_FORMAT\_ISO1\_E = 1, PIN\_BLOCK\_FORMAT\_ISO2\_E = 2,
PIN\_BLOCK\_FORMAT\_ISO3\_E = 3, PIN\_BLOCK\_FORMAT\_ISO4\_E = 4, PIN\_BLOCK\_FORMAT\_INC\_KSN = 4
}

| ### TypedefDocumentation ### key\_type\_t typedef uint8\_t \[key\_type\_t]\(#a2418ec606f68970a9ed5ddf6ede58a2f) ### pin\_block\_format\_t typedef enum \[com\_verifone\_host::pin\_block\_format\_e]\(#a9187fdfc7bd10fdf9a04181929e41693) \[pin\_block\_format\_t]\(#ad9cc247c205c1cbf74aae27e459c4ce9) PIN Block Format ### pin\_entry\_type\_t typedef enum \[com\_verifone\_host::pin\_entry\_type\_e]\(#a112cf2dddd5a504da9cb646fe6df856a) \[pin\_entry\_type\_t]\(#a8912bf5e7a5e7c3572234976755a39aa) PIN Entry Type ### EnumerationType Documentation ### key\_type\_e enum \[key\_type\_e]\(#ab6420af507afd2c6a57f725ad69d11cb) Key types | | | | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | KEY\_TYPE\_\_INVALID\_E | Value not set | | KEY\_TYPE\_TMK | Termina Master Key | | KEY\_TYPE\_PPK | PIN Protection Key | | KEY\_TYPE\_MGK | MAC Generation Key | | KEY\_TYPE\_DEK | Data Encryption Key | | KEY\_TYPE\_TCU\_PK | Bendigo only: TCU RSA Public Key | | KEY\_TYPE\_SPONSOR\_PK | Bendigo only: Sponsor RSA Public Key | | KEY\_TYPE\_SPONSOR\_MK | Bendigo only: Sponsor Master Keys | | KEY\_TYPE\_SPONSOR\_KI | Bendigo only: Sponsor Initialisation Key | | KEY\_TYPE\_SEC\_ACQ\_KI | Bendigo only: Secondary Acquirer Initialisation Key | | KEY\_TYPE\_ACQUIRER\_MK | Bendigo only: Acquirer Master Keys | | KEY\_TYPE\_SEC\_ACQ\_MK | Bendigo only: Secondary Acquirer Master Keys | | KEY\_TYPE\_ACQ\_SESSION\_KEYS | Bendigo only: Acquirer Session Keys | | KEY\_TYPE\_ENC\_KI\_FMT\_0 | Bendigo only: Encrypted KI (Format 0) | | KEY\_TYPE\_ENC\_KI\_FMT\_1 | Bendigo only: Encrypted KI (Format 1) | | KEY\_TYPE\_ENC\_KI\_FMT\_2 | Bendigo only: Encrypted KI (Format 2) | | KEY\_TYPE\_ENC\_PPID | Bendigo only: Encrypted PPID | | KEY\_TYPE\_ENC\_PPASN | Bendigo only: Encrypted PPASN | | KEY\_TYPE\_KVC\_KIA | Bendigo only: KVC of KIA | | KEY\_TYPE\_KVC\_KEK1 | Bendigo only: KVC of KEK1 | | KEY\_TYPE\_MVK | MAC Verification Key | | KEY\_TYPE\_DDK | Data Decryption Key | | KEY\_TYPE\_KEK | Key Encryption Key | | KEY\_TYPE\_DUKPT | DUKPT key | | KEY\_TYPE\_CERT | Certificate | | KEY\_TYPE\_DIRECT\_MK\_PLAIN |

iPS\_LoadMasterClearKey replacement. Loads the security script's master key. The values are sent in the clear, but must all be loaded in the same session.
Before loading the first key after a power cycle, all previously loaded keys (including the system keys) are erased.

This function should be used exclusively in a secure environment.

| | KEY\_TYPE\_DIRECT\_MK\_ENC | iPS\_LoadMasterEncKey replacement. Loads the security script's master key without deleting the keys already loaded. The key value must be encrypted with VSS\_KLK | | KEY\_TYPE\_DIRECT\_SYSK\_PLAIN |

iPS\_LoadSysClearKey replacement. Loads the VSS\_KLK (system key) in the clear.
Before writing the new value of the key, all other keys in the terminal are erased.

This function should be used exclusively in a secure environment.

| | KEY\_TYPE\_DIRECT\_SYSK\_ENC | iPS\_LoadSysEncKey replacement. Loads the system key. The new values must be encrypted under the current value of VSS\_KLK. | | KEY\_TYPE\_DELETE\_ALL\_KEYS | iPS\_DeleteKey replacement. | | KEY\_TYPE\_DELETE\_SYS\_KEY | iPS\_DeleteKey replacement. | | KEY\_TYPE\_DIRECT\_AUTHEX\_ENC | rsaAuthexVssKeyInstall replacement. Loads the VSS key. The new values must be encrypted under AuthEx. | | KEY\_TYPE\_DIRECT\_AUTHEX\_SYSK | rsaAuthexVssKeyInstall replacement. Loads the VSS\_KLK. The new values must be encrypted under AuthEx. | | KEY\_TYPE\_DELETE\_ALL\_CUST\_KEYS | iPS\_DeleteKey replacement for DEL\_ALL - clears all OS-managed customer keys like VSS, IPP and ADE. | | KEY\_TYPE\_DIRECT\_CUSTOM\_ASYM | customAsymmKeyVssKeyInstall replacement. Install the given encrypted VSS key after decrypting it with the Custom RSA key loaded previously by VRKv2. This key loading functionality is provided only by VOS2. | | KEY\_TYPE\_DIRECT\_CUSTOM\_ASYM\_SYSK | customAsymmKeyVssKeyInstall replacement. Install the given encrypted VSS\_KLK key after decrypting it with the Custom RSA key loaded previously by VRKv2. This key loading functionality is provided only by VOS2. | ### pin\_block\_format\_e enum \[pin\_block\_format\_e]\(#a9187fdfc7bd10fdf9a04181929e41693) PIN Block Format | | | | -------------------------------- | ------------------------------------ | | Enumerator | | | PIN\_BLOCK\_FORMAT\_\_INVALID\_E | Value not set | | PIN\_BLOCK\_FORMAT\_ISO0\_E | ISO-0 | | PIN\_BLOCK\_FORMAT\_ISO1\_E | ISO-1 | | PIN\_BLOCK\_FORMAT\_ISO2\_E | ISO-2 | | PIN\_BLOCK\_FORMAT\_ISO3\_E | ISO-3 | | PIN\_BLOCK\_FORMAT\_ISO4\_E | ISO-4 Supported only with AES module | | PIN\_BLOCK\_FORMAT\_INC\_KSN | | ### pin\_entry\_type\_e enum \[pin\_entry\_type\_e]\(#a112cf2dddd5a504da9cb646fe6df856a) PIN Entry Type | | | | -------------------------------------------- | ------------------------------------ | | Enumerator | | | PIN\_ENTRY\_TYPE\_\_INVALID\_E | Value not set | | PIN\_ENTRY\_TYPE\_MANDATORY\_E |

PIN Mandatory

| | PIN\_ENTRY\_TYPE\_OPTIONAL\_E | PIN Optional | | PIN\_ENTRY\_TYPE\_OPTIONAL\_0LN\_PIN\_ENC\_E | PIN Optional 0 length PIN Encryption | | PIN\_ENTRY\_TYPE\_OPTIONAL\_0LN\_PIN\_E | 0 Length PIN | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/namespaces/namespacecom__verifone__host.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.