> For the complete documentation index, see [llms.txt](https://legacy-docs.usesmileid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy-docs.usesmileid.com/further-reading/faqs/what-are-partner_params.md).

# What are partner\_params?

The Smile ID system requires two unique identifiers for each job, the **job\_id** and the **user\_id**. These identifiers are used to track a job through the system and are ultimately always sent back to the Partner with the results of a job (see note below). These identifiers, along with the **job\_type**, are send in the request JSON, specifically in the **partner\_params** section. The Partner can also add optional additional information as decribed in the **"Optional Key"** section below.

{% hint style="info" %}
**user\_id** - this is a **unique string** that is used to track an individual user's profile. This can be repeated for different jobs relating to the same user. **job\_id** - this is a string that is unique to the job (verification request). **No two jobs should have the same job\_id**.
{% endhint %}

{% hint style="danger" %}
**All fields in the partner\_params must be strings except the job\_type**. Any strings of length 0 will be replaced by "null". Null values in the JSON will be rejected with an error.
{% endhint %}

This JSON is inserted into the zip file that is sent to the server by either the mobile SDK or the core library.

#### partner\_params Keys

| Key             | Value                                                                                   | Comment                     |
| --------------- | --------------------------------------------------------------------------------------- | --------------------------- |
| job\_id         | \<UUID or other unique identifier>                                                      | Must be a string - required |
| user\_id        | \<UUID or other unique identifier>                                                      | Must be a string - required |
| job\_type       | [See Job Types](/further-reading/faqs/how-do-job-types-map-to-the-new-product-names.md) | Integer - required          |
| \<Optional Key> | \<Any string>                                                                           | Must be a string - optional |

```json
{
  "partner_params": {
    "job_id": "3ba0e15e-1a56-4799-a94d-b0e084f50256",
    "user_id": "4cb0f26-2b567-5800-b05e-c0f095g6036",
    "job_type": 5,
    "optional_key": "Something helpful"
  }
}
```

{% hint style="info" %}
The complete **partner\_params** JSON is sent with each result sent from the system back to the Partner but in a slightly different format. The key name is changed to **PartnerParams** and all values including the job\_type are strings.
{% endhint %}

#### Optional Key

This is any key that you intend to use as meta data about the job. These keys are defined by you and provided from your system. You can add as many optional keys as you need and they will be returned to you in the response sent to you.


---

# 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://legacy-docs.usesmileid.com/further-reading/faqs/what-are-partner_params.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.