> 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/s-adk-5.1-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/sdikeyservice_8h.md).

# sdikeyservice.h

[Functions](#func-members)

`#include <string>` `#include <vector>`

Include dependency graph for sdikeyservice.h:

![](/files/gFFIJrlQbuU3SFCGmAGU)

This graph shows which files directly or indirectly include this file:

![](/files/pG8GOjcVR3mDJg3YJDok)

[Go to the source code of this file.](/s-adk-5.1-programmers-guide/sdikeyservice_8h_source.md)

|                |                                                                                                                                               |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Functions      |                                                                                                                                               |
| std::string    | [keyservice\_get\_libname](#a3fabfa707548aef85d0a275bf161437d) ()                                                                             |
| std::string    | [keyservice\_get\_build\_date](#ab421e5234fb10c889cddac6b78d3c5ea) ()                                                                         |
| std::string    | [keyservice\_get\_version](#ad987589fe9eb5c2406524bf8ec4147df) ()                                                                             |
| void           | [keyservice\_start](#aff15ff808005686075653f803fad5a00) ()                                                                                    |
| void           | [keyservice\_stop](#a9e49df21fedb4d23fc8c0ea2f8b6f4e0) ()                                                                                     |
| unsigned short | [keyservice\_read\_certificate](#ab974c4fe15eef3d7f1599b8a5d965cb5) (const std::string \&refname, std::vector< unsigned char > \&certificate) |

### FunctionDocumentation <a href="#function-documentation" id="function-documentation"></a>

### keyservice\_get\_build\_date() <a href="#ab421e5234fb10c889cddac6b78d3c5ea" id="ab421e5234fb10c889cddac6b78d3c5ea"></a>

std::string keyservice\_get\_build\_date

returns the build date string for the SDI remote keyservice library

#### Returns

build date or an empty string, if SDI remote keyservice is not supported for this device type

### keyservice\_get\_libname() <a href="#a3fabfa707548aef85d0a275bf161437d" id="a3fabfa707548aef85d0a275bf161437d"></a>

std::string keyservice\_get\_libname

returns the library name for the SDI remote keyservice

#### Returns

library name or an empty string, if SDI remote keyservice is not supported for this device type

### keyservice\_get\_version() <a href="#ad987589fe9eb5c2406524bf8ec4147df" id="ad987589fe9eb5c2406524bf8ec4147df"></a>

std::string keyservice\_get\_version

returns the version string for the SDI remote keyservice library

#### Returns

version string or an empty string, if SDI remote keyservice is not supported for this device type

### keyservice\_read\_certificate() <a href="#ab974c4fe15eef3d7f1599b8a5d965cb5" id="ab974c4fe15eef3d7f1599b8a5d965cb5"></a>

unsigned short keyservice\_read\_certificate

read a X.509 certificate for a corresponding reference name specified by parameter `refname`. As reference name the friendly certificate labels (as specified for Android keystore) are used cross over platforms. Example: "VFI\_AUTHN\_RSA" to read the Authex certificate "VFI\_VRK\_RSA" or "VFI\_VRK\_ECC" to read the certificate for remote keyloading The certificate is returned as second parameter `certificate` in binary DER format.

**Parameters**

\[in] **refname** reference name used to select the corresponding certificate to be read \[in] **certificate** buffer containing the X.509 certificate

#### Returns

SDI error code: 0x9000 for success 0x64FE for parameter error (reference name not supported) 0x6400 for execution error (certificate not installed or invalid)

### keyservice\_start() <a href="#aff15ff808005686075653f803fad5a00" id="aff15ff808005686075653f803fad5a00"></a>

void keyservice\_start

starts the SDI remote keyservice

{% hint style="info" %}
This function does nothing, if SDI remote keyservice is not supported for this device type
{% endhint %}

### keyservice\_stop() <a href="#a9e49df21fedb4d23fc8c0ea2f8b6f4e0" id="a9e49df21fedb4d23fc8c0ea2f8b6f4e0"></a>

void keyservice\_stop

stops the SDI remote keyservice

{% hint style="info" %}
This function does nothing, if SDI remote keyservice is not supported for this device type
{% endhint %}


---

# 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/s-adk-5.1-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/sdikeyservice_8h.md?ask=<question>&goal=<endgoal>
```

`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.