Actions8
- People Actions
- Person Identity Document Actions
Overview
The node interacts with a "Person Identity Document" resource in the Pulse API, specifically supporting an operation to update an existing identity document. This operation allows users to modify details of an identity document such as its type, number, issue place, and relevant dates.
This node is beneficial in scenarios where identity documents need to be kept current within a system, for example:
- Updating a passport's expiration date after renewal.
- Correcting or adding missing information like the issue place or document number.
- Changing the type of identity document if it was initially recorded incorrectly.
Practical example: A user can automate updating identity document records in their database when new information is received from clients or external verification services.
Properties
| Name | Meaning |
|---|---|
| Identity Document ID * | The unique identifier of the identity document to retrieve or update (required). |
| Update Fields | Collection of fields to update in the identity document, including: |
| - Identity Document Type | The type of the identity document (e.g., passport, driver_license, national_id, etc.). |
| - Identity Document Number | The serial number of the identity document. |
| - Issue Place | The place where the identity document was issued. |
| - Issue Date | The issue date of the identity document. |
| - Expiration Date | The expiration date of the identity document. |
Output
The output is a JSON object representing the updated identity document as returned by the Pulse API. It contains the latest state of the identity document after applying the updates.
If the node encounters an error during execution and is configured to continue on failure, the output will include a JSON object with an error field describing the issue.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Pulse API.
- The node depends on the Pulse API service being available and accessible.
- Proper configuration of the API authentication credentials in n8n is necessary.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Identity Document ID will result in errors indicating the document could not be found.
- Missing required fields or incorrect data formats (e.g., invalid date format) may cause the API to reject the update.
- Network or authentication failures will prevent successful communication with the Pulse API.
Error messages and resolutions:
"The operation "updateIdentityDocument" is not supported for resource "identityDocument"!": Indicates a misconfiguration of the operation or resource; verify that the correct operation and resource are selected.- Errors related to authentication usually mean the API key credential is missing, expired, or invalid; reconfigure the credential.
- Validation errors from the API typically specify which field is problematic; ensure all input fields conform to expected formats and constraints.
Links and References
- Pulse API Documentation (hypothetical link)
- n8n documentation on creating custom nodes
- General best practices for managing identity documents in automated workflows