Pulse People icon

Pulse People

People resource from Pulse API

Actions8

Overview

The "Create Person Document" operation in the "Person Document" resource allows users to create and attach a document record to a specific person within the Pulse system. This node is useful for managing various types of personal documents such as ID cards, passports, driving licenses, resumes, and other official or personal documents related to individuals.

Typical use cases include:

  • Automating the upload and registration of identity documents for employees or clients.
  • Keeping track of expiration dates for important documents like passports or health insurance cards.
  • Storing URLs or references to digital copies of documents.
  • Organizing and categorizing documents by type for easy retrieval and compliance.

For example, an HR automation workflow could use this node to add a scanned copy of a new employee’s passport and driving license to their profile automatically after onboarding.

Properties

Name Meaning
Person ID * The unique numeric identifier of the person for whom the document is being created.
Document Type * The category/type of the document. Options: ID Card, Duplicata, Passport, Driving License, ID CNaPs (health insurance), Resume, Others.
URL A string containing the URL where the document can be accessed or downloaded.
Name The name or title of the document.
Issued Place The location where the document was issued. Applicable for most document types except Resume.
Issued Date The date when the document was issued. Applicable for most document types except Resume.
Expiration Date The date when the document expires. Applicable for most document types except Resume.

*Fields marked with * are required.

Output

The node outputs a JSON object representing the newly created person document record. This typically includes all the properties sent during creation along with any additional metadata or identifiers assigned by the backend system.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Pulse API via an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities to perform authenticated requests.
  • Proper permissions on the Pulse API side to create person documents are necessary.

Troubleshooting

  • Common Issues:

    • Missing required fields such as Person ID or Document Type will cause errors.
    • Invalid date formats for issuedDate or expirationDate may lead to request failures.
    • Insufficient API permissions or invalid API credentials will result in authentication errors.
    • Providing a Person ID that does not exist in the system will cause a "not found" error.

  • Error Messages:

    • "The operation "createPersonDocument" is not supported for resource "personDocument"!" — indicates a misconfiguration of the operation parameter.
    • "The resource "personDocument" is not supported!" — indicates an invalid resource selection.
    • API response errors related to validation or authorization will be passed through; check the message for details.

  • Resolution Tips:

    • Ensure all required fields are provided and correctly formatted.
    • Verify API credentials and permissions.
    • Confirm the Person ID exists before attempting to create a document.
    • Use the "Continue On Fail" option in n8n to handle errors gracefully in workflows.

Links and References

Discussion