BlindVault API (1.0.0)

Download OpenAPI specification:Download

BlindVault REST API

webhook-controller

getWebhook

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

updateWebhook

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

url required	string
events required	Array of strings Items Enum: "signing.process.created" "signing.process.updated" "signing.process.completed" "signing.process.cancelled" "signing.process.withdrawn" "signing.participant.invited" "signing.participant.accepted" "signing.participant.declined" "signing.review.approved" "signing.review.rejected" "signing.signature.applied" "webhook.test"
enabled	boolean
rotateSecret	boolean

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"events": ["signing.process.created"
],
"enabled": true,
"rotateSecret": true
}

deleteWebhook

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

listWebhooks

Authorizations:

bearerAuth

query Parameters

ownerUserId

string

Responses

createWebhook

Authorizations:

bearerAuth

Request Body schema: application/json

ownerUserId	string
url required	string
events required	Array of strings Items Enum: "signing.process.created" "signing.process.updated" "signing.process.completed" "signing.process.cancelled" "signing.process.withdrawn" "signing.participant.invited" "signing.participant.accepted" "signing.participant.declined" "signing.review.approved" "signing.review.rejected" "signing.signature.applied" "webhook.test"
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"ownerUserId": "string",
"url": "string",
"events": ["signing.process.created"
],
"enabled": true
}

testWebhook

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

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

object

Responses

Request samples

Payload

Content type

application/json

{ }

deleteSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

listSigningProcesses

Authorizations:

bearerAuth

Responses

createSigningProcess

Authorizations:

bearerAuth

Request Body schema: application/json

ownerUserId	string
name required	string
desc	string
processStatus	string Enum: "DRAFT" "PENDING_SIGNATURE" "COMPLETED" "EXPIRED" "PENDING" "WITHDRAWN" "FAILED"
signingMode	string Enum: "PARALLEL" "SEQUENTIAL"
signatureLevel	string Enum: "SES" "AES" "QES"
message	string
salt required	string
required	Array of objects (Signer)
	Array of objects (Observer)
	Array of objects (Reviewer)
participantsOrder	Array of strings
required	Array of objects (SigningDocument)

Responses

Request samples

Payload

Content type

application/json

{"ownerUserId": "string",
"name": "string",
"desc": "string",
"processStatus": "DRAFT",
"signingMode": "PARALLEL",
"signatureLevel": "SES",
"message": "string",
"salt": "string",
"signers": [{"id": "string",
"email": "string",
"completed": true,
"formFields": [{"documentId": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"page": 0,
"type": "CHECK",
"readOnly": true,
"textProps": {"value": "string",
"fontSize": 0,
"fontFamily": "string",
"textAlign": "left",
"multiline": true,
"required": true,
"color": "string",
"bold": true,
"italic": true,
"underline": true
},
"checkProps": {"state": "UNCHECKED",
"required": true,
"color": "string"
},
"signatureProps": {"required": true,
"placeHolder": "string"
},
"dropdownProps": {"options": ["string"
],
"value": "string",
"required": true
},
"dateProps": {"value": "string",
"required": true
}
}
],
"guestName": "string",
"host": true
}
],
"observers": [{"email": "string",
"completed": true
}
],
"reviewers": [{"email": "string",
"completed": true
}
],
"participantsOrder": ["string"
],
"documents": [{"id": "string",
"encryptedFile": "string",
"encryptedFilename": "string",
"iv": "string"
}
]
}

withdrawSigningProcess

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

rotatePassphrase

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

salt	string
	Array of objects (UpdateDocumentRequest)
	Array of objects (UpdateCekRequest)
version	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"salt": "string",
"documents": [{"documentId": "string",
"encryptedFile": "string",
"encryptedFilename": "string",
"iv": "string",
"pdfHash": "string"
}
],
"ceks": [{"id": "string",
"encryptedCek": "string"
}
],
"version": 0
}

rejectReview

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

approveReview

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

resendParticipantInvitation

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

declineParticipation

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

updateCeks

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

Array

id required	string
encryptedCek required	string

Responses

Request samples

Payload

Content type

application/json

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

getSelfCek

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

updateSelfCek

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

encryptedCek required	string
required	object (PublicKey)

Responses

Request samples

Payload

Content type

application/json

{"encryptedCek": "string",
"receiverPublicKey": {"kty": "string",
"n": "string",
"e": "string",
"alg": "string",
"use": "string",
"kid": "string"
}
}

getPendingCeks

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

listCekPublicKeys

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

signing-process-template-controller

getTemplate

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

updateTemplate

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

name required	string
desc	string
message	string
signatureLevel	string Enum: "SES" "AES" "QES"
signingMode	string Enum: "PARALLEL" "SEQUENTIAL"
required	Array of objects (Signer)
	Array of objects (Observer)
required	Array of objects (SigningDocument)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"desc": "string",
"message": "string",
"signatureLevel": "SES",
"signingMode": "PARALLEL",
"signers": [{"id": "string",
"email": "string",
"completed": true,
"formFields": [{"documentId": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"page": 0,
"type": "CHECK",
"readOnly": true,
"textProps": {"value": "string",
"fontSize": 0,
"fontFamily": "string",
"textAlign": "left",
"multiline": true,
"required": true,
"color": "string",
"bold": true,
"italic": true,
"underline": true
},
"checkProps": {"state": "UNCHECKED",
"required": true,
"color": "string"
},
"signatureProps": {"required": true,
"placeHolder": "string"
},
"dropdownProps": {"options": ["string"
],
"value": "string",
"required": true
},
"dateProps": {"value": "string",
"required": true
}
}
],
"guestName": "string",
"host": true
}
],
"observers": [{"email": "string",
"completed": true
}
],
"documents": [{"id": "string",
"encryptedFile": "string",
"encryptedFilename": "string",
"iv": "string"
}
]
}

deleteTemplate_1

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

listTemplates

Authorizations:

bearerAuth

Responses

createTemplate_1

Authorizations:

bearerAuth

Request Body schema: application/json

name required	string
desc	string
message	string
signatureLevel	string Enum: "SES" "AES" "QES"
signingMode	string Enum: "PARALLEL" "SEQUENTIAL"
required	Array of objects (Signer)
	Array of objects (Observer)
required	Array of objects (SigningDocument)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"desc": "string",
"message": "string",
"signatureLevel": "SES",
"signingMode": "PARALLEL",
"signers": [{"id": "string",
"email": "string",
"completed": true,
"formFields": [{"documentId": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"page": 0,
"type": "CHECK",
"readOnly": true,
"textProps": {"value": "string",
"fontSize": 0,
"fontFamily": "string",
"textAlign": "left",
"multiline": true,
"required": true,
"color": "string",
"bold": true,
"italic": true,
"underline": true
},
"checkProps": {"state": "UNCHECKED",
"required": true,
"color": "string"
},
"signatureProps": {"required": true,
"placeHolder": "string"
},
"dropdownProps": {"options": ["string"
],
"value": "string",
"required": true
},
"dateProps": {"value": "string",
"required": true
}
}
],
"guestName": "string",
"host": true
}
],
"observers": [{"email": "string",
"completed": true
}
],
"documents": [{"id": "string",
"encryptedFile": "string",
"encryptedFilename": "string",
"iv": "string"
}
]
}

signature-management-controller

setDefaultSignature

Authorizations:

bearerAuth

path Parameters

signatureId

required

string

Responses

getSignatures

Authorizations:

bearerAuth

Responses

addSignature

Authorizations:

bearerAuth

Request Body schema: application/json

base64

required

string

Responses

Request samples

Payload

Content type

application/json

{"base64": "string"
}

getDefaultSignature

Authorizations:

bearerAuth

Responses

deleteSignature

Authorizations:

bearerAuth

path Parameters

signatureId

required

string

Responses

profile-controller

getProfile

Authorizations:

bearerAuth

Responses

updateProfile

Authorizations:

bearerAuth

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

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

deleteAccount

Authorizations:

bearerAuth

Responses

getUserKeys

Authorizations:

bearerAuth

Responses

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"
}

startCheckout

Authorizations:

bearerAuth

query Parameters

lookupKey	string
StripePriceId	string
successUrl	string
cancelUrl	string

Responses

listApiKeys

Authorizations:

bearerAuth

Responses

createApiKey

Authorizations:

bearerAuth

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

getPublicProfileByEmail

Authorizations:

bearerAuth

query Parameters

email

required

string

Responses

deleteApiKey

Authorizations:

bearerAuth

path Parameters

apiKeyId

required

string

Responses

test-data-cleanup-controller

clearTestData

Authorizations:

bearerAuth

Responses

stripe-webhook-controller

handle

Authorizations:

bearerAuth

header Parameters

Stripe-Signature

required

string

Request Body schema: application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

signcard-template-controller

getTemplates

Authorizations:

bearerAuth

Responses

createTemplate

Authorizations:

bearerAuth

Request Body schema: application/json

id	string
userId	string
image	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"userId": "string",
"image": "string"
}

getTemplateById

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

deleteTemplate

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

signing-controller

uploadSignedDocuments

Authorizations:

bearerAuth

path Parameters

processId

required

string

Request Body schema: application/json

required	Array of objects (UpdateDocumentRequest)
version required	integer <int64>
signerId	string

Responses

Request samples

Payload

Content type

application/json

{"documents": [{"documentId": "string",
"encryptedFile": "string",
"encryptedFilename": "string",
"iv": "string",
"pdfHash": "string"
}
],
"version": 0,
"signerId": "string"
}

sign

Authorizations:

bearerAuth

path Parameters

processId

required

string

Request Body schema: application/json

required

Array of objects (DocumentHash)

Responses

Request samples

Payload

Content type

application/json

{"documentHashes": [{"documentId": "string",
"pdfHash": "string"
}
]
}

submitOtp

Authorizations:

bearerAuth

Request Body schema: application/json

processId	string
otpCode	string

Responses

Request samples

Payload

Content type

application/json

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

signHash

Authorizations:

bearerAuth

Request Body schema: application/json

pdfHash	string
signatureLevel	string Enum: "SES" "AES" "QES"

Responses

Request samples

Payload

Content type

application/json

{"pdfHash": "string",
"signatureLevel": "SES"
}

getSigningStatus

Authorizations:

bearerAuth

path Parameters

processId

required

string

Responses

signature-card-controller

list

Authorizations:

bearerAuth

Responses

create

Authorizations:

bearerAuth

Request Body schema: application/json

id	string
userId	string
name	string
image	string
text1	string
text2	string
showDate	boolean
signatureStandard	boolean
isDefault	boolean
claimLabel	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"userId": "string",
"name": "string",
"image": "string",
"text1": "string",
"text2": "string",
"showDate": true,
"signatureStandard": true,
"isDefault": true,
"claimLabel": true
}

setDefault

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

get

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

delete

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

getDefault

Authorizations:

bearerAuth

Responses

membership-controller

getAllMemberships

Authorizations:

bearerAuth

Responses

createMembership

Authorizations:

bearerAuth

Request Body schema: application/json

inviteeUserId	string
inviteeEmail	string
admin	boolean

Responses

Request samples

Payload

Content type

application/json

{"inviteeUserId": "string",
"inviteeEmail": "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
}