Autentique icon

Autentique

Trabalhe com dados da API do Autentique para assinaturas digitais

Actions19

Overview

The node integrates with the Autentique API to search for documents using advanced filters. It allows users to query documents by name, status, folder, and supports pagination and sorting options. This is useful in scenarios where you need to programmatically retrieve a list of documents matching specific criteria, such as finding all signed contracts in a particular folder or fetching pending documents for review.

Practical examples:

  • Retrieve the first 50 signed documents created recently.
  • Search for documents containing "Service Agreement" in their name that are still pending signature.
  • List expired documents within a specific folder for archival purposes.

Properties

Name Meaning
Limit Max number of results to return (minimum 1).
Page Page number of the results (starting at 1).
Search Term Text term to search within the document names.
Document Status Filter documents by status. Options: All, Draft, Expired, Pending, Rejected, Signed.
Search Folder ID Optional folder ID to filter documents within a specific folder.
Order By Field to order results by. Options: Created At, Updated At, Name.
Order Direction Direction of ordering. Options: Descending, Ascending.

Output

The output JSON contains a paginated list of documents matching the search criteria. Each document includes:

  • id: Unique identifier of the document.
  • name: Document name.
  • refusable: Boolean indicating if the document can be refused.
  • sortable: Boolean indicating if signatures must follow a specific order.
  • created_at: Timestamp of document creation.
  • updated_at: Timestamp of last update.
  • status: Current status of the document (e.g., draft, signed).
  • signatures: Array of signature objects, each with:
    • public_id: Signature unique ID.
    • name: Signatory's name.
    • email: Signatory's email.
    • created_at: Signature creation timestamp.
    • action: Object describing the action type (e.g., sign, approve).
    • user: User details who signed (id, name, email).
  • folder: Object with folder id and name where the document is stored.

Additionally, pagination metadata is included:

  • total: Total number of matching documents.
  • per_page: Number of documents per page.
  • current_page: Current page number.
  • last_page: Last available page number.

No binary data is returned by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Autentique API.
  • The node uses the Autentique GraphQL endpoint at https://api.autentique.com.br/v2.
  • No additional external dependencies beyond standard HTTP requests.

Troubleshooting

  • Empty Results: If no documents are returned, verify that the search parameters (term, status, folder) are correct and that documents exist matching those filters.
  • Invalid Folder ID: Using an incorrect or non-existent folder ID will result in no matches; ensure folder IDs are valid.
  • API Authentication Errors: Ensure the API key credential is correctly configured and has necessary permissions.
  • Pagination Issues: Requesting a page number beyond the last page will return empty data; check the last_page value in responses.
  • Rate Limits: Excessive requests may trigger API rate limits; implement retries or backoff as needed.

Links and References

Discussion