Scope Specification

• postCreate scope specification
• getGet scope specification
• patchUpdate an existing scope specification

API docs by Redocly

Blockvault Scope Specification (v1.0.0)

Download OpenAPI specification:Download

NUVA Labs: inbound@nuvalabs.com URL: https://nuvalabs.com/ License: Apache 2.0 Terms of Service

API Documentation for Blockvault Scope Specification

Create scope specification

Authorizations:

BearerAuth

Request Body schema: application/json

required

ScopeSpecification defines the required parties, resources, conditions, and consideration outputs for a contract. All of these fields are stored on chain in plaintext.

description	string or null Optional field that describes this specification
icon_url	string or null Optional icon that can be intelligently displayed on some blockchain explorers
name required	string Name of this specification
owner_addresses required	Array of strings Addresses of the owners of this scope specification
parties_involved required	Array of strings (PartyType) Items Enum: "PARTY_TYPE_UNSPECIFIED" "PARTY_TYPE_ORIGINATOR" "PARTY_TYPE_SERVICER" "PARTY_TYPE_INVESTOR" "PARTY_TYPE_CUSTODIAN" "PARTY_TYPE_OWNER" "PARTY_TYPE_AFFILIATE" "PARTY_TYPE_OMNIBUS" "PARTY_TYPE_PROVENANCE" "PARTY_TYPE_CONTROLLER" "PARTY_TYPE_VALIDATOR" A list of parties that must be present on a scope (and their associated roles)
	object (CreateScopeSchema) A schema that all scopes must adhere to. Contains properties which allow this schema to be flexible or strict.
uuid	string <uuid> Unique identifier for this specification on chain, randomly generated when not provided
website_url	string or null Optional link that can be intelligently displayed on some blockchain explorers

Responses

NUVA Labs API Server

https://api.provlabs.com/metadata/scope-specification

Request samples

• Payload

Content type

application/json

{

• "description": "An example scope specification for documentation purposes.",
• "icon_url": "https://www.datocms-assets.com/114273/1705434302-provlabs-logo.svg",
• "name": "NUVA Labs API Docs Example",
• "owner_addresses": [

  • "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22"

  ],
• "parties_involved": [

  • "PARTY_TYPE_OWNER"

  ],
• "uuid": "464a9b4d-956d-4946-9469-a6bfdc2923a1",
• "website_url": "https://nuvalabs.com/",
• "schema": {

  • "all_records_required": false,
  • "extraneous_records_allowed": true,
  • "records": [

    • {

      • "record": "personal_info"

      },
    • {

      • "record": "address"

      },
    • {

      • "record": "occupation"

      },
    • {

      • "record": "credit_report"

      }

    ]

  }

}

Response samples

• 201
• 400
• 401
• 404

Content type

application/json

{

• "tx_hash": "3ea1b237f303455d1e7c04fc128168cf9a6b903759b8b06bc05315e9333da1ae",
• "height": 18621414,
• "uuid": "464a9b4d-956d-4946-9469-a6bfdc2923a1"

}

Get scope specification

Authorizations:

BearerAuth

path Parameters

required

string or string (ScopeSpecificationId) Scope specification identifier

Responses

NUVA Labs API Server

https://api.provlabs.com/metadata/scope-specification/{id}

Response samples

• 200
• 400
• 401
• 404

Content type

application/json

{

• "scope_specification": {

  • "specification": {

    • "specification_id": "scopespec1q3ry4x6dj4k5j355dxntlhpfywssp5u67a",
    • "description": {

      • "name": "NUVA Labs API Docs Example",
      • "description": "An example scope specification for documentation purposes.",
      • "website_url": "https://nuvalabs.com/",
      • "icon_url": "https://www.datocms-assets.com/114273/1705434302-provlabs-logo.svg"

      },
    • "owner_addresses": [

      • "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22"

      ],
    • "parties_involved": [

      • "PARTY_TYPE_OWNER"

      ],
    • "contract_spec_ids": [

      • "contractspec1q0d2ed2t00hghjmnx2psaqs298vqctjvrm",
      • "contractspec1qw03ttwa9n5qju8vjz0nfdkxhjrqtkjxa9",
      • "contractspec1qdl5enkv5q8wfuk3aauczvjt8t2s74paaa"

      ]

    },
  • "scope_spec_id_info": {

    • "scope_spec_addr": "scopespec1q3ry4x6dj4k5j355dxntlhpfywssp5u67a",
    • "scope_spec_uuid": "464a9b4d-956d-4946-9469-a6bfdc2923a1"

    }

  },
• "schema": {

  • "all_records_required": false,
  • "extraneous_records_allowed": true,
  • "records": [

    • {

      • "record": "personal_info"

      },
    • {

      • "record": "address"

      },
    • {

      • "record": "occupation"

      },
    • {

      • "record": "credit_report"

      }

    ]

  }

}

Update an existing scope specification

Authorizations:

BearerAuth

path Parameters

required

string or string (ScopeSpecificationId) Scope specification identifier

Request Body schema: application/json

required

ScopeSpecification defines the required parties, resources, conditions, and consideration outputs for a contract. All of these fields are stored on chain in plaintext.

description	string or null Field that describes this specification
icon_url	string or null Optional icon that can be intelligently displayed on some blockchain explorers
name	string or null Name of this specification
owner_addresses	Array of strings or null Addresses of the owners of this scope specification
parties_involved	Array of strings or null (PartyType) Enum: "PARTY_TYPE_UNSPECIFIED" "PARTY_TYPE_ORIGINATOR" "PARTY_TYPE_SERVICER" "PARTY_TYPE_INVESTOR" "PARTY_TYPE_CUSTODIAN" "PARTY_TYPE_OWNER" "PARTY_TYPE_AFFILIATE" "PARTY_TYPE_OMNIBUS" "PARTY_TYPE_PROVENANCE" "PARTY_TYPE_CONTROLLER" "PARTY_TYPE_VALIDATOR" A list of parties that must be present on a scope (and their associated roles)
	null or CreateScopeSchema (object)
website_url	string or null Optional link that can be intelligently displayed on some blockchain explorers

Responses

NUVA Labs API Server

https://api.provlabs.com/metadata/scope-specification/{id}

Request samples

• Payload

Content type

application/json

{

• "description": "An example scope specification for documentation purposes.",
• "icon_url": "https://www.datocms-assets.com/114273/1705434302-provlabs-logo.svg",
• "name": "NUVA Labs API Docs Example",
• "website_url": "https://nuvalabs.coms/",
• "schema": {

  • "all_records_required": true,
  • "extraneous_records_allowed": false,
  • "records": [

    • {

      • "record": "name"

      },
    • {

      • "record": "age"

      },
    • {

      • "record": "ssn"

      }

    ]

  }

}

Response samples

• 200
• 400
• 401
• 404

Content type

application/json

{

• "tx_hash": "3ea1b237f303455d1e7c04fc128168cf9a6b903759b8b06bc05315e9333da1ae",
• "height": 18621414,
• "uuid": "464a9b4d-956d-4946-9469-a6bfdc2923a1"

}