Actions8
- People Actions
- Person Identity Document Actions
Overview
This node interacts with the "Person Identity Document" resource from the Pulse API, specifically supporting operations to retrieve detailed information about identity documents. The "Show Identity Document details info" operation fetches comprehensive data for a specified identity document by its ID. This is useful in scenarios where you need to verify or display official identity document details associated with a person, such as in HR systems, compliance checks, or customer onboarding processes.
For example, you might use this node to:
- Retrieve and display passport or driver's license details linked to a person.
- Include related person information alongside the identity document data for richer context.
- Automate verification workflows by fetching identity document metadata programmatically.
Properties
| Name | Meaning |
|---|---|
| Include Related Resources | Select related resources to include in the response. Currently supports: Person |
| Identity Document ID * | The unique identifier of the identity document to retrieve details for (required) |
- Include Related Resources: Allows including additional linked data in the response, such as the person associated with the identity document.
- Identity Document ID*: Specifies which identity document's details to fetch.
Output
The node outputs a JSON object containing the detailed information of the requested identity document. If the "Include Related Resources" property includes "Person," the output will also contain related person data embedded within the response.
The structure typically includes fields representing identity document attributes such as type, number, issuing country, expiration date, and possibly metadata about the associated person.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Pulse API.
- The node depends on the Pulse API service being accessible and properly configured within n8n.
- No additional external dependencies are required beyond the API access.
Troubleshooting
Common Issues:
- Providing an invalid or empty Identity Document ID will result in errors or empty responses.
- Network or authentication failures with the Pulse API can cause request errors.
- Selecting unsupported related resources in "Include Related Resources" may be ignored or cause unexpected results.
Error Messages:
"The operation "getIdentityDocumentById" is not supported for resource "identityDocument"!": Indicates a mismatch or typo in operation/resource selection.- API errors returned from Pulse API (e.g., 404 Not Found if the ID does not exist).
Resolutions:
- Ensure the Identity Document ID is correct and exists in the system.
- Verify that the API key credential is valid and has necessary permissions.
- Confirm network connectivity and Pulse API availability.
- Use only supported related resources in the "Include Related Resources" option.
Links and References
- Pulse API Documentation (hypothetical link)
- n8n documentation on creating custom nodes
- General info on identity documents and their typical fields for reference