Generate insights

post

https://{baseUrl}/insights

This endpoint generates insights based on the provided workflow and identity details. It requires the user to have access to the workflow associated with the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Relevant Information

  USER.CUSTOMER_ID

USER.WORKFLOWS

Body Params

workflowId

string

required

The unique identifier for the workflow

requestId

string

required

Client provided unique identifier for the request

caseStrategy

string

enum

If the Case Management module is enabled, this will be the strategy used for creating a new case. "merge" will find an open case with shared PII and automatically add the verification to it. If there is no open case, a new case will be created. "relate" will automatically create a new case and relate any existing cases with shared PII. This is an optional key, and if not provided, the "merge" strategy will be used.

Allowed:

identity

object

required

The customer inputs to be verified by the workflow

payment

object

Payment information for application fee. Only included when payment is required and collected via Square SDK.

signature

object

Signature information captured during Apply submission. Only included when signature capture is enabled.

Headers

x-api-version

string

enum

API version (e.g., 1.0). Defaults to 0.9 if not provided

Allowed:

Responses

201

401