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 Data, Start a Workflow and Reconfirm a Workflow accept, and that Read a Workflow echoes back.
Sessions and Workflows shows a worked term array being staged.
| Page | What it covers |
|---|---|
| Build a Loan Step by Step | Start here. A loan built one term at a time, with the fields each step introduces. |
| 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. Also correlation ids on terms, and what is validated. |
| Value Vocabularies | The documented values for every field that reads like an enumeration, such as participantType, propertyPurpose and loanPurpose. |
| Term Examples | Worked term arrays, including how to express two people and how the branch keys fit together. |
| Glossary | The mortgage and SAMI terms these pages use, and the field each one maps to. |
| Known Issues | Current defects in how a staged loan is recorded, and what to send instead. |
The pages here describe the common fields and their values, not the full catalog. Ask your Pitchpoint Account Representative for it if you need every field a branch accepts.