Actions8
- People Actions
- Person Identity Document Actions
Overview
This node interacts with the "Person Identity Document" resource of the Pulse API, specifically supporting the operation to retrieve a list of identity documents. It is useful for scenarios where you need to fetch multiple identity documents associated with people, optionally including related resources or applying filters and pagination.
Practical examples include:
- Retrieving all identity documents for auditing or compliance purposes.
- Fetching identity documents filtered by organization or other criteria.
- Including related person data alongside identity documents in one request.
Properties
| Name | Meaning |
|---|---|
| Include Related Resources | Select related resources to include in the response. Options: Person (includes related person data). |
| Additional Fields | Collection of optional fields to customize the request: |
| - Sort | String specifying the sort order of the results. |
| - Page Number | Number indicating which page of results to retrieve (pagination). |
| - Page Size | Number indicating how many results per page (pagination). |
| - Filters | One or more filters to apply to the request. Each filter has: |
| - Filter Key: The field to filter on (e.g., organization_id). | |
| - Values: Comma-separated values to filter by (e.g., 1,2,3). | |
| - Fields | Specify which fields to include in the response. Each field entry has: |
| - Field Key: The key identifying the field group (e.g., iam/organizations/people_directories). | |
| - Fields: Comma-separated list of field names to include (e.g., id,name). |
Output
The output JSON contains the list of identity documents retrieved from the Pulse API according to the specified parameters. This typically includes document details such as IDs, types, issuing authorities, and possibly related person information if requested.
If related resources are included, their data will be nested within the output accordingly.
The node does not output binary data.
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.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect filter keys or values may result in empty responses or errors.
- Requesting unsupported fields or related resources might lead to errors.
- Pagination parameters out of range could return no data.
Error messages:
"The operation "getIdentityDocumentList" is not supported for resource "identityDocument"!"indicates a mismatch between selected operation and resource.- Network or API errors will propagate as error messages; ensure network connectivity and valid API endpoint.
- If the node throws errors about invalid parameters, verify that filters, fields, and pagination inputs conform to expected formats.
To resolve errors, check API credentials, validate input parameters, and consult the Pulse API documentation for correct usage.
Links and References
- Pulse API official documentation (for detailed API endpoints and parameters)
- n8n documentation on creating and using custom nodes
- General REST API best practices for filtering, pagination, and sorting