Sessions
Blockvault Sessions (v1.0.0)
Download OpenAPI specification:Download
API Documentation for Blockvault Sessions
Create session
Authorizations:
BearerAuth
path Parameters
required | string or string (ScopeSpecificationId) Scope specification identifier |
Request Body schema: application/jsonrequired
Create a session to alter a scope's records
required | object (Party) Party responsible for this session |
object Record keys map to Provenance Metadata Records. Values are typeful with a few types supported natively. Values are base64 encoded and persisted directly on-chain. IMPORTANT: sensitive data, or large blobs, should not be stored on chain in a plaintext encoding. | |
object Record keys map to Provenance Metadata Records. Values are typeful with a few types supported natively. | |
null or CreateScope (object) | |
| uuid | string <uuid> Unique identifier for this scope on chain, randomly generated when not provided |
Responses
Request samples
- Payload
Content type
application/json
{- "party": {
- "address": "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22",
- "role": "PARTY_TYPE_OWNER"
}, - "scope": {
- "data_access": [
- "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22",
- "tp1dpqhlfd6uwaezmv8skm47d95yn6pfv7ngg8lgp"
], - "value_owner_address": "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22",
- "usd_mills": 10000
}, - "records": {
- "personal_info": {
- "name": "George Castanza",
- "age": "31"
}, - "address": "Manhattan, New York",
- "occupation": {
- "employer": "Vandelay Industries",
- "title": "Importer/exporter"
}, - "credit_report": {
- "type_url": "/provlabs.protos.experian.CreditReport",
- "value": "cHJvdG9idWYgbWVzc2FnZSBieXRlcw=="
}
}, - "public_records": {
- "is_over_50": false
}, - "uuid": "3d8de57d-bda1-4635-a377-3d9a8a5c3fca"
}Response samples
- 201
- 400
- 401
- 404
Content type
application/json
{- "tx_hash": "3ea1b237f303455d1e7c04fc128168cf9a6b903759b8b06bc05315e9333da1ae",
- "height": 18621389,
- "uuid": "2dccded0-f546-4519-8468-4aeaba91552b",
- "scope_uuid": "3d8de57d-bda1-4635-a377-3d9a8a5c3fca"
}