API Reference
VSP Open API Workflow
Get Access to VIDA Sign Platform and Generate API Keys The client requests access to the VIDA Sign platform and generates API keys needed to interact with the platform’s API securely.
Authentication: Begin by obtaining an access token through the Authentication API. This token will be used for secure access to the VSP Open API.
Document Upload (for Multiple Documents):
For transactions involving multiple documents, use the Upload Document API to upload each document individually. This generates unique
document_idsfor each document.These
document_idscan then be added to an envelope in the next step.
If only a single document is required, this step can be skipped, and the document can be added directly during envelope creation.
Envelope Creation:
Multiple Documents: Use the Create Envelope API to group the uploaded
document_idsinto a single envelope, preparing them for signing by one or more recipients.Single Document: If only a single document is involved, it can be directly added during the envelope creation process, bypassing the document upload step.
Envelope Distribution: VIDA handles the secure distribution of the envelope via email or URL, ensuring that recipients can easily access and sign the documents.
Signer Authentication:
If the signer’s identity has not been verified, they will undergo a KYC (Know Your Customer) verification process. Use the KYC Verification API to perform this step.
Once verified (or if already verified), the signer proceeds to review the document(s) for signing.
Document Signing:
The signer reviews the document(s) in the provided preview interface. VIDA handles the UI for the signature style and placement.
The signer then authenticates using either an SMS OTP or biometric verification.
Tracking and Document Retrieval:
After the document is signed, track the status of the signing process.
Once completed, use the Download Signed Document API to retrieve the signed document(s).
Last updated