Enrollment

After completing all the enrollment steps, the user data captured must be saved. This endpoint allows you to submit the enrollment data to the server to save. Ensure to clear the data from the device after you get the success message.

Headers

  • Authentication: Bearer <JWT>
  • Accept: application/json
  • Content-Type: application/json

Path Parameters

ParametersTypeDescription
organizationNamestringDenotes the name of the organization.

Body Parameters

ParametersTypeDescription
userobjectThe user enrollment data object that is to be posted to the server to save.

user Object

ParametersTypeDescription
idLong (Required)The unique ID of the user.
workflowNameString (Required)The name of the workflow assigned to the user.
groupIdString (Required)The unique ID of the group assigned to the user.
nameString (Required)The name of the user.
userIDProofDocumentsUser ID Proofing Documents Object (Required)This object captures the details of the ID Proofing documents that the user submits as a part of the ID proofing step.
userAttributeUser Attributes Object (Required)This object captures the biographic details of the user. The data elements vary based on the type of the identity and form data elements configured in the workflow.
userAppearanceUser Appearance Object (Required)This object captures the user's visual appearance details. The data elements vary based on the type of identity and form data elements configured in the workflow.
userEmployeeIDUser Employment Details Object (Required)This object captures the data related to the user's employment details. The data elements vary based on the form data elements configured in the workflow.
userBiometricsUser Biometrics Object (Required)Array of objects where each object represents a type of user biometric data, capturing the face and signature of the user for the ID wallet app.
userEnrollmentHistoryUser Enrollment History Object (Required)This object captures details such as who initiated and completed the enrollment, and when.
Language
URL