Share
Data exchange between qid accounts
A Share is a record of data exchanged between two or more qid accounts.
What is shared
Data can include:
- Documents
- Form fields
- Signatures
- Selfies
- Other identity-related data
qid Account
A qid Account can be a user or an organisation.
Properties
| Property | Description |
|---|---|
templateId | Form Id under which the share was created |
participants | Accounts involved in the share |
status | Current share status |
Status values
| Status | Description |
|---|---|
open | Share is active and accepting data |
completed | All required data has been exchanged |
closed | Share has been cancelled |
Participant
Any account involved in a share — whether as a receiver or sharer — is called a participant.
Each participant can have one or more roles:
| Role | Description |
|---|---|
| Organiser | The person organizing the share. For example, in a hotel check-in, the hotel acts as the organiser. |
| Admin | Participants who can add data. For example, in a group check-in, the guest submitting data on behalf of everyone has the admin role. |
| Sharer | Any participant who shares their data, such as ID, form fields, photos, etc. |
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /di/share | Create Share |
GET | /di/share/{id} | Read Share |
Updated 4 days ago
Did this page help you?