Overview
This node integrates with the Scanify API to send Brazilian document files for data extraction. It is designed to upload binary document data, specify the type of document, and provide additional metadata and callback information. The node is useful in scenarios where automated extraction of structured data from scanned or photographed Brazilian documents is needed, such as identity verification, document processing workflows, or compliance checks.
Practical examples include:
- Uploading a scanned CPF or RG document to extract personal identification data.
- Sending invoices or receipts for automatic data capture.
- Providing a callback URL to receive asynchronous processing results.
Properties
| Name | Meaning |
|---|---|
| Binary Property (Arquivo) | The name of the binary property containing the file data to be sent for extraction. |
| Document Type | The type of the document being uploaded (e.g., CPF, RG, invoice). |
| Callback URL | A URL where Scanify will send the extraction results asynchronously once processing completes. |
| Reference ID | An optional identifier to associate with the request for tracking purposes. |
| Metadata (JSON) | Optional additional metadata in JSON format to send along with the document. |
Output
The node outputs an array of JSON objects, each representing the response from the Scanify API for the corresponding input item. The JSON contains the extracted data returned by the API.
No binary output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Scanify API.
- Makes HTTP POST requests to
https://api.scanify.com.br/extract. - Uses multipart/form-data encoding to upload files.
- Requires the binary data to be present in the specified binary property of the input items.
Troubleshooting
- No binary data found error: If the specified binary property does not exist or contains no data, the node throws an error indicating the missing binary field. Ensure the binary property name matches the actual binary data field.
- Invalid Metadata JSON: If the metadata field is not valid JSON, the node throws an error. Verify that the metadata input is correctly formatted JSON.
- HTTP request errors: Network issues or invalid API keys can cause request failures. Check the API key validity and network connectivity.
- Callback URL issues: Ensure the callback URL is reachable and correctly configured to handle incoming requests from Scanify.
Links and References
- Scanify API Documentation (example link, verify actual URL)
- n8n documentation on working with binary data
- n8n documentation on HTTP Request node (for understanding underlying HTTP calls)