The ID Wallet app allows you to issue digital identities and credentials on the mobile devices of your users (employees, contractors, or admins) that are used for multi-factor authentication, passwordless authentication, and verification. Below is a workflow of the ID Wallet app.
All APIs are protected using OAuth2 Access Token. Pairing the ID Wallet app with the organization initiates the user authentication process to acquire JSON Web Token (JWT) based Access token consisting of user claims and scopes to access protected resources.
The Authorization Header with the access token in an HTTP Request is usually, but not always, sent along with the requests to access a resource. In the documented API, it is mentioned for each API described if an access token is required or not to access a protected resource.
The latest TLS Protocol is recommended to securely transmit the data.
This API endpoint pairs the user's device with the organization.
Headers
- Authentication: Bearer <JWT>
- Accept: application/json
- Content-Type: application/json
Path Parameters
| Parameters | Type | Description |
|---|---|---|
| organizationName | string | Denotes the name of the organization. |
Body Parameters
| Parameters | Type | Description |
|---|---|---|
| requestUserDevice | object | The object that contains the body for the API call. |
requestUserDevice Object
| Parameters | Type | Description |
|---|---|---|
| appName | string | The name of the app (ID Wallet). |
| appRegID | integer | The registered ID of the app (ID Wallet). |
| appVersion | integer | The version of the app (ID Wallet). |
| deviceManufacturerName | string | The name of the device manufacturer. |
| deviceModelName | string | The model name of the device. |
| devicePublicKeyAlgorithm | string | The public key algorithm of the device. This key would be used to encrypt the token and share across the user device. |
| devicePublicKeyB64 | string | The device public key in base 64 format. |
| friendlyName | string | The friendly name given to the device. |
| gpsCoordinates | string | The GPS coordinates (location) of the user device from where the device was used. The location coordinates are returned only if the permission to access the location is allowed by the user while launching the app on the mobile device else it will return 0.0,0.0. |
| operatingSystem | string | The operating system of the device. E.g.: Android/iOS |
| organizationName | string | The name of the organization. |
| osApiVersion | string | The API version of the operating system. This field is specific for Android devices only. E.g.: API level 31 |
| osVersion | string | The version of the operating system (E.g.: Android 12.0/iOS 15.0) |
| Type | string | The type of the mobile device-Mobile/iPad/Note/Tablet. |
| uniqueIdentifier | integer | The unique ID number of the device. |
| uuid | integer | The secret key generated for pairing the device. Expires after 30 seconds. |
Response Object
| Parameter | Type | Description |
|---|---|---|
| id | Number | The ID associated with the user. |
| name | String | The username of the user. |
| fullName | String | The full name of the user. |
| organisationName | String | The name of the organization to which the user belongs. |
| organisationId | Number | The ID of the organization to which the user belongs. |
| groupId | String | The ID of the group to which the user belongs. |
| groupName | String | The name of the group to which the user belongs. |
| status | String | The status of the user, indicating whether they are ready for reissuance or not. |
| firstName | String | The first name of the user. |
| lastName | String | The last name of the user. |
| String | The email address of the user. | |
| userPrincipalName | String | The principal name of the user. |
| enrollmentStatus | String | The enrollment status of the user. |
| userStatus | String | The status of the user. |
| canIssueIdentity | Boolean | Indicates whether the user can issue an identity. |
| createdDate | Date | The date and time when the user was created. |
| lastModifiedDate | Date | The date and time when the user was last modified. |
| userBiometrics | Array | An array containing details of the user's biometrics, such as type, format, and image data. |
| wfMobileIDStepDetails | Object | An object containing details of the mobile ID step, including configuration for onboarding, face verification, adjudication, and hardware-backed authentication. |