Actions8
Overview
The node provides integration with a "People" resource API, specifically allowing management of person documents. The Update Person Document operation updates details of an existing document associated with a person. This is useful in scenarios where document information changes over time, such as updating expiration dates, correcting names, or changing document types.
Practical examples include:
- Updating a passport's expiration date after renewal.
- Changing the name or URL of a scanned ID card.
- Modifying issued place or document type if initially entered incorrectly.
Properties
| Name | Meaning |
|---|---|
| Person Document ID * | The unique identifier of the person document to update. Required for identifying the target document. |
| Update Fields | A collection of fields that can be updated on the person document: |
| - Document Type | The type/category of the document. Options: ID Card, Duplicata, Passport, Driving License, ID CNaPs (health insurance), Resume, Others. |
| - URL | The web address or link to the document file. |
| - Name | The name/title of the document. |
| - Issued Place | The location where the document was issued. |
| - Issued Date | The date when the document was issued. |
| - Expiration Date | The expiry date of the document. |
Output
The output is a JSON object representing the updated person document. It contains the latest state of the document after applying the requested updates. The exact structure depends on the API response but typically includes fields like document ID, type, name, URLs, issue and expiration dates, and issued place.
No binary data output is indicated for this operation.
Dependencies
- Requires connection to the external Pulse API service.
- Needs an API authentication credential configured in n8n to authorize requests.
- The node uses a helper factory to interact with the Pulse API endpoints.
Troubleshooting
Common issues:
- Invalid or missing Person Document ID will cause the update to fail.
- Providing invalid field values (e.g., wrong date format) may result in API errors.
- Network or authentication failures can prevent successful API calls.
Error messages:
"The operation "updatePersonDocument" is not supported for resource "personDocument"!"indicates a misconfiguration of operation or resource parameters.- Errors returned from the API usually contain descriptive messages; ensure all required fields are correctly set.
Resolutions:
- Verify the Person Document ID exists and is correct.
- Check that all date fields use valid ISO date-time formats.
- Confirm API credentials are valid and have necessary permissions.
- Use the node’s "Continue On Fail" option to handle partial failures gracefully.
Links and References
- Pulse API Documentation (replace with actual URL)
- n8n documentation on Creating Custom Nodes
- General best practices for managing document metadata in APIs