API REFERENCE
Beta
SAMI v2 Terms
SAMI is PitchPoint’s own format for describing a loan. You send it as an array of terms, where each term is an object carrying exactly one branch key — a person, a property, the loan’s headline terms, and so on.
This is not an API of its own. It is the shape of the terms array that Stage a Loan and Start a Workflow accept, and that Read a Workflow echoes back.
Sessions and Workflows shows a worked term array being staged.
| Page | What it covers |
|---|---|
| Conventions | The four conventions that trap most first integrations: key casing, flat arrays, numbers and dates as strings, and free-text fields that look like enums. |
| Term Examples | Worked term arrays, including how to express two people and how the branch keys fit together. |
Field-level descriptions are not published here. Ask your Pitchpoint Account Representative for the term catalog if you need the full list for a branch key.