Skip to main content

All-In-One Parameters

SDK Initialisation Parameters

You need to add the following parameters to initiate the All-In-One SDK.

ParametersDescription
client_idRequired: Yes
Type: string
Your ShuftiPro client ID obtained from the back office.
customer_idRequired: Yes
Type: string
The unique identifier of the user within your application. This ID is likely generated by your application upon user registration.
configObjectRequired: Yes
Type: string
This object is required for sdk configuration.
applicationContextRequired: Yes
Type: string
Pass the application context so instance remains until application active.

Create Customer Journey Parameters

ParametersDescription
journey_idRequired: Yes
Type: string
The unique identifier of the verification journey you want to associate with the user. This ID is typically obtained from your ShuftiPro back office platform where you define the verification steps for each journey.
customer_idRequired: Yes
Type: string
The unique identifier of the user within your application. This ID is likely generated by your application upon user registration.
referenceRequired: Yes
Type: string
Each request is assigned a unique reference ID, sent back with each response.

Customer Journey Response Parameters

ParametersDescription
referenceRequired: Yes
Type: bool
If the association fails, ShuftiPro will return error bool as true, else false.
messageRequired: Yes
Type: string
If the association is successful, ShuftiPro might return a success response message.