Stage a Loan

API REFERENCE

Beta

Stage a Loan

Records a snapshot of your data into this session. Call it as often as you need to: the newest snapshot is what any workflow you start afterwards will read.

A session holds successive snapshots of your data — one subject, restated, not a collection of separate ones.

Get the URL to submit against from your Pitchpoint Account Representative. The shape of a term is described under SAMI v2 Terms.

Sample
Responses

Sample

url="https://api.pointservices.com/riskinsight-services-ws/resources/v1/sessions/0000000000013500001/sami"
curl -X POST "${url}" \
  -H "Authorization: Bearer your_access_token_here" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "terms": [
      {
        "person": {
          "firstName": "Jane",
          "lastName": "Sample",
          "ssn": "000-00-0000",
          "dob": "01/31/1980"
        }
      },
      {
        "property": {
          "propertyUsage": "PrimaryResidence",
          "propertyType": "Detached",
          "address": {
            "addressLine1": "1 Sample Street",
            "city": "Sampleton",
            "state": "NY",
            "postalCode": "00000"
          }
        }
      },
      {
        "loanTerms": {
          "noteAmount": "450000.00",
          "noteRatePercent": "6.375",
          "loanPurpose": "Purchase",
          "mortgageType": "Conventional"
        }
      }
    ]
  }'

Header Properties

Property	Value	Required?
Authorization	Bearer your token	true
Content-Type	application/json	true
Accept	application/json	false
X-PPS-UserAlias	your value	false
X-PPS-UserAgent	your value	false
X-PPS-CorrelationID	your value	false

Send Content-Type: application/json on every POST, including one with no body at all. In deployed environments a request that arrives without it is refused by edge protection in front of the application, with a 403 carrying an HTML body rather than any response documented here — and because the service never sees the request, nothing can explain it to you. A local or unprotected deployment may accept the same request, so do not take a working call there as evidence the header is optional.

Accept is not enforced — a request without it is answered normally with JSON — but send it anyway, so that a future change to content negotiation cannot alter what you receive.

X-PPS-CorrelationID is a support-tracing header and is not the same thing as the correlationId field in a request body. Only the body field is recorded against an order and searched by Find Workflows; setting the header globally in your HTTP client does not make your orders findable.

See the Common Headers guide for details on the optional X-PPS-* headers above.

Path Parameters

Property	Description	Type
sessionId	(mandatory) The session to stage into.	string

Request Data Properties

Property	Description	Type
terms	(mandatory) The loan, as an array of terms. Must be present and non-empty — `[]` is rejected. Each element is an object carrying exactly one of the eleven branch keys. See SAMI v2 Terms.	array

Each snapshot is complete, not a patch. Send your data as it now stands, in full. Anything you leave out is simply absent from the new snapshot rather than inherited from the previous one — which is exactly how you remove a borrower or a property. There is no way to add one field to an existing snapshot.

Until then, keep your own copy of what you sent, and build each new snapshot from that rather than from memory. A read-back on this path, letting you fetch the current snapshot, edit it and post it straight back, is on the way in a future release; this page will describe it once it is live.

The body carries terms and nothing else. A product belongs on Start a Workflow in a Session; a stage body carrying one is currently accepted and the field ignored rather than rejected. Do not send it — neither the acceptance nor the ignoring is contractual.

Only three things about terms are checked when you submit:

terms must be present and a non-empty array. "terms": [] is rejected.
Every element must be a JSON object — never null, never a bare string or number.
Every element must carry one of the eleven branch keys: person, property, participant, loanTerms, loanToValue, transactionDetail, loanDetail, refinance, housingExpense, closing, company.

Everything else is permissive. An absent field is accepted without complaint, and a key this service does not recognize is ignored rather than refused, so a misspelled field name will not be reported back to you. Read the term descriptions as a statement of what is understood, not as a validator.

Send exactly one key per term. A term carrying two keys is not currently rejected: one of the two facts is silently dropped, and the submission still stages and runs normally. A mistake here therefore surfaces as missing information in the result rather than as an error on the request, which makes it expensive to trace. Split every fact into its own term.

A product’s own requirements are checked when it runs, not when you stage. Staging data that a product will reject still returns 200; the workflow is then accepted with a 202 and the workflow fails. ADV, for example, needs at least one borrower carrying a residential address, a home phone and a date of birth. See the flow guide for a worked example of that failure, and ask your Account Representative what your other products require.

Responses

Not every response carries the same body, so branch on the status code first, and then on what the body actually contains. Some responses carry the messages envelope described on this page; others carry a JSON problem document with an entirely different set of fields; others carry no JSON at all. A client that calls its JSON parser on every non-2xx body, or that reads messages[0].code without first checking that messages is present, will fail on the responses it is most likely to meet.

200

The snapshot was recorded and is now what the session holds. loanStaged is true from here on.

Property	Description	Type
session	(present) The session, with `loanStaged` now `true`. Never carries the staged data itself.	object
messages	(present) Always an array, never null. Carries one message whose `code` is `SESSION_UPDATED`.	array

Example:

{
  "session": {
    "sessionId": "0000000000013500001",
    "loanStaged": true,
    "correlationId": "alpha_numeric_string_to_help_identify_this_session",
    "links": {
      "self": {
        "href": "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sessions/0000000000013500001"
      },
      "sami": {
        "href": "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sessions/0000000000013500001/sami",
        "method": "POST"
      },
      "workflows": {
        "href": "https://api.pointservices.com/riskinsight-services-ws/resources/v1/sessions/0000000000013500001/workflows",
        "method": "POST"
      }
    }
  },
  "messages": [
    {
      "code": "SESSION_UPDATED",
      "text": "loan snapshot recorded",
      "timestamp": "2026-08-07T15:01:42Z"
    }
  ]
}

Staging costs nothing. Nothing is billed until you start a workflow.

400

The request was refused and the session is left exactly as it was — nothing is kept from a rejected stage, including a previous snapshot, which remains the current one. Causes: terms absent, empty, or not an array; an element that is not a JSON object; an element carrying none of the eleven branch keys. One bad term rejects the whole request rather than being dropped while the others proceed.

A 400 arrives in two different body shapes, decided by how far the request got before it was refused. Check for a messages array first, and fall back to the problem document when it is absent.

A value this service evaluated and rejected carries the messages envelope with the code VALIDATION_ERROR.

Property	Description	Type
messages	(present) Always an array, never null. Carries one message whose `code` is `VALIDATION_ERROR`.	array
messages[].code	(present) Always `VALIDATION_ERROR` on this shape.	string
messages[].text	(present) Human-readable description of what was wrong. Never machine-parsed — the wording is not contractual.	string
messages[].timestamp	(present) RFC 3339 UTC with a trailing `Z`. Fractional seconds appear only when they are not zero, so parse this value rather than slicing it.	string

Example:

{
  "messages": [
    {
      "code": "VALIDATION_ERROR",
      "text": "every term in terms must be a recognized SAMI term",
      "timestamp": "2026-08-07T15:01:42Z"
    }
  ]
}

A body that could not be read as this request at all — a JSON array where an object was expected, a field of the wrong type, or malformed JSON — is refused before the service evaluates any value, so there is nothing to put in a messages array. It carries a JSON problem document instead, with Content-Type: application/problem+json and no messages key and no VALIDATION_ERROR code.

Example:

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Request body has a field that must be a value of type SessionStartRequest",
  "instance": "urn:pps:request:0000000000000000000000000000000000000000000000000000"
}

A client that reads messages[0].code on every 400 without checking that messages exists will throw on this second shape. Branch on the presence of messages, not on the status.

No snapshot is recorded, and the session object is omitted.

401

No credential the platform could accept reached the service.

The body is a JSON problem document, not the messages envelope, and the response carries a WWW-Authenticate: Bearer realm="Helix" challenge. Read the machine-readable part from type; title and detail are human copy and are not contractual.

Property	Description	Type
type	(present) An absolute URI identifying the problem. `about:blank` when no credential was sent at all.	string
title	(present) Short human-readable summary.	string
status	(present) Repeats the HTTP status code.	number
detail	(present) Human-readable explanation. Never machine-parsed.	string
instance	(present) An identifier for this one request. Quote it when contacting support.	string

Examples:

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required. Present a bearer access token in the Authorization header.",
  "instance": "urn:pps:request:0000000000000000000000000000000000000000000000000000"
}

{
  "type": "https://pointservices.com/problems/invalid-token",
  "title": "The access token was not accepted",
  "status": 401,
  "detail": "The access token was rejected.",
  "instance": "urn:pps:request:0000000000000000000000000000000000000000000000000000"
}

The second form carries WWW-Authenticate: Bearer realm="Helix", error="invalid_token", and is what a token the service will not accept returns.

Treat a 401 and a 403 alike: both mean your credential did not work, and neither distinguishes reliably enough to build separate recovery paths on. Obtain a fresh access token and retry the request once. If it fails again, stop and surface the error rather than looping — repeated attempts with a credential the service has already refused will meet the rate throttle described below.

403

Your credential was understood but you are not permitted to stage into this session. No snapshot is recorded.

The body does not carry the messages envelope, so there is no code to branch on. Branch on the status alone, and treat the body as opaque: do not assume it is empty, and do not assume it is JSON.

A 403 is not always a permissions problem — try a fresh token first. A credential the service will not honour can be refused with either status, so a sudden wall of 403s on calls that worked a moment ago is more often an expired token than a change to your entitlements. Obtain a new access token and retry once. If it fails again, then treat it as entitlement and talk to your Account Representative.

A 403 is also produced at the edge, before this service is reached, when a request omits Content-Type or carries a value resembling SQL injection or cross-site scripting. Those refusals carry an HTML body and this service never sees them. A value that legitimately contains such text should be encoded — Base64, for instance — rather than sent raw.

This is the call most likely to meet the edge refusal described above, because terms carry borrower and property free text. A name or an address containing something that resembles SQL or markup is refused before this service sees it.

404

No session exists with this identifier, or the path you called is not served.

A 404 arrives in two different body shapes, decided by whether the path is served at all.

A path this service serves, naming something that does not exist carries a JSON problem document with Content-Type: application/problem+json. Read the machine-readable part from type.

Property	Description	Type
type	(present) An absolute URI identifying the problem, ending `/problems/not-found` here.	string
title	(present) Short human-readable summary.	string
status	(present) Repeats the HTTP status code.	number
detail	(present) Human-readable explanation naming what was not found. Never machine-parsed.	string
instance	(present) An identifier for this one request. Quote it when contacting support.	string

Example:

{
  "type": "https://pointservices.com/problems/not-found",
  "title": "No such resource",
  "status": 404,
  "detail": "Session[0000000000013500001] not found",
  "instance": "urn:pps:request:0000000000000000000000000000000000000000000000000000"
}

An identifier this API has already issued to you is readable the moment you receive it, so a 404 on one is final rather than a race. Retrying will not make it appear.

A path that is not served at all — most often a URL missing the riskinsight-services-ws context root — is refused by infrastructure in front of the application, which never sees the request. That response carries no body this API defines, so branch on the status alone and do not attempt to parse what comes back. Its exact shape depends on the environment you are calling.

If a 404 has no body, check the context root before anything else.

409

WORKFLOW_WRITE_CONFLICT — a concurrent change was detected and this attempt lost the race. Final for that attempt: the service does not retry it, so you decide whether to resubmit. No code path emits this today — concurrent changes are serialized server side, and what is not yet built is the translation of a lost race into this response rather than a generic failure. Handle it anyway: the code is part of the permanent vocabulary and may begin appearing without notice. Stage snapshots one after another rather than concurrently.

Branch on messages[].code, never on the status alone. A 409 on this surface means more than one thing, and the corrective action differs by cause.

Property	Description	Type
messages	(present) Always an array, never null.	array
messages[].code	(present) One of the codes described above for this status.	string
messages[].text	(present) Human copy. Never machine-parsed.	string
messages[].timestamp	(present) RFC 3339 UTC with a trailing `Z`, fractional seconds only when they are not zero.	string

A conflict can also arrive without a messages array, as a JSON problem document carrying type, title, status, detail and instance. When messages is absent, read the machine-readable part from the last path segment of type. Treat the conflict as final for that attempt in either shape, and check that messages is present before reading messages[0].code.

429

Refused by a rate throttle at the edge, before this service is reached. The throttle counts requests per source address across every endpoint on both the session and workflow surfaces.

The refusal carries no body, no messages array and no Retry-After header, and this service never sees it, so it will not appear in any support trace.

Back off and resume. When following a workflow to completion, an interval that stays clear of the throttle is two seconds for the first two checks, then five, then ten seconds thereafter, with an overall deadline after which you stop and investigate.

500

An unhandled failure inside the service. The body does not carry the messages envelope, so branch on the status alone.

A 500 means the outcome is unknown, not that nothing happened. A failure raised after a write has already committed leaves that write in place. The snapshot may or may not have been recorded. Read the session to see whether loanStaged is now true, and re-stage if you need certainty about which snapshot is current — re-staging is free and simply replaces it. Retrying blind is how one order becomes two, and nothing on this surface removes a duplicate for you.