Partner Params

Partner Parameters allow you to add any additional information that you would like associated with the job. This information will come back as a JSON object in results sent from the Smile Identity server. A common use case for this is to add your own unique ID to track the job as it relates to a user/instance in your own system. All fields in the partner_params must be strings except job_type.

job_type 🔴 required

integer

See Job Types

job_id 🔴required

string

A value generated on your side so you can track the jobs from your side.

This value can be any string. It can follow your identifier convention.

user_id 🔴required

string

A value generated on your side so you can track the users from your side.

This value can be any string. It can follow your identifier convention.

optional_parameter_of_my_choice

optional

string

partner parameter can have any number of extra keys

{
"partner_id": "023",
...,
"dob": "1980-05-04",
"partner_params": {
"job_id": "3ba0e15e-1a56-4799-a94d-b0e084f50256",
"user_id": "4cb0f26-2b567-5800-b05e-c0f095g6036",
"job_type": 5,
"optional_parameter_of_my_choice": "Something helpful"
}
}