DeepIDV icon

DeepIDV

DeepIDV session management operations

Actions2

Overview

This node integrates with the DeepIDV service to manage identity verification sessions. It supports operations such as inviting a user to a verification session and listing existing sessions within an organization.

A common use case is automating the process of sending identity verification invitations to users by providing their contact details, or retrieving a list of verification sessions for monitoring or reporting purposes.

For example, you can use this node to invite a new user to verify their identity by supplying their name, email, phone number, and other details. Alternatively, you can fetch a paginated list of all verification sessions associated with your organization.

Properties

Name Meaning
Organization ID The unique identifier of the organization under which the session is managed.
First Name The first name of the person to be invited to the verification session.
Last Name The last name of the person to be invited.
Email The email address of the invitee.
Phone The phone number of the invitee.
Sender User ID The identifier of the user sending the invitation.
Send Invite? Boolean flag indicating whether to send the actual invite notification (true) or just create the session (false).

Note: The above properties are relevant specifically for the "Invite Session" operation.

Output

The node outputs JSON data representing the response from the DeepIDV API:

  • For the "Invite Session" operation, the output JSON contains details about the created invitation/session.
  • If the response is an array, each element is output as a separate item.
  • The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating requests to the DeepIDV API.
  • The node makes HTTP requests to DeepIDV endpoints:
    • POST https://henzev2hp9.execute-api.us-east-1.amazonaws.com/dev/v1/verification/sessionInvite for inviting sessions.
    • GET https://henzev2hp9.execute-api.us-east-1.amazonaws.com/dev/v1/verification/session/list for listing sessions.

Ensure that the API key is configured properly in the node credentials before execution.

Troubleshooting

  • Missing API Key: The node will throw an error if the API key credential is not set. Make sure to provide a valid API key.
  • Unsupported Operation: If an unsupported operation value is provided, the node throws an error indicating the operation is not supported.
  • API Request Failures: Network issues or invalid parameters may cause the API request to fail. Check the input parameters and network connectivity.
  • Invalid Input Data: Required fields like organization ID, email, or phone must be provided; missing these will likely cause errors from the API.

Links and References

Discussion