BlindVault API (1.0.0)

Download OpenAPI specification:Download

BlindVault REST API

signing-process-controller

getSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

updateSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

name	string
desc	string
encryptedFile	string
encryptedMetadata	string
iv	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"desc": "string",
"encryptedFile": "string",
"encryptedMetadata": "string",
"iv": "string"
}

deleteSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

listSigningProcesses

Authorizations:

bearerAuth

Responses

createSigningProcess

Authorizations:

bearerAuth

Request Body schema: application/json

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
	Array of objects (SigningGuid)

Responses

Request samples

Payload

Content type

application/json

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

addInvitation

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

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

removeInvitationById

Authorizations:

bearerAuth

path Parameters

id required	string
invitationId required	string

Responses

profile-controller

getProfile

Authorizations:

bearerAuth

Responses

updateProfile

Authorizations:

bearerAuth

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

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

updateUserKeys

Authorizations:

bearerAuth

Request Body schema: application/json

required	object (PublicKey)
encryptedPrivateKey required	string

Responses

Request samples

Payload

Content type

application/json

{"publicKey": {"kty": "string",
"n": "string",
"e": "string",
"alg": "string",
"use": "string",
"kid": "string"
},
"encryptedPrivateKey": "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

signing-controller

sign2

Authorizations:

bearerAuth

Request Body schema: application/json

pdfHash	string
processId	string

Responses

Request samples

Payload

Content type

application/json

{"pdfHash": "string",
"processId": "string"
}

submitOtp

Authorizations:

bearerAuth

Request Body schema: application/json

processId	string
otpCode	string
pdfHash	string

Responses

Request samples

Payload

Content type

application/json

{"processId": "string",
"otpCode": "string",
"pdfHash": "string"
}

getSigningStatus

Authorizations:

bearerAuth

path Parameters

processId

required

string

Responses

getHtmlAsBase64

Authorizations:

bearerAuth

query Parameters

userEmail

string

Responses

Response samples

200

Content type

application/json

{"mimeType": "string",
"base64": "string"
}

membership-controller

getAllMemberships

Authorizations:

bearerAuth

Responses

createMembership

Authorizations:

bearerAuth

Request Body schema: application/json

inviteeUserId	string
admin	boolean

Responses

Request samples

Payload

Content type

application/json

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

declineMembershipInvitation

Authorizations:

bearerAuth

path Parameters

membershipId

required

string

Responses

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

invitation-controller

bulkUpdateInvitationCeks

Authorizations:

bearerAuth

Request Body schema: application/json

Array

invitationId	string
encryptedCek	string

Responses

Request samples

Payload

Content type

application/json

[{"invitationId": "string",
"encryptedCek": "string"
}
]

getMissingCekInvitations

Authorizations:

bearerAuth

query Parameters

signingProcessId

string

Responses

deleteVisualSealGuideFromInvitation

Authorizations:

bearerAuth

path Parameters

invitationId required	string
visualSealId required	string