# API Reference

{% hint style="info" %}
**Symitar eDocs References:** [SymXchange API Version](https://learnmore.symitar.com/edocs/#xml/SymXchange/SymXchangeAPIVrsn_C.html), [Available SymXchange Services](https://learnmore.symitar.com/edocs/#xml/SymXchange/SymXchangeSrvcsCnfgInstnc_R.html)
{% endhint %}

## SymXchange Versions

Below are the SymXchange versions that have published API references.

{% hint style="success" %}
We ensure [NexumAPI](https://libum.io/nexum/) is always up-to-date with all Jack Henry™ supported SymXchange versions. At the time of writing this, that would be <mark style="color:purple;">`v2018`</mark> through <mark style="color:purple;">`v2022`</mark> including the <mark style="color:purple;">`persistent`</mark> endpoint.
{% endhint %}

### Persistent

{% content-ref url="/pages/80YNCJErC8xY4UZVPfGS" %}
[Persistent](/nexum/symxchange/api-reference/persistent.md)
{% endcontent-ref %}

### v2022.01

{% content-ref url="<https://github.com/libum-llc/corporate-docs/blob/main/src/nexum/symxchange/api-reference/v2022.01>" %}
<https://github.com/libum-llc/corporate-docs/blob/main/src/nexum/symxchange/api-reference/v2022.01>
{% endcontent-ref %}

{% hint style="warning" %}
We're working hard to provide complete coverage for detailed parameter descriptions and working sample request payloads for each operation through a mix of generative AI, our translation engine, and manual validation. Below is a list of full-content SymX services maintained in a best effort fashion and may not reflect all changes being made.\
\
[Full-content SymX services (7 of 36)](#user-content-fn-1)[^1]

* BatchJobService
* InformationService
* FindByService
* PowerOnService
* SymXchangeVerificationService
* UserService
* UserManagementService
  {% endhint %}

## Understanding your endpoints

We've included the SymXchange version as a first class resource as a parameter in the request path as shown below:

```http
https://naas.ymcu.libum.io/nexum/{sym}/{version}/{service}/{operation}
```

**Note:** The version should be set immediately after the Sym number and before the target SymXchange service.

[^1]: as of Jul 18, 2024


---

# Agent Instructions: 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:

```
GET https://docs.libum.io/nexum/symxchange/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.