Electronic Signature Validator

Product: Electronic Signature

The Electronic Signature validation API provides a link for performing an electronic signature on a document created in ZapSign online.

We have 2 types of integrations available for this validator:

  • You can use it in your DI Web or WhatsApp flows.
  • You can integrate it via API.

DI Web or WhatsApp flows:

  • It’s necessary for you to set up the Zapsign integration in your Truora account. This procedure can be done through the Truora platform or via API.
  • You must create a Web or WhatsApp DI flow.

Create Zapsign and Truora Integration

Creates a new integration between Truora and Zapsing for your account.

Note: Follow this step only if you want to include the electronic signature validator in your Web or WhatsApp DI flow and it only needs to be done once. Remember that the integration process between Zapsign and Truora is done only once per account.

To do it via API, you must follow these steps:

  1. Create a POST request to the endpoint api.account.truora.com/v1/integrations.
  2. Set the following key : values within the request body and x-www-form-urlencoded format:
    • integration_type: Represents how the services are going to be used. For example: zapsign.
    • config.token: Represents Zapsign API Key get ZapSign api key.
Response 201 

{
    "integration": {
        "customer_integration_id:" "CINxxxxxxxxxx",
        "integration_type": "zapsign",
        "config": {},
        "status": "pending"
    }
}
  1. Please make a GET request to the endpoint api.account.truora.com/v1/integrations/{{customer_integration_id}}. It is important to validate that the status has been set to enabled.
Response 200 

{
    "customer_integration_id": "CINxxxxxxxxxx",
    "integration_type": "zapsign",
    "config": {},
    "status": "enabled"
}

API integration

Create Validation

This request generate the link to sign the document

To do it you must follow these steps:

  1. Create a POST request to the endpoint api.validations.truora.com/v1/validations.

  2. Set the following key : values within the request body and x-www-form-urlencoded format:

    • type: [Required] Validation type. Allowed: electronic-signature.
    • user_authorized: [Required] Indicates whether the validation subject consents to be validated. Must be true for the validation to proceed.
    • zapsign_document_type: template or document.
    • zapsign_id: [Required] ID of the document/template created in ZapSign. You can find this ID in the URL of your browser when you create a document or template in ZapSign.
    sample image
    • name: [Required] Name of the person assigned as signer of the document created in ZapSign.
    • account_id: ID of the account registered to this validation. If not provided a default value is generated in our API *.
    • var.NAME: Name of the variable in the Zapsign template and its value.
    • face_validation_id: ID of the Face Recognition. The validation_status must be success *.
    • document_validation_id: ID of the document validation. The validation_status must be success *.
  • You must use the same account ID of the document and face recognition to ensure that they are linked properly. This will ensure that the validation process runs smoothly and that the results are accurate.

Note: In case you require the used inputs of document + face recognition, you must also send the validation identifiers in the face_validation_id and document_validation_id inputs. Keep in mind that the validation_status of those validations must be success in order to use this new functionality.

Response 200 

{
    "validation id": "VLDbae796f8ba2£83c658b3XXXXXXX",
    "ip_address": "190.000.000.000",
    "account_id": "ACC1234567890asdfXXXXXX",
    "type": "electronic-signature",
    "validation_status": "pending",
    "creation date": "2022-10-19T20:42:23.379184377Z",
    "instructions": {
        "signer_link": "https://app.zapsign.com.br/verificar/a0ca48c0-c807-4d59-841d-XXXXXXXXXX"
    }
}

Get Validation Result

Validation result can be obtained by polling.

To do it you must follow these steps:

  • Create a GET request to the endpoint api.validations.truora.com/v1/validations/{{validation_id}}.

Note: Use the provided validation_id from the Validation Creation step. If you wish to inquire about all integrations associated with the account, simply make a GET request to the respective endpoint without sending the validation_id.

Note: The response with 200 http status will give us an additional item called details, where you can access the URLs of the original document, signed document and signature image.

Response 200 

{
    "validation_id": "VLDbae796f8ba2£8£3c658b34XXXXXXXXX",
    "ip_address": "190.000.000.000",
    "account id": "ACC1234567890asdfXXXXXX",
    "type": "electronic-signature",
    "validation status": "success",
    "creation_date": "2022-10-19T20:42:23.379184377Z"
    "details": {
        "electronic_signature_details": {
            "original_document_url": "https://zapsign.s3.amazonaws.com/2023/5/pdf/28adcf6c-dac8-4bb2-a3f4-d5a9fb36fe77/a5a56e54-7ce7-431f-8e19-8a33bxxxxxx.pdf",
            "signed_document_url": "https://zapsign.s3.amazonaws.com/2023/5/pdf/3067e4fd-d2b6-497c-a39d-8573b00f30fc/7850ae62-29ff-4f16-9376-25bxxxxxxxx.pdf",
            "signature_image_url": "https://zapsign.s3.amazonaws.com/2023/5/files/4e701f71-3565-4aa1-839d-95fd5a20c690/b03f0159-ca1f-4e17-811c-cbf3dxxxxxxx.png"
        }
    }
}