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.
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.
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
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
Integer - required
<Optional Key>
<Any string>
Must be a string - optional
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.
Last updated
Was this helpful?