{ "openapi": "3.0.0", "info": { "title": "VNF Registrar API", "version": "1.0", "description": "API for supplementary services provided by velocity network foundation", "contact": { "name": "Andres Olave", "email": "andres.olave@velocitycareerlabs.com", "url": "www.velocitycareerlabs.com" }, "license": { "url": "https://creativecommons.org/licenses/by/4.0/", "name": "CC BY 4.0" } }, "servers": [ { "url": "https://devregistrar.velocitynetwork.foundation/api/v0.6", "description": "DevNet" }, { "url": "https://stagingregistrar.velocitynetwork.foundation/api/v0.6", "description": "TestNet" }, { "url": "https://registrar.velocitynetwork.foundation/api/v0.6", "description": "MainNet" } ], "paths": { "/organizations/full": { "post": { "summary": "Create Organization by Admin", "operationId": "post-full-organizations", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "./full-organization.json" }, { "type": "object", "properties": { "keys": { "type": "array", "items": { "$ref": "./key.json" } }, "authClients": { "type": "array", "items": { "$ref": "./auth-client.json" } }, "messageCode": { "type": "string", "x-stoplight": { "id": "nt13y8vixz22b" }, "description": "a message code" }, "custodied": { "type": "boolean", "x-stoplight": { "id": "1jy683jm8ybl2" }, "description": "whether the organization keys has at least one custodied key" } }, "required": [ "keys" ] } ] }, "examples": { "Sample Response": { "value": { "id": "did:web:example.com", "didDoc": { "@context": "https://www.w3.org/ns/did/v1", "id": "did:web:example.com", "controller": "did:web:example.com", "publicKey": [ { "id": "did:web:example.com#key-1", "type": "EcdsaSecp256k1VerificationKey2019", "controller": "did:web:example.com", "publicKeyJwk": { "crv": "secp256k1", "kid": "JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw", "kty": "EC", "x": "dWCvM4fTdeM0KmloF57zxtBPXTOythHPMm1HCLrdd3A", "y": "36uMVGM7hnw-N6GnjFcihWE3SkrhMLzzLCdPMXPEXlA" }, "publicKeyBase58": "CaSHXEvLKS6SfN9aBfkVGBpp15jSnaHazqHgLHp8KZ3Y" } ], "authentication": [ "#key-1" ], "service": [ { "id": "did:web:example.com#credentialagent-1", "type": "VlcCareerIssuer_v1", "credentialTypes": [ "EducationDegreeGraduationV1.1" ], "serviceEndpoint": "https://agent.samplevendor.com/acme" } ], "created": "2019-08-24T14:15:22Z", "updated": "2019-08-24T14:15:22Z" }, "profile": { "id": "did:web:example.com", "did": "did:web:example.com", "name": "ACME Limited", "description": "Sample description of ACME Limited", "location": { "countryCode": "US", "regionCode": "US-TX" }, "logo": "https://acme.com/logo.png", "website": "https://acme.com", "founded": "2008-01-06", "contactEmail": "support@acme.com", "technicalEmail": "support@acme.com", "type": "company", "registrationNumbers": [ { "authority": "DunAndBradstreet", "number": "117521337" } ], "permittedVelocityServiceCategory": [ "Issuer" ], "verifiableCredentialJwt": "http://example.com/acme.jwt", "secureMessagesUrl": "https://example.com/webhook", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "ids": { "tokenAccountId": "319231321321", "fineractClientId": "444444", "ethereumAccount": "19030912311", "did": "did:web:example.com" }, "keys": [ { "kidFragment": "#key-1", "purposes": [ "DLT_TRANSACTIONS" ], "algorithm": "EcdsaSecp256k1", "encoding": "hex", "didDocumentKey": { "id": "#key-1", "type": "JsonWebKey2020", "controller": "did:web:acmecorp.com", "publicKeyJwk": { "kty": "EC", "x": "fXZfrDLSF-RaYJ3R6cmM0UBIOzQmYfRjju844wU_YdA", "y": "61gcKsDtjEJecn099TiOAFKbdcFfeuFtA8pezfopGqQ", "crv": "secp256k1" } } } ], "custodied": true, "authClients": [ { "type": "string", "clientType": "string", "clientId": "string", "clientSecret": "string", "serviceId": "string" } ] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "$ref": "./organization-profile-modification.v1.json" }, "serviceEndpoints": { "type": "array", "items": { "$ref": "./service-modification.json" } }, "invitationCode": { "type": "string", "x-stoplight": { "id": "suf0l0bubz95q" }, "description": "the invitationCode used to generate this organization" }, "byoDid": { "type": "string", "x-stoplight": { "id": "gmpg3typjec5x" }, "description": "the did value that the organization will use instead of the one custodied by VNF" }, "keys": { "type": "array", "x-stoplight": { "id": "yfgyiwleiamfj" }, "description": "the keys to add for this organization", "items": { "$ref": "./new-key.json" } } }, "required": [ "profile", "serviceEndpoints" ] }, "examples": { "example-1": { "value": { "profile": { "name": "ACME Limited", "description": "Sample description of ACME Limited", "location": { "countryCode": "US", "regionCode": "US-TX" }, "logo": "https://acme.com/logo.png", "website": "https://acme.com", "founded": "2008-01-06", "contactEmail": "support@acme.com", "technicalEmail": "support@acme.com", "type": "company", "registrationNumbers": [ { "authority": "DunAndBradstreet", "number": "117521337" } ], "secureMessagesUrl": "https://example.com/webhook" }, "serviceEndpoints": [] } } } } }, "description": "The new organization" }, "description": "Create an organization", "tags": [ "organization-management" ] }, "get": { "summary": "Get All Organizations", "operationId": "get-full-organizations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./full-organization.json" } }, "examples": { "example-1": { "value": [ { "id": "did:web:example.com", "didDoc": { "@context": "https://www.w3.org/ns/did/v1", "id": "did:web:example.com", "controller": "did:web:example.com", "publicKey": [ { "id": "did:web:example.com#key-1", "type": "EcdsaSecp256k1VerificationKey2019", "controller": "did:web:example.com", "publicKeyJwk": { "crv": "secp256k1", "kid": "JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw", "kty": "EC", "x": "dWCvM4fTdeM0KmloF57zxtBPXTOythHPMm1HCLrdd3A", "y": "36uMVGM7hnw-N6GnjFcihWE3SkrhMLzzLCdPMXPEXlA" }, "publicKeyBase58": "CaSHXEvLKS6SfN9aBfkVGBpp15jSnaHazqHgLHp8KZ3Y" } ], "authentication": [ "#key-1" ], "service": [ { "id": "did:web:example.com#credentialagent-1", "type": "VlcCareerIssuer_v1", "credentialTypes": [ "EducationDegreeGraduationV1.1" ], "serviceEndpoint": "https://agent.samplevendor.com/acme" } ], "created": "2019-08-24T14:15:22Z", "updated": "2019-08-24T14:15:22Z" }, "profile": { "id": "did:web:example.com", "did": "did:web:example.com", "name": "ACME Limited", "description": "Sample description of ACME Limited", "location": { "countryCode": "US", "regionCode": "US-TX" }, "logo": "https://acme.com/logo.png", "website": "https://acme.com", "founded": "2008-01-06", "contactEmail": "support@acme.com", "technicalEmail": "support@acme.com", "type": "company", "permittedVelocityServiceCategory": [ "Issuer" ], "registrationNumbers": [ { "authority": "DunAndBradstreet", "number": "117521337" } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "verifiableCredentialJwt": "http://example.com/acme.jwt", "secureMessagesUrl": "https://example.com/webhook" }, "ids": { "tokenAccountId": "319231321321", "fineractClientId": "444444", "ethereumAccount": "19030912311", "did": "did:web:example.com" } } ] } } } } } }, "description": "Gets all the org did docs & profiles. Should be capped at 100 results in the array. For admins of the VNF", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "filter.credentialTypes", "description": "Filters orgs based on credential types " }, { "schema": { "type": "string", "enum": [ "Issuer", "Inspector", "CredentialAgentOperator", "NodeOperator", "TrustRoot", "NotaryIssuer", "IdDocumentIssuer", "NotaryIdDocumentIssuer", "ContactEndpointIssuer", "NotaryContactEndpointIssuer", "HolderAppProvider" ] }, "in": "query", "name": "filter.serviceTypes", "description": "Filters orgs based on Service Types" }, { "schema": { "type": "string" }, "in": "query", "name": "filter.did", "description": "Filters orgs based on DIDs" }, { "schema": { "type": "string" }, "in": "query", "name": "q", "description": "Full Text search for the name property of the organization. Matches on partials strings. Prefer results that are the first word of the name, or first letter of a word" }, { "schema": { "type": "array" }, "in": "query", "name": "sort[]", "description": "A array of tuples indicating the field to sort by" }, { "schema": { "type": "string" }, "in": "query", "name": "page.skip", "description": "The objectId to skip" }, { "schema": { "type": "string" }, "in": "query", "name": "page.size", "description": "The number of records to retrieve" } ], "tags": [ "organization-management" ] }, "parameters": [] }, "/organizations/full/{did}": { "get": { "summary": "Get Organization", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "./full-organization.json" }, "examples": { "Example 1": { "value": { "id": "did:web:example.com", "didDoc": { "@context": "https://www.w3.org/ns/did/v1", "id": "did:key:z6MksQ35B5bwZDQq4QKuhQW2Sv6dcqwg4PqcSFf67pdgrtjB", "controller": [ "did:key:z6MksQ35B5bwZDQq4QKuhQW2Sv6dcqwg4PqcSFf67pdgrtjB" ], "publicKey": [ { "id": "did:example:123#primary", "type": [ "EcdsaSecp256k1VerificationKey2019" ], "controller": "did:example:123", "publicKeyJwk": { "crv": "secp256k1", "kid": "JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw", "kty": "EC", "x": "dWCvM4fTdeM0KmloF57zxtBPXTOythHPMm1HCLrdd3A", "y": "36uMVGM7hnw-N6GnjFcihWE3SkrhMLzzLCdPMXPEXlA" } } ], "authentication": [ "string" ], "service": [ { "id": "string", "type": "VlcCredentialAgentOperator_v1", "serviceEndpoint": "http://example.com", "credentialTypes": [ "string" ] } ], "created": "2019-08-24T14:15:22Z", "updated": "2019-08-24T14:15:22Z" }, "profile": { "name": "string", "description": "string", "location": { "countryCode": "US" }, "logo": "http://example.com", "website": "http://example.com", "contactEmail": "user@example.com", "technicalEmail": "string", "closed": "2019-08-24", "founded": "2019-08-24", "type": "company", "registrationNumbers": [ { "authority": "NationalAuthority", "number": "string", "uri": "http://example.com" } ], "id": "did:web:example.com", "permittedVelocityServiceCategory": [ "Issuer" ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "verifiableCredentialJwt": "http://example.com", "activatedServiceIds": [ "string" ] }, "ids": { "tokenAccountId": "string", "fineractClientId": "string", "ethereumAccount": "string", "did": "string" } } } } } } } }, "operationId": "get-full-organization", "security": [ { "Bearer Token": [] } ], "description": "Gets the speicific organization for the did", "tags": [ "organization-management" ] }, "parameters": [ { "schema": { "type": "string", "pattern": "^did:[a-z0-9]+:[A-Za-z0-9.-_:?=&;]+$" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ] }, "/organizations/{did}/verified-profile": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "get": { "summary": "Get Verified Organization's Profile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique id for the credential that was disclosed at this time." }, "type": { "type": "array", "description": "type is identical to the standard based type found on verifiable credentials but does not accept a string, it only accepts an array to indicate an unordered set of type URIs", "items": { "type": "string" } }, "issuer": { "type": "object", "description": "DID of the issuer", "properties": { "id": { "type": "string" } } }, "credentialSubject": { "$ref": "./organization-profile-credential-subject.v1.json" }, "credentialSchema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "validFrom": { "type": "string", "format": "date-time", "description": "when the credential will start being valid" }, "validUntil": { "type": "string", "format": "date-time", "description": "when the credential will expire" }, "issued": { "type": "string", "format": "date-time", "description": "when did the issuer actually issue the verified credential" }, "credentialChecks": { "type": "object", "properties": { "checked": { "type": "string", "format": "date-time", "description": "when did the system last run checks on the profile VC" }, "TRUSTED_ISSUER": { "type": "string", "enum": [ "PASS", "FAIL", "NOT_CHECKED", "SELF_SIGNED" ] }, "UNREVOKED": { "type": "string", "enum": [ "PASS", "FAIL", "NOT_CHECKED" ] }, "UNEXPIRED": { "type": "string", "enum": [ "PASS", "FAIL", "NOT_CHECKED", "NOT_APPLICABLE" ] }, "UNTAMPERED": { "type": "string", "enum": [ "PASS", "FAIL", "NOT_CHECKED" ] } } } }, "required": [ "type", "issuer", "credentialSubject", "issued", "credentialChecks" ] }, "examples": { "Example": { "value": { "id": "1231-23123-1231", "type": [ "VerifiableCredential", "OrganizationBasicProfile-v1.0" ], "issuer": { "id": "did:web:velocitynetwork.foundation" }, "credentialSubject": { "id": "did:web:example.com", "name": "ACME Limited", "description": "Sample description of ACME Limited", "location": { "countryCode": "US", "regionCode": "US-TX" }, "logo": "https://acme.com/logo.png", "website": "https://acme.com", "founded": "2008-01-06", "contactEmail": "support@acme.com", "technicalEmail": "support@acme.com", "type": "company", "registrationNumbers": [ { "authority": "DunAndBradstreet", "number": "117521337" } ], "permittedVelocityServiceCategory": [ "Issuer", "Inspector" ], "supportsSecureMessages": true }, "credentialSchema": { "id": "https://vnf.com/organization-basic-profile-v1.0", "type": "OrganizationBasicProfile-v1.0" }, "issued": "2019-08-24T14:15:22Z", "credentialChecks": { "checked": "2021-08-24T14:15:22Z", "TRUSTED_ISSUER": "PASS", "UNREVOKED": "PASS", "UNEXPIRED": "PASS", "UNTAMPERED": "PASS" } } } } } } } }, "operationId": "get-organizations-did-verified-profile", "description": "Organization must have a VC cached on the system", "tags": [ "public-organization-registry" ] } }, "/organizations/profile/{did}": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "in": "path", "required": true, "description": "the did of the org" } ], "put": { "summary": "Update an Organization's Profile", "operationId": "put-organization-profile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "./organization-profile.v1.json" }, "examples": { "example-1": { "value": { "id": "did:web:acmecorp.com", "did": "did:web:acmecorp.com", "name": "ACME Corporation", "description": "Sample description of ACME Limited", "location": { "countryCode": "US", "regionCode": "US-CA" }, "logo": "http://example.com/logo.com", "website": "http://example.com", "contactEmail": "user@example.com", "technicalEmail": "support@acme.com", "founded": "2019-08-24", "closed": "2019-08-24", "type": "company", "registrationNumbers": [ { "authority": "DunAndBradstreet", "number": "12342190312392131", "uri": "http://example.com/dnbNUmber" } ], "permittedVelocityServiceCategory": [ "Issuer" ], "verifiableCredentialJwt": "http://example.com/vc.jwt", "secureMessagesUrl": "https://example.com/webhook", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } } }, "description": "Update the organization profile", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "./organization-profile-modification.v1.json" }, "examples": { "example-1": { "value": { "name": "ACME Limited", "description": "Sample description of ACME Limited", "location": { "countryCode": "US", "regionCode": "US-TX" }, "logo": "https://acme.com/logo.png", "website": "https://acme.com", "founded": "2008-01-06", "contactEmail": "support@acme.com", "technicalEmail": "support@acme.com", "type": "company", "registrationNumbers": [ { "authority": "DunAndBradstreet", "number": "117521337" } ], "secureMessagesUrl": "https://example.com/webhook" } } } } } }, "tags": [ "organization-management" ] } }, "/organizations": { "get": { "summary": "Get All Custodied DID Docs", "operationId": "get-organization-did-docs", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "../common/models/did-doc.v1.json" } } } } } }, "description": "Gets all the org did docs & profiles. Should be capped at 100 results in the array. For admins of the VNF", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "filter.credentialTypes", "description": "Filters orgs based on credential types " }, { "schema": { "type": "string", "enum": [ "Issuer", "Inspector", "CredentialAgentOperator", "NodeOperator", "TrustRoot", "NotaryIssuer", "IdDocumentIssuer", "NotaryIdDocumentIssuer", "ContactEndpointIssuer", "NotaryContactEndpointIssuer", "HolderAppProvider" ] }, "in": "query", "name": "filter.serviceTypes", "description": "Filters orgs based on Service Types" }, { "schema": { "type": "string" }, "in": "query", "name": "filter.did", "description": "Filters orgs based on DIDs" }, { "schema": { "type": "string" }, "in": "query", "name": "q", "description": "Full Text search for the name property of the organization. Matches on partials strings. Prefer results that are the first word of the name, or first letter of a word" }, { "schema": { "type": "array" }, "in": "query", "name": "sort[]", "description": "A array of tuples indicating the field to sort by" }, { "schema": { "type": "string" }, "in": "query", "name": "page.skip", "description": "The objectId to skip" }, { "schema": { "type": "string" }, "in": "query", "name": "page.size", "description": "The number of records to retrieve" } ], "tags": [ "organization-management" ] }, "parameters": [] }, "/organizations/{did}": { "get": { "summary": "Get Custodied DID Doc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "../common/models/did-doc.v1.json" } } } } }, "operationId": "get-organization-did-doc", "security": [ { "Bearer Token": [] } ], "description": "Gets the speicific organization for the did", "tags": [ "organization-management" ] }, "parameters": [ { "schema": { "type": "string", "pattern": "^did:[a-z0-9]+:[A-Za-z0-9.-_:?=&;]+$" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "delete": { "summary": "Soft Delete Organization", "operationId": "delete-organizations-did", "responses": { "204": { "description": "No Content" } }, "description": "Soft delete an organization", "tags": [ "superuser-organization-management" ] } }, "/organizations/{did}/keys": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "post": { "summary": "Add a key", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "$ref": "./key.json" }, "custodied": { "type": "boolean", "x-stoplight": { "id": "4lzffdjmxq1j2" }, "description": "whether the key is custodied or not" } }, "required": [ "key", "custodied" ] }, "examples": { "Sample Response": { "value": { "key": { "kidFragment": "#key-1", "purposes": [ "DLT_TRANSACTIONS" ], "algorithm": "EcdsaSecp256k1", "encoding": "hex", "didDocumentKey": { "id": "#key-1", "type": "JsonWebKey2020", "controller": "did:web:acmecorp.com", "publicKeyJwk": { "kty": "EC", "x": "fXZfrDLSF-RaYJ3R6cmM0UBIOzQmYfRjju844wU_YdA", "y": "61gcKsDtjEJecn099TiOAFKbdcFfeuFtA8pezfopGqQ", "crv": "secp256k1" } } }, "custodied": true } } } } } } }, "operationId": "post-organizations-did-keys", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "kidFragment": { "type": "string", "pattern": "^#[a-zA-Z0-9-_]*$", "description": "defaults to `{key-purpose}-{timestamp}`", "x-stoplight": { "id": "wuh5ykp0n2pxb" } }, "algorithm": { "type": "string", "default": "EcdsaSecp256k1", "enum": [ "EcdsaSecp256k1" ], "description": "only secp256k1 for ecdsa signatures is supported for now" }, "purposes": { "type": "array", "minItems": 1, "description": "`purpose` must be set. at least one, but more can specified", "items": { "type": "string", "enum": [ "EXCHANGES", "ISSUING_METADATA", "DLT_TRANSACTIONS" ] } } }, "required": [ "algorithm", "purposes" ] }, "examples": { "Set key": { "value": { "kidFragment": "#key-2", "purposes": [ "EXCHANGES" ] } }, "Generate a key": { "value": { "algorithm": "EcdsaSecp256k1", "purposes": [ "DLT_TRANSACTIONS" ] } } } } }, "description": "Registers keys to be used on the network.\nIf `custodied` is true then the key will be generated and custodied on the registrar on behalf of the organization\nIf `custodied` is false, then the key MUST be specified on the DID Document, under the id fragment, and be available under one of `publicKeyJwk` or `publicKeyHex`" }, "description": "Add a new key of the specified type for the organization. Either pass in a public key or it will generate a new key pair and set the public key on the DID Document for the specified purpose. Currently only SECP256K1 types are supported. Adds it to the DID Document", "tags": [ "organization-management" ] } }, "/organizations/{did}/keys/{kid}": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "kid", "description": "the KID of the organization key", "in": "path", "required": true } ], "get": { "summary": "Get Key", "description": "Get Key", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "$ref": "./key.json" }, "custodied": { "type": "boolean", "x-stoplight": { "id": "cd7v2ppe1yygq" } } }, "required": [ "key", "custodied" ] }, "examples": { "Custodied Key": { "value": { "key": { "kidFragment": "#key-1", "purposes": [ "DLT_TRANSACTIONS" ], "algorithm": "EcdsaSecp256k1", "encoding": "hex", "didDocumentKey": { "id": "#key-1", "type": "JsonWebKey2020", "controller": "did:web:acmecorp.com", "publicKeyJwk": { "kty": "EC", "x": "fXZfrDLSF-RaYJ3R6cmM0UBIOzQmYfRjju844wU_YdA", "y": "61gcKsDtjEJecn099TiOAFKbdcFfeuFtA8pezfopGqQ", "crv": "secp256k1" } } }, "custodied": true } }, "Non-custodied key": { "value": { "key": { "kidFragment": "#key-1", "purposes": [ "DLT_TRANSACTIONS" ], "algorithm": "EcdsaSecp256k1", "didDocumentKey": { "id": "#key-1", "type": "JsonWebKey2020", "controller": "did:web:acmecorp.com", "publicKeyJwk": { "kty": "EC", "x": "fXZfrDLSF-RaYJ3R6cmM0UBIOzQmYfRjju844wU_YdA", "y": "61gcKsDtjEJecn099TiOAFKbdcFfeuFtA8pezfopGqQ", "crv": "secp256k1" } } }, "custodied": false } } } } } } }, "operationId": "get-organizations-did-keys-kid", "tags": [ "organization-management" ] }, "delete": { "summary": "Delete a Key", "operationId": "delete-organizations-did-keys-kid", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "tags": [ "organization-management" ], "description": "Delete a key" } }, "/organizations/{did}/services": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "post": { "summary": "Add a new service", "operationId": "post-organization-did-services", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "service": { "$ref": "./registered-service.json" }, "authClient": { "$ref": "./auth-client.json" }, "messageCode": { "type": "string", "x-stoplight": { "id": "ou5cn3pzvm49e" } } } }, "examples": { "Web Wallet Response": { "value": { "service": { "id": "#webwallet-1", "type": "VlcWebWallet_v1", "serviceEndpoint": "http://example.com", "logoUrl": "http://example.com/logo.png", "playStoreUrl": "http://play.google.com/play/acew013132105t2r24", "appleAppStoreUrl": "http://store.apple.com/acew013132105t2r24", "appleAppId": "45", "googlePlayId": "123", "name": "Velocity Career Wallet" } } }, "CAO Creation Response": { "value": { "service": { "id": "#credentialagent-1", "type": "VlcCredentialAgentOperator_v1", "serviceEndpoint": "https://agent.samplevendor.com/acme" }, "authClient": { "type": "auth0", "clientType": "agent", "clientId": "5fdaklslkalsfkas", "clientSecret": "as7000rewop43pkf234412390fjsdk-3149asdad", "serviceId": "#credentialagent-1" }, "messageCode": "ok_and_keys_not_sent" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "./service-modification.json", "x-stoplight": { "id": "zvweqpugafc55" } }, { "type": "object", "x-stoplight": { "id": "gx7iwloz4m2fy" }, "properties": { "invitationCode": { "type": "string", "x-stoplight": { "id": "v7zpvkw5dvok8" }, "description": "the invitationCode used to generate this organization" } } } ] }, "examples": { "Sample issuer service creation": { "value": { "id": "#issuer-1", "type": "VlcCareerIssuer_v1", "credentialTypes": [ "EducationDegree" ], "serviceEndpoint": "https://agent.samplevendor.com/acme", "invitationCode": "1P8r3wT9a" } }, "CAO Creation": { "value": { "id": "##credentialagent-1", "type": "VlcCredentialAgentOperator_v1", "serviceEndpoint": "http://example.com" } }, "Web Wallet": { "value": { "id": "#webwallet-1", "type": "VlcWebWallet_v1", "serviceEndpoint": "http://example.com", "logoUrl": "http://example.com/logo.png", "playStoreUrl": "http://play.google.com/play/acew013132105t2r24", "appleAppStoreUrl": "http://store.apple.com/acew013132105t2r24", "appleAppId": "45", "googlePlayId": "123", "name": "Velocity Career Wallet" } } } } } }, "description": "Adds the service to the specified org", "tags": [ "organization-management" ] }, "get": { "summary": "Get all services", "operationId": "get-organizations-did-services", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./registered-service.json" } }, "examples": { "example-1": { "value": [ { "id": "#webwallet-1", "type": "VlcWebWallet_v1", "serviceEndpoint": "http://example.com", "logoUrl": "http://example.com/logo.png", "playStoreUrl": "http://play.google.com/play/acew013132105t2r24", "appleAppStoreUrl": "http://store.apple.com/acew013132105t2r24", "appleAppId": "45", "googlePlayId": "123", "name": "Velocity Career Wallet" }, { "id": "#credentialagent-1", "type": "VlcCredentialAgentOperator_v1", "serviceEndpoint": "https://agent.samplevendor.com/acme" } ] } } } } } }, "description": "Gets all services for a DID", "tags": [ "organization-management" ] } }, "/organizations/{did}/services/{serviceId}": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "serviceId", "description": "the service Id on the DID Document of the organization", "in": "path", "required": true } ], "get": { "summary": "Get the specified service", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "./registered-service.json" }, "examples": { "example-1": { "value": { "id": "#credentialagent-1", "type": "VlcCredentialAgentOperator_v1", "serviceEndpoint": "https://agent.samplevendor.com/acme" } } } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "operationId": "get-organizations-did-services-serviceId", "description": "Gets the specific service for the specified org", "tags": [ "organization-management" ] }, "put": { "summary": "Update the specified service", "operationId": "put-organizations-did-services-serviceId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "./registered-service.json" }, "examples": { "example-1": { "value": { "id": "#issuer-1", "type": "VlcCareerIssuer_v1", "credentialTypes": [ "EducationDegreeRegistrationV1.1", "EducationDegreeGraduationV1.1" ], "serviceEndpoint": "https://agent.samplevendor.com/acme2" } } } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "description": "Updates the service on the did", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./service-modification.json" }, "examples": { "example-1": { "value": { "id": "#issuer-1", "type": "VlcCareerIssuer_v1", "credentialTypes": [ "EducationDegreeRegistrationV1.1", "EducationDegreeGraduationV1.1" ], "serviceEndpoint": "https://agent.samplevendor.com/acme2" } } } } }, "description": "PUT semantics" }, "tags": [ "organization-management" ] }, "delete": { "summary": "Delete the specified service", "operationId": "delete-organizations-did-services-serviceId", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "description": "Deletes the specified service", "tags": [ "organization-management" ] } }, "/organizations/{did}/resolve-vc": { "get": { "summary": "Resolve an Organization's VC by type", "description": "Resolve an Organization's VC by type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "array of vcs encoded as jwts", "items": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "jwt_vc" ], "description": "format of the vc. for now only jwt_vc is supported" }, "vc": { "type": "string", "description": "the vc itself" } }, "required": [ "format", "vc" ] } }, "examples": { "JWTs": { "value": [ { "format": "jwt_vc", "vc": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } ] } } } } } }, "operationId": "get-resolve-vc", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "type", "description": "The vc type. Typically OrganizationBasicProfile-v1.0", "required": true } ], "tags": [ "public-organization-registry" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "did", "in": "path", "required": true, "description": "the DID of the organization" } ] }, "/organizations/{did}/resolve-vc/{id}": { "get": { "summary": "Resolve an Organization's VC by id", "description": "Resolve an Organization's VC by id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "jwt_vc" ], "description": "format of the vc. for now only jwt_vc is supported" }, "vc": { "type": "string", "description": "the vc itself" } }, "required": [ "format", "vc" ] }, "examples": { "JWTs": { "value": { "format": "jwt_vc", "vc": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } } } } } } }, "operationId": "get-resolve-vc-by-id", "tags": [ "public-organization-registry" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "the id of the vc" }, { "schema": { "type": "string" }, "name": "did", "in": "path", "required": true, "description": "the did of the organization" } ] }, "/organizations/search-profiles": { "get": { "summary": "Search Org Profiles", "operationId": "get-organizationProfiles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "result" ], "properties": { "result": { "type": "array", "items": { "allOf": [ { "$ref": "./organization-profile-credential-subject.v1.json" }, { "type": "object", "required": [ "profileVcUri", "service" ], "properties": { "profileVcUri": { "type": "string" }, "service": { "type": "array", "items": { "$ref": "./registered-service.json" } } } } ] } } } }, "examples": { "example-2": { "value": { "result": [ { "id": "did:web:example.com", "name": "ACME Corp", "description": "Sample description of ACME Limited", "logo": "https://acme.com/logo.png", "website": "https://acme.com", "type": "company", "contactEmail": "support@acme.com", "technicalEmail": "support@acme.com", "location": { "countryCode": "US", "regionCode": "US-TX" }, "permittedVelocityServiceCategory": [ "Issuer", "Inspector", "HolderApp" ], "supportsSecureMessages": true, "profileVcUri": "https://example.com/vc/1231322131", "service": [ { "id": "did:web:example.com#service-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "https://example.com/get-credential-manifest", "credentialTypes": [ "EmploymentRoleCurrentV1.1" ] }, { "id": "did:web:example.com#service-2", "type": "VlcInspector_v1", "serviceEndpoint": "https://example.com/get-presentation-request" }, { "id": "did:web:example.com#wallet1", "type": "VlcHolderAppProvider_v1", "serviceEndpoint": "http://example.com", "logoUrl": "http://example.com/logo.png", "playStoreUrl": "http://play.google.com/play/acew013132105t2r24", "appleAppStoreUrl": "http://store.apple.com/acew013132105t2r24", "appleAppId": "45", "googlePlayId": "123", "name": "Velocity Career Wallet" } ] } ] } } } } } } }, "description": "For the holder app. Gets the org profiles via search. Should be capped at 100 results in the array.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "filter.credentialTypes", "description": "Filters orgs based on credential types " }, { "schema": { "type": "string", "enum": [ "Issuer", "Inspector", "CredentialAgentOperator", "NodeOperator", "TrustRoot", "NotaryIssuer", "IdDocumentIssuer", "NotaryIdDocumentIssuer", "ContactEndpointIssuer", "NotaryContactEndpointIssuer", "HolderAppProvider" ] }, "in": "query", "name": "filter.serviceTypes", "description": "Filters orgs based on Service Types" }, { "schema": { "type": "string" }, "in": "query", "name": "filter.did", "description": "Filters orgs based on DIDs" }, { "schema": { "type": "string" }, "in": "query", "name": "q", "description": "Full Text search for the name property of the organization. Matches on partials strings. Prefer results that are the first word of the name, or first letter of a word" }, { "schema": { "type": "array" }, "in": "query", "name": "sort[]", "description": "A array of tuples indicating the field to sort by" }, { "schema": { "type": "string" }, "in": "query", "name": "page.skip", "description": "The objectId to skip" }, { "schema": { "type": "string" }, "in": "query", "name": "page.size", "description": "The number of records to retrieve" } ], "tags": [ "public-organization-registry" ] }, "parameters": [] }, "/resolve-did/{did}": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "get": { "summary": "Resolve a did to a did document", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "../common/models/did-doc.v1.json" }, "examples": { "example-1": { "value": { "@context": "https://www.w3.org/ns/did/v1", "id": "did:velocity:0x698cc3b917978db1c4f2a121206b064215534c02", "controller": "did:velocity:0x97eb86c59fc79475d9042de25534ab31bbe85a2e", "publicKey": [ { "id": "did:velocity:0x698cc3b917978db1c4f2a121206b064215534c02#key-1", "type": "EcdsaSecp256k1VerificationKey2019", "controller": "did:velocity:0x698cc3b917978db1c4f2a121206b064215534c02", "publicKeyBase58": "SCDqdDQhHkPi9DB5dRZHGFp3zE7iHUnuscXHrEboUaC964Smg5RrtJaWwkHjr8QXdLUdrEEjmuzmnM6YqhyQQNnW" } ], "authentication": [ "did:velocity:0x97eb86c59fc79475d9042de25534ab31bbe85a2e#key-1" ], "service": [ { "id": "did:velocity:0x698cc3b917978db1c4f2a121206b064215534c02#credential-agent-issuer-1", "serviceEndpoint": "https://velocity.staffmarkgroup.com", "type": "VlcCareerIssuer_v1", "credentialTypes": [ "PastEmploymentPosition", "CurrentEmploymentPosition", "Course", "Badge", "Assessment", "EducationDegree" ] }, { "id": "did:velocity:0x698cc3b917978db1c4f2a121206b064215534c02#credential-agent-inspector-1", "serviceEndpoint": "https://velocity.staffmarkgroup.com", "type": "VlcInspector_v1" }, { "id": "did:velocity:0x698cc3b917978db1c4f2a121206b064215534c02#credential-agent-provider-1", "serviceEndpoint": "https://velocity.staffmarkgroup.com", "type": "VlcCredentialAgentOperator_v1" } ], "created": "2021-07-26T19:19:25.253Z", "updated": "2021-07-27T00:03:56.401Z" } } } } } } }, "operationId": "resolve-did", "description": "Will resolve a did document typically a did:web", "tags": [ "public-organization-registry" ] } }, "/resolve-kid/{kid}": { "parameters": [ { "schema": { "type": "string" }, "name": "kid", "description": "the DID of the organization", "in": "path", "required": true } ], "get": { "summary": "Resolve KID to public key in specified format", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "example-1": { "value": "eycadasf1.....1231df" } } } } } }, "operationId": "resolve-kid", "parameters": [ { "schema": { "type": "string", "enum": [ "pem", "base58", "hex", "jwk" ], "default": "pem" }, "in": "query", "name": "format", "description": "the format of the key to return" } ], "description": "Looks up the did and then resolves the kid that was referenced such as\n`did:velocity:0x4021312332132312#key-1`\n\nformat query param is optional and defaults to pem. Also supports base58, hex and jwk\n", "tags": [ "public-organization-registry" ] } }, "/service-types": { "get": { "summary": "Get Service types", "tags": [ "credential-type-management" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "serviceTypes": { "type": "array", "items": { "type": "object", "x-stoplight": { "id": "aw7taheur54ke" }, "properties": { "serviceType": { "type": "string", "x-stoplight": { "id": "pqflkongv4ob4" } }, "serviceCategory": { "type": "string", "x-stoplight": { "id": "vt6ytqpd6bwwr" } }, "notary": { "type": "boolean", "x-stoplight": { "id": "mr5aeot8kedav" } }, "credentialGroup": { "x-stoplight": { "id": "oqiz7fjznro0g" }, "enum": [ "Career", "IdDocument", "Contact" ] } } } } } }, "examples": { "Sample response": { "value": { "serviceTypes": [ { "serviceType": "Issuer_v1", "serviceCategory": "CareerIssuer", "notary": false, "credentialGroup": "Career" }, { "serviceType": "NotaryIssuer_v1", "serviceCategory": "NotaryCareerIssuer", "notary": true, "credentialGroup": "Career" } ] } } } } } } }, "operationId": "get-service-types", "x-stoplight": { "id": "i2siotibd7yu3" } } }, "/credential-types": { "get": { "summary": "Gets all credential types", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./credential-type.v1.json" } }, "examples": { "Sample response": { "value": [ { "id": "5f3243094320493", "credentialType": "EducationDegreeGraduationV1.1", "schemaName": "education-degree-graduation-v1.1", "schemaUrl": "http://example.com/education-degree-graduation-v1.1.schema.json", "jsonldContext": [ "http://lib.velocitynetwork.foundation/context/layer1-v1.1.jsonld.json" ], "issuerCategory": "RegularIssuer", "credentialGroup": "Career", "recommended": true, "title": "Education degree graduation", "linkedIn": { "shareInProfile": true, "shareInFeed": true }, "layer1": true, "displayDescriptorUrls": { "en": "http://example.com/education-degree-graduation-v1.1.descriptor.json" }, "formSchemaUrls": { "en": "http://example.com/education-degree-graduation-v1.1.form-schema.json" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, { "credentialType": "EmailV1.0", "schemaName": "email-v1.0", "schemaUrl": "http://example.com/email-v1.0.schema.json", "jsonldContext": [ "http://lib.velocitynetwork.foundation/context/layer1-v1.1.jsonld.json" ], "issuerCategory": "IdDocumentIssuer", "credentialGroup": "IdDocument", "recommended": false, "title": "Email", "linkedIn": { "shareInProfile": true, "shareInFeed": true }, "layer1": true, "displayDescriptorUrls": { "en": "http://example.com/email-v1.0.descriptor.json" }, "formSchemaUrls": { "en": "http://example.com/email-v1.0.form-schema.json" }, "id": "5f3243094320494", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] } } } } }, "500": { "description": "Internal Server Error" } }, "operationId": "get-credential-types", "description": "Get all the supported credential types", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "credentialType", "description": "the credential type to filter by" } ], "tags": [ "credential-type-management" ] }, "post": { "summary": "Create a new credential type via API", "description": "Create a new credential type via API", "operationId": "post-credential-types", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "./credential-type.v1.json" }, "examples": { "Example Response": { "value": { "credentialType": "EmploymentCurrentV1.1", "schemaName": "employment-current-v1.1", "jsonldContext": [ "http://example.com/jsonld.json" ], "issuerCategory": "RegularIssuer", "recommended": false, "title": "Current Employment", "linkedIn": { "shareInProfile": false, "shareInFeed": true }, "layer1": true, "schemaUrl": "http://example.com/employment-current-v1.1.schema.json", "displayDescriptorUrls": { "en": "http://example.com/employment-current-v1.1.descriptor.json" }, "formSchemaUrls": { "en": "http://example.com/employment-current-v1.1.form-schema.json" }, "id": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "./credential-type-modification.v1.json" }, "examples": { "Example 1": { "value": { "credentialType": "EmploymentCurrentV1.1", "schemaName": "employment-current-v1.1", "jsonldContext": [ "http://example.com/jsonld.json" ], "issuerCategory": "RegularIssuer", "recommended": false, "title": "Current Employment", "linkedIn": { "shareInProfile": false, "shareInFeed": true }, "layer1": true, "schemaUrl": "http://example.com/employment-current-v1.1.schema.json", "displayDescriptorUrls": { "en": "http://example.com/employment-current-v1.1.descriptor.json" }, "formSchemaUrls": { "en": "http://example.com/employment-current-v1.1.form-schema.json" } } } } } } }, "tags": [ "credential-type-management" ] } }, "/credential-types/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "the id of the credential type" } ], "get": { "summary": "Get specific credential type", "description": "Get specific credential type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "./credential-type.v1.json" }, "examples": { "Example 1": { "value": { "credentialType": "Badge_2023", "schemaName": "badge.2023.schema.json", "jsonldContext": [ "http://example.com/badge_2023.jsonld" ], "issuerCategory": "RegularIssuer", "credentialGroup": "Career", "schema": "https://example.com/badge_2023.schema.json", "recommended": false, "title": "Badge 2023", "linkedIn": { "shareInProfile": false, "shareInFeed": true }, "id": "1023-13-213-2103", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "operationId": "get-credential-types-credentialType", "tags": [ "credential-type-management" ] }, "delete": { "summary": "Deletes the specific credential type", "operationId": "delete-credential-types-credentialType", "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "description": "Deletes the credential type", "tags": [ "credential-type-management" ] }, "put": { "summary": "Update Credential Type", "operationId": "put-credential-types-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialType": { "$ref": "./credential-type-modification.v1.json" } }, "required": [ "credentialType" ] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "./credential-type-modification.v1.json" } } } }, "description": "Updates the credential type", "tags": [ "registrar-credential-types" ] } }, "/users": { "post": { "summary": "Create User", "operationId": "post-users", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "./user.v1.json" } } }, "examples": { "Sample Response": { "value": { "user": { "id": "auth0|12901231293901231", "email": "admin@example.com", "givenName": "Adam", "familyName": "Smith", "groupId": "did:web:example.com", "registrarRole": "clientadmin", "tokenWalletRole": "clientfinanceadmin", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "./user-modification.v1.json" }, "examples": { "Creating a clientadmin and token wallet admin": { "value": { "email": "admin@example.com", "givenName": "Adam", "familyName": "Smith", "groupId": "did:web:example.com", "registrarRole": "clientadmin", "tokenWalletRole": "clientfinanceadmin" } }, "Superuser example": { "value": { "givenName": "Andres", "familyName": "Olave", "email": "andres@example.com", "registrarRole": "superuser" } }, "VNF Operations example": { "value": { "givenName": "Aurelia", "familyName": "Greystroke", "email": "aurelia@example.com", "fineractRole": "operations" } } } } } }, "description": "Gets all users for the user's organization", "tags": [ "users" ] }, "get": { "summary": "COMING SOON: Get Users", "description": "COMING SOON: Get Users", "operationId": "get-users", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "q", "description": "Full Text search for the firstName, givenName & email properties of the user. Matches on partials strings. Prefer results that are the first word of the name, or first letter of a word" }, { "schema": { "type": "array" }, "in": "query", "name": "sort[]", "description": "A array of tuples indicating the field to sort by" }, { "schema": { "type": "string" }, "in": "query", "name": "page.skip", "description": "The objectId to skip" }, { "schema": { "type": "string" }, "in": "query", "name": "page.size", "description": "The number of records to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "./user.v1.json" } } } }, "examples": { "example-1": { "value": { "users": [ { "id": "auth0|123213131232", "givenName": "Tom", "familyName": "Skreens", "email": "tom.skreens@example.com", "phone": "+11234567890", "groupId": "did:web:example.com", "picture": "https://example.com/image.jpg", "registrarRole": "clientadmin", "tokenWalletRole": "clientfinanceadmin", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] } } } } } } }, "tags": [ "users" ] } }, "/users/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "the id of the user" } ], "get": { "summary": "Get a User", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "./user.v1.json" } } }, "examples": { "example-1": { "value": { "user": { "id": "auth0|12901231293901231", "email": "admin@example.com", "givenName": "Adam", "familyName": "Smith", "groupId": "did:web:example.com", "registrarRole": "superuser", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "operationId": "get-users-id", "description": "Gets a user by their id", "tags": [ "users" ] }, "put": { "summary": "COMING SOON: Update the user", "operationId": "put-users-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "./user.v1.json" } } }, "examples": { "update the user": { "value": { "user": { "id": "auth0|12901231293901231", "email": "admin@example.com", "givenName": "Adam", "familyName": "Smith", "groupId": "did:web:example.com", "registrarRole": "superuser", "createdAt": "2021-07-26T19:00:00.000Z", "updatedAt": "2021-07-26T19:00:00.000Z" } } } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "./user-modification.v1.json" }, "examples": { "example-1": { "value": { "email": "admin@example.com", "givenName": "Adam", "familyName": "Smith", "groupId": "did:web:example.com", "registrarRole": "superuser" } } } } } }, "description": "COMING SOON: Update the user", "tags": [ "users" ] }, "delete": { "summary": "Delete the User", "operationId": "delete-users-id", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "description": "Deactivate the user. \nIf `permantentlyRemove` is set to true the User record will be removed (Should only be used for GDPR Right to delete requests)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permanentlyRemove": { "type": "boolean", "default": false } } } } } }, "tags": [ "users" ] } }, "/schemas/{schemaName}": { "parameters": [ { "schema": { "type": "string" }, "name": "schemaName", "in": "path", "required": true, "description": "the schema name. typically something like `employment-current-v1.0`" } ], "get": { "summary": "Gets a JSON schema for the specified schema name", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "404": { "description": "Not Found" } }, "operationId": "get-schemas-schemaName", "description": "Returns a schema", "tags": [ "credential-type-public-registry" ] } }, "/schemas/{schemaName}.schema.json": { "parameters": [ { "schema": { "type": "string" }, "name": "schemaName", "in": "path", "required": true, "description": "the schema name. typically something like `employment-current-v1.0`" } ], "get": { "summary": "Gets a JSON schema for the specified schema filename", "description": "Gets a JSON schema for the specified schema filename", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "404": { "description": "Not Found" } }, "operationId": "get-schemas-schemaName-.schema.json", "tags": [ "credential-type-public-registry" ] } }, "/form-schemas/{formSchemaName}.form-schema.json": { "parameters": [ { "schema": { "type": "string" }, "name": "formSchemaName", "description": "the form schema name. typically something like `employment-current-v1.0-form-schema`", "in": "path", "required": true } ], "get": { "summary": "Gets a form-schema for the specified schema filename", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "404": { "description": "Not Found" } }, "operationId": "get-form-schemas-schemaName-.form-schema.json", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "locale", "description": "the iso ISO 639-1 language code with an optional suffix of the ISO-3166 two letter country code. Default is `en`" } ], "description": "If specified locale gets the closest available", "tags": [ "credential-type-public-registry" ] } }, "/credential-type-descriptors/{credentialType}": { "parameters": [ { "schema": { "type": "string" }, "name": "credentialType", "in": "path", "required": true, "description": "The credential type" } ], "get": { "summary": "Get Descriptor for DIF Presentation Exchange", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "./credential-type-descriptor.json" }, "examples": { "example-1": { "value": { "id": "EducationDegreeGraduationV1.1", "name": "Education Degree", "schema": [ { "uri": "http://velocitynetwork.foundation/schemas/education-degree-graduation-v1.1.schema.json" } ] } } } } } } }, "operationId": "get-credential-type-descriptors-credentialType", "description": "Returns a descriptor for a specific credential type", "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "includeDisplay", "description": "If a display descriptor for the credential type is needed send through `includeDisplay=true`" }, { "schema": { "type": "string" }, "in": "query", "name": "locale", "description": "the iso ISO 639-1 language code with an optional suffix of the ISO-3166 two letter country code" } ], "tags": [ "credential-type-public-registry" ] } }, "/schemas": { "get": { "summary": "Gets schemas by query params", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "each object ia a schema of one of the passed credential types" } } } } } }, "operationId": "get-schemas", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "credentialType", "description": "the credential type of the schema being retrieved" } ], "description": "Gets schemas by credentials type", "tags": [ "credential-type-public-registry" ] } }, "/test-secure-webhook-url": { "post": { "summary": "Test Secure Webhook Url", "operationId": "post-test-secure-webhook-url", "tags": [ "organization-management" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "secureWebhookUrl": { "type": "string", "x-stoplight": { "id": "0q6obdxuh4pcq" }, "format": "uri" } }, "required": [ "secureWebhookUrl" ] } } } } } }, "/schemas/{schemaName}/validate": { "parameters": [ { "schema": { "type": "string" }, "name": "schemaName", "in": "path", "required": true, "description": "the schema to validate against" } ], "post": { "summary": "Validate Credential Subject", "operationId": "post-schemas-schemaName-validate", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean", "x-stoplight": { "id": "vjm5qobd2aiw0" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean", "x-stoplight": { "id": "w7hehltspb1ne" } }, "errors": { "type": "array", "x-stoplight": { "id": "5xcw6i1o4v596" }, "items": { "x-stoplight": { "id": "ll46dmpdixfju" }, "type": "string" } } } } } } }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "the credential Subject to be verified" } } }, "examples": { "EducationDegreeGraduation": { "value": { "@context": "https://velocitynetwork.foundation/contexts/education-degree", "institution": { "name": "XYZ University", "identifier": "did:web:www.xyzuniversity.com", "place": { "addressLocality": "Chicago", "addressRegion": "US-IL", "addressCountry": "US" } }, "school": { "name": "School of nursing", "place": { "name": "Florida Branch", "addressLocality": "Fort Myers", "addressRegion": "US-FL", "addressCountry": "US" } }, "programName": "RN to BSN", "programType": "1 year full time program", "programMode": "Online", "degreeName": "Bachelor of Science", "degreeMajor": [ "Nursing" ], "description": "Starfield College’s RN to BSN Online Option allows working nurses to advance your degree in as few as 3 semesters.\n If you are a registered nurse with an active RN license looking to earn your BSN, Chamberlain's online RN to BSN option can help prepare you for the next step in your career.\n Our RN to BSN online option allows you to earn your degree while you work.", "alignment": { "targetName": "Bachelor of Science in Nursing, RN to BSN", "targetUrl": "https://credentialfinder.org/credential/5769/Bachelor_of_Science_in_Nursing,_RN_to_BSN", "targetDescription": "The RN to BSN completion program has been developed to address the specific needs of working registered nurses who return to the university to earn the BSN.", "targetFramework": "Credential Engine's Credential Registry" }, "startDate": "2011-08", "endDate": "2013-06", "conferredDate": "2014-01", "honors": "cum laude" } } } }, "description": "Verify a credential subject against a Velocity Network Foundation Layer 1 Credential Type Schema", "tags": [ "credential-type-public-registry" ] } }, "/organizations/{did}/activate-services": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "post": { "summary": "Activate Services", "description": "Activate Services for a organization", "operationId": "post-organizations-did-activate-services", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "$ref": "./organization-profile.v1.json" }, "activatedSerivceIds": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Example 1": { "value": { "profile": { "name": "ACME Corporation", "description": "ACME Corporation produces widgets", "location": { "countryCode": "US", "regionCode": "US-CA" }, "logo": "https://example.com/logo.png", "website": "http://example.com", "contactEmail": "user@example.com", "technicalEmail": "user@example.com", "closed": "2019-08-24", "founded": "2019-08-24", "type": "company", "registrationNumbers": [ { "authority": "NationalAuthority", "number": "string", "uri": "http://example.com" } ], "id": "did:web:example.com", "permittedVelocityServiceCategory": [ "Issuer" ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "verifiableCredentialJwt": "http://example.com" }, "activatedSerivceIds": [ "5f129312dfe031ac101231" ] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "serviceIds": { "type": "array", "minItems": 1, "items": { "type": "string", "x-stoplight": { "id": "98qmay9whwfp7" } } } }, "required": [ "serviceIds" ] }, "examples": { "Example 1": { "value": { "serviceIds": [ "5f129312dfe031ac101231" ] } } } } } }, "tags": [ "superuser-organization-management" ] } }, "/organizations/{did}/deactivate-services": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "description": "the DID of the organization", "in": "path", "required": true } ], "post": { "summary": "Deactivate Services", "description": "Deactivate Services for a organization", "operationId": "post-organizations-did-deactivate-services", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "$ref": "./organization-profile.v1.json" }, "activatedSerivceIds": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Example 1": { "value": { "profile": { "name": "ACME Corporation", "description": "ACME Corporation produces widgets", "location": { "countryCode": "US", "regionCode": "US-CA" }, "logo": "https://example.com/logo.png", "website": "http://example.com", "contactEmail": "user@example.com", "technicalEmail": "user@example.com", "closed": "2019-08-24", "founded": "2019-08-24", "type": "company", "registrationNumbers": [ { "authority": "NationalAuthority", "number": "string", "uri": "http://example.com" } ], "id": "did:web:example.com", "permittedVelocityServiceCategory": [ "Issuer" ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "verifiableCredentialJwt": "http://example.com" }, "activatedSerivceIds": [ "5f129312dfe031ac101231" ] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "serviceIds": { "type": "array", "minItems": 1, "items": { "type": "string", "x-stoplight": { "id": "hxx48s7mlpanx" } } } }, "required": [ "serviceIds" ] }, "examples": { "Example 1": { "value": { "serviceIds": [ "5f129312dfe031ac101231" ] } } } } } }, "tags": [ "superuser-organization-management" ] } }, "/consents": { "parameters": [], "get": { "summary": "Get the consents for this user", "tags": [ "Consents" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "consents": { "type": "array", "items": { "$ref": "#/components/schemas/Consent" } } } }, "examples": { "Example 1": { "value": { "consents": [ { "id": "5f128931931298abce89g", "version": "1.0", "userId": "auth0|12894894237412312", "type": "AppTerms", "createdAt": "2022-08-24T14:15:22Z" }, { "id": "5f128931931298abce89f", "version": "1.0", "userId": "auth0|12894894237412312", "type": "IssuerInspector", "did": "did:web:example.com", "serviceIdFragment": "#velocity-issuer-1", "createdAt": "2022-08-24T14:15:22Z" } ] } } } } } } }, "operationId": "get-consents", "description": "" }, "post": { "summary": "Add a consent for this user", "operationId": "post-consents", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "consent": { "$ref": "#/components/schemas/Consent" } } }, "examples": { "Terms Agreement": { "value": { "consent": { "id": "5f128931931298abce89f", "version": "1.0", "userId": "auth0|12894894237412312", "type": "RegistrarAppTerms", "did": "did:web:example.com", "createdAt": "2022-08-24T14:15:22Z" } } }, "Service Agreement": { "value": { "consent": { "id": "5f128931931298abce89f", "version": "1.0", "userId": "auth0|12894894237412312", "type": "IssuerInspector", "did": "did:web:example.com", "serviceIdFragment": "#velocity-issuer-1", "createdAt": "2022-08-24T14:15:22Z" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "string", "description": "version of the agreement being consented to" }, "type": { "type": "string", "enum": [ "IssuerInspector", "CAO", "NodeOperator", "RegistrarAppTerms" ], "default": "IssuerInspector" }, "did": { "type": "string", "x-stoplight": { "id": "9oo2dztmhg14y" }, "description": "the DID of the organization" } } }, "examples": { "Terms Agreement": { "value": { "version": "1.0", "type": "IssuerInspector" } }, "ServiceAgreement": { "value": { "version": "1.0", "type": "IssuerInspector", "serviceIdFragment": "#velocity-issuer-1" } } } } } }, "tags": [ "Consents" ] } }, "/organizations/{did}/invitations": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "in": "path", "required": true } ], "post": { "summary": "Create an organization invitation", "operationId": "post-organization-did-invite", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "$ref": "#/components/schemas/Invitation", "x-stoplight": { "id": "opq8rhr4bvhrr" } }, "messageCode": { "type": "string", "x-stoplight": { "id": "pk3peuf5lnjnq" } } }, "required": [ "invitation" ] }, "examples": { "Example 1": { "value": { "invitation": { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteeEmail": { "type": "string", "x-stoplight": { "id": "5f3x6wkbko47w" }, "format": "email", "description": "the email to send the invitation to" }, "inviteeService": { "type": "array", "x-stoplight": { "id": "arztqn2loetj1" }, "description": "service information for the profile", "items": { "$ref": "../common/models/did-service.v1.json" } }, "inviteeProfile": { "$ref": "./organization-profile-base.json" }, "inviteeDid": { "type": "string", "x-stoplight": { "id": "0kpbzhifvpp96" }, "format": "uri", "description": "an optional DID for the invitee for the profile & service to be associated with" }, "keyIndividuals": { "$ref": "./key-individuals.json" } }, "required": [ "inviteeEmail", "inviteeService" ] }, "examples": { "Example 1": { "value": { "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022-01-01", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ] } } } } }, "description": "" }, "tags": [ "invitations" ] }, "get": { "summary": "List invitations", "operationId": "get-organization-did-invite", "parameters": [ { "schema": { "type": "array" }, "in": "query", "name": "sort[]", "description": "A array of tuples indicating the field to sort by" }, { "schema": { "type": "string" }, "in": "query", "name": "page.skip", "description": "The number of records to skip" }, { "schema": { "type": "string" }, "in": "query", "name": "page.size", "description": "The number of records to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitations": { "type": "array", "x-stoplight": { "id": "keba5u9eok3l0" }, "items": { "$ref": "#/components/schemas/Invitation", "x-stoplight": { "id": "f4y1fob60dnli" } } } }, "required": [ "invitations" ] }, "examples": { "Example 1": { "value": { "invitations": [ { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" } ] } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "tags": [ "invitations" ] } }, "/organizations/{did}/invitations/{invitationId}": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "invitationId", "in": "path", "required": true } ], "get": { "summary": "Gets a single invitation", "tags": [ "invitations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "$ref": "#/components/schemas/Invitation", "x-stoplight": { "id": "4bjevx6btd86j" } } }, "required": [ "invitation" ] }, "examples": { "Example 1": { "value": { "invitation": { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" } } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "operationId": "get-organizations-did-invitation-invitationId" }, "delete": { "summary": "Delete invitation", "operationId": "delete-organizations-did-invitation-invitationId", "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "description": "Soft deletes the invitation", "tags": [ "invitations" ] }, "put": { "summary": "Resend invitation", "operationId": "put-organizations-did-invitation-invitationId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "$ref": "#/components/schemas/Invitation", "x-stoplight": { "id": "yilous6ax7tik" } }, "messageCode": { "type": "string", "x-stoplight": { "id": "put04tt7wwoar" } } }, "required": [ "invitation" ] }, "examples": { "Example 1": { "value": { "invitation": { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteeEmail": { "type": "string", "x-stoplight": { "id": "8lceaif893v2a" }, "description": "the email address to send the invitation to" } }, "required": [ "inviteeEmail" ] } } } }, "description": "Resend the invitation to the specified email address", "tags": [ "invitations" ] } }, "/invitations/{code}": { "parameters": [ { "schema": { "type": "string" }, "name": "code", "in": "path", "required": true } ], "get": { "summary": "Get an invitation by code", "tags": [ "invitations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "$ref": "#/components/schemas/Invitation", "x-stoplight": { "id": "d9m9otnsq0bf3" } } } }, "examples": { "Example 1": { "value": { "invitation": { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" } } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "operationId": "get-invitations-code", "description": "Gets the invitation by code", "requestBody": { "content": {} } } }, "/setup_image_upload": { "parameters": [], "post": { "summary": "Setup Image Upload", "operationId": "post-organizations-did-upload", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "imageMetadata": { "$ref": "#/components/schemas/ImageMetadata" } } }, "examples": { "Pending upload": { "value": { "imageMetadata": { "url": "http://example.com/4829223.jpg", "uploadUrl": "http://example.com/4829223.jpg/upload_image", "userId": "auth0|5f812983fss812oesoqqp4u89189rq", "state": "pending_upload", "uploadSucceeded": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extension": { "type": "string", "x-stoplight": { "id": "bkj1jgyi2i4cp" }, "description": "the image type (extension) being used" } }, "required": [ "extension" ] } } } }, "tags": [ "images" ] } }, "/image_processing_result": { "post": { "summary": "Set image processing result", "operationId": "post-image_processing_result", "responses": { "200": { "description": "OK" } }, "x-stoplight": { "id": "n4rydsqfmg39h" }, "tags": [ "images" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uploadUrl": { "type": "string", "x-stoplight": { "id": "g6qnye8lrvf5q" }, "format": "uri", "description": "the upload url that has failed. Should be unique\n" }, "success": { "type": "boolean", "x-stoplight": { "id": "p5adyj6zlhagk" }, "description": "set true if the image processing has been successful" }, "errorCode": { "type": "string", "x-stoplight": { "id": "gdq5bmu80j057" }, "description": "set an error code if image processing failed" }, "errorMessage": { "type": "string", "x-stoplight": { "id": "16bxjuf8k2lrb" } } }, "required": [ "uploadUrl", "success" ] }, "examples": { "Success": { "value": { "uploadUrl": "http://example.com/image_123", "success": true } }, "Error": { "value": { "uploadUrl": "http://example.com/image_666", "success": false, "errorCode": "image_bad_size" } } } } } }, "x-internal": false } }, "/image_upload/{url}": { "parameters": [ { "schema": { "type": "string" }, "name": "url", "in": "path", "required": true } ], "get": { "summary": "Get Image upload status", "tags": [ "images" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "imageMetadata": { "$ref": "#/components/schemas/ImageMetadata" } }, "required": [ "imageMetadata" ] }, "examples": { "After upload": { "value": { "imageMetadata": { "url": "http://example.com/4829223.jpg", "uploadUrl": "http://example.com/4829223.jpg/upload_image", "userId": "auth0|5f812983fss812oesoqqp4u89189rq", "state": "upload_done", "uploadSucceeded": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } }, "Active image": { "value": { "imageMetadata": { "url": "http://example.com/4829223.jpg", "uploadUrl": "http://example.com/4829223.jpg/upload_image", "userId": "auth0|5f812983fss812oesoqqp4u89189rq", "state": "active", "uploadSucceeded": true, "activeAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } }, "Upload errored": { "value": { "imageMetadata": { "url": "http://example.com/4829223.jpg", "uploadUrl": "http://example.com/4829223.jpg/upload_image", "userId": "auth0|5f812983fss812oesoqqp4u89189rq", "state": "error", "errorCode": "upload_url_already_used", "uploadSucceeded": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } }, "Upload in Progress": { "value": { "imageMetadata": { "url": "http://example.com/4829223.jpg", "uploadUrl": "http://example.com/4829223.jpg/upload_image", "userId": "auth0|5f812983fss812oesoqqp4u89189rq", "state": "upload_in_progress", "uploadSucceeded": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } }, "Pending Upload": { "value": { "imageMetadata": { "url": "http://example.com/4829223.jpg", "uploadUrl": "http://example.com/4829223.jpg/upload_image", "userId": "auth0|5f812983fss812oesoqqp4u89189rq", "state": "pending_upload", "uploadSucceeded": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } } } } } } }, "operationId": "get-images-url", "x-stoplight": { "id": "vy08klfrcivgk" }, "description": "" } }, "/setup_credential_file_upload": { "post": { "summary": "Setup a credential file upload", "operationId": "post-setup_credential_file_upload", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileMetadata": { "type": "object", "required": [ "id", "credentialFileType", "url", "uploadUrl", "validatedAt", "createdAt" ], "properties": { "id": { "type": "string", "x-stoplight": { "id": "437w75o2bs4te" } }, "credentialFileType": { "x-stoplight": { "id": "dpr291avi6icb" }, "enum": [ "JsonSchema", "DisplayDescriptor", "FormSchema", "JsonldContext" ] }, "url": { "type": "string", "x-stoplight": { "id": "lklmwrc9g0n5v" }, "format": "uri" }, "uploadUrl": { "type": "string", "x-stoplight": { "id": "ux0xh2al4qovh" }, "format": "uri" }, "userId": { "type": "string", "x-stoplight": { "id": "dg287ddwn7ggy" } }, "isValid": { "type": "boolean", "x-stoplight": { "id": "jmc80y94k2yze" } }, "validatedAt": { "type": "string", "x-stoplight": { "id": "ma5rxz2f9i34o" }, "format": "date-time" }, "errorCode": { "type": "string", "x-stoplight": { "id": "32wflljc7lrom" } }, "createdAt": { "type": "string", "x-stoplight": { "id": "g869ibxkkcly3" }, "format": "date-time" } } } }, "required": [ "fileMetadata" ] }, "examples": { "Invalid File": { "value": { "fileMetadata": { "credentialFileType": "JsonSchema", "url": "http://example.com/filename.json", "uploadUrl": "http://example.com/s3bucket", "userId": "auth0|12345", "isValid": false, "errorCode": "properties_required", "validatedAt": "2019-08-24T14:17:22Z", "createdAt": "2019-08-24T14:15:22Z" } } }, "Valid File 1": { "value": { "fileMetadata": { "credentialFileType": "JsonldContext", "url": "http://example.com/filename.json", "uploadUrl": "http://example.com/s3bucket", "userId": "auth0|132112", "isValid": true, "validatedAt": "2019-08-24T14:17:22Z", "createdAt": "2019-08-24T14:15:22Z" } } } } } } } }, "x-stoplight": { "id": "r9wecmxexdywe" }, "x-extension-1": null, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialFileType": { "x-stoplight": { "id": "yuiu7c2fhi1dj" }, "enum": [ "JsonSchema", "DisplayDescriptor", "FormSchema", "JsonldContext" ], "description": "the kind of credential metadata file" }, "originalFilename": { "type": "string", "x-stoplight": { "id": "5wt5ta1nc441y" }, "description": "the original filename" } }, "required": [ "credentialFileType", "originalFilename" ] }, "examples": { "Example 1": { "value": { "credentialFileType": "JsonSchema", "originalFilename": "badgev1.schema.json" } } } } } }, "tags": [ "registrar-credential-types" ] } }, "/organizations/{did}/signatories/response/{response}": { "parameters": [ { "schema": { "type": "string" }, "name": "did", "in": "path", "required": true, "description": "did of the organization" }, { "schema": { "type": "string", "enum": [ "approve", "reject" ] }, "name": "response", "in": "path", "required": true, "description": "the response of the signature (approve or reject)" } ], "get": { "summary": "Register Signatory Response", "tags": [ "organization-management" ], "responses": { "200": { "description": "OK" } }, "operationId": "get-organizations-did-signatory-approval", "x-stoplight": { "id": "skkh6vxqmskrs" }, "description": "", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "authCode", "required": true, "description": "the auth code to use to identify the signatory" } ] } } }, "components": { "securitySchemes": { "API Key": { "type": "http", "scheme": "bearer" } }, "schemas": { "Invitation": { "title": "Invitation", "x-stoplight": { "id": "p0fvogrl5ai20" }, "type": "object", "x-examples": { "Outstanding Invitation": { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" }, "Accepted Invitation": { "id": "5f89348912931fqee04911", "inviterId": "did:web:example-cao.com", "inviteeEmail": "admin@acmecorp.com", "inviteeProfile": { "name": "Beta Corporation", "description": "Makes widgets", "location": { "countryCode": "US" }, "logo": "https://betacorp.com/logo.png", "website": "http://betacorp.com", "contactEmail": "contact@betacorp.com", "technicalEmail": "support@betacorp.com", "founded": "2022", "type": "company" }, "inviteeService": [ { "id": "#vcl-issuer-1", "type": "VlcCareerIssuer_v1", "serviceEndpoint": "did:web:example-cao.com#cao-service-1" } ], "code": "dRT4#trPO9!", "invitationUrl": "http://registrarapp.velocitynetwork.foundation/invitations/dRT4#trPO9!", "expiresAt": "2023-08-24T14:15:22Z", "sentAt": "2023-07-21T11:10:22Z", "acceptedAt": "2023-08-20T14:15:22Z", "acceptedBy": "auth0|9999993921594090", "createdAt": "2023-07-21T11:10:22Z", "createdBy": "auth0|1289318923812312", "updatedAt": "2023-07-21T11:10:22Z", "updatedBy": "auth0|1289318923812312" } }, "properties": { "id": { "type": "string", "x-stoplight": { "id": "wn1e01oibmbg7" }, "description": "invitation's id" }, "inviterDid": { "type": "string", "x-stoplight": { "id": "ytkxedb67t9nb" }, "format": "uri", "description": "DID of the inviting organization" }, "inviteeEmail": { "type": "string", "x-stoplight": { "id": "a41rq1ai8xb94" }, "format": "email", "description": "The email that the invitation will be sent to" }, "inviteeProfile": { "$ref": "./organization-profile-base.json" }, "inviteeDid": { "type": "string", "x-stoplight": { "id": "wzlbhhb3yrsj3" }, "format": "uri", "description": "an optional DID for the invitee for the profile & service to be associated with" }, "inviteeService": { "type": "array", "x-stoplight": { "id": "3j1g13cj7jmfk" }, "description": "array of service entries for this organization", "items": { "$ref": "../common/models/did-service.v1.json" } }, "code": { "type": "string", "x-stoplight": { "id": "ins1uidrvdso2" }, "description": "the code to include in the link" }, "invitationUrl": { "type": "string", "x-stoplight": { "id": "p9j9chli3hnbw" }, "format": "uri", "description": "a full url used in the email or shareable containing the invitation code" }, "expiresAt": { "type": "string", "x-stoplight": { "id": "nw5nt1sczgkog" }, "format": "date-time", "description": "when the invitation code expires" }, "acceptedAt": { "type": "string", "x-stoplight": { "id": "krne6v9cdv7sh" }, "format": "date-time", "description": "timestamp when the invitation was accepted" }, "acceptedBy": { "type": "string", "x-stoplight": { "id": "wfqngedj0mes3" }, "description": "user id of the person who accepted the invitation" }, "createdAt": { "type": "string", "x-stoplight": { "id": "iqwjyj2z56bac" }, "description": "date created at", "format": "date-time" }, "updatedAt": { "type": "string", "x-stoplight": { "id": "ovmd7px8q5a7w" }, "format": "date-time" }, "createdBy": { "type": "string", "x-stoplight": { "id": "um4t55qh6jcxk" }, "description": "created by this user" }, "updatedBy": { "type": "string", "x-stoplight": { "id": "9ug7vdpmgdb8e" } } }, "required": [ "id", "inviterDid", "inviteeEmail", "inviteeService", "code", "invitationUrl", "expiresAt", "createdAt", "updatedAt", "createdBy", "updatedBy" ] }, "Consent": { "title": "Consent", "x-stoplight": { "id": "7gl8tz2ffodek" }, "type": "object", "x-examples": { "Basic T&Cs Consent": { "id": "5f128931931298abce89f", "version": "1.0", "userId": "auth0|12894894237412312", "type": "AppTerms", "createdAt": "2022-08-24T14:15:22Z" }, "ServiceAgreement": { "id": "5f128931931298abce89f", "version": "1.0", "userId": "auth0|12894894237412312", "type": "IssuerInspector", "did": "did:web:example.com", "serviceIdFragment": "#velocity-issuer-1", "createdAt": "2022-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "description": "the id of the consent" }, "type": { "type": "string", "description": "the type of agreement being consented to", "enum": [ "CAO", "NodeOperator", "IssuerInspector", "RegistrarAppTerms" ] }, "version": { "type": "string", "description": "the version of the T&Cs being agreed to" }, "userId": { "type": "string", "description": "the userId doing the agreeing" }, "organizationId": { "type": "string", "description": "the did of the organziation that the user belongs to", "x-stoplight": { "id": "kp4fbk3fh9mi8" } }, "serviceId": { "type": "string", "description": "the service id fragment identifier that was being created when the consent needed to be grabbed", "x-stoplight": { "id": "pbz0soi9r3owi" } }, "createdAt": { "type": "string", "format": "date-time", "description": "the time it was created" } }, "required": [ "id", "type", "version", "userId", "createdAt" ] }, "ImageMetadata": { "title": "ImageMetadata", "x-stoplight": { "id": "tmhnyg6m7rrxv" }, "type": "object", "properties": { "url": { "type": "string", "x-stoplight": { "id": "vd2rn4y35xdcl" }, "format": "uri", "description": "url that the image will be served from" }, "uploadUrl": { "type": "string", "x-stoplight": { "id": "zb5zhmfum5ypd" }, "format": "uri", "description": "the url a client should use to upload (only sent if called from `setup_image_upload`" }, "userId": { "type": "string", "x-stoplight": { "id": "3ren8lld38z4d" }, "description": "The uploading user's id" }, "state": { "x-stoplight": { "id": "ttgfvyqnzcyww" }, "enum": [ "pending_upload", "upload_in_progress", "upload_done", "active", "error" ], "description": "the image state. The image is created with state `pending_upload`\n`upload_in_progress` for images that are being processed\n`upload_done` for images that have been uploaded successfully\n`active` for uploaded images that are referenced\n`error` if an error has occurred" }, "uploadSucceeded": { "type": "boolean", "x-stoplight": { "id": "fwd3j1foxxpq2" }, "description": "if upload was successful" }, "errorCode": { "type": "string", "x-stoplight": { "id": "08quwynwu4b2x" }, "description": "the optional error code if the state is in ERROR" }, "activateAt": { "type": "string", "x-stoplight": { "id": "yaikt6iuj85ov" }, "format": "date-time", "description": "the time that the image was activated at after a succesful upload" }, "createdAt": { "type": "string", "x-stoplight": { "id": "ezi27u961mq9f" }, "format": "date-time" }, "updatedAt": { "type": "string", "x-stoplight": { "id": "imey01x4o5k2s" }, "format": "date-time" } }, "required": [ "url", "uploadUrl", "userId", "state", "uploadSucceeded", "createdAt", "updatedAt" ] } } }, "tags": [ { "name": "organization-management" }, { "name": "public-organization-registry" }, { "name": "superuser-organization-management" }, { "name": "registrar-credential-types" }, { "name": "users" } ] }