Pulse People icon

Pulse People

People resource from Pulse API

Overview

This node interacts with a People management API, specifically handling operations related to people and their identity documents. For the Person Identity Document resource, the Create Identity Document operation allows users to create a new identity document record for a specified person. This is useful in scenarios where you need to store or update official identification details such as passports, driver licenses, or national IDs within an automated workflow.

Practical examples include:

  • Automatically adding identity documents when onboarding new employees.
  • Keeping digital records of customer identity documents for compliance.
  • Integrating identity verification steps into business processes.

Properties

Name Meaning
Person ID * The unique identifier of the person for whom the identity document will be created.
Identity Document Type * The type/category of the identity document (e.g., passport, driver_license, national_id).
Identity Document Number * The serial or registration number of the identity document.
Issue Place * The location where the identity document was issued.
Issue Date * The date when the identity document was issued.
Expiration Date * The date when the identity document expires.

(* indicates required fields)

Output

The node outputs a JSON object representing the newly created identity document. This JSON typically includes all the input properties along with any additional metadata or identifiers assigned by the API upon creation.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to the external People management API via an API key or authentication token configured in n8n credentials.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase to perform API requests.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials can cause authentication failures.
    • Providing incomplete or incorrectly formatted input properties (e.g., missing required fields or invalid dates) may result in API errors.
    • Network connectivity problems can prevent communication with the external API.
  • Error messages:

    • "The operation "createIdentityDocument" is not supported for resource "identityDocument"!" — This indicates a mismatch between selected operation and resource; ensure correct selections.
    • API error responses usually contain descriptive messages about validation failures or permission issues; review these messages to adjust inputs or credentials.
  • Resolution tips:

    • Double-check that all required fields are provided and correctly formatted.
    • Verify that the API credentials are valid and have sufficient permissions.
    • Use the node’s “Continue On Fail” option to handle errors gracefully during batch processing.

Links and References

Discussion