Beta
Workflow API
A workflow is one run of a product against your data. Start one and you get a workflowId back straight away, while the product runs in the background. Read the workflow to follow its state, or trigger a reconfirm to run it again under the same handle. Once the application behind a workflow reaches an outcome, an approved integration system can report it. A product set up for outcome-based billing uses the reported outcomes to bill only for the results your agreement covers, such as loans that fund.
You can start a workflow with your data supplied inline, or against a session that already holds it.
Sessions and Workflows covers starting a workflow, learning when the result is ready, and reading it.
Browse every operation, its schemas and code samples in the API Explorer, or download the OpenAPI specification for your own tools.
Every path below is relative to the base URL:
https://api.pointservices.com/riskinsight-services-ws/resources
| Operation | Method and path | Reference |
|---|---|---|
| Start a Workflow | POST /v1/workflows | Start a Workflow |
| Read a Workflow | GET /v1/workflows/{workflowId} | Read a Workflow |
| Reconfirm a Workflow | POST /v1/workflows/{workflowId} | Reconfirm a Workflow |
| Edit a Workflow | POST /v1/workflows/{workflowId}/edit | Edit a Workflow |
| Find Workflows | GET /v1/workflows | Find Workflows |
A reconfirm keeps the same workflowId and issues a new runId. It is billed as its own workflow.
To learn when a result is ready without polling, register a webhook endpoint — see Webhooks.