User Data Request
Requests user-specific data stored on or associated with a VerusID. An authentication request is automatically prepended to identify the recipient whose data is being requested.
Recipient Identity (required)
The VerusID (e.g. user@) whose data you want to retrieve. This identity is embedded in an AuthenticationRequestOrdinalVDXFObject that is prepended to the request details.
Data Types
- Full Data - Returns the complete data object matching the search criteria.
- Partial Data - Returns a zk-proof containing only the specified Requested Keys from the matched object. Requested Keys is required for this type.
- Collection - Returns all data objects matching the search criteria. Requested Keys cannot be used with this type.
Request Types
- Attestation - A signed statement about an identity.
- Claim - A claim made by or about an identity.
- Credential - A verifiable credential.
Search Data Key (required)
The i-address of a VDXF key to search for. For example:
iEEjVkvM9Niz4u2WCr6QQzx1zpVSvDFub1 - vrsc::attestation.name
i3bgiLuaxTr6smF8q6xLG4jvvhF1mmrkM2 - valu.vrsc::claims.employment
Requested Keys (required for Partial Data)
JSON array of i-addresses for keys to include in the zk-proof response. Example:
["iAXYYrZaipc4DAmAKXUFYZxavsf6uBJqaj", "iJ4pq4DCymfbu8SAuXyNhasLeSHFNKPr23"]
Redirects (required)
At least one redirect URI must be provided so the wallet knows where to send the requested data back. Type 1 = browser redirect, Type 2 = POST callback.
[{"type": 2, "uri": "https://example.com/callback"}]
Examples
Full Data Request: Request complete employment attestation from a specific signer.
Partial Data Request: Request only email and over21 status as zk-proof.
Collection Request: Get all education credentials from a signer.