If an Entity has been sent a document to sign (an 'eSign' document), the details can be retrieved via the GET /api/v2/ci/entities/{entityId}/esign-documents/{eSignDocumentId}.
This will return the document details along with the signature information:
{
"id": 0,
"name": "string",
"dateCreated": "2024-03-15T12:58:30.898Z",
"dateCompleted": "2024-03-15T12:58:30.898Z",
"requiredSignatureCount": 0,
"pendingSignatureCount": 0,
"signedSignatureCount": 0,
"status": 1,
"signatures": [
{
"id": 0,
"order": 0,
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signatureTag": "string",
"signatoryName": "string",
"signatoryEmail": "string",
"signatoryPhoneNumber": "string",
"requiredToSign": true,
"name": "string",
"ipAddress": "string",
"userAgent": "string",
"signedDate": "2024-03-15T12:58:30.898Z",
"signed": true
}
]
}
Downloading the signed document
Use the GET /api/v2/ci/entities/{entityId}/esign-documents/{eSignDocumentId}/pdf endpoint to retrieve the signed PDF document.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article
Join our live training sessions
Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including: - AML / ID verification - Right to Work - Our brand-new Credas Lettings solution - Admin / advanced training In each session we will walk you through how platform works and answer any questions you may have.
See our full training schedule