BlindVault API (1.0.0)

Download OpenAPI specification:Download

BlindVault REST API

profile-controller

getProfile

Authorizations:

bearerAuth

Responses

updateProfile

Authorizations:

bearerAuth

Request Body schema: application/json

firstName required	string
lastName required	string
mobileNumber	string
organisationName	string
avatar	string

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"mobileNumber": "string",
"organisationName": "string",
"avatar": "string"
}

listApiKeys

Authorizations:

bearerAuth

Responses

createApiKey

Authorizations:

bearerAuth

Request Body schema: application/json

name	string
scopes	Array of strings Items Enum: "READ" "WRITE" "SIGN" "ADMIN"
expiresAt	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"scopes": ["READ"
],
"expiresAt": "2019-08-24T14:15:22Z"
}

deleteApiKey

Authorizations:

bearerAuth

path Parameters

apiKeyId

required

string

Responses

client-controller

getClientById

Authorizations:

bearerAuth

path Parameters

clientId

required

string

Responses

updateClient

Authorizations:

bearerAuth

path Parameters

clientId

required

string

Request Body schema: application/json

name	string
type	string
userAgent	string
publicKey	string
encryptedPrivateKey	string
encryptionMethod	string
kdfSalt	string
os	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "string",
"userAgent": "string",
"publicKey": "string",
"encryptedPrivateKey": "string",
"encryptionMethod": "string",
"kdfSalt": "string",
"os": "string"
}

revokeClient

Authorizations:

bearerAuth

path Parameters

clientId

required

string

Responses

getMyClients

Authorizations:

bearerAuth

Responses

createClient

Authorizations:

bearerAuth

Request Body schema: application/json

name	string
type	string
userAgent	string
	object (PublicKey)
os	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "string",
"userAgent": "string",
"publicKey": {"kty": "string",
"n": "string",
"e": "string",
"alg": "string",
"use": "string",
"kid": "string"
},
"os": "string"
}

client-access-key-controller

uploadEncryptedCEK

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

id	string
encryptedCek	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"encryptedCek": "string"
}

createClientAccessKey

Authorizations:

bearerAuth

Request Body schema: application/json

signingProcessId	string
senderClientId	string
senderKeyId	string
	object (PublicKey)
invitationId	string
receiverUserId	string
receiverClientId	string
receiverKeyId	string
	object (PublicKey)
encryptedCek	string

Responses

Request samples

Payload

Content type

application/json

{"signingProcessId": "string",
"senderClientId": "string",
"senderKeyId": "string",
"senderPublicKey": {"kty": "string",
"n": "string",
"e": "string",
"alg": "string",
"use": "string",
"kid": "string"
},
"invitationId": "string",
"receiverUserId": "string",
"receiverClientId": "string",
"receiverKeyId": "string",
"receiverPublicKey": {"kty": "string",
"n": "string",
"e": "string",
"alg": "string",
"use": "string",
"kid": "string"
},
"encryptedCek": "string"
}

getByInvitationId

Authorizations:

bearerAuth

path Parameters

invitationId

required

string

Responses

getAccessKeys

Authorizations:

bearerAuth

query Parameters

senderClientId	string
receiverClientId	string
missing	boolean
signingProcessId	string
invitationId	string
organisationId	string
callerClientId	string

Responses

signing-process-controller

listSigningProcesses

Authorizations:

bearerAuth

Responses

createSigningProcess

Authorizations:

bearerAuth

Request Body schema: application/json

senderClientId	string
ownerUserId	string
name	string
desc	string
signingMode	string Enum: "PARALLEL" "SEQUENTIAL"
requiredSignatureLevel	string Enum: "SES" "AES" "QES"
message	string
observersList	Array of strings
encryptedFile	string
encryptedMetadata	string
iv	string
pdfHash	string
	Array of objects (SigningGuid)

Responses

Request samples

Payload

Content type

application/json

{"senderClientId": "string",
"ownerUserId": "string",
"name": "string",
"desc": "string",
"signingMode": "PARALLEL",
"requiredSignatureLevel": "SES",
"message": "string",
"observersList": ["string"
],
"encryptedFile": "string",
"encryptedMetadata": "string",
"iv": "string",
"pdfHash": "string",
"signingGuidList": [{"email": "string",
"visualSealGuideList": [{"x": 0,
"y": 0,
"width": 0,
"height": 0,
"page": 0,
"base64Image": "string"
}
]
}
]
}

addInvitation

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

senderUserId	string
senderClientId	string
signingProcessId	string
email	string
timestamp	string <date-time>
	Array of objects (VisualSeal)
kid	string
jwksUrl	string
signerCertFingerprint	string

Responses

Request samples

Payload

Content type

application/json

{"senderUserId": "string",
"senderClientId": "string",
"signingProcessId": "string",
"email": "string",
"timestamp": "2019-08-24T14:15:22Z",
"visualSeals": [{"id": "string",
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"page": 0,
"base64Image": "string"
}
],
"kid": "string",
"jwksUrl": "string",
"signerCertFingerprint": "string"
}

getSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

deleteSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

removeInvitationById

Authorizations:

bearerAuth

path Parameters

invitationId

required

string

Responses

signing-controller

signDocumentWithAudit

Authorizations:

bearerAuth

Request Body schema: application/json

pdfHash	string
signatureLevel	string Enum: "SES" "AES" "QES"
processId	string
invitationId	string
	object (ZeroKnowledgeProof)

Responses

Request samples

Payload

Content type

application/json

{"pdfHash": "string",
"signatureLevel": "SES",
"processId": "string",
"invitationId": "string",
"zkp": {"proof": "string",
"verifierKey": "string",
"circuitHash": "string",
"algorithm": "string"
}
}

getSigningStatus

Authorizations:

bearerAuth

Request Body schema: application/json

swisscomId

string

Responses

Request samples

Payload

Content type

application/json

{"swisscomId": "string"
}

sign

Authorizations:

bearerAuth

Request Body schema: application/json

pdfHash	string
signatureLevel	string Enum: "SES" "AES" "QES"
processId	string
invitationId	string
	object (ZeroKnowledgeProof)

Responses

Request samples

Payload

Content type

application/json

{"pdfHash": "string",
"signatureLevel": "SES",
"processId": "string",
"invitationId": "string",
"zkp": {"proof": "string",
"verifierKey": "string",
"circuitHash": "string",
"algorithm": "string"
}
}

sign2

Authorizations:

bearerAuth

Request Body schema: application/json

pdfHash	string
signatureLevel	string Enum: "SES" "AES" "QES"
processId	string
invitationId	string
	object (ZeroKnowledgeProof)

Responses

Request samples

Payload

Content type

application/json

{"pdfHash": "string",
"signatureLevel": "SES",
"processId": "string",
"invitationId": "string",
"zkp": {"proof": "string",
"verifierKey": "string",
"circuitHash": "string",
"algorithm": "string"
}
}

exportProof

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

exportProofChain

Authorizations:

bearerAuth

path Parameters

documentHash

required

string

Responses

getHtmlAsBase64

Authorizations:

bearerAuth

query Parameters

userEmail

string

Responses

getFinalAuditLog

Authorizations:

bearerAuth

path Parameters

documentId

required

string

Responses

proof-verification-controller

verifyProof

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

document required	string <binary>
proof required	string <binary>

Responses

membership-controller

getAllMemberships

Authorizations:

bearerAuth

Responses

createMembership

Authorizations:

bearerAuth

Request Body schema: application/json

inviteeUserId required	string
admin	boolean

Responses

Request samples

Payload

Content type

application/json

{"inviteeUserId": "string",
"admin": true
}

acceptMembershipInvitation

Authorizations:

bearerAuth

path Parameters

membershipId

required

string

Responses

changeMembershipRole

Authorizations:

bearerAuth

path Parameters

membershipId

required

string

Request Body schema: application/json

admin

boolean

Responses

Request samples

Payload

Content type

application/json

{"admin": true
}

getMembershipById

Authorizations:

bearerAuth

path Parameters

membershipId

required

string

Responses

leaveMembership

Authorizations:

bearerAuth

path Parameters

membershipId

required

string

Responses

auth-controller

registerUser

Authorizations:

bearerAuth