PointServices Docs
PitchPoint runs compliance products against the data you send us. You start a workflow against that data, PPS tells you when the result is ready, and you read the findings. These guides cover that loop end to end, plus the reference for every API behind it.
Start here
- Sessions and Workflows: the end-to-end path, from staging a loan to reading the result.
- Download Postman Collection: try every API without writing code.
- Obtaining An Access Token: you need one before any call.
The loop
1. Sessions and Workflows
Stage a loan into a session, then start a workflow to run a product against it. Staging is free; starting a workflow is billed. You get back a workflowId straight away, and the product runs in the background.
2. Webhooks
PPS tells you a result is ready by POSTing an event to an HTTPS endpoint you host, so you never poll. Register the endpoint once, verify the signature on what arrives, and act on it. Two topics: workflow.updated and workflow.failed.
3. Findings
Read the findings a workflow produced, filter them by category or severity, and record your review — resolve a finding, add a note, or attach a document.
Other guides
- Orders: place a synchronous order and get the finished report in the response.
- Common Headers: the headers every request carries, and the ones that change how a call behaves.
- Authentication: sign in, refresh a token, and act on behalf of another user.
- Encompass Workflow Rule: configure the workflow rule inside Encompass.
API reference
- Authentication: sign in, refresh, and the token shape.
- Order: submit an order and read the report it returns.
- Session: hold a loan and start workflows against it.
- Workflow: start a workflow, follow it to a result, and trigger a reconfirm.
- SAMI v2 Terms: PitchPoint’s own format for describing a loan.
- Findings: read findings, review them, and manage attachments.
- Webhooks: register endpoints, inspect deliveries, and replay them.