Pylon GraphQL API
Welcome to the Pylon GraphQL API Documentation! This reference includes the complete set of GraphQL queries and mutations needed for mortgage - from getting teaser rates to show potential borrowers to getting a rate lock for a borrower at the end of the application process.
API Endpoints
https://pylon.mortgage/graphql
Webhooks
Pylon can notify your application when something changes in your loans by sending signed webhooks over HTTPS, so you do not have to poll. Each webhook is a POST request with a JSON body, sent to a callback URL you give Pylon, for the event types you subscribe to.
Webhooks are enabled per organization. Contact Pylon to enable webhook management for your organization, then register your endpoint with createWebhookSubscription: the https callback URL your endpoint listens on and the event types you want. An organization can register several endpoints, for example one per integration or one per tester, each with its own callback URL, event types and signing keys; registering one never replaces another, and each event goes to every endpoint that subscribed to its type. The callback URL must be a public https address. Pylon does not follow redirects, so give the final URL your endpoint answers on. The response returns your first signing secret once, in that response only: store it where your receiver can read it, because it cannot be retrieved again. If it is lost, or to rotate it, mint a new signing key with createWebhookSigningKey. Nothing is delivered until the endpoint has been verified; see Verifying your endpoint.
Every delivery carries these headers:
| Header | Meaning |
|---|---|
X-Pylon-Signature |
Versioned HMAC signature of the request: v1=<hex digest>. |
X-Pylon-Timestamp |
Unix time (seconds) at which this delivery attempt was signed. |
X-Pylon-Key-Id |
The id of the signing key that produced the signature. See Signing keys and rotation. |
X-Pylon-Event-Type |
The event type, the same value as the body's type. |
X-Pylon-Idempotency-Key |
Stable identifier for the event, identical across retries: the same value as the body's id. |
Body
Every delivery, whatever the event, is one envelope:
| Field | Type | Meaning |
|---|---|---|
type |
string | The event type, e.g. contributor.created or Borrower.changed. |
id |
string | The delivery's identity; identical across retries and re-emits, so de-duplicate on it. The same value as X-Pylon-Idempotency-Key. |
occurredAt |
string | ISO-8601 time the thing happened, not when it was delivered. |
sequence |
number | The event's number among the events recorded for you: 1 for the first, then 2, 3 and so on, with no gaps, across every event-log type. Identical across retries and in eventLog.page. Absent from contributor.created and webhook.test, which are not in the event log, and from an event-log delivery queued before sequence was introduced or sent while it was rolling out; treat a missing sequence as unknown. |
data |
object | The event's own fields; each event type below documents its data. |
The keys are always in that order, and the signature covers the exact bytes, so verify the raw body before parsing it. Pylon may add keys to the envelope; ignore any key you do not recognize.
Responding. Return a 2xx status within 10 seconds to acknowledge a delivery; Pylon stops waiting for an answer after 15 seconds and counts the attempt as failed. Do the work after you respond: store the event and process it in the background. Pylon treats any other answer as a failed attempt:
- For every event type except
contributor.created:401,403,404,408,425,429, any5xx, a timeout, or a connection error is retried for up to 24 hours. Pylon waits 2 seconds before the first retry and doubles the wait each time, up to an hour between attempts, with each wait shortened by up to a quarter at random, never lengthened; the last attempt is made 23 to 24 hours after the first, after about 33 attempts in all.401,403and404are retried because receivers answer them while a key rotation or a deploy is in progress. - For
contributor.created:429, any5xx, a timeout, or a connection error is retried. Pylon makes up to 8 attempts, waiting 2 seconds before the first retry and doubling the wait each time, up to 5 minutes between attempts. Counting the time each attempt can take, the attempts span about four to six minutes. - Any other
4xx, or a redirect (3xx), stops delivery of that event at once. These answers mean the request will not succeed if it is sent again unchanged.
Suspended endpoints. Where Pylon has turned auto-disabling on for your organization, an endpoint that keeps failing is suspended: Pylon stops the deliveries still retrying and starts no new ones. "Keeps failing" means 50 consecutive failing events (an event fails on any answer other than 2xx, a timeout, or a connection error, and counts once: the retries of an event that already failed add nothing; one 2xx resets the count) whose first failure is at least 30 minutes old. A failure on Pylon's side that never reached your endpoint is not counted. A streak that reaches six hours starts over, so fifty failures inside a short outage do not suspend you, and neither do failures spread thinly over a day. Your subscription then reads status: SUSPENDED in webhookSubscriptions. Once your endpoint is fixed, call updateWebhookSubscription with enabled: true to resume it with a clean failure count (it needs a promoted signing key, WEBHOOK_NO_PROMOTED_KEY otherwise), or, if you do not manage your endpoint through the API, ask Pylon to re-enable it. Nothing else resumes a suspended endpoint: changing its URL or event types, a test delivery, promoting a key or revoking one all leave it SUSPENDED (a promotion that moves a pending URL into place starts the failure count over at the new URL, but the endpoint stays suspended until enabled: true). Events skipped while it was suspended are not sent later, and you read them back from the event log (Missed events and replay), except contributor.created, which is not in the event log: one skipped while your endpoint was suspended is lost. Pylon checks the status as it reaches each event, so an event recorded shortly before you re-enabled may still be delivered: expect a replay to overlap the first deliveries after re-enabling, and de-duplicate on id.
Delivery latency (recorded to accepted). For event-log webhooks (every event except contributor.created), Pylon measures the time from data.recordedAt, the server-assigned append timestamp just before the event-log transaction commits, to receipt of your endpoint's 2xx response headers. This includes the remaining transaction time, routing, queueing, and your response time; response-body transfer time is excluded. It is not measured from occurredAt or a separately captured commit timestamp. A successful retry includes earlier attempts and backoff; failed attempts do not produce latency samples.
In production and sandbox, Pylon alerts when the p95 of successful deliveries across all attempts stays above 60 seconds for 15 minutes, per customer. A successful retry is measured from the original append timestamp, including queue delays, earlier attempts, and retry backoff. Disabled endpoints and failed attempts emit no sample. This is an operational alert threshold, not a measured p95 or a delivery-time guarantee. Retry timing and your response deadline are separate, as described above.
Duplicates and order. Delivery is at least once, so the same event can arrive more than once. Use X-Pylon-Idempotency-Key to ignore an event you have already processed. Events are not guaranteed to arrive in the order they happened: a retried delivery can arrive after a later event. Each event carries the times it happened and was recorded, and most events are a prompt to fetch the record's current state, so order rarely matters. When it does, compare sequence rather than arrival order: a higher sequence was recorded later.
Detecting missed events. sequence counts the events recorded for you, one by one, including some that are never pushed as webhooks. A jump between two deliveries, say from 41 to 43, means event 42 has not reached you: it may still be being retried, it was not sent (see Missed events), it is of a type you do not subscribe to, or it is of a type outside the webhook vocabulary. Those types are numbered but never pushed, so even with every webhook type subscribed you can see permanent gaps. To tell which, and to catch up, use the event log: read it from your stored cursor (see Missed events and replay), and every event there carries the sequence its push carried. A delivery without sequence has no number to compare; find its place in the log by its id. Pylon still does not promise to deliver events in sequence order.
Receiver reorder recipe. Apply the per-entity.id checkpoint recipe only to the change-data types listed under Webhook events, whose data.entity.id names the record that changed, not to loan-activity types. For these change-data deliveries with a known sequence, keep the highest sequence applied for each entity, scoped to your customer. Ignore a sequence at or below that entity's applied sequence (stale or duplicate). By default, apply an arrival immediately if its sequence is above that entity's applied sequence; a later-arriving lower sequence is then stale. This fits events that prompt fetching current state rather than applying every change. Update the applied sequence atomically with your state, and only after a successful fetch if one is needed. Serialize application and reconciliation for each entity. Do not use a single customer-wide applied sequence to discard another entity's events. The helper is a reference model, not an efficient implementation.
Buffering is only needed when you must process every event for an entity in order, such as applying each event as a change. Keep a durable buffer by entity.id, and apply buffered events in increasing sequence order. You may apply them before the deadline once the event log has established that no earlier relevant events are missing, or if your application accepts dropping a later-arriving older change. A sequence gap is not evidence of a missing event for this entity: the counter is per customer, not per entity, and intervening numbers usually belong to other entities or unsubscribed types. Do not wait for every intervening number to be pushed.
Give the first buffered arrival a fixed deadline; later arrivals must not extend it. Stop waiting after 1473 minutes from the first buffered arrival (24 hours plus 33 minutes). This is the delivery workflow's 24-hour retry window plus its execution grace: 10 minutes queueing and 30 seconds running the last delivery attempt, three failure-record attempts each allowed 5 minutes queueing and 30 seconds running, two waits of up to 30 seconds, and a 5-minute margin. It bounds how long an earlier delivery workflow's retried push can still arrive once that workflow has started. It does not bound delayed routing or replay. After the deadline, use the event log or replay for completeness; reconciliation recovers current state, not every intervening change.
For change-data events, if a gap is still unresolved at that deadline, stop waiting and re-fetch the record's current state using the query documented for that event type under Webhook events; use node(id:) only for records it supports. For example, reconcile OptimalStructureRun.changed with pricing.optimalStructure(id:), not node(id:). You may reconcile this way earlier instead of waiting. Capture the highest buffered sequence before the fetch. Distinguish three outcomes: found, not-found and failed. After a successful found result, replace your local state; after a successful not-found result, record the state as missing (the reference model uses null). In either successful case, commit the captured sequence as applied for this entity and discard buffered events at or below it, without applying them to resurrect a missing record. Leave arrivals during the fetch above the captured sequence buffered. If the fetch fails, retain both the checkpoint and buffer unchanged and retry reconciliation, not stale event application. Reset the first-buffered deadline when apply or reconciliation empties the buffer. For events with no sequence or no entity, fetch current state rather than guessing their order; use the event log only for types it records.
For example, entity E is a borrower and has applied sequence 41. Its event 42 is retrying while event 43 for E arrives first. Buffer 43. To avoid waiting, fetch E with node(id:) now; it returns the state after 43. Save that state and applied sequence 43 together. When 42 arrives, drop it as stale: it must not roll E back. Alternatively, buffer both if 42 arrives before reconciliation and the event log establishes there are no earlier relevant events missing; process 42 then 43, ending with 43's state and applied sequence 43. If E's next event is 47, do not wait for 44 through 46: they may all belong to other entities. In immediate-apply mode, apply 47 now and checkpoint 47. In buffering mode, reconcile at the fixed deadline, or earlier, and checkpoint 47 only after the fetch succeeds.
Loan-activity events are separate facts. Each loan-activity event listed under Webhook events is an immutable fact, with its own lev_ loan-event data.entity.id, not the changed record's ID. Process each once using X-Pylon-Idempotency-Key or the envelope's id for deduplication. If ordering matters, sort activity events by sequence within each loan identified by data.loans[].id. Do not discard a distinct activity event at or below a per-loan checkpoint: it remains a separate fact even if a higher-sequence fact arrived first. Use the event log or replay for completeness and to fill gaps; customer-wide sequence gaps need not belong to this loan. Recover the loan's current state with loan(id:) using that loan ID, not node(id:) on the lev_ ID, which resolves the loan event. The separate contributor.created event has no event-log sequence and uses its own payload, as described below; deduplicate by its envelope id, not this checkpoint recipe.
Missed events. If your endpoint is down for longer than the retries last, the events whose retries ran out are not sent later, and neither is any event skipped while your endpoint was suspended. If webhooks are paused for your organization, an event is skipped when Pylon reaches it while the pause is on and is never sent later; events Pylon reaches after the pause ends are delivered, so a replay of the paused period can overlap with deliveries. Use X-Pylon-Idempotency-Key to ignore an event you have already processed. Every event type except contributor.created can be read back from the event log; see Missed events and replay.
Verifying webhooks
Verify every delivery before you trust it:
- Read the raw request body exactly as received. Do not parse and re-serialize the JSON, because the signature covers the exact bytes.
- Choose the signing secret that matches
X-Pylon-Key-Id. During a key rotation you hold more than one secret; the header tells you which one Pylon used. - Join the value of
X-Pylon-Timestamp, a period (.), and the raw body. - Compute the HMAC-SHA256 of that string with the secret, as lowercase hex.
- Compare
v1=<digest>withX-Pylon-Signatureusing a constant-time comparison. - Reject the delivery if the timestamp is more than 5 minutes from your clock. The timestamp is part of what is signed, so an old request cannot be replayed with a fresh one. Each retry is signed again with a new timestamp.
Answer 401 when verification fails. For every event type except contributor.created, Pylon retries a 401 for up to 24 hours, because a receiver answers it while a key rotation is in progress; once your secrets are right, the pending retries succeed, unless the endpoint was suspended first (Suspended endpoints above). For contributor.created, a 401 is final for that event.
Node.js:
import { createHmac, timingSafeEqual } from "node:crypto";
// secretsByKeyId: { "<X-Pylon-Key-Id value>": "<signing secret>", ... }
export function verifyPylonWebhook(headers, rawBody, secretsByKeyId) {
const timestamp = headers["x-pylon-timestamp"] ?? "";
const signature = headers["x-pylon-signature"] ?? "";
const keyId = headers["x-pylon-key-id"] ?? "";
const secret = Object.hasOwn(secretsByKeyId, keyId)
? secretsByKeyId[keyId]
: undefined;
if (secret === undefined) {
return false;
}
if (timestamp === "" || /\D/.test(timestamp)) {
return false;
}
if (Math.abs(Date.now() / 1000 - Number(timestamp)) > 300) {
return false;
}
const digest = createHmac("sha256", secret)
.update(timestamp + "." + rawBody)
.digest("hex");
const expected = Buffer.from("v1=" + digest);
const received = Buffer.from(signature);
return (
expected.length === received.length &&
timingSafeEqual(expected, received)
);
}
Python:
import hashlib
import hmac
import time
# secrets_by_key_id: {"<X-Pylon-Key-Id value>": "<signing secret>", ...}
def verify_pylon_webhook(headers, raw_body: bytes, secrets_by_key_id) -> bool:
timestamp = headers.get("X-Pylon-Timestamp", "")
signature = headers.get("X-Pylon-Signature", "")
secret = secrets_by_key_id.get(headers.get("X-Pylon-Key-Id", ""))
if secret is None or not (timestamp.isascii() and timestamp.isdigit()):
return False
if abs(time.time() - int(timestamp)) > 300:
return False
signed = timestamp.encode() + b"." + raw_body
digest = hmac.new(secret.encode(), signed, hashlib.sha256).hexdigest()
return hmac.compare_digest(f"v1={digest}".encode(), signature.encode())
An organization that has used Pylon webhooks since before signing keys existed receives X-Pylon-Key-Id: legacy, which means the one secret you were originally given. When Pylon moves your organization onto signing keys, that same secret becomes your first ACTIVE key, and from then on deliveries carry that key's whsk_ id instead of legacy, with the secret unchanged. Pylon tells you before it moves your organization. The whsk_ id exists only once the move has happened, so you cannot map it in advance: before the move, have your receiver fall back to your original secret for a whsk_ id it does not recognize (the signature still has to verify against that secret, so nothing is accepted unsigned); after it, read the id with the webhookSubscriptions query, map it, and drop the fallback. The legacy signing path is deprecated and is retired once every organization has been moved to a signing key.
Verifying your endpoint
Nothing is delivered to an endpoint until it has been verified. To verify it, call sendWebhookTestDelivery with a pending signing key. Pylon sends a signed webhook.test event, the envelope every delivery uses, whose data.challenge is a one-time token of 64 lowercase hex characters. Check the signature as described in Verifying webhooks, then answer 2xx within 10 seconds with a JSON body carrying the hex HMAC-SHA256 of the string challenge. followed by the token, under the key's secret (the same secret the signature uses):
{ "challenge": "<hex HMAC-SHA256 of the string challenge.<token>, keyed with the secret>" }
An answer that carries anything else, the token echoed back or its HMAC without the challenge. prefix included, is reported as CHALLENGE_NOT_ANSWERED and does not verify the endpoint: only a holder of the secret can produce the HMAC. The challenge. prefix keeps the answer from ever being a valid delivery signature (those sign <timestamp>.<body>), so answering a challenge can never sign a forged delivery; answer only a token of that shape. Once a key has passed, promoteWebhookSigningKey makes it the key deliveries are signed with.
Changing the callback URL does not interrupt deliveries. The new URL is held as pendingCallbackUrl while deliveries continue to the current callbackUrl; the next sendWebhookTestDelivery goes to the pending URL, with a pending key or with the active key when you are not rotating. A passing test with the active key makes it the callbackUrl in the same step, as does a passing test with any key while nothing else signs your deliveries yet (no active key and no shared secret from onboarding). A passing test with a pending key while the active key, or the shared secret, still signs deliveries records the pass and leaves deliveries on the current URL; promoteWebhookSigningKey then moves the URL and switches the signing key together, so keep the current receiver running until the promotion. Naming the current URL again withdraws the move.
Signing keys and rotation
Each webhook subscription has signing keys, and deliveries are signed with its one ACTIVE key. You can replace that key without pausing delivery. Your endpoint accepts both the old and the new key for a while, and Pylon switches between them in one step.
In-flight retries. Each delivery attempt resolves the subscription's currently active signing key at send time, including retries of an event scheduled before promotion. The key is not snapshotted when the delivery is scheduled: attempt 1 can carry the old X-Pylon-Key-Id and attempt 2 the new one, with the same event id and body. Accept both the active and retiring keys throughout the overlap window, selecting the secret by X-Pylon-Key-Id. Freezing the original key would let a retry use a key your receiver has already dropped after retirement, or keep signing with a compromised key after an emergency revocation. A revoked key is never selected for a new attempt; revoking the active key pauses delivery until a replacement is promoted.
Key states:
| State | Meaning |
|---|---|
PENDING |
Newly created. Signs nothing yet, except the test deliveries you request. Expires 72 hours after it is created unless it is promoted. Creating another key replaces it. |
ACTIVE |
Signs every delivery. A subscription has exactly one. |
RETIRING |
The previous active key. No longer used to sign, but your endpoint must keep accepting it for 7 days, after which Pylon revokes it. |
REVOKED |
Never used again. Remove it from your endpoint. |
Managing keys needs an access token with the update:webhook-endpoint scope, the one that also registers, changes and deletes the subscription; listing subscriptions and their keys needs read:webhook-endpoint. Subscriptions and their keys are part of the experimental API, so the token also needs use:experimental-api. Every key mutation returns userErrors: an empty list means it succeeded, and otherwise each entry carries a code saying why the request was refused (for example WEBHOOK_KEY_NOT_TESTED or WEBHOOK_KEY_EXPIRED). Check it on every call. Creating keys is limited to 10 an hour, test deliveries to 30 an hour, and emergency revocations to 6 a minute; promoting is not limited.
To rotate:
- Find your subscription's
idwithquery { webhookSubscriptions { id callbackUrl status signingKeys { id state expiresAt testedAt } } }. It returns your own organization's subscriptions. - Create a key with
mutation { organization { createWebhookSigningKey(input: { subscriptionId: "<id>" }) { secret signingKey { id state expiresAt } userErrors { code message } } } }. The response returns the new secret once and never again, so store it securely right away. - Configure your endpoint to accept the new secret for its key id, alongside the current one.
- Send a test with
organization.sendWebhookTestDelivery, passing the new key's id assigningKeyId. Pylon signs awebhook.testevent with the new key and posts it to your callback URL (or to your pending URL, if you are changing it). A2xxanswer carrying the challenge's HMAC, as described in Verifying your endpoint, records the key as tested; any other answer does not. The test is not retried; the response tells you how it ended. - Promote the key with
organization.promoteWebhookSigningKey. From that moment every delivery is signed with the new key, and the old key becomesRETIRING. - After 7 days the old key is revoked. Remove its secret from your endpoint then.
The 7-day overlap. Only one key can be RETIRING at a time, so while the previous rotation's overlap is open, promoting another key is refused with WEBHOOK_ROTATION_IN_PROGRESS. That error is a WebhookRotationInProgressError: select ... on WebhookRotationInProgressError { retiringSigningKey { id expiresAt } retiringKeyExpiresAt } to see which key holds the overlap open and when it ends on its own (the same time as that key's expiresAt). You can wait until then, but a PENDING key expires 72 hours after it is created, so create and test the replacement key within 72 hours before retiringKeyExpiresAt. Or end the overlap early: once your endpoint verifies deliveries signed with the active key, revoke the retiring key with mutation { organization { emergencyRevokeWebhookSigningKey(input: { signingKeyId: "<retiringSigningKey.id>" }) { userErrors { code message } } } } and promote again. Revoking a RETIRING key does not pause delivery; revoking the ACTIVE key does, until a new key is promoted.
The test delivery body looks like this:
{
"type": "webhook.test",
"id": "whsk_3Lq9Vb2NwXc7Kd4RtY8Zm:webhook.test:1",
"occurredAt": "2026-10-24T17:05:12.418Z",
"data": {
"signingKeyId": "whsk_3Lq9Vb2NwXc7Kd4RtY8Zm",
"attempt": 1,
"challenge": "9f2c4a7e1b3d5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8"
}
}
If a key may have been exposed, revoke it at once with organization.emergencyRevokeWebhookSigningKey. Revoking a PENDING or RETIRING key has no effect on delivery. Revoking the ACTIVE key disables the subscription: deliveries stop until you create, test and promote a new key, and events from the gap are not sent later. Read them back from the event log.
Webhook events
Every event type except contributor.created comes from Pylon's event log, and the event log's PylonEvent type returns the same envelope, so one parser handles a pushed event and a replayed one alike. The envelope is the same for every event type; type tells you which data to expect.
The envelope is the contract: its outer fields, listed in the Body table above, are stable. New fields may be added; receivers must ignore unknown fields. Incompatible changes to an event type's versioned data raise schemaVersion. An incompatible outer-envelope change would be announced ahead of time as a new envelope that subscriptions opt into; the current envelope would remain the default until an announced, dated cutover.
data carries:
| Field | Type | Meaning |
|---|---|---|
schemaVersion |
number | Version of this event type's data. Raised only when the fields change incompatibly. |
recordedAt |
string | ISO-8601 time Pylon recorded the event; the envelope's occurredAt is when the change happened. |
entity |
object or null | { "id": ... } of the record that changed. |
loans |
array | { "id": ... } of every loan the record belonged to when the event was recorded. Empty when none. |
The envelope's id and sequence are the same ones eventLog.page returns for that event, so you can de-duplicate across a push and a replay.
{
"type": "Borrower.changed",
"id": "nrmev_8Hn2Qx5TfLw9Pc3Vk6Jr",
"occurredAt": "2026-10-24T17:02:44.118Z",
"sequence": 1042,
"data": {
"schemaVersion": 1,
"recordedAt": "2026-10-24T17:02:44.402Z",
"entity": { "id": "borr_4Rm7Ty2WqNs8Lk3Xc9Bv" },
"loans": [{ "id": "app_6Gd3Pz8MvKw2Hs5Nq7Ft" }]
}
}
A .changed event says that the record changed, not how. Several writes to one record close together can produce a single event. Treat it as a prompt to fetch the record's current state:
- For a loan application, borrower, asset, income, employment, liability, owned property, subject property, subject property intent, party or non-borrowing owner, fetch the record by its id with the
node(id:)query. - For a loan's credit pulls, AUS runs, disclosure runs, appraisal orders, flood orders, undisclosed-debt monitors, optimal structure runs and selected product structure, use the query for that kind of record in this reference with the id in
entityor the loan inloans, for examplecredit.report(id:)for a credit pull,credit.udnMonitors(loanId:)for undisclosed-debt monitors, orpricing.optimalStructure(id:)for an optimal structure run.
LoanApplication.changed is sent whenever the loan application's own record is created or written. For example: creating a loan; the loan mutations update, archive, withdraw, updateBorrowerPreferences, attachTitleCompany, setUseOwnTitleCompany, freeze and thaw; a stage change or underwriting decision from the loan system; and removing a non-borrowing owner (nonBorrowingOwner.delete), which sends no NonBorrowingOwner.changed. A stage change or decision also sends its loan-activity event below (such as LoanApplication.stageChanged), so the two can arrive together for one action. Changes to the loan's borrowers, assets, incomes, employments, liabilities, properties or parties send those records' own .changed events. Pylon also writes the record during internal syncs, so it can arrive when nothing you can read has changed, and writes close together can arrive as one. It does not identify an action: fetch the loan with node(id:) and compare.
The event types you can subscribe to are LoanApplication.changed, Borrower.changed, Asset.changed, CreditPull.changed, AusRun.changed, DisclosuresRun.changed, AppraisalOrder.changed, FloodOrder.changed, UndisclosedDebtMonitor.changed, OptimalStructureRun.changed, Income.changed, Employment.changed, Liability.changed, OwnedProperty.changed, SubjectProperty.changed, SubjectPropertyIntent.changed, Party.changed, NonBorrowingOwner.changed, ProductStructure.changed, Deal.changed, FeeSheetRequest.changed, ConventionalPreQualification.changed, PreApproval.changed, BulkLoanDocumentsExportJob.changed, CustomerLockDocumentGenerationJob.changed, IncomeVerificationOrder.changed, Contributor.changed, Concession.changed, LoanDocument.changed, AsyncJob.completed, AusRun.statusChanged, LoanApplication.created, LoanApplication.stageChanged, LoanApplication.disclosed, LoanApplication.decisionRecorded, LoanApplication.borrowerMergeOwnershipConflict, LoanApplication.requirementMet, LoanApplication.titleAgentsChanged, Document.uploaded, Task.created, Task.completed, Task.reopened, Task.cancelled, Task.conditionCleared, RateLock.changed, Fee.created, Fee.updated, Fee.deleted and contributor.created. For the change-data types (LoanApplication.changed, Borrower.changed, Asset.changed, CreditPull.changed, AusRun.changed, DisclosuresRun.changed, AppraisalOrder.changed, FloodOrder.changed, UndisclosedDebtMonitor.changed, OptimalStructureRun.changed, Income.changed, Employment.changed, Liability.changed, OwnedProperty.changed, SubjectProperty.changed, SubjectPropertyIntent.changed, Party.changed, NonBorrowingOwner.changed, ProductStructure.changed, Deal.changed, FeeSheetRequest.changed, ConventionalPreQualification.changed, PreApproval.changed, BulkLoanDocumentsExportJob.changed, CustomerLockDocumentGenerationJob.changed, IncomeVerificationOrder.changed, Contributor.changed, Concession.changed, LoanDocument.changed), entity.id is the record that changed. The loan-activity types are AsyncJob.completed, AusRun.statusChanged, LoanApplication.created, LoanApplication.stageChanged, LoanApplication.disclosed, LoanApplication.decisionRecorded, LoanApplication.borrowerMergeOwnershipConflict, LoanApplication.requirementMet, LoanApplication.titleAgentsChanged, Document.uploaded, Task.created, Task.completed, Task.reopened, Task.cancelled, Task.conditionCleared, RateLock.changed, Fee.created, Fee.updated, Fee.deleted: for each of these, entity.id is a lev_ loan event that node(id) resolves, with the same payload shape as a change-data event; read the loan event's eventType and metadata for the detail. RateLock.changed is a loan-activity type despite its name. AsyncJob.completed is sent when an asynchronous job a loan asked for, such as an automated valuation, ends, and it is switched on per customer. New types are added over time, and you receive only the types you subscribed to. Ignore any type your code does not recognize.
Topics. Beside listing event types, an endpoint can subscribe to a topic, which delivers every event type about that part of a loan: BORROWERS, CONTRIBUTORS, CREDIT, DISCLOSURES, LOANS, ORDERS and UNDERWRITING (the WebhookTopic description names the read scopes each topic delivers under; deliveredEventTypes on your subscription lists the event types a topic gives you). LOANS covers the loan file: LoanApplication.changed, the loan-activity types, the subject property, pricing, parties, Deal.changed (delivered only under read:deal), FeeSheetRequest.changed (read:pricing), ConventionalPreQualification.changed (read:pre-qualification) PreApproval.changed (read:loan), Concession.changed (read:loan), LoanDocument.changed (read:document), BulkLoanDocumentsExportJob.changed and CustomerLockDocumentGenerationJob.changed (read:document and read:loan together, as the Job node); CONTRIBUTORS adds Contributor.changed (read:borrower) beside contributor.created, and ORDERS adds IncomeVerificationOrder.changed (read:loan) beside the appraisal and flood orders. An event reached through a topic is delivered only under the read scopes of the record it names, every one of them held, for example read:credit for CreditPull.changed; an event type you list directly is checked when you list it and keeps delivering until you remove it. Listing an event type needs every read scope its record is read under on your key, or it is refused with WEBHOOK_TOPIC_SCOPE_MISSING; a topic is refused when none of its events has all of its scopes held, and also when no API key of your organization can read any of its events (WEBHOOK_TOPIC_KEY_SCOPE_MISSING, naming the scope no key holds: delivery is judged against your keys, so such a topic could deliver nothing); changing an endpoint (its URL, its event types or its topics) needs the key making the change to hold every read scope of everything the endpoint delivers right now and of everything it will deliver after the change, as registering one needs every read scope of everything it will deliver, or it is refused with WEBHOOK_TOPIC_SCOPE_MISSING; and a topic you hold in part delivers the events all of whose scopes you hold. A topic's events are checked against your organization's current scopes at delivery time, not when topics was sent: if your keys lose a scope, the topic's events needing it are withheld (not sent later; read them back from the event log) while the subscription stays as it is, and as soon as a key holds the scope again they are delivered again, with nothing to resend. deliveredEventTypes on the subscription is the full set that reaches your endpoint: its listed event types plus the topic events your key can read.
contributor.created is sent when a contributor, for example a borrower, is created, including when a loan officer creates the borrower in Pylon's Command Center. It is the one event type that is not in the event log, so its data has its own fields and it cannot be replayed from eventLog.
data carries:
| Field | Type | Meaning |
|---|---|---|
contributorId |
string | The contributor's Pylon ID — the identifier to store. |
dealId |
string or null | The deal in scope at creation, when one exists. |
role |
string | The contributor's role, for example BORROWER. |
customerId |
string | The Pylon customer the contributor belongs to. |
source |
string or null | Where the contributor was created: COMMAND_CENTER, MORTGAGE_PORTAL or ELEMENTS. null for creations that predate source attribution. |
The envelope's id is <contributorId>:contributor.created, and its occurredAt is when the contributor was created.
{
"type": "contributor.created",
"id": "cont_2q3X8x1JQvXhYw5mZk7Rr:contributor.created",
"occurredAt": "2026-07-02T17:24:08.000Z",
"data": {
"contributorId": "cont_2q3X8x1JQvXhYw5mZk7Rr",
"dealId": "morwor_5b9Kd2mPnWcVtL4sYq8Hh",
"role": "BORROWER",
"customerId": "cust_7f1Ns6vBqTgXjM3wZp2Ee",
"source": "COMMAND_CENTER"
}
}
If you also poll the events query, the same rule applies there: the set of NodeType values it reports grows as more records are covered, so ignore a type your code does not recognize rather than failing on it.
Missed events and replay
Webhooks are the fast path, and the event log is the record. Every event type except contributor.created can be read back from the event log in order, so you can fill any gap: an outage at your end longer than the retries, a delivery your endpoint rejected, or a period when webhooks were paused for your organization.
Catching up needs a token with the read:events scope; the event log is part of the experimental API, so the token also needs use:experimental-api.
The page size defaults to 100 and must be an integer from 1 to 200; out-of-range values are refused, not truncated.
Keep a cursor that only ever comes from reading the event log itself: the id of the last event you processed from a page result. Do not set it from webhooks. Webhooks can arrive out of order, and one can fail while a later one succeeds, so the id of the last webhook you received can be ahead of an event you never got. To catch up, call query { eventLog { page(after: "<that id>", pageSize: 100) { events { type id occurredAt sequence data { schemaVersion recordedAt entity { id } loans { id } } } hasMore } } } and pass the id of the last event of each page as after for the next, until hasMore is false. Events come oldest first, up to 200 per page. Process each event idempotently: an event you received by webhook can appear again in the log.
If you have no stored id yet, start from a time instead: eventLog.cursorAt(since:) returns the event just before that time. Pass its id as after and every event recorded at or after since is returned. It returns null when nothing precedes since; then omit after to start from the oldest event the log still holds. Events are kept for at least 90 days and then removed a whole calendar month at a time, so an event older than 90 days may no longer be available to page or cursorAt; don't rely on it.
An after that the log no longer holds is refused with the error code EVENT_LOG_CURSOR_TOO_OLD. Events may have been missed: start again from cursorAt with the time of the last event you processed. An after that is not an event id at all is refused with EVENT_LOG_INVALID_CURSOR. cursorAt(since:) is limited by default to 30 calls per minute per organization, with a burst of 5. A seek that exceeds its 2-second statement budget returns EVENT_LOG_SINCE_TOO_COSTLY. Try a different time, or omit after to read from the oldest event the log holds.
A practical pattern is to run the catch-up loop when your service starts and on a schedule, for example every few minutes, and to treat webhooks as the signal to run it sooner.
Delivery history and redelivery
After fixing a receiver outage, inspect that endpoint's delivery history to find the events that failed. Contact Pylon to enable delivery history and redelivery for your organization. These operations are part of the experimental API, so your token needs use:experimental-api. History also needs read:webhook-endpoint, the same scope that reads your subscriptions. It returns your organization's deliveries for event types that your token has every required read scope for, such as read:borrower for Borrower.changed.
query DeliveryHistory {
webhookSubscriptions {
id
deliveries(first: 20) {
edges {
node {
id
event { id type sequence }
trigger
status
attemptCount
lastFailureReason
lastHttpStatus
createdAt
lastAttemptedAt
completedAt
}
}
pageInfo { hasNextPage endCursor }
}
}
}
Each subscription's history comes newest first. The page size defaults to 20 and must be an integer from 1 to 50. To read older deliveries, pass that subscription's pageInfo.endCursor as deliveries(after:) until hasNextPage is false. History begins when delivery recording is enabled; earlier deliveries are not reconstructed. History is kept for at least 90 days, then removed in batches. Deleting a subscription also deletes its history. History and redelivery cover events in the event log; they do not cover the older contributor.created event, which has no log entry or sequence.
A history entry describes one delivery of an event to one subscription. Automatic retries update that entry's attempt count and outcome. Asking to redeliver creates a separate entry with the original event's id and sequence; your receiver must still de-duplicate on the event id, which is also the X-Pylon-Idempotency-Key header. A successful request queues delivery; it does not mean that your endpoint has acknowledged it. Read the history again to see the outcome.
A final outcome can remain PENDING or IN_PROGRESS while it is being confirmed. Recovery can take longer during a large incident. Refresh the history and check your receiver's logs before requesting another delivery. FAILED with INTERNAL_ERROR can mean Pylon could not confirm acceptance; it does not prove your receiver never accepted the event.
To send one event again, use organization.redeliverWebhookEvent with the subscription's id and the event's id from the history or event log. Your token needs update:webhook-endpoint and every read scope for that event's type. The event must still be retained in the event log (at least 90 days), and the endpoint must currently subscribe to its type.
mutation RedeliverWebhookEvent(: RedeliverWebhookEventInput!) {
organization {
redeliverWebhookEvent(input: ) {
delivery {
id
event { id sequence }
status
attemptCount
}
userErrors { code message }
}
}
}
For example, set input to { "subscriptionId": "<subscription id>", "eventId": "<event.id>" }. Use the event's id, not the delivery row's id.
Redelivery uses the subscription's current verified endpoint and signing keys, and the same signature, timeout and retry rules as an ordinary push. Re-enable a suspended endpoint and restore any missing event scopes before asking to redeliver. A refused request returns userErrors; an unknown event or subscription, including one belonging to another organization, returns a not-found error. Rate limiting returns a top-level GraphQL error. The default limit is 120 requests per hour per organization, with a burst of 20, shared by its endpoints and keys. Each accepted request records who asked for it while the delivery's history is kept. Deleting the subscription deletes that history; deleting the requesting user or API client clears the recorded requester identity.
PENDING means that no numbered attempt has been recorded yet, IN_PROGRESS that an attempt has started or delivery is waiting to retry, and DELIVERED that your endpoint answered 2xx. FAILED means that delivery ended without a recorded acknowledgement; lastFailureReason and lastHttpStatus help explain it. An INTERNAL_ERROR can mean Pylon could not confirm acceptance, so the receiver should still deduplicate on the event's id. NOT_STARTED means that a redelivery could not be started. A failure starting delivery can also return a system error; check history before asking again. Redelivery does not replay other events or advance an event-log cursor. Use Missed events and replay when you need to recover a range of events.
Funding
The funding API lets a partner read the amount Pylon says to wire for a loan, report the wire-out transfers it makes, and reconcile them against Pylon's records. Reading it needs a token with read:loan and read:funding; reporting a wire-out transfer with recordWireOutRemittance also needs write:funding. Pylon, not the partner, records wire-in transfers, wire-in inputs and corrections, and completes the wire-in purchase. Funding is enabled per company; contact Pylon to turn it on.
A loan has one funding settlement, read through Loan.fundingSettlement. The settlement has two legs of the same type, FundingWireLeg: wireOut, the payment to the settlement agent at closing, and wireIn, the payment to the seller at purchase. The legs share one shape, but some fields mean different things on each; the field descriptions say which.
- Figure. An issued, immutable amount to wire (
FundingFigure), with itsnetAmount,effectiveDateand, when known,recipientName. A leg'scurrentFigureis the one to order against, and is present only while the leg'savailabilityisREADY. Save the figureidwhen you place a bank order. When a figure's inputs change, or Pylon revises the calculation, a new figure replaces it and names the one it replaced throughsupersedesFigureIdandsupersededReason. Earlier figures stay readable throughfiguresandfigure(id:). Always wirenetAmount. - Lines. The signed accounting breakdown of one figure (
lines).linesReconciliationsays whether they add up tonetAmount. A breakdown that does not reconcile does not change the amount to wire. - Remittance. A bank transfer recorded against one specific figure (
FundingRemittance, with itsfigureId). A wire-out remittance records a bank order the partner placed; a wire-in remittance records a transfer Pylon places. A leg'stotalRemittedAmountis the money sent minus the money returned, corrections applied: aRETURN_RECEIVEDremittance records money that came back when a wire exceeded the figure, and aREMITTANCErecords money sent.remainingAmountis the current figure'snetAmountminus that total. A remittance is never edited: a mistaken one is corrected by Pylon with a later event for the exact negative amount that names the original throughcorrectsRemittanceId, and the original stays in the history. - Versions. Pylon records the inputs to a purchase figure as immutable versions (
FundingWireInInputVersion); recording changed inputs issues a new figure rather than altering an old one. To see the state as it was, passasOftofundingSettlement: the settlement, its figures, remittances and status are read as of that instant.
Loan
└─ fundingSettlement
├─ wireOut ─ figures (a new figure can supersede the current one) ─ lines
│ └─ remittances (each against one figure; corrections point back)
└─ wireIn ── the same shape; completing the purchase closes this leg only
When Pylon completes a wire-in purchase (completeWireInPurchase), settlementStatus becomes COMPLETED. After that the wire-in's current figure stays readable, but no new wire-in figures, transfers or corrections are accepted; wire-out is not closed by this. null is not zero: an amount that is null means the value is unavailable, not that nothing was transferred. Amounts are MonetaryAmount strings with two fractional digits, such as "500000.00". Recording a transfer in Pylon does not move money.
Meaning of each leg
| Field | wireOut |
wireIn |
|---|---|---|
Payment and recipient |
Payment to the closing settlement agent; recipient is the agent when known. | Purchase payment to the seller; recipient is the seller's legal name when known. |
Figure effective |
Calendar date Pylon used to price the wire-out figure. | Purchase date used for the figure. |
priced and disclosed |
Pricing date and the scheduled disbursement date captured from the closing disclosure; the disclosed date can be null or differ from the pricing date. | Both null. |
Remittance funds |
Bank-order time reported by your integration. | Time Pylon placed the purchase-payment order. |
availability: PENDING |
No active closing disclosure package has been observed. | No wire-in issuance has been attempted. |
settlement, completed, status |
Null status and completion time; empty status history. | Purchase status OPEN or COMPLETED, completion time when completed, and recorded status history. Status is null when funding is unavailable. |
retained |
NOT_. |
RETAINED, NOT_RETAINED, or UNKNOWN when the stored calculation cannot establish it. |
Date values are calendar dates in YYYY-MM-DD format. DateTime values are ISO-8601 instants with an offset. A remittance's recordedAt is when the API recorded it, which can differ from fundsOrderedAt. Verify the returned recipient against approved bank instructions; a name alone is not a source of bank instructions. Contact Pylon if the recipient is unknown.
Figure availability and purchase completion
READY means a current figure is available. PENDING means the leg is awaiting the prerequisite shown above. BLOCKED means an issuance was attempted but required figure inputs are missing or invalid. UNAVAILABLE means funding information is unavailable, for example because the company is not enabled or the loan is ineligible. Ask Pylon to investigate unexpected blocked or unavailable states.
A blocked issuance attempt withdraws the current figure: the leg stops being READY, and currentFigure, remainingAmount and balanceState are null until a usable figure is issued. Earlier figures and the transfers recorded against them stay readable through figures and remittances. Availability describes the figure, not bank receipt or purchase completion. On wire-in, OPEN permits further purchase activity; COMPLETED closes the purchase to new figures, remittances, and corrections while keeping the current figure readable. A zero remaining balance does not complete the purchase. Pylon records completion explicitly.
Amounts and reconciliation
MonetaryAmount values are exact USD decimal strings with two fractional digits, such as "500000.00". Preserve their precision; do not send a JSON number or integer cents where this scalar is required.
netAmount is the full figure amount, before subtracting transfers. totalRemittedAmount is the signed sum of the leg's recorded remittances and corrections, including events against earlier figures. remainingAmount is the current figure's netAmount minus that total. For example, "500000.00" less "200000.00" leaves "300000.00". balanceState says where recorded transfers stand against the current figure: OWED when they are below it, SETTLED when they equal it, and EXPECTED_RETURN when they exceed it. It is null exactly when remainingAmount is null. For EXPECTED_RETURN, expectedReturnAmount is the excess and is null in every other state. SETTLED does not mean the wire-in purchase is complete; read settlementStatus for that.
Null means unavailable or not applicable, not zero. Without a current figure, currentFigure and remainingAmount are null. An unavailable response with a zero total or empty history is not proof that no transfer occurred.
Use netAmount as the authoritative figure total and reconcile recorded transfers before deciding on an additional bank order. linesReconciliation reports whether its breakdown is RECONCILED, NON_RECONCILING, or UNAVAILABLE. Non-reconciling lines are still returned; unavailable breakdowns have empty lines and a linesUnavailableReason. Neither condition replaces the authoritative figure amount. Null items means itemization is unavailable, not that the parent line is zero. DELIVERY_FEE_CREDIT is the prepaid delivery-fee credit amount applied under your contract; sum its returned line amount once with the other signed lines.
Read the latest or a historical position
query Funding(: ID!, : DateTime) {
loan(id: ) {
id
fundingSettlement(asOf: ) {
asOf
wireOut {
availability
currentFigure { id netAmount effectiveDate recipientName }
totalRemittedAmount
remainingAmount
}
wireIn {
availability
settlementStatus
completedAt
currentFigure { id netAmount effectiveDate recipientName }
totalRemittedAmount
remainingAmount
}
}
}
}
Omit asOf for the latest position or provide an instant to read persisted figures, remittances, and purchase status at that cutoff. A remittance or correction appears according to its recordedAt, even if its order or accounting date is earlier. Keep those dates separate when reconciling a period. Use each leg's figures and figure(id:) to retrieve issued history, and confirm receipt against your bank records.
Queries
advisorCompletionJob
Response
Returns an AdvisorCompletionJob
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query advisorCompletionJob($id: ID!) {
advisorCompletionJob(id: $id) {
failureMessage
id
status
}
}
Variables
{"id": 4}
Response
{
"data": {
"advisorCompletionJob": {
"failureMessage": "xyz789",
"id": 4,
"status": "FAILED"
}
}
}
advisorSession
Response
Returns an AdvisorSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query advisorSession($id: ID!) {
advisorSession(id: $id) {
createdAt
id
messages {
...AdvisorSessionMessageFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"advisorSession": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"messages": [AdvisorSessionMessage]
}
}
}
advisorSessions
Response
Returns [AdvisorSession!]
Example
Query
query advisorSessions {
advisorSessions {
createdAt
id
messages {
...AdvisorSessionMessageFragment
}
}
}
Response
{
"data": {
"advisorSessions": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"messages": [AdvisorSessionMessage]
}
]
}
}
analytics
Description
Namespace for analytics queries. Analytics queries are for querying tabular data built from pre-aggregated API entities. The results can be consumed directly or exported in bulk to a file.
Response
Returns an Analytics
Example
Query
query analytics {
analytics {
job {
...AnalyticsExportJobFragment
}
loanApplicationMetrics {
...LoanApplicationAnalyticsMetricsFragment
}
loanApplications {
...LoanApplicationAnalyticsConnectionFragment
}
summary {
...PipelineSummaryResponseFragment
}
}
}
Response
{
"data": {
"analytics": {
"job": AnalyticsExportJob,
"loanApplicationMetrics": LoanApplicationAnalyticsMetrics,
"loanApplications": LoanApplicationAnalyticsConnection,
"summary": PipelineSummaryResponse
}
}
}
appraisal
Description
Appraisal queries.
Response
Returns an AppraisalQueries
Example
Query
query appraisal {
appraisal {
availableAmcs {
...AvailableAmcFragment
}
availableAppraisalTypes {
...AvailableAppraisalTypeFragment
}
}
}
Response
{
"data": {
"appraisal": {
"availableAmcs": [AvailableAmc],
"availableAppraisalTypes": [AvailableAppraisalType]
}
}
}
asset
Description
Get an asset by ID
Example
Query
query asset($id: ID!) {
asset(id: $id) {
amount
assetReportId
borrowerIds
borrowers {
...BorrowerFragment
}
dataSource
id
nonBorrowerOwnerNames
qualifiedAmount
verifiedAmount
}
}
Variables
{"id": "4"}
Response
{
"data": {
"asset": {
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"nonBorrowerOwnerNames": ["abc123"],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
}
}
assetTransaction
Description
Get an asset transaction by ID
Response
Returns an AssetTransaction
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query assetTransaction($id: ID!) {
assetTransaction(id: $id) {
amount
asset {
...AssetFragment
}
assetId
category
date
id
merchantName
}
}
Variables
{"id": "4"}
Response
{
"data": {
"assetTransaction": {
"amount": 123,
"asset": Asset,
"assetId": 4,
"category": ["xyz789"],
"date": "2007-12-03",
"id": "4",
"merchantName": "xyz789"
}
}
}
assetTransactions
Description
Get all transactions for an asset
Response
Returns [AssetTransaction!]!
Arguments
| Name | Description |
|---|---|
assetId - ID!
|
Example
Query
query assetTransactions($assetId: ID!) {
assetTransactions(assetId: $assetId) {
amount
asset {
...AssetFragment
}
assetId
category
date
id
merchantName
}
}
Variables
{"assetId": "4"}
Response
{
"data": {
"assetTransactions": [
{
"amount": 987,
"asset": Asset,
"assetId": "4",
"category": ["xyz789"],
"date": "2007-12-03",
"id": "4",
"merchantName": "xyz789"
}
]
}
}
assetVerification
Response
Returns an AssetVerificationQueries
Example
Query
query assetVerification {
assetVerification {
items {
...AssetVerificationItemFragment
}
links {
...AssetVerificationLinkSummaryFragment
}
}
}
Response
{
"data": {
"assetVerification": {
"items": [AssetVerificationItem],
"links": [AssetVerificationLinkSummary]
}
}
}
aus
Description
Fetch AUS information associated with a loan.
Response
Returns an Aus
Example
Query
query aus {
aus {
ausRequiredForLoan
ausRunJob {
...AusRunJobFragment
}
latestAusRunForLoan {
...AusRunJobFragment
}
}
}
Response
{
"data": {
"aus": {
"ausRequiredForLoan": true,
"ausRunJob": AusRunJob,
"latestAusRunForLoan": AusRunJob
}
}
}
auth
Description
Namespace for auth queries.
Response
Returns an AuthQueries
Example
Query
query auth {
auth {
impersonation {
...AuthImpersonationFragment
}
scopes
viewer {
...AuthViewerFragment
}
}
}
Response
{
"data": {
"auth": {
"impersonation": AuthImpersonation,
"scopes": ["xyz789"],
"viewer": AuthViewer
}
}
}
borrower
Description
Get a borrower by id
Example
Query
query borrower($id: ID!) {
borrower(id: $id) {
assets {
...AssetFragment
}
borrowerTasks {
...BorrowerTaskFragment
}
createdOn
credit {
...BorrowerCreditFragment
}
creditInquiries {
...CreditInquiryFragment
}
creditPullStatus
deal {
...DealFragment
}
demographicInfo {
...DemographicInfoFragment
}
dependentAges
econsentCaptureMethod
econsentStatus
emailVerified
employments {
...EmploymentFragment
}
externalUserId
financialDeclarations {
...BorrowerFinancialDeclarationsFragment
}
hardCreditConsentDate
hardCreditConsentType
id
incomeVerificationConsentDate
incomeVerificationConsentType
incomes {
...IncomeConnectionFragment
}
isFirstTimeHomeBuyer
liabilities {
...LiabilityConnectionFragment
}
mailingAddress {
...AddressFragment
}
maritalStatus
militaryService {
...BorrowerMilitaryServiceFragment
}
militaryServiceDeclaration {
... on MilitaryService {
...MilitaryServiceFragment
}
... on NoMilitaryService {
...NoMilitaryServiceFragment
}
}
ownedProperties {
...OwnedPropertyConnectionFragment
}
personalInformation {
...BorrowerPersonalInformationFragment
}
plaid {
...BorrowerPlaidFragment
}
pointOfContact
propertyDeclarations {
...BorrowerPropertyDeclarationsFragment
}
softCreditConsentDate
softCreditConsentType
spouse {
...BorrowerSpouseFragment
}
useOwnTitleCompany
}
}
Variables
{"id": "4"}
Response
{
"data": {
"borrower": {
"assets": [Asset],
"borrowerTasks": [BorrowerTask],
"createdOn": "2007-12-03T10:15:30Z",
"credit": BorrowerCredit,
"creditInquiries": [CreditInquiry],
"creditPullStatus": "COMPLETE",
"deal": Deal,
"demographicInfo": DemographicInfo,
"dependentAges": [987.65],
"econsentCaptureMethod": "ELECTRONIC",
"econsentStatus": "ACCEPT",
"emailVerified": true,
"employments": [Employment],
"externalUserId": "xyz789",
"financialDeclarations": BorrowerFinancialDeclarations,
"hardCreditConsentDate": "2007-12-03T10:15:30Z",
"hardCreditConsentType": "ELECTRONIC",
"id": 4,
"incomeVerificationConsentDate": "2007-12-03T10:15:30Z",
"incomeVerificationConsentType": "ELECTRONIC",
"incomes": IncomeConnection,
"isFirstTimeHomeBuyer": false,
"liabilities": LiabilityConnection,
"mailingAddress": Address,
"maritalStatus": "DIVORCED",
"militaryService": BorrowerMilitaryService,
"militaryServiceDeclaration": MilitaryService,
"ownedProperties": OwnedPropertyConnection,
"personalInformation": BorrowerPersonalInformation,
"plaid": BorrowerPlaid,
"pointOfContact": false,
"propertyDeclarations": BorrowerPropertyDeclarations,
"softCreditConsentDate": "2007-12-03T10:15:30Z",
"softCreditConsentType": "ELECTRONIC",
"spouse": BorrowerSpouse,
"useOwnTitleCompany": true
}
}
}
borrowerUser
Description
Fetch a user in an organization by id
Response
Returns a BorrowerUser
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query borrowerUser($id: ID!) {
borrowerUser(id: $id) {
id
loanApplications {
...BorrowerUserLoanApplicationSummaryFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"borrowerUser": {
"id": "4",
"loanApplications": [
BorrowerUserLoanApplicationSummary
]
}
}
}
commsSettings
Description
Get the comms settings for the current organization. Distinct from the per-template opt-ins: these govern when a communication is triggered, not which templates the customer receives.
Response
Returns a CommsSettings
Example
Query
query commsSettings {
commsSettings {
autoSendBorrowerPortalInvite
customerId
}
}
Response
{
"data": {
"commsSettings": {"autoSendBorrowerPortalInvite": false, "customerId": 4}
}
}
commsTemplate
Description
Get comms template by id
Response
Returns a CommsTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query commsTemplate($id: ID!) {
commsTemplate(id: $id) {
id
name
recipients
subject
template
}
}
Variables
{"id": 4}
Response
{
"data": {
"commsTemplate": {
"id": "4",
"name": "xyz789",
"recipients": ["BORROWER"],
"subject": "abc123",
"template": "abc123"
}
}
}
commsTemplates
Description
Get all comms templates
Response
Returns [CommsTemplate!]
Example
Query
query commsTemplates {
commsTemplates {
id
name
recipients
subject
template
}
}
Response
{
"data": {
"commsTemplates": [
{
"id": "4",
"name": "abc123",
"recipients": ["BORROWER"],
"subject": "xyz789",
"template": "xyz789"
}
]
}
}
company
Description
Get a company by ID
contributor
Response
Returns a Contributor
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query contributor($id: ID!) {
contributor(id: $id) {
contactInfo {
...ContributorContactInfoFragment
}
deals {
...DealConnectionFragment
}
disabledAt
displayName
id
role
roleId
}
}
Variables
{"id": 4}
Response
{
"data": {
"contributor": {
"contactInfo": ContributorContactInfo,
"deals": DealConnection,
"disabledAt": "2007-12-03T10:15:30Z",
"displayName": "abc123",
"id": "4",
"role": "abc123",
"roleId": "4"
}
}
}
contributorRoles
Response
Returns a ContributorRoleConnection
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query contributorRoles(
$after: String,
$before: String,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
contributorRoles(
after: $after,
before: $before,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...ContributorRoleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sortDirection": "ASC"
}
Response
{
"data": {
"contributorRoles": {
"edges": [ContributorRoleEdge],
"pageInfo": PageInfo
}
}
}
contributors
Response
Returns a ContributorConnection
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
filterBy - ContributorFilter
|
|
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query contributors(
$after: String,
$before: String,
$filterBy: ContributorFilter,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
contributors(
after: $after,
before: $before,
filterBy: $filterBy,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...ContributorEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"filterBy": ContributorFilter,
"first": 123,
"last": 987,
"sortDirection": "ASC"
}
Response
{
"data": {
"contributors": {
"edges": [ContributorEdge],
"pageInfo": PageInfo
}
}
}
credit
Description
Namespace for credit queries. These allow checking on the status of a credit pull and retrieving the credit report once the credit pull is complete.
Response
Returns a Credit
Example
Query
query credit {
credit {
job {
...CreditPullJobFragment
}
missingFieldsForCreditPull
report {
...CreditReportFragment
}
udnMonitors {
...UdnMonitorGqlFragment
}
}
}
Response
{
"data": {
"credit": {
"job": CreditPullJob,
"missingFieldsForCreditPull": ["BORROWER_CURRENT_ADDRESS"],
"report": CreditReport,
"udnMonitors": [UdnMonitorGql]
}
}
}
creditInquiry
Description
Get a credit inquiry by ID
Response
Returns a CreditInquiry
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query creditInquiry($id: ID!) {
creditInquiry(id: $id) {
creditBusinessType
creditInquiryResultType
date
detailCreditBusinessType
id
name
}
}
Variables
{"id": 4}
Response
{
"data": {
"creditInquiry": {
"creditBusinessType": "ADVERTISING",
"creditInquiryResultType": "ACCOUNT_CLOSED",
"date": "2007-12-03T10:15:30Z",
"detailCreditBusinessType": "ADVERTISING_AGENCIES",
"id": 4,
"name": "xyz789"
}
}
}
currentLoanOfficer
Description
The authenticated user's own GlobalLoanOfficer record, matched by Auth0 email within the current organization. Null when the caller is not a loan officer.
Response
Returns a GlobalLoanOfficer
Example
Query
query currentLoanOfficer {
currentLoanOfficer {
email
firstName
id
lastName
slug
status
statusChange {
...LoanOfficerStatusChangeFragment
}
statusHistory {
...LoanOfficerStatusChangeConnectionFragment
}
}
}
Response
{
"data": {
"currentLoanOfficer": {
"email": "xyz789",
"firstName": "abc123",
"id": 4,
"lastName": "abc123",
"slug": "abc123",
"status": "ACTIVE",
"statusChange": LoanOfficerStatusChange,
"statusHistory": LoanOfficerStatusChangeConnection
}
}
}
customerCommsOptIns
Description
Get customer comms opt-in status for the current organization
Response
Returns a CustomerCommsOptIns
Example
Query
query customerCommsOptIns {
customerCommsOptIns {
comms {
...CommsWithOptInStatusFragment
}
customerId
customerName
}
}
Response
{
"data": {
"customerCommsOptIns": {
"comms": [CommsWithOptInStatus],
"customerId": 4,
"customerName": "abc123"
}
}
}
deal
Description
Fetch a deal by id. A deal encapsulates the entire process of getting a mortgage, including situations such as concurrent financing where there could be multiple loans
Example
Query
query deal($id: ID!) {
deal(id: $id) {
borrowers {
...BorrowerConnectionFragment
}
creationTime
friendlyId
id
loans {
...LoanApplicationFragment
}
parties {
...PartyFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deal": {
"borrowers": BorrowerConnection,
"creationTime": "2007-12-03T10:15:30Z",
"friendlyId": "xyz789",
"id": 4,
"loans": [LoanApplication],
"parties": [Party]
}
}
}
deals
Description
List all deals
Response
Returns a DealConnection
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query deals(
$after: String,
$before: String,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
deals(
after: $after,
before: $before,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...DealEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"last": 987,
"sortDirection": "ASC"
}
Response
{
"data": {
"deals": {
"edges": [DealEdge],
"pageInfo": PageInfo
}
}
}
demoSeed
Response
Returns a DemoSeedQueries
Example
Query
query demoSeed {
demoSeed {
ausConditionScenarios {
...DemoAusConditionScenarioFragment
}
wireOutWorksheetScenarios {
...DemoWireOutWorksheetScenarioFragment
}
}
}
Response
{
"data": {
"demoSeed": {
"ausConditionScenarios": [DemoAusConditionScenario],
"wireOutWorksheetScenarios": [
DemoWireOutWorksheetScenario
]
}
}
}
disclosures
disclosuresHistory instead to grab all disclosures, including both recent and historical runs. Response
Returns a Disclosures
Arguments
| Name | Description |
|---|---|
loanId - String!
|
Example
Query
query disclosures($loanId: String!) {
disclosures(loanId: $loanId) {
adverseAction {
...DisclosureFragment
}
closingDisclosure {
...DisclosureFragment
}
initialDisclosure {
...DisclosureFragment
}
redisclosure {
...DisclosureFragment
}
}
}
Variables
{"loanId": "xyz789"}
Response
{
"data": {
"disclosures": {
"adverseAction": Disclosure,
"closingDisclosure": Disclosure,
"initialDisclosure": Disclosure,
"redisclosure": Disclosure
}
}
}
disclosuresHistory
Response
Returns a DisclosuresHistory
Arguments
| Name | Description |
|---|---|
loanId - ID!
|
Example
Query
query disclosuresHistory($loanId: ID!) {
disclosuresHistory(loanId: $loanId) {
disclosures {
...DisclosureFragment
}
}
}
Variables
{"loanId": 4}
Response
{
"data": {
"disclosuresHistory": {"disclosures": [Disclosure]}
}
}
disclosuresPreviews
Response
Returns a DisclosuresPreviews
Arguments
| Name | Description |
|---|---|
loanId - String!
|
Example
Query
query disclosuresPreviews($loanId: String!) {
disclosuresPreviews(loanId: $loanId) {
adverseAction {
...DisclosurePreviewFragment
}
closingDisclosure {
...DisclosurePreviewFragment
}
initialDisclosure {
...DisclosurePreviewFragment
}
redisclosure {
...DisclosurePreviewFragment
}
}
}
Variables
{"loanId": "abc123"}
Response
{
"data": {
"disclosuresPreviews": {
"adverseAction": DisclosurePreview,
"closingDisclosure": DisclosurePreview,
"initialDisclosure": DisclosurePreview,
"redisclosure": DisclosurePreview
}
}
}
disclosuresRunStatus
Description
Look up the status of an asynchronous disclosures run by its ID (e.g. the disclosuresRunId returned from floatStructure). Use this to observe whether an enqueued package was actually sent, is still processing, or failed — and, on failure, why.
Response
Returns a DisclosuresRunStatus!
Arguments
| Name | Description |
|---|---|
disclosuresRunId - ID!
|
Example
Query
query disclosuresRunStatus($disclosuresRunId: ID!) {
disclosuresRunStatus(disclosuresRunId: $disclosuresRunId) {
disclosuresRunId
documentLinks {
...DocumentLinkFragment
}
errors
failureCode
stage
status
}
}
Variables
{"disclosuresRunId": "4"}
Response
{
"data": {
"disclosuresRunStatus": {
"disclosuresRunId": 4,
"documentLinks": [DocumentLink],
"errors": ["xyz789"],
"failureCode": "xyz789",
"stage": "ADVERSE_ACTION_DISCLOSURES",
"status": "FAILED"
}
}
}
documentEvidence
Description
Document evidence queries.
Response
Returns a LoanDocumentQueries
Example
Query
query documentEvidence {
documentEvidence {
documentById {
...LoanDocumentFragment
}
}
}
Response
{
"data": {
"documentEvidence": {"documentById": LoanDocument}
}
}
documentIntake
Description
Per-file document-intake status queries.
Response
Returns a DocumentIntakeQueries
Example
Query
query documentIntake {
documentIntake {
fieldProvenance {
...FieldProvenanceFragment
}
seedOutcome {
...SeedOutcomeResponseFragment
}
seeding {
...DocumentSeedingFragment
}
status {
...DocumentIntakeStatusResponseFragment
}
}
}
Response
{
"data": {
"documentIntake": {
"fieldProvenance": [FieldProvenance],
"seedOutcome": SeedOutcomeResponse,
"seeding": DocumentSeeding,
"status": DocumentIntakeStatusResponse
}
}
}
eventLog
Description
Replay of the durable event log: page through your events after the last one you saw, or find the event to start after for a point in time.
Response
Returns an EventLogQueries
Example
Query
query eventLog {
eventLog {
cursorAt {
...PylonEventFragment
}
page {
...PylonEventPageFragment
}
}
}
Response
{
"data": {
"eventLog": {
"cursorAt": PylonEvent,
"page": PylonEventPage
}
}
}
events
Description
Query entity change events. Use the 'next' field to poll for subsequent changes. Changes to loans, borrowers and assets are reported as changes to that entity.
Response
Returns an EntityEventsResponse!
Arguments
| Name | Description |
|---|---|
since - String
|
The next cursor from the previous batch, or null to obtain a fresh cursor. |
Example
Query
query events($since: String) {
events(since: $since) {
batch {
...NodeChangedEventBatchFragment
}
next
}
}
Variables
{"since": "abc123"}
Response
{
"data": {
"events": {
"batch": NodeChangedEventBatch,
"next": "abc123"
}
}
}
exportOrganizationUsers
Description
Every user in the organization as a CSV file. Pylon internal admins only.
Response
Returns an OrganizationUserExport!
Example
Query
query exportOrganizationUsers {
exportOrganizationUsers {
expiresAt
filename
url
}
}
Response
{
"data": {
"exportOrganizationUsers": {
"expiresAt": "2007-12-03T10:15:30Z",
"filename": "abc123",
"url": "abc123"
}
}
}
extractDocument
Description
Document extraction queries.
Response
Returns an ExtractDocumentQueries
Example
Query
query extractDocument {
extractDocument {
status {
...ExtractDocumentStatusResponseFragment
}
}
}
Response
{
"data": {
"extractDocument": {
"status": ExtractDocumentStatusResponse
}
}
}
featureFlags
Description
Evaluate feature flags by name for the current customer
Response
Returns [FeatureFlagResult!]!
Arguments
| Name | Description |
|---|---|
names - [String!]!
|
Flag names to evaluate |
Example
Query
query featureFlags($names: [String!]!) {
featureFlags(names: $names) {
enabled
name
}
}
Variables
{"names": ["abc123"]}
Response
{
"data": {
"featureFlags": [
{"enabled": false, "name": "abc123"}
]
}
}
fee
Example
Query
query fee($id: ID!) {
fee(id: $id) {
escrowItemType
feeActualTotalAmount
feeDescription
feePaidToType
feePayments {
...FeePaymentFragment
}
feeSpecifiedFixedAmount
feeTotalPercent
feeType
id
integratedDisclosureSectionType
monthlyAmount
monthsPaid
paidTo {
...PaidToFragment
}
prepaidItemType
}
}
Variables
{"id": "4"}
Response
{
"data": {
"fee": {
"escrowItemType": "ASSESSMENT_TAX",
"feeActualTotalAmount": 123,
"feeDescription": "abc123",
"feePaidToType": "BROKER",
"feePayments": [FeePayment],
"feeSpecifiedFixedAmount": 123,
"feeTotalPercent": 123,
"feeType": "APPLICATION_FEE",
"id": 4,
"integratedDisclosureSectionType": "DUE_FROM_BORROWER_AT_CLOSING",
"monthlyAmount": 123,
"monthsPaid": 123,
"paidTo": PaidTo,
"prepaidItemType": "BOROUGH_PROPERTY_TAX"
}
}
}
feeSheet
Description
Fee sheet queries
Response
Returns a FeeSheetQueries
Example
Query
query feeSheet {
feeSheet {
feeSheetRequestStatus {
...FeeSheetRequestStatusFragment
}
}
}
Response
{
"data": {
"feeSheet": {
"feeSheetRequestStatus": FeeSheetRequestStatus
}
}
}
flood
Description
Namespace for flood queries. Allows checking the status of a flood determination order and retrieving its result once completed.
Response
Returns a FloodQueries
Example
Query
query flood {
flood {
floodOrder {
...FloodOrderFragment
}
}
}
Response
{"data": {"flood": {"floodOrder": FloodOrder}}}
funding
Description
Funding queries
Response
Returns a FundingQueries
Example
Query
query funding {
funding {
activity {
...FundingActivityPageFragment
}
prepaidBalance {
...FundingPrepaidBalanceFragment
}
}
}
Response
{
"data": {
"funding": {
"activity": FundingActivityPage,
"prepaidBalance": FundingPrepaidBalance
}
}
}
geography
Description
Namespace for geography queries. These allow querying state and county information needed for licensing and pre-approval.
Response
Returns a Geography
Example
Query
query geography {
geography {
place {
...PlaceDetailsFragment
}
placeAutocomplete {
...PlaceAutocompleteSuggestionFragment
}
usState {
...UsStateFragment
}
}
}
Response
{
"data": {
"geography": {
"place": PlaceDetails,
"placeAutocomplete": [PlaceAutocompleteSuggestion],
"usState": UsState
}
}
}
income
Description
Get an income by ID
Example
Query
query income($id: ID!) {
income(id: $id) {
amounts {
...IncomeAmountsFragment
}
averageHoursPerWeek
id
payPeriodFrequency
qualifiedAmount
statedAmount
statedMonthlyAmount
verifiedAmount
voieReportId
}
}
Variables
{"id": 4}
Response
{
"data": {
"income": {
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
}
}
incomeVerification
Response
Returns an IncomeVerificationQueries
Example
Query
query incomeVerification {
incomeVerification {
orders {
...IncomeVerificationOrderSummaryFragment
}
}
}
Response
{
"data": {
"incomeVerification": {
"orders": [IncomeVerificationOrderSummary]
}
}
}
liability
Description
Get a liabilitiy by ID
Example
Query
query liability($id: ID!) {
liability(id: $id) {
accountIdentifier
balance
bankName
borrowers {
...BorrowerFragment
}
createdOn
creditorName
exclusionReason
id
intent
lienPriorityType
monthlyPayment
ownedProperty {
...OwnedPropertyFragment
}
reportType
subjectProperty {
...SubjectPropertyFragment
}
type
}
}
Variables
{"id": "4"}
Response
{
"data": {
"liability": {
"accountIdentifier": "xyz789",
"balance": 123.45,
"bankName": "abc123",
"borrowers": [Borrower],
"createdOn": "2007-12-03T10:15:30Z",
"creditorName": "abc123",
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"id": "4",
"intent": "DO_NOTHING",
"lienPriorityType": "FIRST_LIEN",
"monthlyPayment": 123.45,
"ownedProperty": OwnedProperty,
"reportType": "CREDIT_REPORT",
"subjectProperty": SubjectProperty,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
}
}
loan
Description
Get a Loan by ID or by friendly ID
Example
Query
query loan($id: ID!) {
loan(id: $id) {
allowedStates
appraisal {
...AppraisalFragment
}
appraisalOrders {
...AppraisalOrderFragment
}
archiveDate
assignedLoanOfficer {
...LoanOfficerFragment
}
availableGlobalLoanOfficers {
...GlobalLoanOfficerFragment
}
availableLoanAssignments {
...LoanAssignmentUserFragment
}
borrowerPreferences {
...BorrowerPreferencesFragment
}
borrowers {
...BorrowerConnectionFragment
}
bulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
cashOutType
changeEventWordings {
...LoanChangeEventWordingFragment
}
changeRequests {
...LoanChangeRequestFragment
}
closingDate
concessions {
...ConcessionLogFragment
}
contacts {
...ContactFragment
}
currentStage
customerPointAdjustments {
...CustomerPointAdjustmentFragment
}
dealId
disclosureDrift {
... on DisclosureDriftAssessed {
...DisclosureDriftAssessedFragment
}
... on DisclosureDriftNoBaseline {
...DisclosureDriftNoBaselineFragment
}
}
disclosureSendAttention {
...DisclosureSendAttentionFragment
}
documents {
...DocumentFragment
}
dti
duplicateLiabilitySuggestions {
...DuplicateLiabilitySuggestionFragment
}
earnestMoneyDeposit
effectiveAppraisalWaiver
employmentsMissingStartDateCount
estimatedRatios {
...EstimatedLoanRatiosFragment
}
fees {
...FeeFragment
}
friendlyId
fundedDate
fundingSettlement {
...FundingSettlementFragment
}
getAutoConditionalApprovalStatus {
...GetAutoConditionalApprovalStatusResponseFragment
}
homeBuyingProcess
icdFieldHistory {
...IcdFieldHistoryFragment
}
icdReadiness {
...IcdReadinessFragment
}
id
intentToProceedDate
interestedPartyContributions {
...InterestedPartyContributionsFragment
}
isClosed
isFirstTimeHomebuyer
isFloated
isFrozen
lastPreApprovalRunAt
latestBulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
latestPreApprovalRunTime
latestSuccessfulBulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
legacyLoanStage
liabilities {
...LiabilityFragment
}
loanAssignments {
...LoanAssignmentFragment
}
loanChannel
loanContact {
...LoanContactFragment
}
loanDocuments {
...LoanDocumentFragment
}
loanNumber
loanOfficerDocumentTasks {
...LoanOfficerDocumentTaskFragment
}
loanProcess {
...LoanProcessFragment
}
loanPurpose
loanStatus
loanTermYears
lockReplacementChangeRequest {
...LockReplacementChangeRequestFragment
}
lockReplacementChangedCircumstanceReason
lockedSummary {
...LockedLoanSummaryFragment
}
ltv
maxLoanAmount
maxPurchasePrice
mismoImport {
...MismoImportFragment
}
nonBorrowingOwners {
...NonBorrowingOwnerFragment
}
nonBorrowingOwnersTaskStatus
noteRatePercent
orderOuts {
... on Appraisal {
...AppraisalFragment
}
... on Title {
...TitleFragment
}
}
organization {
...OrganizationFragment
}
outOfPocketMax
ownedProperties {
...OwnedPropertyFragment
}
pointOfContact {
...BorrowerFragment
}
preapprovalProduct {
...ProductFragment
}
pricingChangeFindings {
...PricingChangeFindingFragment
}
pricingFreshness {
...LoanPricingFreshnessFragment
}
productPricingRate {
...ProductPricingRateFragment
}
productStructure {
...ProductPricingRateFragment
}
productStructureDegraded {
...DegradedProductStructureFragment
}
purchasePrice
pylonApproved
rateLock {
...RateLockDetailsFragment
}
rateLockExtensionTerms {
...RateLockExtensionTermsFragment
}
rateLockHistory {
...RateLockHistoryConnectionFragment
}
rateLockTerm
realtorsTaskStatus
redisclosureFeeChanges {
...RedisclosureFeeChangeFragment
}
redisclosurePipelineRun {
...RedisclosurePipelineRunFragment
}
refinanceCashOutProceeds
requirementConversationSessions {
...RequirementConversationSessionConnectionFragment
}
sellerCredit
servicers {
...ContactFragment
}
stages {
...LoanStageFragment
}
subjectProperty {
...SubjectPropertyFragment
}
subjectPropertyFoundTaskStatus
subjectPropertyIntent {
...SubjectPropertyIntentFragment
}
systemOfRecordDti
title {
...TitleFragment
}
titleCompanyAttached
totalAssetsAvailable
tridTriggeredDate
underwritingSubmissionGate {
...UnderwritingSubmissionGateFragment
}
useOwnTitleCompany
}
}
Variables
{"id": "4"}
Response
{
"data": {
"loan": {
"allowedStates": ["AK"],
"appraisal": Appraisal,
"appraisalOrders": [AppraisalOrder],
"archiveDate": "2007-12-03T10:15:30Z",
"assignedLoanOfficer": LoanOfficer,
"availableGlobalLoanOfficers": [GlobalLoanOfficer],
"availableLoanAssignments": [LoanAssignmentUser],
"borrowerPreferences": BorrowerPreferences,
"borrowers": BorrowerConnection,
"bulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"cashOutType": "CASH_OUT",
"changeEventWordings": [LoanChangeEventWording],
"changeRequests": [LoanChangeRequest],
"closingDate": "2007-12-03",
"concessions": [ConcessionLog],
"contacts": [Contact],
"currentStage": "xyz789",
"customerPointAdjustments": CustomerPointAdjustment,
"dealId": "abc123",
"disclosureDrift": DisclosureDriftAssessed,
"disclosureSendAttention": DisclosureSendAttention,
"documents": [Document],
"dti": 123.45,
"duplicateLiabilitySuggestions": [
DuplicateLiabilitySuggestion
],
"earnestMoneyDeposit": 123.45,
"effectiveAppraisalWaiver": "AUTOMATED_COLLATERAL_EVALUATION",
"employmentsMissingStartDateCount": 987,
"estimatedRatios": EstimatedLoanRatios,
"fees": [Fee],
"friendlyId": "xyz789",
"fundedDate": "2007-12-03",
"fundingSettlement": FundingSettlement,
"getAutoConditionalApprovalStatus": GetAutoConditionalApprovalStatusResponse,
"homeBuyingProcess": "ACTIVELY_LOOKING",
"icdFieldHistory": IcdFieldHistory,
"icdReadiness": IcdReadiness,
"id": "4",
"intentToProceedDate": "2007-12-03",
"interestedPartyContributions": InterestedPartyContributions,
"isClosed": false,
"isFirstTimeHomebuyer": false,
"isFloated": true,
"isFrozen": true,
"lastPreApprovalRunAt": "2007-12-03T10:15:30Z",
"latestBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"latestPreApprovalRunTime": "2007-12-03T10:15:30Z",
"latestSuccessfulBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"legacyLoanStage": "xyz789",
"liabilities": [Liability],
"loanAssignments": [LoanAssignment],
"loanChannel": "Broker",
"loanContact": LoanContact,
"loanDocuments": [LoanDocument],
"loanNumber": "xyz789",
"loanOfficerDocumentTasks": [
LoanOfficerDocumentTask
],
"loanProcess": LoanProcess,
"loanPurpose": "PURCHASE",
"loanStatus": "abc123",
"loanTermYears": 123.45,
"lockReplacementChangeRequest": LockReplacementChangeRequest,
"lockReplacementChangedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"lockedSummary": LockedLoanSummary,
"ltv": 123.45,
"maxLoanAmount": 123.45,
"maxPurchasePrice": 123.45,
"mismoImport": MismoImport,
"nonBorrowingOwners": [NonBorrowingOwner],
"nonBorrowingOwnersTaskStatus": "COMPLETED",
"noteRatePercent": 123.45,
"orderOuts": [Appraisal],
"organization": Organization,
"outOfPocketMax": 123,
"ownedProperties": [OwnedProperty],
"pointOfContact": Borrower,
"preapprovalProduct": Product,
"pricingChangeFindings": [PricingChangeFinding],
"pricingFreshness": LoanPricingFreshness,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate,
"productStructureDegraded": DegradedProductStructure,
"purchasePrice": 123,
"pylonApproved": false,
"rateLock": RateLockDetails,
"rateLockExtensionTerms": RateLockExtensionTerms,
"rateLockHistory": RateLockHistoryConnection,
"rateLockTerm": 123,
"realtorsTaskStatus": "COMPLETED",
"redisclosureFeeChanges": [RedisclosureFeeChange],
"redisclosurePipelineRun": RedisclosurePipelineRun,
"refinanceCashOutProceeds": 123,
"requirementConversationSessions": RequirementConversationSessionConnection,
"sellerCredit": 123,
"servicers": [Contact],
"stages": [LoanStage],
"subjectProperty": SubjectProperty,
"subjectPropertyFoundTaskStatus": "COMPLETED",
"subjectPropertyIntent": SubjectPropertyIntent,
"systemOfRecordDti": 123.45,
"title": Title,
"titleCompanyAttached": false,
"totalAssetsAvailable": 123,
"tridTriggeredDate": "2007-12-03",
"underwritingSubmissionGate": UnderwritingSubmissionGate,
"useOwnTitleCompany": true
}
}
}
loanAssigneeHistory
Description
Who was assigned to a loan in the loan system, as a list of the loan's whole team each time it changed, oldest first. The loan system keeps no assignment history, so this starts from when braid began recording it for the loan: a loan with no snapshots has no recorded history, which says nothing about who was assigned.
Response
Returns [LoanAssigneeSnapshot!]!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The loan system's loan id (a UUID), not a Pylon loan id: loan(id:) takes those. Any other id is refused as an unknown loan. |
Example
Query
query loanAssigneeHistory($id: ID!) {
loanAssigneeHistory(id: $id) {
assignees {
...LoanAssigneeFragment
}
changedByReference
occurredAt
recordedAt
source
}
}
Variables
{"id": "4"}
Response
{
"data": {
"loanAssigneeHistory": [
{
"assignees": [LoanAssignee],
"changedByReference": "xyz789",
"occurredAt": "2007-12-03T10:15:30Z",
"recordedAt": "2007-12-03T10:15:30Z",
"source": "SEED"
}
]
}
}
loanByLoanNumber
Description
Get a Loan by its loan number
Example
Query
query loanByLoanNumber($loanNumber: Int!) {
loanByLoanNumber(loanNumber: $loanNumber) {
allowedStates
appraisal {
...AppraisalFragment
}
appraisalOrders {
...AppraisalOrderFragment
}
archiveDate
assignedLoanOfficer {
...LoanOfficerFragment
}
availableGlobalLoanOfficers {
...GlobalLoanOfficerFragment
}
availableLoanAssignments {
...LoanAssignmentUserFragment
}
borrowerPreferences {
...BorrowerPreferencesFragment
}
borrowers {
...BorrowerConnectionFragment
}
bulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
cashOutType
changeEventWordings {
...LoanChangeEventWordingFragment
}
changeRequests {
...LoanChangeRequestFragment
}
closingDate
concessions {
...ConcessionLogFragment
}
contacts {
...ContactFragment
}
currentStage
customerPointAdjustments {
...CustomerPointAdjustmentFragment
}
dealId
disclosureDrift {
... on DisclosureDriftAssessed {
...DisclosureDriftAssessedFragment
}
... on DisclosureDriftNoBaseline {
...DisclosureDriftNoBaselineFragment
}
}
disclosureSendAttention {
...DisclosureSendAttentionFragment
}
documents {
...DocumentFragment
}
dti
duplicateLiabilitySuggestions {
...DuplicateLiabilitySuggestionFragment
}
earnestMoneyDeposit
effectiveAppraisalWaiver
employmentsMissingStartDateCount
estimatedRatios {
...EstimatedLoanRatiosFragment
}
fees {
...FeeFragment
}
friendlyId
fundedDate
fundingSettlement {
...FundingSettlementFragment
}
getAutoConditionalApprovalStatus {
...GetAutoConditionalApprovalStatusResponseFragment
}
homeBuyingProcess
icdFieldHistory {
...IcdFieldHistoryFragment
}
icdReadiness {
...IcdReadinessFragment
}
id
intentToProceedDate
interestedPartyContributions {
...InterestedPartyContributionsFragment
}
isClosed
isFirstTimeHomebuyer
isFloated
isFrozen
lastPreApprovalRunAt
latestBulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
latestPreApprovalRunTime
latestSuccessfulBulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
legacyLoanStage
liabilities {
...LiabilityFragment
}
loanAssignments {
...LoanAssignmentFragment
}
loanChannel
loanContact {
...LoanContactFragment
}
loanDocuments {
...LoanDocumentFragment
}
loanNumber
loanOfficerDocumentTasks {
...LoanOfficerDocumentTaskFragment
}
loanProcess {
...LoanProcessFragment
}
loanPurpose
loanStatus
loanTermYears
lockReplacementChangeRequest {
...LockReplacementChangeRequestFragment
}
lockReplacementChangedCircumstanceReason
lockedSummary {
...LockedLoanSummaryFragment
}
ltv
maxLoanAmount
maxPurchasePrice
mismoImport {
...MismoImportFragment
}
nonBorrowingOwners {
...NonBorrowingOwnerFragment
}
nonBorrowingOwnersTaskStatus
noteRatePercent
orderOuts {
... on Appraisal {
...AppraisalFragment
}
... on Title {
...TitleFragment
}
}
organization {
...OrganizationFragment
}
outOfPocketMax
ownedProperties {
...OwnedPropertyFragment
}
pointOfContact {
...BorrowerFragment
}
preapprovalProduct {
...ProductFragment
}
pricingChangeFindings {
...PricingChangeFindingFragment
}
pricingFreshness {
...LoanPricingFreshnessFragment
}
productPricingRate {
...ProductPricingRateFragment
}
productStructure {
...ProductPricingRateFragment
}
productStructureDegraded {
...DegradedProductStructureFragment
}
purchasePrice
pylonApproved
rateLock {
...RateLockDetailsFragment
}
rateLockExtensionTerms {
...RateLockExtensionTermsFragment
}
rateLockHistory {
...RateLockHistoryConnectionFragment
}
rateLockTerm
realtorsTaskStatus
redisclosureFeeChanges {
...RedisclosureFeeChangeFragment
}
redisclosurePipelineRun {
...RedisclosurePipelineRunFragment
}
refinanceCashOutProceeds
requirementConversationSessions {
...RequirementConversationSessionConnectionFragment
}
sellerCredit
servicers {
...ContactFragment
}
stages {
...LoanStageFragment
}
subjectProperty {
...SubjectPropertyFragment
}
subjectPropertyFoundTaskStatus
subjectPropertyIntent {
...SubjectPropertyIntentFragment
}
systemOfRecordDti
title {
...TitleFragment
}
titleCompanyAttached
totalAssetsAvailable
tridTriggeredDate
underwritingSubmissionGate {
...UnderwritingSubmissionGateFragment
}
useOwnTitleCompany
}
}
Variables
{"loanNumber": 123}
Response
{
"data": {
"loanByLoanNumber": {
"allowedStates": ["AK"],
"appraisal": Appraisal,
"appraisalOrders": [AppraisalOrder],
"archiveDate": "2007-12-03T10:15:30Z",
"assignedLoanOfficer": LoanOfficer,
"availableGlobalLoanOfficers": [GlobalLoanOfficer],
"availableLoanAssignments": [LoanAssignmentUser],
"borrowerPreferences": BorrowerPreferences,
"borrowers": BorrowerConnection,
"bulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"cashOutType": "CASH_OUT",
"changeEventWordings": [LoanChangeEventWording],
"changeRequests": [LoanChangeRequest],
"closingDate": "2007-12-03",
"concessions": [ConcessionLog],
"contacts": [Contact],
"currentStage": "xyz789",
"customerPointAdjustments": CustomerPointAdjustment,
"dealId": "abc123",
"disclosureDrift": DisclosureDriftAssessed,
"disclosureSendAttention": DisclosureSendAttention,
"documents": [Document],
"dti": 123.45,
"duplicateLiabilitySuggestions": [
DuplicateLiabilitySuggestion
],
"earnestMoneyDeposit": 123.45,
"effectiveAppraisalWaiver": "AUTOMATED_COLLATERAL_EVALUATION",
"employmentsMissingStartDateCount": 123,
"estimatedRatios": EstimatedLoanRatios,
"fees": [Fee],
"friendlyId": "xyz789",
"fundedDate": "2007-12-03",
"fundingSettlement": FundingSettlement,
"getAutoConditionalApprovalStatus": GetAutoConditionalApprovalStatusResponse,
"homeBuyingProcess": "ACTIVELY_LOOKING",
"icdFieldHistory": IcdFieldHistory,
"icdReadiness": IcdReadiness,
"id": "4",
"intentToProceedDate": "2007-12-03",
"interestedPartyContributions": InterestedPartyContributions,
"isClosed": false,
"isFirstTimeHomebuyer": false,
"isFloated": true,
"isFrozen": true,
"lastPreApprovalRunAt": "2007-12-03T10:15:30Z",
"latestBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"latestPreApprovalRunTime": "2007-12-03T10:15:30Z",
"latestSuccessfulBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"legacyLoanStage": "abc123",
"liabilities": [Liability],
"loanAssignments": [LoanAssignment],
"loanChannel": "Broker",
"loanContact": LoanContact,
"loanDocuments": [LoanDocument],
"loanNumber": "abc123",
"loanOfficerDocumentTasks": [
LoanOfficerDocumentTask
],
"loanProcess": LoanProcess,
"loanPurpose": "PURCHASE",
"loanStatus": "xyz789",
"loanTermYears": 123.45,
"lockReplacementChangeRequest": LockReplacementChangeRequest,
"lockReplacementChangedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"lockedSummary": LockedLoanSummary,
"ltv": 123.45,
"maxLoanAmount": 123.45,
"maxPurchasePrice": 123.45,
"mismoImport": MismoImport,
"nonBorrowingOwners": [NonBorrowingOwner],
"nonBorrowingOwnersTaskStatus": "COMPLETED",
"noteRatePercent": 123.45,
"orderOuts": [Appraisal],
"organization": Organization,
"outOfPocketMax": 123,
"ownedProperties": [OwnedProperty],
"pointOfContact": Borrower,
"preapprovalProduct": Product,
"pricingChangeFindings": [PricingChangeFinding],
"pricingFreshness": LoanPricingFreshness,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate,
"productStructureDegraded": DegradedProductStructure,
"purchasePrice": 123,
"pylonApproved": false,
"rateLock": RateLockDetails,
"rateLockExtensionTerms": RateLockExtensionTerms,
"rateLockHistory": RateLockHistoryConnection,
"rateLockTerm": 123,
"realtorsTaskStatus": "COMPLETED",
"redisclosureFeeChanges": [RedisclosureFeeChange],
"redisclosurePipelineRun": RedisclosurePipelineRun,
"refinanceCashOutProceeds": 123,
"requirementConversationSessions": RequirementConversationSessionConnection,
"sellerCredit": 123,
"servicers": [Contact],
"stages": [LoanStage],
"subjectProperty": SubjectProperty,
"subjectPropertyFoundTaskStatus": "COMPLETED",
"subjectPropertyIntent": SubjectPropertyIntent,
"systemOfRecordDti": 123.45,
"title": Title,
"titleCompanyAttached": false,
"totalAssetsAvailable": 123,
"tridTriggeredDate": "2007-12-03",
"underwritingSubmissionGate": UnderwritingSubmissionGate,
"useOwnTitleCompany": true
}
}
}
loanEvents
Description
A loan's lifecycle events in append order, oldest first. Pass the returned next cursor back as after to page or poll.
Response
Returns a LoanEventsResponse!
Example
Query
query loanEvents(
$after: String,
$first: Int,
$loanId: ID!
) {
loanEvents(
after: $after,
first: $first,
loanId: $loanId
) {
events {
...LoanEventFragment
}
next
}
}
Variables
{
"after": "abc123",
"first": 25,
"loanId": 4
}
Response
{
"data": {
"loanEvents": {
"events": [LoanEvent],
"next": "abc123"
}
}
}
loanScript
Response
Returns a LoanScriptQueries
Example
Query
query loanScript {
loanScript {
all {
...LoanScriptFragment
}
byScenarioId {
...LoanScriptFragment
}
stepCatalog {
...LoanScriptStepCatalogEntryFragment
}
}
}
Response
{
"data": {
"loanScript": {
"all": [LoanScript],
"byScenarioId": LoanScript,
"stepCatalog": [LoanScriptStepCatalogEntry]
}
}
}
loans
Description
Get several Loans by ID in one request. Returns the loans the caller may read, in the order requested, with duplicates collapsed. A loan that does not exist or that the caller cannot access is OMITTED rather than returned as null or raised as an error: the response would otherwise distinguish 'no such loan' from 'not yours', which is exactly the existence check a batch endpoint must not hand out. Compare the returned ids against the ids sent to see what was dropped. At most 100 ids per request.
Example
Query
query loans($ids: [ID!]!) {
loans(ids: $ids) {
allowedStates
appraisal {
...AppraisalFragment
}
appraisalOrders {
...AppraisalOrderFragment
}
archiveDate
assignedLoanOfficer {
...LoanOfficerFragment
}
availableGlobalLoanOfficers {
...GlobalLoanOfficerFragment
}
availableLoanAssignments {
...LoanAssignmentUserFragment
}
borrowerPreferences {
...BorrowerPreferencesFragment
}
borrowers {
...BorrowerConnectionFragment
}
bulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
cashOutType
changeEventWordings {
...LoanChangeEventWordingFragment
}
changeRequests {
...LoanChangeRequestFragment
}
closingDate
concessions {
...ConcessionLogFragment
}
contacts {
...ContactFragment
}
currentStage
customerPointAdjustments {
...CustomerPointAdjustmentFragment
}
dealId
disclosureDrift {
... on DisclosureDriftAssessed {
...DisclosureDriftAssessedFragment
}
... on DisclosureDriftNoBaseline {
...DisclosureDriftNoBaselineFragment
}
}
disclosureSendAttention {
...DisclosureSendAttentionFragment
}
documents {
...DocumentFragment
}
dti
duplicateLiabilitySuggestions {
...DuplicateLiabilitySuggestionFragment
}
earnestMoneyDeposit
effectiveAppraisalWaiver
employmentsMissingStartDateCount
estimatedRatios {
...EstimatedLoanRatiosFragment
}
fees {
...FeeFragment
}
friendlyId
fundedDate
fundingSettlement {
...FundingSettlementFragment
}
getAutoConditionalApprovalStatus {
...GetAutoConditionalApprovalStatusResponseFragment
}
homeBuyingProcess
icdFieldHistory {
...IcdFieldHistoryFragment
}
icdReadiness {
...IcdReadinessFragment
}
id
intentToProceedDate
interestedPartyContributions {
...InterestedPartyContributionsFragment
}
isClosed
isFirstTimeHomebuyer
isFloated
isFrozen
lastPreApprovalRunAt
latestBulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
latestPreApprovalRunTime
latestSuccessfulBulkLoanDocumentsExportJob {
...BulkLoanDocumentsExportJobFragment
}
legacyLoanStage
liabilities {
...LiabilityFragment
}
loanAssignments {
...LoanAssignmentFragment
}
loanChannel
loanContact {
...LoanContactFragment
}
loanDocuments {
...LoanDocumentFragment
}
loanNumber
loanOfficerDocumentTasks {
...LoanOfficerDocumentTaskFragment
}
loanProcess {
...LoanProcessFragment
}
loanPurpose
loanStatus
loanTermYears
lockReplacementChangeRequest {
...LockReplacementChangeRequestFragment
}
lockReplacementChangedCircumstanceReason
lockedSummary {
...LockedLoanSummaryFragment
}
ltv
maxLoanAmount
maxPurchasePrice
mismoImport {
...MismoImportFragment
}
nonBorrowingOwners {
...NonBorrowingOwnerFragment
}
nonBorrowingOwnersTaskStatus
noteRatePercent
orderOuts {
... on Appraisal {
...AppraisalFragment
}
... on Title {
...TitleFragment
}
}
organization {
...OrganizationFragment
}
outOfPocketMax
ownedProperties {
...OwnedPropertyFragment
}
pointOfContact {
...BorrowerFragment
}
preapprovalProduct {
...ProductFragment
}
pricingChangeFindings {
...PricingChangeFindingFragment
}
pricingFreshness {
...LoanPricingFreshnessFragment
}
productPricingRate {
...ProductPricingRateFragment
}
productStructure {
...ProductPricingRateFragment
}
productStructureDegraded {
...DegradedProductStructureFragment
}
purchasePrice
pylonApproved
rateLock {
...RateLockDetailsFragment
}
rateLockExtensionTerms {
...RateLockExtensionTermsFragment
}
rateLockHistory {
...RateLockHistoryConnectionFragment
}
rateLockTerm
realtorsTaskStatus
redisclosureFeeChanges {
...RedisclosureFeeChangeFragment
}
redisclosurePipelineRun {
...RedisclosurePipelineRunFragment
}
refinanceCashOutProceeds
requirementConversationSessions {
...RequirementConversationSessionConnectionFragment
}
sellerCredit
servicers {
...ContactFragment
}
stages {
...LoanStageFragment
}
subjectProperty {
...SubjectPropertyFragment
}
subjectPropertyFoundTaskStatus
subjectPropertyIntent {
...SubjectPropertyIntentFragment
}
systemOfRecordDti
title {
...TitleFragment
}
titleCompanyAttached
totalAssetsAvailable
tridTriggeredDate
underwritingSubmissionGate {
...UnderwritingSubmissionGateFragment
}
useOwnTitleCompany
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"loans": [
{
"allowedStates": ["AK"],
"appraisal": Appraisal,
"appraisalOrders": [AppraisalOrder],
"archiveDate": "2007-12-03T10:15:30Z",
"assignedLoanOfficer": LoanOfficer,
"availableGlobalLoanOfficers": [
GlobalLoanOfficer
],
"availableLoanAssignments": [LoanAssignmentUser],
"borrowerPreferences": BorrowerPreferences,
"borrowers": BorrowerConnection,
"bulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"cashOutType": "CASH_OUT",
"changeEventWordings": [LoanChangeEventWording],
"changeRequests": [LoanChangeRequest],
"closingDate": "2007-12-03",
"concessions": [ConcessionLog],
"contacts": [Contact],
"currentStage": "abc123",
"customerPointAdjustments": CustomerPointAdjustment,
"dealId": "xyz789",
"disclosureDrift": DisclosureDriftAssessed,
"disclosureSendAttention": DisclosureSendAttention,
"documents": [Document],
"dti": 123.45,
"duplicateLiabilitySuggestions": [
DuplicateLiabilitySuggestion
],
"earnestMoneyDeposit": 123.45,
"effectiveAppraisalWaiver": "AUTOMATED_COLLATERAL_EVALUATION",
"employmentsMissingStartDateCount": 987,
"estimatedRatios": EstimatedLoanRatios,
"fees": [Fee],
"friendlyId": "xyz789",
"fundedDate": "2007-12-03",
"fundingSettlement": FundingSettlement,
"getAutoConditionalApprovalStatus": GetAutoConditionalApprovalStatusResponse,
"homeBuyingProcess": "ACTIVELY_LOOKING",
"icdFieldHistory": IcdFieldHistory,
"icdReadiness": IcdReadiness,
"id": 4,
"intentToProceedDate": "2007-12-03",
"interestedPartyContributions": InterestedPartyContributions,
"isClosed": true,
"isFirstTimeHomebuyer": false,
"isFloated": true,
"isFrozen": false,
"lastPreApprovalRunAt": "2007-12-03T10:15:30Z",
"latestBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"latestPreApprovalRunTime": "2007-12-03T10:15:30Z",
"latestSuccessfulBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"legacyLoanStage": "xyz789",
"liabilities": [Liability],
"loanAssignments": [LoanAssignment],
"loanChannel": "Broker",
"loanContact": LoanContact,
"loanDocuments": [LoanDocument],
"loanNumber": "abc123",
"loanOfficerDocumentTasks": [
LoanOfficerDocumentTask
],
"loanProcess": LoanProcess,
"loanPurpose": "PURCHASE",
"loanStatus": "abc123",
"loanTermYears": 123.45,
"lockReplacementChangeRequest": LockReplacementChangeRequest,
"lockReplacementChangedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"lockedSummary": LockedLoanSummary,
"ltv": 123.45,
"maxLoanAmount": 123.45,
"maxPurchasePrice": 123.45,
"mismoImport": MismoImport,
"nonBorrowingOwners": [NonBorrowingOwner],
"nonBorrowingOwnersTaskStatus": "COMPLETED",
"noteRatePercent": 123.45,
"orderOuts": [Appraisal],
"organization": Organization,
"outOfPocketMax": 123,
"ownedProperties": [OwnedProperty],
"pointOfContact": Borrower,
"preapprovalProduct": Product,
"pricingChangeFindings": [PricingChangeFinding],
"pricingFreshness": LoanPricingFreshness,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate,
"productStructureDegraded": DegradedProductStructure,
"purchasePrice": 123,
"pylonApproved": false,
"rateLock": RateLockDetails,
"rateLockExtensionTerms": RateLockExtensionTerms,
"rateLockHistory": RateLockHistoryConnection,
"rateLockTerm": 123,
"realtorsTaskStatus": "COMPLETED",
"redisclosureFeeChanges": [RedisclosureFeeChange],
"redisclosurePipelineRun": RedisclosurePipelineRun,
"refinanceCashOutProceeds": 123,
"requirementConversationSessions": RequirementConversationSessionConnection,
"sellerCredit": 123,
"servicers": [Contact],
"stages": [LoanStage],
"subjectProperty": SubjectProperty,
"subjectPropertyFoundTaskStatus": "COMPLETED",
"subjectPropertyIntent": SubjectPropertyIntent,
"systemOfRecordDti": 123.45,
"title": Title,
"titleCompanyAttached": false,
"totalAssetsAvailable": 123,
"tridTriggeredDate": "2007-12-03",
"underwritingSubmissionGate": UnderwritingSubmissionGate,
"useOwnTitleCompany": false
}
]
}
}
marketingRates
Description
Namespace for marketing rates queries. Marketing rates take simple borrower profiles and determine the best rates that borrower could get for various loan products.
Response
Returns a MarketingRates
Example
Query
query marketingRates {
marketingRates {
conforming {
...ConformingMarketingRateFragment
}
custom {
...CustomMarketingRateFragment
}
fha {
...FhaMarketingRateFragment
}
jumbo {
...JumboMarketingRateFragment
}
warehousingCosts {
...WarehousingCostsFragment
}
}
}
Response
{
"data": {
"marketingRates": {
"conforming": [ConformingMarketingRate],
"custom": [CustomMarketingRate],
"fha": [FhaMarketingRate],
"jumbo": [JumboMarketingRate],
"warehousingCosts": WarehousingCosts
}
}
}
mismoImport
Description
A MISMO import by id. Null when the id is unknown, when the retention sweep has already removed the import — it is kept for 24 hours — or when it belongs to a loan the caller may not read. The three are deliberately indistinguishable: telling them apart would confirm to an unauthorized caller that a particular import exists.
Response
Returns a MismoImport
Arguments
| Name | Description |
|---|---|
id - ID!
|
The import's id. |
Example
Query
query mismoImport($id: ID!) {
mismoImport(id: $id) {
id
importedAt
loan {
...LoanFragment
}
nonAdoptions {
...MismoNonAdoptionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"mismoImport": {
"id": 4,
"importedAt": "2007-12-03T10:15:30Z",
"loan": Loan,
"nonAdoptions": [MismoNonAdoption]
}
}
}
node
Description
Get an entity by ID
nonBorrowingOwner
Response
Returns a NonBorrowingOwner
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query nonBorrowingOwner($id: ID!) {
nonBorrowingOwner(id: $id) {
id
personalInformation {
...PersonalInformationFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"nonBorrowingOwner": {
"id": 4,
"personalInformation": PersonalInformation
}
}
}
omniLoanApplications
Description
The loan pipeline across every customer, for the omni-customer view. Reachable only from a session whose view scope is ALL_CUSTOMERS (entered via OmniViewMiddleware, which requires use:pylon-internal-admin and canMasquerade, re-verified on every request); denied otherwise. Each row carries organizationName alongside the existing organizationId so a UI merging rows from several customers can label them.
Response
Returns a LoanApplicationAnalyticsConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
A cursor value that indicates the position after which items should be returned. Typically this should be the 'endCursor' of the previous page. |
before - String
|
A cursor value that indicates the position before which items should be returned. Typically this should be the 'startCursor' of the following page. |
filters - LoanApplicationAnalyticsFilters
|
|
first - Int
|
The number of items to be retrieved for forward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
last - Int
|
The number of items to be retrieved for backward pagination. Either 'first' or 'last' must be specified, but not both. This value must be between 1 and 500. |
sortDirection - SortDirection
|
The direction in which the results should be sorted. Defaults to ASC. |
Example
Query
query omniLoanApplications(
$after: String,
$before: String,
$filters: LoanApplicationAnalyticsFilters,
$first: Int,
$last: Int,
$sortDirection: SortDirection
) {
omniLoanApplications(
after: $after,
before: $before,
filters: $filters,
first: $first,
last: $last,
sortDirection: $sortDirection
) {
edges {
...LoanApplicationAnalyticsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"filters": LoanApplicationAnalyticsFilters,
"first": 987,
"last": 987,
"sortDirection": "ASC"
}
Response
{
"data": {
"omniLoanApplications": {
"edges": [LoanApplicationAnalyticsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
omniLoanApplicationsSummary
Description
Per-stage/status loan counts across every customer, for the omni-customer view. Applies the identical ALL_CUSTOMERS gate and mandatory-assignment-allowlist rule as omniLoanApplications, each resolved independently per request: the two calls apply the same scoping RULE, not a shared snapshot of it, so a Pipeline page's table and its stage counters can disagree if the allowlist changes in the (millisecond) window between the two round trips.
Response
Returns a PipelineSummaryResponse!
Arguments
| Name | Description |
|---|---|
counters - [PipelineSummaryCounter!]!
|
Example
Query
query omniLoanApplicationsSummary($counters: [PipelineSummaryCounter!]!) {
omniLoanApplicationsSummary(counters: $counters) {
counts {
...PipelineSummaryItemFragment
}
totalCount
}
}
Variables
{"counters": [PipelineSummaryCounter]}
Response
{
"data": {
"omniLoanApplicationsSummary": {
"counts": [PipelineSummaryItem],
"totalCount": 987.65
}
}
}
orgEvents
Description
The organization's loan-lifecycle events across all its loans, in append order. Scoped to the caller's organization; since bounds results to events that occurred at or after the given instant.
Response
Returns a LoanEventsResponse!
Arguments
| Name | Description |
|---|---|
after - String
|
The next cursor from the previous page, or null to start from the beginning of the organization's history. |
first - Int
|
Maximum number of events to return (capped server-side). Default = 25 |
since - DateTimeISO
|
Only return events that occurred at or after this instant. Applies to domain time (occurredAt), not recording time. |
Example
Query
query orgEvents(
$after: String,
$first: Int,
$since: DateTimeISO
) {
orgEvents(
after: $after,
first: $first,
since: $since
) {
events {
...LoanEventFragment
}
next
}
}
Variables
{
"after": "abc123",
"first": 25,
"since": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"orgEvents": {
"events": [LoanEvent],
"next": "xyz789"
}
}
}
organization
Description
Get the current organization.
Response
Returns an Organization
Example
Query
query organization {
organization {
accountStatus
accountStatusChange {
...OrganizationAccountStatusChangeFragment
}
apiAccessStatus
availableCustomers {
...CustomerMembershipFragment
}
borrowerPortalUrl
branding {
...OrganizationBrandingFragment
}
companyAddress {
...AddressFragment
}
companyLegalName
companyName
companySupportEmail
concessionLimitPerLoan
contacts {
...ContactFragment
}
costAbsorption {
...CostAbsorptionFragment
}
customerShare
customerSlug
defaultLoanChannel
defaultPrimaryLoanContact {
...LoanContactFragment
}
defaultPrimaryLoanContactFallbackEmail
effectiveMargin {
...OrganizationMarginFragment
}
electronicCommunicationsConsentUrl
emailDomains
enableSso
enabledLoanProducts
enabledPlaidProducts
feeHistory {
...OrganizationFeeScheduleFragment
}
fees {
...OrganizationFeeFragment
}
id
legalEntityGroup
loanOfficers {
...GlobalLoanOfficerConnectionFragment
}
loanProductAvailability {
...LoanProductAvailabilityFragment
}
margin
marginBreakdown {
...MarginSplitFragment
}
marginHistory {
...OrganizationMarginFragment
}
masqueradableCustomers {
...CustomerMembershipFragment
}
mersOrgId
multiInstanceLoanOfficers
multiInstanceLoanOfficersChange {
...OrganizationSettingChangeFragment
}
multiInstanceLoanOfficersGroup {
...MultiInstanceLoanOfficersGroupMemberFragment
}
nmlsId
privacyPolicyUrl
share
telephonicCommunicationsConsentEnabled
telephonicCommunicationsConsentUrl
termsOfServiceUrl
underwritingCostRecovery {
...UnderwritingCostRecoveryFragment
}
underwritingGateThresholds {
...UnderwritingGateThresholdsFragment
}
}
}
Response
{
"data": {
"organization": {
"accountStatus": "ACTIVE",
"accountStatusChange": OrganizationAccountStatusChange,
"apiAccessStatus": "ACTIVE",
"availableCustomers": [CustomerMembership],
"borrowerPortalUrl": "abc123",
"branding": OrganizationBranding,
"companyAddress": Address,
"companyLegalName": "xyz789",
"companyName": "xyz789",
"companySupportEmail": "abc123",
"concessionLimitPerLoan": 987.65,
"contacts": [Contact],
"costAbsorption": [CostAbsorption],
"customerShare": 123.45,
"customerSlug": "xyz789",
"defaultLoanChannel": "Broker",
"defaultPrimaryLoanContact": LoanContact,
"defaultPrimaryLoanContactFallbackEmail": "abc123",
"effectiveMargin": OrganizationMargin,
"electronicCommunicationsConsentUrl": "abc123",
"emailDomains": ["abc123"],
"enableSso": false,
"enabledLoanProducts": ["BayviewBayviewJumboAus"],
"enabledPlaidProducts": ["ASSETS"],
"feeHistory": [OrganizationFeeSchedule],
"fees": [OrganizationFee],
"id": 4,
"legalEntityGroup": "xyz789",
"loanOfficers": GlobalLoanOfficerConnection,
"loanProductAvailability": [
LoanProductAvailability
],
"margin": 987.65,
"marginBreakdown": MarginSplit,
"marginHistory": [OrganizationMargin],
"masqueradableCustomers": [CustomerMembership],
"mersOrgId": 987,
"multiInstanceLoanOfficers": "OFF",
"multiInstanceLoanOfficersChange": OrganizationSettingChange,
"multiInstanceLoanOfficersGroup": [
MultiInstanceLoanOfficersGroupMember
],
"nmlsId": "abc123",
"privacyPolicyUrl": "abc123",
"share": 123.45,
"telephonicCommunicationsConsentEnabled": true,
"telephonicCommunicationsConsentUrl": "xyz789",
"termsOfServiceUrl": "xyz789",
"underwritingCostRecovery": UnderwritingCostRecovery,
"underwritingGateThresholds": UnderwritingGateThresholds
}
}
}
organizationLicensing
Description
Get licensing information for the current organization.
Response
Returns an OrganizationLicensing
Example
Query
query organizationLicensing {
organizationLicensing {
states {
...OrganizationStateWithLicensesFragment
}
}
}
Response
{
"data": {
"organizationLicensing": {
"states": [OrganizationStateWithLicenses]
}
}
}
organizationRole
Description
Fetch a role in an organization by id
Response
Returns an OrganizationRole
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query organizationRole($id: ID!) {
organizationRole(id: $id) {
description
id
name
permissions
}
}
Variables
{"id": "4"}
Response
{
"data": {
"organizationRole": {
"description": "abc123",
"id": "4",
"name": "abc123",
"permissions": ["abc123"]
}
}
}
organizationRoles
Description
List roles in an organization
Response
Returns an OrganizationRoleConnection
Example
Query
query organizationRoles(
$after: ID,
$first: Int
) {
organizationRoles(
after: $after,
first: $first
) {
edges {
...OrganizationRoleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{"after": null, "first": 100}
Response
{
"data": {
"organizationRoles": {
"edges": [OrganizationRoleEdge],
"pageInfo": PageInfo
}
}
}
organizationUser
Description
Fetch a user in an organization by id
Response
Returns an OrganizationUser
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query organizationUser($id: ID!) {
organizationUser(id: $id) {
companyName
email
firstName
id
individualNmlsId
lastName
licenses {
...OrganizationUserLicenseFragment
}
organizationRoles {
...OrganizationRoleFragment
}
phoneNumber
processorFeeAmount
}
}
Variables
{"id": 4}
Response
{
"data": {
"organizationUser": {
"companyName": "xyz789",
"email": "xyz789",
"firstName": "abc123",
"id": "4",
"individualNmlsId": "abc123",
"lastName": "abc123",
"licenses": [OrganizationUserLicense],
"organizationRoles": [OrganizationRole],
"phoneNumber": "abc123",
"processorFeeAmount": 123.45
}
}
}
organizationUsers
Description
List users in an organization
Response
Returns an OrganizationUserConnection
Example
Query
query organizationUsers(
$after: ID,
$first: Int
) {
organizationUsers(
after: $after,
first: $first
) {
edges {
...OrganizationUserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{"after": null, "first": 100}
Response
{
"data": {
"organizationUsers": {
"edges": [OrganizationUserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
ownedProperty
Description
Get an owned property by ID
Response
Returns an OwnedProperty
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query ownedProperty($id: ID!) {
ownedProperty(id: $id) {
address {
...AddressFragment
}
createdOn
currentUsageType
homeInsuranceMonthlyPayment
id
intendedDisposition
intendedUsageType
liabilities {
...LiabilityFragment
}
monthlyAssociationDues
mortgageInsuranceMonthlyPayment
neighborhoodHousingType
nonBorrowingOwners {
...NonBorrowingOwnerFragment
}
pendingNetSaleProceedsAsset {
...AssetFragment
}
propertyTaxMonthlyPayment
propertyValue
purchaseDate
rentalIncome {
...IncomeFragment
}
sellDate
}
}
Variables
{"id": "4"}
Response
{
"data": {
"ownedProperty": {
"address": Address,
"createdOn": "2007-12-03T10:15:30Z",
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"id": 4,
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"liabilities": [Liability],
"monthlyAssociationDues": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"nonBorrowingOwners": [NonBorrowingOwner],
"pendingNetSaleProceedsAsset": Asset,
"propertyTaxMonthlyPayment": 123,
"propertyValue": 123,
"purchaseDate": "2007-12-03",
"rentalIncome": Income,
"sellDate": "2007-12-03"
}
}
}
party
Example
Query
query party($id: ID!) {
party(id: $id) {
address {
...AddressFragment
}
id
individual {
...PartyIndividualFragment
}
legalEntity {
...PartyLegalEntityFragment
}
role
}
}
Variables
{"id": 4}
Response
{
"data": {
"party": {
"address": Address,
"id": 4,
"individual": PartyIndividual,
"legalEntity": PartyLegalEntity,
"role": "APPRAISER"
}
}
}
preQualification
Description
Namespace for pre-qualification queries. These queries allow fetching previously created pre-qualifications
Response
Returns a PreQualification
Example
Query
query preQualification {
preQualification {
conventional {
...ConventionalPreQualificationFragment
}
debug {
...PreQualificationProductResultFragment
}
}
}
Response
{
"data": {
"preQualification": {
"conventional": ConventionalPreQualification,
"debug": [PreQualificationProductResult]
}
}
}
pricing
Description
Namespace for pricing queries. These queries are for experimenting with various pricing scenarios, for example comparing products or understanding how concession points influence the downpayment and rate.
Response
Returns a Pricing
Example
Query
query pricing {
pricing {
dumpParameters {
...ProductPricingParameterDumpFragment
}
fixedLoanAmountProductPricing {
...ProductPricingQueryFragment
}
optimalStructure {
...OptimalStructureFragment
}
productPricing {
...ProductPricingQueryFragment
}
}
}
Response
{
"data": {
"pricing": {
"dumpParameters": ProductPricingParameterDump,
"fixedLoanAmountProductPricing": ProductPricingQuery,
"optimalStructure": OptimalStructure,
"productPricing": ProductPricingQuery
}
}
}
pricingChangeQueue
Description
The open pricing change findings of the customer being viewed, or of every customer in the all-customers view, soonest deadline first. Null, with an error, when the findings cannot be read. Restricted to internal Pylon operators.
Response
Returns a PricingChangeQueue
Example
Query
query pricingChangeQueue {
pricingChangeQueue {
findings {
...OpenPricingChangeFindingFragment
}
unlisted
}
}
Response
{
"data": {
"pricingChangeQueue": {
"findings": [OpenPricingChangeFinding],
"unlisted": 987
}
}
}
processDocument
Description
Process-document (split) queries.
Response
Returns a ProcessDocumentQueries
Example
Query
query processDocument {
processDocument {
status {
...ProcessDocumentStatusResponseFragment
}
}
}
Response
{
"data": {
"processDocument": {
"status": ProcessDocumentStatusResponse
}
}
}
productDeliveryCommitments
Description
Each product's delivery commitment (mandatory or best efforts) and its history. Pylon super-admins only.
Response
Returns a ProductDeliveryCommitmentsQueries
Example
Query
query productDeliveryCommitments {
productDeliveryCommitments {
products {
...ProductDeliveryCommitmentFragment
}
}
}
Response
{
"data": {
"productDeliveryCommitments": {
"products": [ProductDeliveryCommitment]
}
}
}
productRelockPolicies
Description
Relock pricing configuration: each product's net price cap with its history, and the relock fee policy in force with its history. Pylon super-admins only.
Response
Returns a ProductRelockPoliciesQueries
Example
Query
query productRelockPolicies {
productRelockPolicies {
products {
...ProductRelockPolicyFragment
}
relockFeePolicyHistory {
...RelockFeePolicyFragment
}
relockFeePolicyInForce {
...RelockFeePolicyFragment
}
}
}
Response
{
"data": {
"productRelockPolicies": {
"products": [ProductRelockPolicy],
"relockFeePolicyHistory": [RelockFeePolicy],
"relockFeePolicyInForce": RelockFeePolicy
}
}
}
rateLockExtensionPolicies
Description
Rate lock extension policies. Pylon super-admins only.
Response
Returns a RateLockExtensionPolicyQueries
Example
Query
query rateLockExtensionPolicies {
rateLockExtensionPolicies {
current {
...RateLockExtensionPolicyFragment
}
history {
...RateLockExtensionPolicyConnectionFragment
}
productPolicies {
...ProductRateLockExtensionPolicyFragment
}
}
}
Response
{
"data": {
"rateLockExtensionPolicies": {
"current": [RateLockExtensionPolicy],
"history": RateLockExtensionPolicyConnection,
"productPolicies": [ProductRateLockExtensionPolicy]
}
}
}
rates
Description
Namespace for fetching data associated with raw rates.
Response
Returns a Rates
Example
Query
query rates {
rates {
apor {
...AporFragment
}
}
}
Response
{"data": {"rates": {"apor": Apor}}}
recentlyViewedLoans
Description
Loans the current user most recently viewed within their active organization, newest first. Empty for callers without an org-user identity.
Response
Returns [RecentlyViewedLoan!]!
Arguments
| Name | Description |
|---|---|
first - Int
|
Maximum number of loans to return (capped server-side). Default = 25 |
Example
Query
query recentlyViewedLoans($first: Int) {
recentlyViewedLoans(first: $first) {
contactPointFullName
currentStage
friendlyLoanId
loan {
...LoanFragment
}
loanId
loanNumber
viewedAt
}
}
Variables
{"first": 25}
Response
{
"data": {
"recentlyViewedLoans": [
{
"contactPointFullName": "abc123",
"currentStage": "xyz789",
"friendlyLoanId": "abc123",
"loan": Loan,
"loanId": 4,
"loanNumber": "xyz789",
"viewedAt": "2007-12-03T10:15:30Z"
}
]
}
}
scenario
Response
Returns a Scenario
Example
Query
query scenario {
scenario {
fixedLoanAmountPurchasePricing {
...ProductPricingQueryFragment
}
pricing {
...ProductPricingQueryFragment
}
purchasePricing {
...ProductPricingQueryFragment
}
purchasePricingNoRestructure {
...ProductPricingQueryFragment
}
refinancePricing {
...ProductPricingQueryFragment
}
}
}
Response
{
"data": {
"scenario": {
"fixedLoanAmountPurchasePricing": ProductPricingQuery,
"pricing": ProductPricingQuery,
"purchasePricing": ProductPricingQuery,
"purchasePricingNoRestructure": ProductPricingQuery,
"refinancePricing": ProductPricingQuery
}
}
}
subjectProperty
Response
Returns a SubjectProperty
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query subjectProperty($id: ID!) {
subjectProperty(id: $id) {
address {
...AddressFragment
}
attachmentType
avmEstimatedValue
avmProvider
borrowerSpecifiedMonthlyPropertyTaxes
firstLienAmount
firstLienLiability {
...LiabilityFragment
}
firstLienLiabilityId
hoaDues
homeInsuranceMonthlyAmount
homeInsuranceMonthlyAmountEstimate
id
isManufacturedHome
isMixedUse
isPlannedUnitDevelopment
liabilities {
...LiabilityFragment
}
manuallyEstimatedValue
monthlyPropertyTaxesEstimate
neighborhoodHousingType
numberOfUnits
propertyTaxesAndInsuranceIncludedInPayment
rentalEstimatedGrossMonthlyRentAmount
rentalIncomeAmounts {
...IncomeAmountsFragment
}
rentalStatus
subjectPropertyIntent {
...SubjectPropertyIntentFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"subjectProperty": {
"address": Address,
"attachmentType": "ATTACHED",
"avmEstimatedValue": 123,
"avmProvider": "xyz789",
"borrowerSpecifiedMonthlyPropertyTaxes": 123,
"firstLienAmount": 123,
"firstLienLiability": Liability,
"firstLienLiabilityId": 4,
"hoaDues": 123,
"homeInsuranceMonthlyAmount": 123,
"homeInsuranceMonthlyAmountEstimate": 123.45,
"id": 4,
"isManufacturedHome": false,
"isMixedUse": false,
"isPlannedUnitDevelopment": true,
"liabilities": [Liability],
"manuallyEstimatedValue": 123,
"monthlyPropertyTaxesEstimate": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"propertyTaxesAndInsuranceIncludedInPayment": false,
"rentalEstimatedGrossMonthlyRentAmount": 123,
"rentalIncomeAmounts": IncomeAmounts,
"rentalStatus": "LEASED",
"subjectPropertyIntent": SubjectPropertyIntent
}
}
}
subjectPropertyIntent
Description
Get a SubjectPropertyIntent by ID
Response
Returns a SubjectPropertyIntent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query subjectPropertyIntent($id: ID!) {
subjectPropertyIntent(id: $id) {
county {
...CountyFragment
}
id
isPlannedUnitDevelopment
neighborhoodHousingType
propertyUsageType
state
}
}
Variables
{"id": "4"}
Response
{
"data": {
"subjectPropertyIntent": {
"county": County,
"id": "4",
"isPlannedUnitDevelopment": false,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"state": "AK"
}
}
}
support
Description
Namespace for support queries.
Response
Returns a SupportQueries
Example
Query
query support {
support {
issueTypes {
...SupportIssueTypeFragment
}
pylonTeam {
...PylonTeamFragment
}
supportTicket {
...SupportTicketFragment
}
supportTicketMessages {
...SupportTicketMessageFragment
}
supportTickets {
...SupportTicketConnectionFragment
}
supportTicketsForLoan {
...SupportTicketFragment
}
}
}
Response
{
"data": {
"support": {
"issueTypes": [SupportIssueType],
"pylonTeam": PylonTeam,
"supportTicket": SupportTicket,
"supportTicketMessages": [SupportTicketMessage],
"supportTickets": SupportTicketConnection,
"supportTicketsForLoan": [SupportTicket]
}
}
}
supportAdmin
Description
Namespace for Pylon-internal support administration queries.
Response
Returns a SupportAdminQueries
Example
Query
query supportAdmin {
supportAdmin {
issueTypes {
...SupportAdminIssueTypeFragment
}
}
}
Response
{
"data": {
"supportAdmin": {
"issueTypes": [SupportAdminIssueType]
}
}
}
titleVendors
Response
Returns [TitleVendor!]!
Arguments
| Name | Description |
|---|---|
input - TitleVendorsInput!
|
Example
Query
query titleVendors($input: TitleVendorsInput!) {
titleVendors(input: $input) {
contactInfo {
...TitleVendorContactInfoFragment
}
name
relationType
}
}
Variables
{"input": TitleVendorsInput}
Response
{
"data": {
"titleVendors": [
{
"contactInfo": TitleVendorContactInfo,
"name": "xyz789",
"relationType": "CLOSING_ONLY"
}
]
}
}
trackedChanges
Description
Experimental: needs the use:experimental-api scope, and its shape can still change. Query entity change events of every tracked kind. Use the 'next' field to poll for subsequent changes. Changes to loans, borrowers and assets are reported as changes to that entity. So are changes to incomes, employments, liabilities, owned properties, subject properties, subject property intents, parties, non-borrowing owners, deals, fee sheet requests, conventional pre-qualifications, pre-approvals, document jobs, income verification orders and loan documents, but only when you name that type in nodeTypes and hold every scope it needs: read:income for incomes, read:employment for employments, read:liability for liabilities, read:owned-property for owned properties, read:subject-property for subject properties and subject property intents, read:party for parties, read:non-borrowing-owner for non-borrowing owners, read:deal for deals, read:pricing for fee sheet requests, read:pre-qualification for conventional pre-qualifications, read:loan for pre-approvals and for income verification orders, and both read:document and read:loan for document jobs, and read:document for loan documents. A change to a kind you lack a scope for is skipped. A change to a loan's credit pulls, AUS runs, disclosure runs, appraisal orders, flood orders, undisclosed debt monitors, pricing structure runs or selected product structure is reported as a change to that Loan; fetch the loan to see it. A contributor's lease, role or deal-attachment change is reported as a change to the loans of the deals the contributor is attached to; the loan itself does not show it, so re-read contributors to see what changed. A concession's change, or a change to one of its requests, is reported as a change to the concession's loan; Loan.concessions shows it.
Response
Returns a TrackedChangesResponse!
Arguments
| Name | Description |
|---|---|
nodeTypes - [TrackedNodeType!]
|
The node types you handle. Only changes to these are reported; a change to any other type is skipped (the cursor still moves past it). Omitted or null: Loan, Borrower and Asset. Name Income, Employment, Liability, OwnedProperty, SubjectProperty, SubjectPropertyIntent, Party, NonBorrowingOwner, Deal, FeeSheetRequest, ConventionalPreQualification, PreApproval, Job or IncomeVerificationOrder to be told of changes to them; a client that decodes TrackedNodeType strictly should name only the types it can handle. Default = [Loan, Borrower, Asset] |
since - String
|
The next cursor from the previous batch, or null to obtain a fresh cursor. |
Example
Query
query trackedChanges(
$nodeTypes: [TrackedNodeType!],
$since: String
) {
trackedChanges(
nodeTypes: $nodeTypes,
since: $since
) {
batch {
...TrackedNodeChangeBatchFragment
}
next
}
}
Variables
{
"nodeTypes": ["Loan", "Borrower", "Asset"],
"since": "xyz789"
}
Response
{
"data": {
"trackedChanges": {
"batch": TrackedNodeChangeBatch,
"next": "abc123"
}
}
}
verify
Description
Namespace for verification queries.
Response
Returns a VerifyQueries
Example
Query
query verify {
verify {
truvVerificationOutcome
}
}
Response
{"data": {"verify": {"truvVerificationOutcome": "COMPLETE"}}}
webhookSubscriptions
Description
Your organization's webhook subscriptions and their signing keys.
Response
Returns [WebhookSubscription!]!
Example
Query
query webhookSubscriptions {
webhookSubscriptions {
callbackUrl
deliveredEventTypes
deliveries {
...WebhookDeliveryConnectionFragment
}
eventTypes
id
pendingCallbackUrl
signingKeys {
...WebhookSigningKeyFragment
}
status
topics
verifiedAt
}
}
Response
{
"data": {
"webhookSubscriptions": [
{
"callbackUrl": "abc123",
"deliveredEventTypes": ["APPRAISAL_ORDER_CHANGED"],
"deliveries": WebhookDeliveryConnection,
"eventTypes": ["APPRAISAL_ORDER_CHANGED"],
"id": 4,
"pendingCallbackUrl": "xyz789",
"signingKeys": [WebhookSigningKey],
"status": "ACTIVE",
"topics": ["BORROWERS"],
"verifiedAt": "2007-12-03T10:15:30Z"
}
]
}
}
Mutations
advisor
Response
Returns an AdvisorMutations
Example
Query
mutation advisor {
advisor {
createSession {
...CreateSessionResponseFragment
}
giveMessageFeedback {
...GiveMessageFeedbackResponseFragment
}
sendMessage {
...SendMessageResponseFragment
}
}
}
Response
{
"data": {
"advisor": {
"createSession": CreateSessionResponse,
"giveMessageFeedback": GiveMessageFeedbackResponse,
"sendMessage": SendMessageResponse
}
}
}
analytics
Description
Namespace for analytics mutations. These allow you to export analytics results to file.
Response
Returns an AnalyticsMutations
Example
Query
mutation analytics {
analytics {
startAnalyticsExportJob {
...StartAnalyticsExportJobResponseFragment
}
}
}
Response
{
"data": {
"analytics": {
"startAnalyticsExportJob": StartAnalyticsExportJobResponse
}
}
}
appraisal
Description
Appraisal mutations.
Response
Returns an AppraisalMutations
Example
Query
mutation appraisal {
appraisal {
addComment {
...AddAppraisalCommentResponseFragment
}
addDocuments {
...AddAppraisalDocumentsResponseFragment
}
orderAppraisal {
...OrderAppraisalResponseFragment
}
}
}
Response
{
"data": {
"appraisal": {
"addComment": AddAppraisalCommentResponse,
"addDocuments": AddAppraisalDocumentsResponse,
"orderAppraisal": OrderAppraisalResponse
}
}
}
approvalProcess
Description
Approval-process mutations namespace.
Response
Returns an ApprovalProcessMutations
Example
Query
mutation approvalProcess {
approvalProcess {
writeDispute {
...WriteDisputeResponseFragment
}
}
}
Response
{
"data": {
"approvalProcess": {
"writeDispute": WriteDisputeResponse
}
}
}
asset
Description
Asset mutations
Response
Returns an AssetMutations
Example
Query
mutation asset {
asset {
addNotableActivity {
...AddNotableActivityResponseFragment
}
attachBorrower {
...AttachBorrowerAssetResponseFragment
}
create {
...CreateAssetResponseFragment
}
delete {
...DeleteAssetResponseFragment
}
deleteNotableActivity {
...DeleteNotableActivityResponseFragment
}
detachBorrower {
...DetachBorrowerAssetResponseFragment
}
explainAssetTransaction {
...ExplainAssetTransactionResponseFragment
}
update {
...UpdateAssetResponseFragment
}
updateNotableActivity {
...UpdateNotableActivityResponseFragment
}
}
}
Response
{
"data": {
"asset": {
"addNotableActivity": AddNotableActivityResponse,
"attachBorrower": AttachBorrowerAssetResponse,
"create": CreateAssetResponse,
"delete": DeleteAssetResponse,
"deleteNotableActivity": DeleteNotableActivityResponse,
"detachBorrower": DetachBorrowerAssetResponse,
"explainAssetTransaction": ExplainAssetTransactionResponse,
"update": UpdateAssetResponse,
"updateNotableActivity": UpdateNotableActivityResponse
}
}
}
assetVerification
Response
Returns an AssetVerificationMutations
Example
Query
mutation assetVerification {
assetVerification {
detachItem {
...DetachItemResponseFragment
}
refreshLink {
...RefreshLinkResponseFragment
}
requestLink {
...RequestLinkResponseFragment
}
}
}
Response
{
"data": {
"assetVerification": {
"detachItem": DetachItemResponse,
"refreshLink": RefreshLinkResponse,
"requestLink": RequestLinkResponse
}
}
}
aus
Description
AUS mutations
Response
Returns an AusMutations
Example
Query
mutation aus {
aus {
triggerAusRun {
...TriggerAusRunResponseFragment
}
}
}
Response
{
"data": {
"aus": {"triggerAusRun": TriggerAusRunResponse}
}
}
auth
Description
Namespace for auth mutations. These allow getting temporary authorization for borrowers to access Pylon's API in a restricted fashion
Response
Returns an AuthMutations
Example
Query
mutation auth {
auth {
createLease {
...CreateLeaseResponseFragment
}
}
}
Response
{"data": {"auth": {"createLease": CreateLeaseResponse}}}
borrower
Description
Borrower mutations
Response
Returns a BorrowerMutations
Example
Query
mutation borrower {
borrower {
attachLiabilities {
...AttachBorrowerLiabilitiesResponseFragment
}
attachNonBorrowingSpouse {
...AttachBorrowerNonBorrowingSpouseResponseFragment
}
create {
...CreateBorrowerResponseFragment
}
declareMilitaryService {
...DeclareMilitaryServiceResponseFragment
}
declareNoMilitaryService {
...DeclareNoMilitaryServiceResponseFragment
}
delete {
...DeleteBorrowerResponseFragment
}
detachLiabilities {
...DetachBorrowerLiabilitiesResponseFragment
}
linkBorrowersAsSpouses {
...LinkBorrowersAsSpousesResponseFragment
}
rejectDocument {
...RejectDocumentResponseFragment
}
sendEmailVerificationCode {
...SendBorrowerEmailVerificationCodeResponseFragment
}
sendPortalInvite {
...SendBorrowerPortalInviteResponseFragment
}
setEmailVerified {
...SetBorrowerEmailVerifiedResponseFragment
}
unsetMilitaryService {
...UnsetBorrowerMilitaryServiceResponseFragment
}
updateBorrower {
...UpdateBorrowerResponseFragment
}
updateConsent {
...UpdateBorrowerConsentResponseFragment
}
updateDemographicInfo {
...UpdateDemographicInfoResponseFragment
}
updateDependents {
...UpdateBorrowerDependentsResponseFragment
}
updateFinancialDeclarations {
...UpdateBorrowerFinancialDeclarationsResponseFragment
}
updateMailingAddress {
...UpdateBorrowerMailingAddressResponseFragment
}
updateMilitaryService {
...UpdateBorrowerMilitaryServiceResponseFragment
}
updatePersonalInformation {
...UpdateBorrowerPersonalInformationResponseFragment
}
updatePhoneNumber {
...UpdateBorrowerPhoneNumberResponseFragment
}
updatePlaid {
...UpdateBorrowerPlaidResponseFragment
}
updatePropertyDeclarations {
...UpdateBorrowerPropertyDeclarationsResponseFragment
}
}
}
Response
{
"data": {
"borrower": {
"attachLiabilities": AttachBorrowerLiabilitiesResponse,
"attachNonBorrowingSpouse": AttachBorrowerNonBorrowingSpouseResponse,
"create": CreateBorrowerResponse,
"declareMilitaryService": DeclareMilitaryServiceResponse,
"declareNoMilitaryService": DeclareNoMilitaryServiceResponse,
"delete": DeleteBorrowerResponse,
"detachLiabilities": DetachBorrowerLiabilitiesResponse,
"linkBorrowersAsSpouses": LinkBorrowersAsSpousesResponse,
"rejectDocument": RejectDocumentResponse,
"sendEmailVerificationCode": SendBorrowerEmailVerificationCodeResponse,
"sendPortalInvite": SendBorrowerPortalInviteResponse,
"setEmailVerified": SetBorrowerEmailVerifiedResponse,
"unsetMilitaryService": UnsetBorrowerMilitaryServiceResponse,
"updateBorrower": UpdateBorrowerResponse,
"updateConsent": UpdateBorrowerConsentResponse,
"updateDemographicInfo": UpdateDemographicInfoResponse,
"updateDependents": UpdateBorrowerDependentsResponse,
"updateFinancialDeclarations": UpdateBorrowerFinancialDeclarationsResponse,
"updateMailingAddress": UpdateBorrowerMailingAddressResponse,
"updateMilitaryService": UpdateBorrowerMilitaryServiceResponse,
"updatePersonalInformation": UpdateBorrowerPersonalInformationResponse,
"updatePhoneNumber": UpdateBorrowerPhoneNumberResponse,
"updatePlaid": UpdateBorrowerPlaidResponse,
"updatePropertyDeclarations": UpdateBorrowerPropertyDeclarationsResponse
}
}
}
borrowerAddress
Description
Mutations for borrower addresses
Response
Returns a BorrowerAddressMutations
Example
Query
mutation borrowerAddress {
borrowerAddress {
createPrevious {
...CreatePreviousBorrowerAddressResponseFragment
}
deletePrevious {
...DeletePreviousBorrowerAddressResponseFragment
}
updateCurrent {
...UpdateCurrentBorrowerAddressResponseFragment
}
updatePrevious {
...UpdatePreviousBorrowerAddressResponseFragment
}
}
}
Response
{
"data": {
"borrowerAddress": {
"createPrevious": CreatePreviousBorrowerAddressResponse,
"deletePrevious": DeletePreviousBorrowerAddressResponse,
"updateCurrent": UpdateCurrentBorrowerAddressResponse,
"updatePrevious": UpdatePreviousBorrowerAddressResponse
}
}
}
citations
Description
Citation mutations namespace.
Response
Returns a CitationsMutations
Example
Query
mutation citations {
citations {
createCitation {
...CreateCitationResponseFragment
}
}
}
Response
{
"data": {
"citations": {
"createCitation": CreateCitationResponse
}
}
}
comms
Description
Comms mutations
Response
Returns a CommsMutations
Example
Query
mutation comms {
comms {
toggleCustomerCommsOptIn {
...ToggleCustomerCommsOptInResponseFragment
}
updateCommsRecipients {
...UpdateCommsRecipientsResponseFragment
}
updateCommsSettings {
...UpdateCommsSettingsResponseFragment
}
updateCommsTemplate {
...UpdateCommsTemplateResponseFragment
}
}
}
Response
{
"data": {
"comms": {
"toggleCustomerCommsOptIn": ToggleCustomerCommsOptInResponse,
"updateCommsRecipients": UpdateCommsRecipientsResponse,
"updateCommsSettings": UpdateCommsSettingsResponse,
"updateCommsTemplate": UpdateCommsTemplateResponse
}
}
}
company
Description
Company mutations
Response
Returns a CompanyMutations
Example
Query
mutation company {
company {
create {
...CreateCompanyResponseFragment
}
}
}
Response
{"data": {"company": {"create": CreateCompanyResponse}}}
concession
Response
Returns a ConcessionMutations
Example
Query
mutation concession {
concession {
approveConcession {
...ApproveConcessionResponseFragment
}
requestConcession {
...RequestConcessionResponseFragment
}
revokeConcession {
...RevokeConcessionResponseFragment
}
updateConcession {
...UpdateConcessionResponseFragment
}
}
}
Response
{
"data": {
"concession": {
"approveConcession": ApproveConcessionResponse,
"requestConcession": RequestConcessionResponse,
"revokeConcession": RevokeConcessionResponse,
"updateConcession": UpdateConcessionResponse
}
}
}
contributor
Response
Returns a ContributorMutations
Example
Query
mutation contributor {
contributor {
attachContributorToDeal {
...AttachContributorToDealResponseFragment
}
createContributor {
...CreateContributorResponseFragment
}
createLease {
...ContributorCreateLeaseResponseFragment
}
detachContributorFromDeal {
...DetachContributorFromDealResponseFragment
}
disableContributor {
...DisableContributorResponseFragment
}
enableContributor {
...EnableContributorResponseFragment
}
updateContributor {
...UpdateContributorResponseFragment
}
}
}
Response
{
"data": {
"contributor": {
"attachContributorToDeal": AttachContributorToDealResponse,
"createContributor": CreateContributorResponse,
"createLease": ContributorCreateLeaseResponse,
"detachContributorFromDeal": DetachContributorFromDealResponse,
"disableContributor": DisableContributorResponse,
"enableContributor": EnableContributorResponse,
"updateContributor": UpdateContributorResponse
}
}
}
credit
Description
Namespace for credit mutations. These mutations allow you to initiate credit pulls
Response
Returns a CreditMutations
Example
Query
mutation credit {
credit {
deactivateUdnMonitoring {
...DeactivateUdnMonitoringResponseFragment
}
invalidateCreditCache {
...InvalidateCreditCacheResponseFragment
}
refreshCreditReport {
...RefreshCreditReportResponseFragment
}
startIndividualCreditPullJob {
...StartIndividualCreditPullJobResponseFragment
}
startJointCreditPullJob {
...StartJointCreditPullJobResponseFragment
}
unmergeCreditReport {
...UnmergeCreditReportResponseFragment
}
updateUdnNotificationEmails {
...UpdateUdnNotificationEmailsResponseFragment
}
upgradeCreditReport {
...UpgradeCreditReportResponseFragment
}
}
}
Response
{
"data": {
"credit": {
"deactivateUdnMonitoring": DeactivateUdnMonitoringResponse,
"invalidateCreditCache": InvalidateCreditCacheResponse,
"refreshCreditReport": RefreshCreditReportResponse,
"startIndividualCreditPullJob": StartIndividualCreditPullJobResponse,
"startJointCreditPullJob": StartJointCreditPullJobResponse,
"unmergeCreditReport": UnmergeCreditReportResponse,
"updateUdnNotificationEmails": UpdateUdnNotificationEmailsResponse,
"upgradeCreditReport": UpgradeCreditReportResponse
}
}
}
creditInquiry
Description
CreditInquiry mutations
Response
Returns a CreditInquiryMutations
Example
Query
mutation creditInquiry {
creditInquiry {
updateCreditInquiry {
...UpdateCreditInquiryResponseFragment
}
}
}
Response
{
"data": {
"creditInquiry": {
"updateCreditInquiry": UpdateCreditInquiryResponse
}
}
}
customerProvisioning
Description
Customer provisioning mutations (internal Pylon administrators only).
Response
Returns a CustomerProvisioningMutations
Example
Query
mutation customerProvisioning {
customerProvisioning {
createCustomerApiClient {
...CreateCustomerApiClientResponseFragment
}
provisionCustomer {
...ProvisionCustomerResponseFragment
}
}
}
Response
{
"data": {
"customerProvisioning": {
"createCustomerApiClient": CreateCustomerApiClientResponse,
"provisionCustomer": ProvisionCustomerResponse
}
}
}
deal
Response
Returns a DealMutations
Example
Query
mutation deal {
deal {
create {
...CreateDealResponseFragment
}
}
}
Response
{"data": {"deal": {"create": CreateDealResponse}}}
dealClaimToken
Response
Returns a DealClaimTokenMutations
Example
Query
mutation dealClaimToken {
dealClaimToken {
claim {
...ClaimDealClaimTokenResponseFragment
}
issue {
...IssueDealClaimTokenResponseFragment
}
}
}
Response
{
"data": {
"dealClaimToken": {
"claim": ClaimDealClaimTokenResponse,
"issue": IssueDealClaimTokenResponse
}
}
}
demoSeed
Response
Returns a DemoSeedMutations
Example
Query
mutation demoSeed {
demoSeed {
seedAusRun {
...SeedAusRunResponseFragment
}
seedWireOutWorksheetCase {
...SeedWireOutWorksheetCaseResponseFragment
}
}
}
Response
{
"data": {
"demoSeed": {
"seedAusRun": SeedAusRunResponse,
"seedWireOutWorksheetCase": SeedWireOutWorksheetCaseResponse
}
}
}
documentIntake
Description
Document-intake mutations namespace.
Response
Returns a DocumentIntakeMutations
Example
Query
mutation documentIntake {
documentIntake {
cancelDocumentSeeding {
...CancelDocumentSeedingResponseFragment
}
cancelSeedFromDocuments {
...CancelSeedFromDocumentsResponseFragment
}
confirmIntakeDraft {
...ConfirmIntakeDraftResponseFragment
}
correctDocumentKind {
...CorrectDocumentKindResponseFragment
}
discardIntakeDraft {
...DiscardIntakeDraftResponseFragment
}
mergeSeededBorrower {
...MergeSeededBorrowerResponseFragment
}
openIntakeDraft {
...OpenIntakeDraftResponseFragment
}
resolveFieldProvenance {
...ResolveFieldProvenanceResponseFragment
}
resolveSeedPersonDecision {
...ResolveSeedPersonDecisionResponseFragment
}
resolveSeedValueDecision {
...ResolveSeedValueDecisionResponseFragment
}
retry {
...RetryDocumentIntakeResponseFragment
}
seedFromDocuments {
...SeedFromDocumentsResponseFragment
}
seedLoanFromDocuments {
...SeedLoanFromDocumentsResponseFragment
}
}
}
Response
{
"data": {
"documentIntake": {
"cancelDocumentSeeding": CancelDocumentSeedingResponse,
"cancelSeedFromDocuments": CancelSeedFromDocumentsResponse,
"confirmIntakeDraft": ConfirmIntakeDraftResponse,
"correctDocumentKind": CorrectDocumentKindResponse,
"discardIntakeDraft": DiscardIntakeDraftResponse,
"mergeSeededBorrower": MergeSeededBorrowerResponse,
"openIntakeDraft": OpenIntakeDraftResponse,
"resolveFieldProvenance": ResolveFieldProvenanceResponse,
"resolveSeedPersonDecision": ResolveSeedPersonDecisionResponse,
"resolveSeedValueDecision": ResolveSeedValueDecisionResponse,
"retry": RetryDocumentIntakeResponse,
"seedFromDocuments": SeedFromDocumentsResponse,
"seedLoanFromDocuments": SeedLoanFromDocumentsResponse
}
}
}
employmentGap
Description
Employment gap mutations
Response
Returns an EmploymentGapMutations
Example
Query
mutation employmentGap {
employmentGap {
explainEmploymentGap {
...ExplainEmploymentGapResponseFragment
}
}
}
Response
{
"data": {
"employmentGap": {
"explainEmploymentGap": ExplainEmploymentGapResponse
}
}
}
fee
Description
Namespace for mutating fees and closing costs.
Response
Returns a FeeMutations
Example
Query
mutation fee {
fee {
create {
...CreateFeeResponseFragment
}
delete {
...DeleteFeeResponseFragment
}
update {
...UpdateFeeResponseFragment
}
}
}
Response
{
"data": {
"fee": {
"create": CreateFeeResponse,
"delete": DeleteFeeResponse,
"update": UpdateFeeResponse
}
}
}
feeSheet
Description
Fee sheet mutations
Response
Returns a FeeSheetMutations
Example
Query
mutation feeSheet {
feeSheet {
createFeeSheetRequest {
...CreateFeeSheetRequestResponseFragment
}
createFeeSheetRequestForLoan {
...CreateFeeSheetRequestForLoanResponseFragment
}
}
}
Response
{
"data": {
"feeSheet": {
"createFeeSheetRequest": CreateFeeSheetRequestResponse,
"createFeeSheetRequestForLoan": CreateFeeSheetRequestForLoanResponse
}
}
}
flood
Description
Flood mutations.
Response
Returns a FloodMutations
Example
Query
mutation flood {
flood {
cancelFlood {
...CancelFloodResponseFragment
}
orderFlood {
...OrderFloodResponseFragment
}
}
}
Response
{
"data": {
"flood": {
"cancelFlood": CancelFloodResponse,
"orderFlood": OrderFloodResponse
}
}
}
fulfillmentParty
Response
Returns a FulfillmentPartyMutations
Example
Query
mutation fulfillmentParty {
fulfillmentParty {
create {
...CreateFulfillmentPartyResponseFragment
}
delete {
...DeleteFulfillmentPartyResponseFragment
}
}
}
Response
{
"data": {
"fulfillmentParty": {
"create": CreateFulfillmentPartyResponse,
"delete": DeleteFulfillmentPartyResponse
}
}
}
funding
Description
Funding mutations
Response
Returns a FundingMutations
Example
Query
mutation funding {
funding {
completeWireInPurchase {
...CompleteWireInPurchaseResponseFragment
}
correctPrepaidEntry {
...CorrectPrepaidEntryResponseFragment
}
correctWireInRemittance {
...CorrectWireInRemittanceResponseFragment
}
correctWireOutRemittance {
...CorrectWireOutRemittanceResponseFragment
}
enterPrepaidAmount {
...EnterPrepaidAmountResponseFragment
}
recordManualWireOutFigure {
...RecordManualWireOutFigureResponseFragment
}
recordWireInAdjustment {
...RecordWireInAdjustmentResponseFragment
}
recordWireInInputs {
...RecordWireInInputsResponseFragment
}
recordWireInRemittance {
...RecordWireInRemittanceResponseFragment
}
recordWireOutRemittance {
...RecordWireOutRemittanceResponseFragment
}
}
}
Response
{
"data": {
"funding": {
"completeWireInPurchase": CompleteWireInPurchaseResponse,
"correctPrepaidEntry": CorrectPrepaidEntryResponse,
"correctWireInRemittance": CorrectWireInRemittanceResponse,
"correctWireOutRemittance": CorrectWireOutRemittanceResponse,
"enterPrepaidAmount": EnterPrepaidAmountResponse,
"recordManualWireOutFigure": RecordManualWireOutFigureResponse,
"recordWireInAdjustment": RecordWireInAdjustmentResponse,
"recordWireInInputs": RecordWireInInputsResponse,
"recordWireInRemittance": RecordWireInRemittanceResponse,
"recordWireOutRemittance": RecordWireOutRemittanceResponse
}
}
}
income
Description
Income mutations
Response
Returns an IncomeMutations
Example
Query
mutation income {
income {
auxiliaryEmployment {
...AuxiliaryEmploymentIncomeMutationsFragment
}
create {
...CreateIncomeResponseFragment
}
delete {
...DeleteIncomeResponseFragment
}
recompute {
...RecomputeIncomeResponseFragment
}
update {
...UpdateIncomeResponseFragment
}
}
}
Response
{
"data": {
"income": {
"auxiliaryEmployment": AuxiliaryEmploymentIncomeMutations,
"create": CreateIncomeResponse,
"delete": DeleteIncomeResponse,
"recompute": RecomputeIncomeResponse,
"update": UpdateIncomeResponse
}
}
}
incomeVerification
Response
Returns an IncomeVerificationMutations
Example
Query
mutation incomeVerification {
incomeVerification {
cancelOrder {
...CancelOrderResponseFragment
}
requestOrder {
...RequestOrderResponseFragment
}
}
}
Response
{
"data": {
"incomeVerification": {
"cancelOrder": CancelOrderResponse,
"requestOrder": RequestOrderResponse
}
}
}
liability
Description
Liability mutations
Response
Returns a LiabilityMutations
Example
Query
mutation liability {
liability {
attachOwnedProperty {
...AttachOwnedPropertyLiabilityResponseFragment
}
create {
...CreateLiabilityResponseFragment
}
delete {
...DeleteLiabilityResponseFragment
}
dismissDuplicateSuggestion {
...DismissDuplicateSuggestionResponseFragment
}
setExclusionReason {
...SetExclusionReasonResponseFragment
}
setIntent {
...SetIntentResponseFragment
}
update {
...UpdateLiabilityResponseFragment
}
}
}
Response
{
"data": {
"liability": {
"attachOwnedProperty": AttachOwnedPropertyLiabilityResponse,
"create": CreateLiabilityResponse,
"delete": DeleteLiabilityResponse,
"dismissDuplicateSuggestion": DismissDuplicateSuggestionResponse,
"setExclusionReason": SetExclusionReasonResponse,
"setIntent": SetIntentResponse,
"update": UpdateLiabilityResponse
}
}
}
loan
Description
Loan mutations
Response
Returns a LoanMutations
Example
Query
mutation loan {
loan {
addRequirementConversationMessage {
...AddRequirementConversationMessageResponseFragment
}
approveChangeRequest {
...ApproveLoanChangeRequestResponseFragment
}
archive {
... on ArchiveLoanSuccess {
...ArchiveLoanSuccessFragment
}
... on LoanClosedError {
...LoanClosedErrorFragment
}
}
assignLoanOfficer {
...AssignLoanOfficerResponseFragment
}
attachContact {
...AttachLoanContactResponseFragment
}
attachLoanNote {
...AttachLoanNoteResponseFragment
}
attachProductPricingRate {
...AttachProductPricingRateResponseFragment
}
attachSubjectProperty {
...AttachSubjectPropertyResponseFragment
}
attachTitleCompany {
...AttachTitleCompanyResponseFragment
}
closeRequirementConversationSession {
...CloseRequirementConversationSessionResponseFragment
}
confirmRateLock {
...ConfirmRateLockResponseFragment
}
create {
...CreateLoanResponseFragment
}
createApplication {
...CreateApplicationResponseFragment
}
createLoanAssignment {
...CreateLoanAssignmentResponseFragment
}
createRequirementConversationSession {
...CreateRequirementConversationSessionResponseFragment
}
denyRateLock {
...DenyRateLockResponseFragment
}
detachContact {
...DetachLoanContactResponseFragment
}
export {
...ExportLoanResponseFragment
}
extendRateLock {
...ExtendRateLockResponseFragment
}
floatStructure {
...FloatStructureResponseFragment
}
forceGenerateDisclosurePackage {
...ForceGenerateDisclosurePackageResponseFragment
}
forceIcdSend {
...ForceIcdSendResponseFragment
}
freeze {
...FreezeLoanResponseFragment
}
generateClosingDisclosurePreview {
...GenerateClosingDisclosurePreviewResponseFragment
}
generateLoanEstimatePreview {
...GenerateLoanEstimatePreviewResponseFragment
}
generateLockReplacementRedisclosurePreview {
...GenerateLockReplacementRedisclosurePreviewResponseFragment
}
generateRedisclosurePreview {
...GenerateRedisclosurePreviewResponseFragment
}
openChangeRequest {
...OpenLoanChangeRequestResponseFragment
}
reassignLoanOfficerTasks {
...ReassignLoanOfficerTasksResponseFragment
}
reassignTask {
...ReassignTaskResponseFragment
}
recordLoanView {
...RecordLoanViewResponseFragment
}
redisclose {
...RediscloseResponseFragment
}
removeLoanAssignment {
...RemoveLoanAssignmentResponseFragment
}
reopenRequirementConversationSession {
...ReopenRequirementConversationSessionResponseFragment
}
resolveUncertainDisclosureSend {
...ResolveUncertainDisclosureSendResponseFragment
}
setUseOwnTitleCompany {
...SetUseOwnTitleCompanyResponseFragment
}
startBulkLoanDocumentsExport {
...StartBulkLoanDocumentsExportResponseFragment
}
submitUnderwritingNotes {
...SubmitUnderwritingNotesResponseFragment
}
thaw {
...ThawLoanResponseFragment
}
update {
...UpdateLoanResponseFragment
}
updateBorrowerPreferences {
...UpdateBorrowerPreferencesResponseFragment
}
updateCompanyName {
...UpdateCompanyNameResponseFragment
}
updateProcessorFee {
...UpdateProcessorFeeResponseFragment
}
updateTaskName {
...UpdateTaskNameResponseFragment
}
withdraw {
... on LoanClosedError {
...LoanClosedErrorFragment
}
... on WithdrawLoanSuccess {
...WithdrawLoanSuccessFragment
}
}
}
}
Response
{
"data": {
"loan": {
"addRequirementConversationMessage": AddRequirementConversationMessageResponse,
"approveChangeRequest": ApproveLoanChangeRequestResponse,
"archive": ArchiveLoanSuccess,
"assignLoanOfficer": AssignLoanOfficerResponse,
"attachContact": AttachLoanContactResponse,
"attachLoanNote": AttachLoanNoteResponse,
"attachProductPricingRate": AttachProductPricingRateResponse,
"attachSubjectProperty": AttachSubjectPropertyResponse,
"attachTitleCompany": AttachTitleCompanyResponse,
"closeRequirementConversationSession": CloseRequirementConversationSessionResponse,
"confirmRateLock": ConfirmRateLockResponse,
"create": CreateLoanResponse,
"createApplication": CreateApplicationResponse,
"createLoanAssignment": CreateLoanAssignmentResponse,
"createRequirementConversationSession": CreateRequirementConversationSessionResponse,
"denyRateLock": DenyRateLockResponse,
"detachContact": DetachLoanContactResponse,
"export": ExportLoanResponse,
"extendRateLock": ExtendRateLockResponse,
"floatStructure": FloatStructureResponse,
"forceGenerateDisclosurePackage": ForceGenerateDisclosurePackageResponse,
"forceIcdSend": ForceIcdSendResponse,
"freeze": FreezeLoanResponse,
"generateClosingDisclosurePreview": GenerateClosingDisclosurePreviewResponse,
"generateLoanEstimatePreview": GenerateLoanEstimatePreviewResponse,
"generateLockReplacementRedisclosurePreview": GenerateLockReplacementRedisclosurePreviewResponse,
"generateRedisclosurePreview": GenerateRedisclosurePreviewResponse,
"openChangeRequest": OpenLoanChangeRequestResponse,
"reassignLoanOfficerTasks": ReassignLoanOfficerTasksResponse,
"reassignTask": ReassignTaskResponse,
"recordLoanView": RecordLoanViewResponse,
"redisclose": RediscloseResponse,
"removeLoanAssignment": RemoveLoanAssignmentResponse,
"reopenRequirementConversationSession": ReopenRequirementConversationSessionResponse,
"resolveUncertainDisclosureSend": ResolveUncertainDisclosureSendResponse,
"setUseOwnTitleCompany": SetUseOwnTitleCompanyResponse,
"startBulkLoanDocumentsExport": StartBulkLoanDocumentsExportResponse,
"submitUnderwritingNotes": SubmitUnderwritingNotesResponse,
"thaw": ThawLoanResponse,
"update": UpdateLoanResponse,
"updateBorrowerPreferences": UpdateBorrowerPreferencesResponse,
"updateCompanyName": UpdateCompanyNameResponse,
"updateProcessorFee": UpdateProcessorFeeResponse,
"updateTaskName": UpdateTaskNameResponse,
"withdraw": LoanClosedError
}
}
}
loanOfficer
Description
Loan officer mutations
Response
Returns a LoanOfficerMutations
Example
Query
mutation loanOfficer {
loanOfficer {
activateLoanOfficerHere {
...ActivateLoanOfficerHereResponseFragment
}
moveLoanOfficersHere {
...MoveLoanOfficersHereResponseFragment
}
removeLoanOfficer {
...RemoveLoanOfficerResponseFragment
}
setLoanOfficerSlug {
...SetLoanOfficerSlugResponseFragment
}
setLoanOfficerStatus {
...SetLoanOfficerStatusResponseFragment
}
}
}
Response
{
"data": {
"loanOfficer": {
"activateLoanOfficerHere": ActivateLoanOfficerHereResponse,
"moveLoanOfficersHere": MoveLoanOfficersHereResponse,
"removeLoanOfficer": RemoveLoanOfficerResponse,
"setLoanOfficerSlug": SetLoanOfficerSlugResponse,
"setLoanOfficerStatus": SetLoanOfficerStatusResponse
}
}
}
loanScript
Response
Returns a LoanScriptMutations
Example
Query
mutation loanScript {
loanScript {
createLoanScript {
...CreateLoanScriptResponseFragment
}
deleteLoanScript {
...DeleteLoanScriptResponseFragment
}
runLoanScript {
...RunLoanScriptResponseFragment
}
updateLoanScript {
...UpdateLoanScriptResponseFragment
}
}
}
Response
{
"data": {
"loanScript": {
"createLoanScript": CreateLoanScriptResponse,
"deleteLoanScript": DeleteLoanScriptResponse,
"runLoanScript": RunLoanScriptResponse,
"updateLoanScript": UpdateLoanScriptResponse
}
}
}
lpaKnownRulesBackfill
Description
Internal AUS known-rules backfill operations.
Response
Returns a LpaKnownRulesBackfillMutations
Example
Query
mutation lpaKnownRulesBackfill {
lpaKnownRulesBackfill {
start {
...StartLpaKnownRulesBackfillResponseFragment
}
status {
...StatusLpaKnownRulesBackfillResponseFragment
}
}
}
Response
{
"data": {
"lpaKnownRulesBackfill": {
"start": StartLpaKnownRulesBackfillResponse,
"status": StatusLpaKnownRulesBackfillResponse
}
}
}
nonBorrowingOwner
Description
NonBorrowingOwner mutations
Response
Returns a NonBorrowingOwnerMutations
Example
Query
mutation nonBorrowingOwner {
nonBorrowingOwner {
create {
...CreateNonBorrowingOwnerResponseFragment
}
delete {
...DeleteNonBorrowingOwnerResponseFragment
}
update {
...UpdateNonBorrowingOwnerResponseFragment
}
}
}
Response
{
"data": {
"nonBorrowingOwner": {
"create": CreateNonBorrowingOwnerResponse,
"delete": DeleteNonBorrowingOwnerResponse,
"update": UpdateNonBorrowingOwnerResponse
}
}
}
organization
Description
Namespace for organization mutations. These allow updating things like your organization's privacy policy url and licensing.
Response
Returns an OrganizationMutations
Example
Query
mutation organization {
organization {
addEmailDomains {
...AddEmailDomainsResponseFragment
}
addOrganizationFee {
...AddOrganizationFeeResponseFragment
}
createContact {
...CreateContactResponseFragment
}
createOrganizationRole {
...CreateOrganizationRoleResponseFragment
}
createOrganizationUser {
...CreateOrganizationUserResponseFragment
}
createWebhookSigningKey {
...CreateWebhookSigningKeyResponseFragment
}
createWebhookSubscription {
...CreateWebhookSubscriptionResponseFragment
}
deleteOrganizationRole {
...DeleteOrganizationRoleResponseFragment
}
deleteOrganizationStateLicenses {
...DeleteOrganizationStateLicensesResponseFragment
}
deleteOrganizationUser {
...DeleteOrganizationUserResponseFragment
}
deleteWebhookSubscription {
...DeleteWebhookSubscriptionResponseFragment
}
emergencyRevokeWebhookSigningKey {
...EmergencyRevokeWebhookSigningKeyResponseFragment
}
promoteWebhookSigningKey {
...PromoteWebhookSigningKeyResponseFragment
}
redeliverWebhookEvent {
...RedeliverWebhookEventResponseFragment
}
removeEmailDomains {
...RemoveEmailDomainsResponseFragment
}
replaceOrganizationFee {
...ReplaceOrganizationFeeResponseFragment
}
requestBrandingLogoUpload {
...RequestBrandingLogoUploadResponseFragment
}
resetOrganizationUserMfa {
...ResetOrganizationUserMfaResponseFragment
}
retireOrganizationFee {
...RetireOrganizationFeeResponseFragment
}
sendOrganizationUserInvitationEmail {
...SendOrganizationUserInvitationEmailResponseFragment
}
sendWebhookTestDelivery {
...SendWebhookTestDeliveryResponseFragment
}
setDefaultPrimaryLoanContact {
...SetDefaultPrimaryLoanContactResponseFragment
}
setOrganizationAccountStatus {
...SetOrganizationAccountStatusResponseFragment
}
setOrganizationApiAccessStatus {
...SetOrganizationApiAccessStatusResponseFragment
}
setOrganizationLegalEntityGroup {
...SetOrganizationLegalEntityGroupResponseFragment
}
setOrganizationMultiInstanceLoanOfficers {
...SetOrganizationMultiInstanceLoanOfficersResponseFragment
}
setUnderwritingCostRecovery {
...SetUnderwritingCostRecoveryResponseFragment
}
setUnderwritingGateThresholds {
...SetUnderwritingGateThresholdsResponseFragment
}
toggleEnabledLoanProduct {
...ToggleEnabledLoanProductResponseFragment
}
togglePlaidProduct {
...TogglePlaidProductResponseFragment
}
updateContact {
...UpdateContactResponseFragment
}
updateCostAbsorption {
...UpdateCostAbsorptionResponseFragment
}
updateCustomerShare {
...UpdateCustomerShareResponseFragment
}
updateOrganization {
...UpdateOrganizationResponseFragment
}
updateOrganizationCustomerMargin {
...UpdateOrganizationCustomerMarginResponseFragment
}
updateOrganizationHouseHoldback {
...UpdateOrganizationHouseHoldbackResponseFragment
}
updateOrganizationLicensing {
...UpdateOrganizationLicensingResponseFragment
}
updateOrganizationMargin {
...UpdateOrganizationMarginResponseFragment
}
updateOrganizationOrigination {
...UpdateOrganizationOriginationResponseFragment
}
updateOrganizationRolePermissions {
...UpdateOrganizationRolePermissionsResponseFragment
}
updateOrganizationUserDetails {
...UpdateOrganizationUserDetailsResponseFragment
}
updateOrganizationUserLicenses {
...UpdateOrganizationUserLicensesResponseFragment
}
updateOrganizationUserRoles {
...UpdateOrganizationUserRolesResponseFragment
}
updateWebhookSubscription {
...UpdateWebhookSubscriptionResponseFragment
}
}
}
Response
{
"data": {
"organization": {
"addEmailDomains": AddEmailDomainsResponse,
"addOrganizationFee": AddOrganizationFeeResponse,
"createContact": CreateContactResponse,
"createOrganizationRole": CreateOrganizationRoleResponse,
"createOrganizationUser": CreateOrganizationUserResponse,
"createWebhookSigningKey": CreateWebhookSigningKeyResponse,
"createWebhookSubscription": CreateWebhookSubscriptionResponse,
"deleteOrganizationRole": DeleteOrganizationRoleResponse,
"deleteOrganizationStateLicenses": DeleteOrganizationStateLicensesResponse,
"deleteOrganizationUser": DeleteOrganizationUserResponse,
"deleteWebhookSubscription": DeleteWebhookSubscriptionResponse,
"emergencyRevokeWebhookSigningKey": EmergencyRevokeWebhookSigningKeyResponse,
"promoteWebhookSigningKey": PromoteWebhookSigningKeyResponse,
"redeliverWebhookEvent": RedeliverWebhookEventResponse,
"removeEmailDomains": RemoveEmailDomainsResponse,
"replaceOrganizationFee": ReplaceOrganizationFeeResponse,
"requestBrandingLogoUpload": RequestBrandingLogoUploadResponse,
"resetOrganizationUserMfa": ResetOrganizationUserMfaResponse,
"retireOrganizationFee": RetireOrganizationFeeResponse,
"sendOrganizationUserInvitationEmail": SendOrganizationUserInvitationEmailResponse,
"sendWebhookTestDelivery": SendWebhookTestDeliveryResponse,
"setDefaultPrimaryLoanContact": SetDefaultPrimaryLoanContactResponse,
"setOrganizationAccountStatus": SetOrganizationAccountStatusResponse,
"setOrganizationApiAccessStatus": SetOrganizationApiAccessStatusResponse,
"setOrganizationLegalEntityGroup": SetOrganizationLegalEntityGroupResponse,
"setOrganizationMultiInstanceLoanOfficers": SetOrganizationMultiInstanceLoanOfficersResponse,
"setUnderwritingCostRecovery": SetUnderwritingCostRecoveryResponse,
"setUnderwritingGateThresholds": SetUnderwritingGateThresholdsResponse,
"toggleEnabledLoanProduct": ToggleEnabledLoanProductResponse,
"togglePlaidProduct": TogglePlaidProductResponse,
"updateContact": UpdateContactResponse,
"updateCostAbsorption": UpdateCostAbsorptionResponse,
"updateCustomerShare": UpdateCustomerShareResponse,
"updateOrganization": UpdateOrganizationResponse,
"updateOrganizationCustomerMargin": UpdateOrganizationCustomerMarginResponse,
"updateOrganizationHouseHoldback": UpdateOrganizationHouseHoldbackResponse,
"updateOrganizationLicensing": UpdateOrganizationLicensingResponse,
"updateOrganizationMargin": UpdateOrganizationMarginResponse,
"updateOrganizationOrigination": UpdateOrganizationOriginationResponse,
"updateOrganizationRolePermissions": UpdateOrganizationRolePermissionsResponse,
"updateOrganizationUserDetails": UpdateOrganizationUserDetailsResponse,
"updateOrganizationUserLicenses": UpdateOrganizationUserLicensesResponse,
"updateOrganizationUserRoles": UpdateOrganizationUserRolesResponse,
"updateWebhookSubscription": UpdateWebhookSubscriptionResponse
}
}
}
ownedProperty
Description
Owned property mutations
Response
Returns an OwnedPropertyMutations
Example
Query
mutation ownedProperty {
ownedProperty {
attachLiabilities {
...AttachOwnedPropertyLiabilitiesResponseFragment
}
attachNonBorrowingOwner {
...AttachOwnedPropertyNonBorrowingOwnerResponseFragment
}
create {
...CreateOwnedPropertyResponseFragment
}
delete {
...DeleteOwnedPropertyResponseFragment
}
detachLiabilities {
...DetachOwnedPropertyLiabilitiesResponseFragment
}
update {
...UpdateOwnedPropertyResponseFragment
}
}
}
Response
{
"data": {
"ownedProperty": {
"attachLiabilities": AttachOwnedPropertyLiabilitiesResponse,
"attachNonBorrowingOwner": AttachOwnedPropertyNonBorrowingOwnerResponse,
"create": CreateOwnedPropertyResponse,
"delete": DeleteOwnedPropertyResponse,
"detachLiabilities": DetachOwnedPropertyLiabilitiesResponse,
"update": UpdateOwnedPropertyResponse
}
}
}
party
Response
Returns a PartyMutations
Example
Query
mutation party {
party {
create {
...CreatePartyResponseFragment
}
delete {
...DeletePartyResponseFragment
}
optForDefaultTitleVendor {
...OptForDefaultTitleVendorResponseFragment
}
update {
...UpdatePartyResponseFragment
}
}
}
Response
{
"data": {
"party": {
"create": CreatePartyResponse,
"delete": DeletePartyResponse,
"optForDefaultTitleVendor": OptForDefaultTitleVendorResponse,
"update": UpdatePartyResponse
}
}
}
preApproval
Response
Returns a PreApprovalMutations
Example
Query
mutation preApproval {
preApproval {
createLoanPreApprovalLetter {
...CreateLoanPreApprovalLetterResponseFragment
}
createMaxLoanPreApprovalLetter {
...CreateMaxLoanPreApprovalLetterResponseFragment
}
runLoanPreApproval {
...RunLoanPreApprovalResponseFragment
}
}
}
Response
{
"data": {
"preApproval": {
"createLoanPreApprovalLetter": CreateLoanPreApprovalLetterResponse,
"createMaxLoanPreApprovalLetter": CreateMaxLoanPreApprovalLetterResponse,
"runLoanPreApproval": RunLoanPreApprovalResponse
}
}
}
preQualification
Description
Namespace for pre-qualification mutations. Pre-qualification is a lightweight process for estimating how large of a mortgage a borrower might qualify for based on stated information.
Response
Returns a PreQualificationMutations
Example
Query
mutation preQualification {
preQualification {
conventional {
...ConventionalResponseFragment
}
}
}
Response
{
"data": {
"preQualification": {
"conventional": ConventionalResponse
}
}
}
pricing
Description
Namespace for asynchronous pricing queries. These mutations kick off asynchronous jobs which can be used to price and structure a loan.
Response
Returns a PricingMutations
Example
Query
mutation pricing {
pricing {
calculateOptimalStructure {
...CalculateOptimalStructureResponseFragment
}
}
}
Response
{
"data": {
"pricing": {
"calculateOptimalStructure": CalculateOptimalStructureResponse
}
}
}
pricingBatches
Description
Asynchronous pricing batch mutations
Response
Returns a PricingBatchesMutations
Example
Query
mutation pricingBatches {
pricingBatches {
createPricingBatchUpload {
...CreatePricingBatchUploadResponseFragment
}
}
}
Response
{
"data": {
"pricingBatches": {
"createPricingBatchUpload": CreatePricingBatchUploadResponse
}
}
}
pricingChanges
Description
Changes to pricing change findings. Restricted to internal Pylon operators.
Response
Returns a PricingChangesMutations
Example
Query
mutation pricingChanges {
pricingChanges {
dismissPricingChangeFinding {
...DismissPricingChangeFindingResponseFragment
}
}
}
Response
{
"data": {
"pricingChanges": {
"dismissPricingChangeFinding": DismissPricingChangeFindingResponse
}
}
}
productDeliveryCommitments
Description
Product delivery commitment mutations. Pylon super-admins only.
Response
Returns a ProductDeliveryCommitmentsMutations
Example
Query
mutation productDeliveryCommitments {
productDeliveryCommitments {
set {
...SetProductDeliveryCommitmentsResponseFragment
}
}
}
Response
{
"data": {
"productDeliveryCommitments": {
"set": SetProductDeliveryCommitmentsResponse
}
}
}
productRelockPolicies
Description
Relock pricing configuration mutations. Pylon super-admins only.
Response
Returns a ProductRelockPoliciesMutations
Example
Query
mutation productRelockPolicies {
productRelockPolicies {
set {
...SetProductRelockPoliciesResponseFragment
}
setRelockFeePolicy {
...SetRelockFeePolicyResponseFragment
}
}
}
Response
{
"data": {
"productRelockPolicies": {
"set": SetProductRelockPoliciesResponse,
"setRelockFeePolicy": SetRelockFeePolicyResponse
}
}
}
rateLockExtensionPolicies
Description
Rate lock extension policy mutations. Pylon super-admins only.
Response
Returns a RateLockExtensionPoliciesMutations
Example
Query
mutation rateLockExtensionPolicies {
rateLockExtensionPolicies {
update {
...UpdateRateLockExtensionPoliciesResponseFragment
}
updateProduct {
...UpdateProductRateLockExtensionPoliciesResponseFragment
}
}
}
Response
{
"data": {
"rateLockExtensionPolicies": {
"update": UpdateRateLockExtensionPoliciesResponse,
"updateProduct": UpdateProductRateLockExtensionPoliciesResponse
}
}
}
reapp
Response
Returns a ReappMutations
Example
Query
mutation reapp {
reapp {
reappLoan {
...ReappLoanResponseFragment
}
}
}
Response
{"data": {"reapp": {"reappLoan": ReappLoanResponse}}}
subjectProperty
Description
SubjectProperty mutations
Response
Returns a SubjectPropertyMutations
Example
Query
mutation subjectProperty {
subjectProperty {
addSubjectPropertyIntent {
...AddSubjectPropertyIntentResponseFragment
}
attachAddress {
...AttachSubjectPropertyAddressResponseFragment
}
attachLiabilities {
...AttachSubjectPropertyLiabilitiesResponseFragment
}
create {
...CreateSubjectPropertyResponseFragment
}
detachAddress {
...DetachSubjectPropertyAddressResponseFragment
}
detachLiabilities {
...DetachSubjectPropertyLiabilitiesResponseFragment
}
setFirstLien {
...SetSubjectPropertyFirstLienResponseFragment
}
unsetFirstLien {
...UnsetSubjectPropertyFirstLienResponseFragment
}
update {
...UpdateSubjectPropertyResponseFragment
}
updateSubjectPropertyIntent {
...UpdateSubjectPropertyIntentResponseFragment
}
}
}
Response
{
"data": {
"subjectProperty": {
"addSubjectPropertyIntent": AddSubjectPropertyIntentResponse,
"attachAddress": AttachSubjectPropertyAddressResponse,
"attachLiabilities": AttachSubjectPropertyLiabilitiesResponse,
"create": CreateSubjectPropertyResponse,
"detachAddress": DetachSubjectPropertyAddressResponse,
"detachLiabilities": DetachSubjectPropertyLiabilitiesResponse,
"setFirstLien": SetSubjectPropertyFirstLienResponse,
"unsetFirstLien": UnsetSubjectPropertyFirstLienResponse,
"update": UpdateSubjectPropertyResponse,
"updateSubjectPropertyIntent": UpdateSubjectPropertyIntentResponse
}
}
}
support
Description
Support ticket mutations.
Response
Returns a SupportMutations
Example
Query
mutation support {
support {
addSupportMessage {
...AddSupportMessageResponseFragment
}
createSupportTicket {
...CreateSupportTicketResponseFragment
}
requestSupportDocumentUpload {
...RequestSupportDocumentUploadResponseFragment
}
}
}
Response
{
"data": {
"support": {
"addSupportMessage": AddSupportMessageResponse,
"createSupportTicket": CreateSupportTicketResponse,
"requestSupportDocumentUpload": RequestSupportDocumentUploadResponse
}
}
}
supportAdmin
Description
Pylon-internal support administration mutations.
Response
Returns a SupportAdminMutations
Example
Query
mutation supportAdmin {
supportAdmin {
addIssueType {
...AddIssueTypeResponseFragment
}
deleteIssueType {
...DeleteIssueTypeResponseFragment
}
importIssueType {
...ImportIssueTypeResponseFragment
}
}
}
Response
{
"data": {
"supportAdmin": {
"addIssueType": AddIssueTypeResponse,
"deleteIssueType": DeleteIssueTypeResponse,
"importIssueType": ImportIssueTypeResponse
}
}
}
underwritingReview
Description
Underwriter review mutations namespace.
Response
Returns an UnderwritingReviewMutations
Example
Query
mutation underwritingReview {
underwritingReview {
addManualRequirement {
...AddManualRequirementResponseFragment
}
confirmAssessment {
...ConfirmAssessmentResponseFragment
}
removeManualRequirement {
...RemoveManualRequirementResponseFragment
}
reopenAssessment {
...ReopenAssessmentResponseFragment
}
requestReconsideration {
...RequestReconsiderationResponseFragment
}
restoreRequirement {
...RestoreRequirementResponseFragment
}
submitCounterAssessment {
...SubmitCounterAssessmentResponseFragment
}
}
}
Response
{
"data": {
"underwritingReview": {
"addManualRequirement": AddManualRequirementResponse,
"confirmAssessment": ConfirmAssessmentResponse,
"removeManualRequirement": RemoveManualRequirementResponse,
"reopenAssessment": ReopenAssessmentResponse,
"requestReconsideration": RequestReconsiderationResponse,
"restoreRequirement": RestoreRequirementResponse,
"submitCounterAssessment": SubmitCounterAssessmentResponse
}
}
}
verify
Response
Returns a VerifyMutations
Example
Query
mutation verify {
verify {
createInitializationToken {
... on PlaidLinkToken {
...PlaidLinkTokenFragment
}
... on TruvBridgeToken {
...TruvBridgeTokenFragment
}
}
createUpdateModeToken {
...CreateUpdateModeTokenResponseFragment
}
exchangePublicToken {
... on PlaidItemAccess {
...PlaidItemAccessFragment
}
... on TruvLinkAccess {
...TruvLinkAccessFragment
}
}
getPlaidLayerSession {
...GetPlaidLayerSessionResponseFragment
}
}
}
Response
{
"data": {
"verify": {
"createInitializationToken": PlaidLinkToken,
"createUpdateModeToken": CreateUpdateModeTokenResponse,
"exchangePublicToken": PlaidItemAccess,
"getPlaidLayerSession": GetPlaidLayerSessionResponse
}
}
}
Types
AccessoryUnitIncome
Description
Accessory unit income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
ActivateLoanOfficerHereInput
Description
Input to the activateLoanOfficerHere mutation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the GlobalLoanOfficer to make active in the current organization. |
Example
{"id": "4"}
ActivateLoanOfficerHereResponse
Description
Response of the activateLoanOfficerHere mutation
Fields
| Field Name | Description |
|---|---|
globalLoanOfficer - GlobalLoanOfficer
|
The GlobalLoanOfficer after the change. Null exactly when userErrors is not empty. |
movedFrom - [LoanOfficerOrganization!]!
|
Every other organization the loan officer was active in, where this change made them inactive, the one they were last active in first. Empty when they were not active in another organization, and when userErrors is not empty. |
userErrors - [UserError!]!
|
Why the change was not made, when the caller can act on it. Empty when it was made. A loan officer not in the organization is reported as an error, not here. |
Example
{
"globalLoanOfficer": GlobalLoanOfficer,
"movedFrom": [LoanOfficerOrganization],
"userErrors": [UserError]
}
AddAppraisalCommentInput
Description
Input for adding a comment to an appraisal order.
Fields
| Input Field | Description |
|---|---|
appraisalId - ID
|
ID of the appraisal or appraisal order to comment on: an Appraisal.id (as in Loan.appraisal(id)), whose order is used, or an AppraisalOrder.id. Give this or appraisalOrderId, not both. |
comment - String!
|
Comment text to add. |
loanId - ID!
|
ID of the loan application that owns the order. |
Example
{
"appraisalId": 4,
"comment": "xyz789",
"loanId": "4"
}
AddAppraisalCommentResponse
Description
Response from adding a comment to an appraisal order.
Fields
| Field Name | Description |
|---|---|
comment - AppraisalComment
|
The comment as recorded on the order. Null when it was not delivered. |
success - Boolean!
|
Whether the comment was successfully added. |
userErrors - [UserError!]!
|
Why the comment was not delivered, when it was not. |
Example
{
"comment": AppraisalComment,
"success": true,
"userErrors": [UserError]
}
AddAppraisalDocumentsInput
Description
Input for adding documents to an appraisal order.
Fields
| Input Field | Description |
|---|---|
appraisalId - ID
|
ID of the appraisal or appraisal order to attach documents to: an Appraisal.id (as in Loan.appraisal(id)), whose order is used, or an AppraisalOrder.id. Give this or appraisalOrderId, not both. |
documents - [AppraisalDocumentInput!]!
|
Documents to upload. |
loanId - ID!
|
ID of the loan application that owns the order. |
Example
{
"appraisalId": 4,
"documents": [AppraisalDocumentInput],
"loanId": 4
}
AddAppraisalDocumentsResponse
Description
Response from adding documents to an appraisal order.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Whether the documents were successfully added. |
userErrors - [UserError!]!
|
Why the documents were not added, when they were not. |
Example
{"success": true, "userErrors": [UserError]}
AddEmailDomainsInput
Fields
| Input Field | Description |
|---|---|
domains - [String!]!
|
Email domains to add to the organization. Domains are normalized to lowercase. |
Example
{"domains": ["abc123"]}
AddEmailDomainsResponse
Fields
| Field Name | Description |
|---|---|
emailDomains - [String!]!
|
Example
{"emailDomains": ["abc123"]}
AddIssueTypeInput
AddIssueTypeResponse
Description
Response from creating an issue type.
Fields
| Field Name | Description |
|---|---|
label - SupportIssueType!
|
The registered issue type. |
Example
{"label": SupportIssueType}
AddManualRequirementInput
Fields
| Input Field | Description |
|---|---|
citationIds - [ID!]
|
Citations grounding the requirement (created beforehand via createCitation). Every id must resolve to a citation on loanId; duplicates collapse to the first occurrence. Recorded as minting provenance only — citations never affect satisfaction. |
description - String!
|
Human-readable description of the condition. |
loanId - ID!
|
The loan to add the requirement to. |
parentRequirementId - ID
|
Optional composite parent to nest the requirement under. Must be an active requirement on the same loan. |
reasoning - String
|
Why the requirement is being added (minting provenance). |
slug - String!
|
Stable identity slug. The requirement id content-addresses on {slug}, so adding a slug that already has a requirement returns that requirement's id and changes nothing. |
Example
{
"citationIds": [4],
"description": "abc123",
"loanId": 4,
"parentRequirementId": 4,
"reasoning": "abc123",
"slug": "abc123"
}
AddManualRequirementResponse
Description
Result of adding a manual requirement.
Fields
| Field Name | Description |
|---|---|
outcome - ManualRequirementAddOutcome!
|
What the add did with the slug. |
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
requirementId - ID!
|
The requirement's stable content-addressed id (req_…). Re-adding the same slug returns the same id. Use requirement { id }.
|
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"outcome": "ALREADY_ON_LOAN",
"requirement": Requirement,
"requirementId": "4",
"warnings": ["TARGET_SUPERSEDED"]
}
AddNotableActivityInput
Description
Input to the addNotableActivity mutation.
Fields
| Input Field | Description |
|---|---|
activityType - FinancialAccountActivityType
|
Activity type |
amount - Int
|
The amount of money in dollars |
assetId - ID!
|
|
date - Date
|
The date when the activity occurred |
description - String
|
Description of the activity |
Example
{
"activityType": "LARGE_DEPOSIT",
"amount": 987,
"assetId": "4",
"date": "2007-12-03",
"description": "abc123"
}
AddNotableActivityResponse
Description
Response of the addNotableActivity mutation.
Fields
| Field Name | Description |
|---|---|
activity - FinancialAccountActivity!
|
The FinancialAccountActivity entity that was added to the asset |
Example
{"activity": FinancialAccountActivity}
AddOrganizationFeeInput
Fields
| Input Field | Description |
|---|---|
fee - OrganizationFeeInput!
|
Example
{"fee": OrganizationFeeInput}
AddOrganizationFeeResponse
Fields
| Field Name | Description |
|---|---|
organization - Organization
|
The organization after the change (select fees / feeHistory for the new schedule); null when the change was refused (see userErrors). |
userErrors - [GenericUserError!]!
|
Why the change was refused: CUSTOMER_FEE_DUAL_COMPENSATION or CUSTOMER_FEE_CONFLICTS_WITH_RATE_COST on an add or replace (see those mutations for when), CUSTOMER_FEE_NOT_ACTIVE when the fee was already replaced or retired, or MARGIN_WINDOW_START_BEFORE_CURRENT when a newer schedule already exists (retry). Empty when it was applied. |
Example
{
"organization": Organization,
"userErrors": [GenericUserError]
}
AddRequirementConversationMessageInput
Fields
| Input Field | Description |
|---|---|
body - String!
|
|
replyToId - ID
|
An earlier message in the same conversation that this one replies to. |
requestId - ID!
|
Caller-chosen idempotency key. Retrying with the same key and input returns the original message; reusing it for a different input is refused. |
sessionId - ID!
|
Example
{
"body": "xyz789",
"replyToId": 4,
"requestId": "4",
"sessionId": "4"
}
AddRequirementConversationMessageResponse
Fields
| Field Name | Description |
|---|---|
message - RequirementConversationMessage
|
The message, or null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused: REQUIREMENT_CONVERSATION_STATE_CONFLICT (the conversation can't take this step now) or REQUIREMENT_CONVERSATION_REQUEST_ID_REUSED (the request id was used for a different request). Empty on success. |
Example
{
"message": RequirementConversationMessage,
"userErrors": [UserError]
}
AddSubjectPropertyIntentInput
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
County-level FIPS code |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
loanId - ID!
|
The ID or friendly ID of the Loan to which the SubjectPropertyIntent should be added |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing |
propertyUsageType - PropertyUsageType
|
How the borrower(s) intend to use the property |
Example
{
"fipsCountyCode": "xyz789",
"isPlannedUnitDevelopment": false,
"loanId": "4",
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT"
}
AddSubjectPropertyIntentResponse
Fields
| Field Name | Description |
|---|---|
subjectPropertyIntent - SubjectPropertyIntent!
|
The SubjectPropertyIntent that was added to the loan |
Example
{"subjectPropertyIntent": SubjectPropertyIntent}
AddSupportMessageInput
Description
Input for adding a message to an existing ticket.
Fields
| Input Field | Description |
|---|---|
additionalRecipients - [SupportRecipientInput!]
|
Extra addresses to copy on this message; at most 10. |
attachmentDocumentIds - [ID!]
|
Loan documents to attach: ids returned by requestSupportDocumentUpload's file POST, or document ids from the ticket's loan documents. Documents are reusable across tickets and messages; at most 20 per message. |
body - String!
|
The message body. |
requesterEmail - String!
|
Email of the person posting the message. |
requesterName - String!
|
Name of the person posting the message. |
ticketId - ID!
|
The ticket id (Plain thread id). |
Example
{
"additionalRecipients": [SupportRecipientInput],
"attachmentDocumentIds": ["4"],
"body": "xyz789",
"requesterEmail": "xyz789",
"requesterName": "xyz789",
"ticketId": "4"
}
AddSupportMessageResponse
Description
Response from adding a message to a ticket.
Fields
| Field Name | Description |
|---|---|
ticketId - ID!
|
The ticket the message was added to. |
Example
{"ticketId": "4"}
Address
Description
US Address
Example
{
"city": "abc123",
"country": "xyz789",
"line": "abc123",
"line2": "xyz789",
"state": "AK",
"zipCode": "xyz789"
}
AddressInput
Description
US Address Input
Example
{
"city": "xyz789",
"country": "abc123",
"line": "xyz789",
"line2": "abc123",
"state": "AK",
"zipCode": "xyz789"
}
AdvisorCompletionJob
Fields
| Field Name | Description |
|---|---|
failureMessage - String
|
|
id - ID!
|
|
status - JobStatus!
|
Example
{
"failureMessage": "xyz789",
"id": 4,
"status": "FAILED"
}
AdvisorMutations
Fields
| Field Name | Description |
|---|---|
createSession - CreateSessionResponse
|
|
giveMessageFeedback - GiveMessageFeedbackResponse
|
|
Arguments
|
|
sendMessage - SendMessageResponse
|
|
Arguments
|
|
Example
{
"createSession": CreateSessionResponse,
"giveMessageFeedback": GiveMessageFeedbackResponse,
"sendMessage": SendMessageResponse
}
AdvisorSession
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
id - ID!
|
|
messages - [AdvisorSessionMessage!]!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"messages": [AdvisorSessionMessage]
}
AdvisorSessionAdvisorMessage
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
The advisor session this message belongs to. |
advisorSessionId - ID!
|
Use advisorSession { id }.
|
content - String!
|
|
createdAt - DateTime!
|
|
feedback - AdvisorSessionAdvisorMessageFeedback
|
|
id - ID!
|
Example
{
"advisorSession": AdvisorSession,
"advisorSessionId": 4,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"feedback": AdvisorSessionAdvisorMessageFeedback,
"id": "4"
}
AdvisorSessionAdvisorMessageFeedback
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
The advisor session this message belongs to. |
advisorSessionId - ID!
|
Use advisorSession { id }.
|
content - String!
|
|
createdAt - DateTime!
|
|
id - ID!
|
|
note - String
|
|
sentiment - AdvisorSessionAdvisorMessageFeedbackSentiment!
|
Example
{
"advisorSession": AdvisorSession,
"advisorSessionId": 4,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"note": "xyz789",
"sentiment": "NEGATIVE"
}
AdvisorSessionAdvisorMessageFeedbackSentiment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NEGATIVE"
AdvisorSessionMessage
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
The advisor session this message belongs to. |
advisorSessionId - ID!
|
Use advisorSession { id }.
|
content - String!
|
|
createdAt - DateTime!
|
|
id - ID!
|
Possible Types
| AdvisorSessionMessage Types |
|---|
Example
{
"advisorSession": AdvisorSession,
"advisorSessionId": 4,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4"
}
AdvisorSessionUserMessage
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
The advisor session this message belongs to. |
advisorSessionId - ID!
|
Use advisorSession { id }.
|
content - String!
|
|
createdAt - DateTime!
|
|
id - ID!
|
Example
{
"advisorSession": AdvisorSession,
"advisorSessionId": "4",
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4
}
AgentProvenance
Description
Provenance from an automated interpretation agent. The requirement exists because an agent derived a concrete, loan-specific ask from an automated underwriting finding; a person can waive or retire it like any manually added condition.
Fields
| Field Name | Description |
|---|---|
ausRunId - ID!
|
The automated underwriting run whose finding produced this ask. |
description - String!
|
The agent's reasoning for why this finding binds this loan. |
evidence - [GuidelineReference!]!
|
Supporting evidence. Always empty — the source finding is carried in the typed fields, and document-anchored evidence lives in the requirement's evidence log. |
findingText - String!
|
The verbatim finding text the ask was derived from. |
messageKey - String!
|
Stable key of the source finding's message type. |
mintedAt - DateTimeISO!
|
When the ask was minted. |
model - String!
|
The model that proposed this ask. |
promptName - String!
|
Name of the interpretation prompt that proposed this ask. |
promptVersion - NonNegativeInt!
|
Version of the interpretation prompt. |
traceId - String
|
Observability trace id of the interpretation call, for auditing. |
Example
{
"ausRunId": 4,
"description": "xyz789",
"evidence": [GuidelineReference],
"findingText": "xyz789",
"messageKey": "xyz789",
"mintedAt": "2007-12-03T10:15:30Z",
"model": "abc123",
"promptName": "xyz789",
"promptVersion": 123,
"traceId": "xyz789"
}
AlimonyIncome
Description
Alimony income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
Analytics
Fields
| Field Name | Description |
|---|---|
job - AnalyticsExportJob!
|
|
Arguments
|
|
loanApplicationMetrics - LoanApplicationAnalyticsMetrics!
|
|
Arguments |
|
loanApplications - LoanApplicationAnalyticsConnection!
|
|
Arguments
|
|
summary - PipelineSummaryResponse!
|
|
Arguments
|
|
Example
{
"job": AnalyticsExportJob,
"loanApplicationMetrics": LoanApplicationAnalyticsMetrics,
"loanApplications": LoanApplicationAnalyticsConnection,
"summary": PipelineSummaryResponse
}
AnalyticsDateBucket
Description
The calendar period a date dimension is grouped into.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAY"
AnalyticsExportFile
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "abc123"}
AnalyticsExportFormat
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CSV"
AnalyticsExportJob
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
result - AnalyticsExportFile
|
|
status - JobStatus!
|
Example
{
"id": "4",
"result": AnalyticsExportFile,
"status": "FAILED"
}
AnalyticsExportRoot
Values
| Enum Value | Description |
|---|---|
|
|
Example
"LOAN_APPLICATIONS"
AnalyticsMutations
Fields
| Field Name | Description |
|---|---|
startAnalyticsExportJob - StartAnalyticsExportJobResponse
|
|
Arguments
|
|
Example
{
"startAnalyticsExportJob": StartAnalyticsExportJobResponse
}
AnyContributor
Possible Types
| AnyContributor Types |
|---|
Example
{"displayName": "xyz789", "id": 4}
Apor
Description
The average interest rate offered to highly qualified buyers, as published by the FFIEC.
Fields
| Field Name | Description |
|---|---|
amortizationType - AporAmortizationType!
|
Whether this APOR applies to fixed or adjustable-rate mortages. |
date - DateTime!
|
The date this APOR was published. |
loanTermOrYearsToFirstAdjustment - PositiveInt!
|
APOR is calculated in buckets according to term for fixed-rate mortgages, or according to the number of years until the rate may adjust for ARMs. |
rate - PositiveFloat!
|
The average interest rate by amortization type and term/years until adjustment. |
Example
{
"amortizationType": "ADJUSTABLE_RATE",
"date": "2007-12-03T10:15:30Z",
"loanTermOrYearsToFirstAdjustment": 123,
"rate": 123.45
}
AporAmortizationType
Description
The amoritization type of the APOR. The APORs of fixed and ARM mortgages are calculated separately.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADJUSTABLE_RATE"
AppliedMargin
Description
The margin applied to a loan's pricing.
Fields
| Field Name | Description |
|---|---|
activeAt - DateTime!
|
The instant this margin segment became active (inclusive). |
customerMargin - NonNegativeFloat!
|
Deprecated: use loanOfficerMargin, or split.companyMargin where you may read the margin breakdown. The portion of the global margin the customer receives, in points (1.5 = 1.5%). A caller without access to the margin breakdown may receive the loan officer margin here instead. Use loanOfficerMargin, or split.companyMargin where you may read the margin breakdown.
|
endsAt - DateTime
|
The instant this margin segment stops being active (exclusive). Null for the segment active right now. |
globalMargin - NonNegativeFloat!
|
Deprecated: no field replaces the full margin; use loanOfficerMargin for the loan officer's part. The full margin priced into the loan, in points (1.5 = 1.5%). A caller without access to the margin breakdown may receive the loan officer margin here instead, which can be smaller than the margin priced into the loan. No field replaces the full margin. Use loanOfficerMargin for the loan officer's part.
|
loanOfficerMargin - NonNegativeFloat!
|
The part of the margin the company's loan officers receive, in points (1.5 = 1.5%). Every caller who may read appliedMargin gets this value. |
split - MarginSplit
|
How the customer margin splits between the company's loan officers and the company. Null unless the caller may read the margin breakdown. |
Example
{
"activeAt": "2007-12-03T10:15:30Z",
"customerMargin": 123.45,
"endsAt": "2007-12-03T10:15:30Z",
"globalMargin": 123.45,
"loanOfficerMargin": 123.45,
"split": MarginSplit
}
Appraisal
Description
Represents an appraisal order and related property valuation details.
Fields
| Field Name | Description |
|---|---|
actualValueAmount - Float
|
The actual appraised value of the property in dollars. |
appraisalManagementCompanies - [Contact!]!
|
Appraisal management companies (AMCs) on the appraisal. |
appraisalTypeName - String
|
Name of the appraisal type that was ordered, as reported by the appraisal vendor. |
appraisers - [Contact!]!
|
Appraisers assigned on the appraisal. |
assignedAt - DateTime
|
Date the appraiser was assigned. |
avmValueAmount - Float
|
The automated valuation model (AVM) estimated value in dollars. |
comments - [AppraisalComment!]
|
The message thread with the appraisal management company on this appraisal's order, oldest first, refreshed like AppraisalOrder.comments. Null when the appraisal has no appraisal order, so the thread is not available; an empty list means the order has no messages. |
deliveredToBorrowerAt - DateTime
|
Date the report was delivered to the borrower. |
documents - [Document!]!
|
Documents associated with the appraisal. |
effectiveDate - Date
|
Effective date of the appraisal valuation. |
id - ID!
|
The ID of the appraisal. |
inspectionCompletedAt - DateTime
|
Date the property inspection was completed. |
orderAcceptedAt - DateTime
|
Date the appraisal order was accepted. |
orderCompletedAt - DateTime
|
Date the appraisal order was completed. |
orderStatus - AppraisalOrderStatus
|
Current status of the appraisal order. |
orderedAt - DateTime
|
Date the appraisal was ordered. |
paidAt - Date
|
Date the appraisal order was paid. |
paymentLink - String
|
Link to the payment portal for the appraisal fee. |
paymentStatus - AppraisalPaymentStatus
|
Current status of the appraisal payment. |
receivedAt - DateTime
|
Date the completed report was received. |
reportSignedAt - DateTime
|
Date the report was signed. |
scheduledAt - DateTime
|
Scheduled date of the property inspection by the appraiser. |
valuationMethod - PropertyValuationMethodType
|
Valuation method used to assess the property's value. |
Example
{
"actualValueAmount": 987.65,
"appraisalManagementCompanies": [Contact],
"appraisalTypeName": "xyz789",
"appraisers": [Contact],
"assignedAt": "2007-12-03T10:15:30Z",
"avmValueAmount": 123.45,
"comments": [AppraisalComment],
"deliveredToBorrowerAt": "2007-12-03T10:15:30Z",
"documents": [Document],
"effectiveDate": "2007-12-03",
"id": 4,
"inspectionCompletedAt": "2007-12-03T10:15:30Z",
"orderAcceptedAt": "2007-12-03T10:15:30Z",
"orderCompletedAt": "2007-12-03T10:15:30Z",
"orderStatus": "ACCEPTED",
"orderedAt": "2007-12-03T10:15:30Z",
"paidAt": "2007-12-03",
"paymentLink": "abc123",
"paymentStatus": "NO_AMOUNT_DUE",
"receivedAt": "2007-12-03T10:15:30Z",
"reportSignedAt": "2007-12-03T10:15:30Z",
"scheduledAt": "2007-12-03T10:15:30Z",
"valuationMethod": "AUTOMATED_VALUATION_MODEL"
}
AppraisalComment
Description
A message on an appraisal order's thread with the appraisal management company.
Fields
| Field Name | Description |
|---|---|
authorSide - AppraisalCommentAuthorSide!
|
Which side of the order wrote the comment. |
body - String!
|
Comment text. |
deliveryStatus - AppraisalCommentDeliveryStatus!
|
How far the comment has got: SENDING, SENT or DELIVERED. |
id - ID!
|
Unique identifier of the comment. |
postedAt - DateTime!
|
When the comment was posted: the vendor's timestamp, or when it was sent from here if the vendor has not echoed it yet. |
Example
{
"authorSide": "LENDER",
"body": "abc123",
"deliveryStatus": "DELIVERED",
"id": 4,
"postedAt": "2007-12-03T10:15:30Z"
}
AppraisalCommentAuthorSide
Description
Which side of an appraisal order wrote a comment: the lender, or the appraisal management company or appraiser.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LENDER"
AppraisalCommentDeliveryStatus
Description
How far a comment has got. A reply sent from here is SENDING until the appraisal vendor accepts it, SENT once it has, and DELIVERED once the vendor's copy of it has been received. Comments from the vendor are always DELIVERED. A reply the vendor refused, or whose send got no definite answer, is not shown.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELIVERED"
AppraisalDocumentInput
Description
A single document to attach to an appraisal order.
Example
{
"base64Content": "xyz789",
"documentTypeId": "xyz789",
"name": "abc123"
}
AppraisalMutations
Description
Root type for appraisal mutations.
Fields
| Field Name | Description |
|---|---|
addComment - AddAppraisalCommentResponse
|
Add a comment to an appraisal's order. Pylon internal admins only, and only for customers with appraisal replies turned on. |
Arguments
|
|
addDocuments - AddAppraisalDocumentsResponse
|
Add documents to an appraisal's order. Pylon internal admins only. |
Arguments
|
|
orderAppraisal - OrderAppraisalResponse
|
Order an appraisal for a loan. Pylon internal admins only. |
Arguments
|
|
Example
{
"addComment": AddAppraisalCommentResponse,
"addDocuments": AddAppraisalDocumentsResponse,
"orderAppraisal": OrderAppraisalResponse
}
AppraisalOrder
Description
An appraisal order placed with a vendor to obtain a property valuation.
Fields
| Field Name | Description |
|---|---|
comments - [AppraisalComment!]!
|
The order's message thread with the appraisal management company, oldest first. Refreshed from the vendor when the stored thread is more than a minute old; if that refresh fails or is slow, the stored thread is returned. |
commentsSyncedAt - DateTime
|
When the comment thread was last refreshed from the vendor and stored; a refresh still in flight or one that failed does not count. Null when it never has been, or when a reply sent from here is waiting to be confirmed. |
createdOn - DateTime!
|
When the order was created. |
id - ID!
|
Unique identifier of the appraisal order. |
result - AppraisalOrderResult
|
Appraisal result once completed. |
status - AppraisalOrderStatusEnum!
|
Current lifecycle status of the order. |
vendor - AppraisalVendor!
|
Vendor handling the appraisal order. |
vendorOrderId - Int
|
Vendor-assigned order identifier. |
Example
{
"comments": [AppraisalComment],
"commentsSyncedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"id": 4,
"result": AppraisalOrderResult,
"status": "CANCELLED",
"vendor": "VALUE_LINK",
"vendorOrderId": 123
}
AppraisalOrderResult
AppraisalOrderStatus
Description
The current status of the appraisal order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
AppraisalOrderStatusEnum
Description
Status of an appraisal order through its lifecycle.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
AppraisalPaymentStatus
Description
The current status of payment for the appraisal order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_AMOUNT_DUE"
AppraisalQueries
Description
Root type for appraisal queries.
Fields
| Field Name | Description |
|---|---|
availableAmcs - [AvailableAmc!]!
|
Available appraisal management companies for a loan and appraisal type, with fees. |
Arguments
|
|
availableAppraisalTypes - [AvailableAppraisalType!]!
|
Available appraisal types for a loan based on property location. |
Arguments
|
|
Example
{
"availableAmcs": [AvailableAmc],
"availableAppraisalTypes": [AvailableAppraisalType]
}
AppraisalVendor
Description
Supported appraisal vendors.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"VALUE_LINK"
AppraisalWaiver
Description
Types of appraisal waivers (e.g., PIW, ACE) that waive the need for an appraisal on eligible loans.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTOMATED_COLLATERAL_EVALUATION"
ApprovalProcessDisputeKind
Description
The dispute action being recorded by an underwriter in approval-process.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CHALLENGE"
ApprovalProcessEvidenceRefInput
Fields
| Input Field | Description |
|---|---|
evidenceId - ID!
|
Content-addressed id of the target assertion edge. The id pins the exact content, so no separate hash is carried. |
Example
{"evidenceId": 4}
ApprovalProcessMutations
Fields
| Field Name | Description |
|---|---|
writeDispute - WriteDisputeResponse
|
Writes a CHALLENGE/REJECTION dispute pinned to an assertion edge, or a WAIVE of a requirement. |
Arguments
|
|
Example
{"writeDispute": WriteDisputeResponse}
ApproveConcessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
ApproveConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
ApproveLoanChangeRequestInput
Description
Input to the loan.approveChangeRequest mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the loan change request to approve |
Example
{"id": 4}
ApproveLoanChangeRequestResponse
Description
Response of the loan.approveChangeRequest mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the loan change request |
status - LoanChangeRequestStatus!
|
Current status of this change request |
Example
{"id": "4", "status": "APPROVED"}
ApprovedPreApprovalRun
Description
A successful pre-approval
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
loanAmount - NonNegativeInt!
|
|
maxPreApprovalLetterUrl - String
|
A download URL for a pre-approval letter with the maximum pre-approved loan amount and purchase price for the loan. |
salesContractAmount - NonNegativeInt!
|
Example
{
"id": 4,
"loanAmount": 123,
"maxPreApprovalLetterUrl": "abc123",
"salesContractAmount": 123
}
AprInaccurateReason
Description
§1026.19(f)(2)(ii)(A): the disclosed APR is no longer accurate. A null currentAprPercent is a loan whose APR can no longer be measured, which is reported rather than passed over.
Fields
| Field Name | Description |
|---|---|
currentAprPercent - Float
|
This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
disclosedAprPercent - Float!
|
This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
kind - DisclosureDriftReasonKind!
|
|
thresholdPercent - Float!
|
The §1026.22(a) tolerance applied. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"currentAprPercent": 987.65,
"disclosedAprPercent": 123.45,
"kind": "APR_INACCURATE",
"thresholdPercent": 987.65
}
ArchiveLoanInput
Description
Input to the archiveLoan mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the loan to archive |
Example
{"id": "4"}
ArchiveLoanResponse
Types
| Union Types |
|---|
Example
ArchiveLoanSuccess
ArchiveLoanSuccess
Description
A successful response after a loan has been archived.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the archived loan |
Example
{"id": "4"}
ArchiveReasonCategory
Description
Why a document was archived (e.g. Duplicate, Illegible).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AssociatedToDifferentAspect"
AsianRace
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHINESE"
Assertion
Description
An authored, reasoned verdict on a requirement, grounded in citations. authoritative marks the assertion that won the requirement's server-side fold — clients must never re-derive it.
Fields
| Field Name | Description |
|---|---|
author - Contributor!
|
WHO authored this assertion — always a Contributor, resolved from the writing context, never client-supplied. |
authoritative - Boolean!
|
True when this assertion won its requirement's authoritative-read fold — server-computed from the reconcile projection pin, never client-derived. |
citations - [Citation!]!
|
The citation rows grounding this assertion. Unresolvable references are skipped (and logged server-side), never surfaced as errors. |
condition - AssertionCondition
|
The open condition this assertion states — what must change for the claim to hold. Null on a FULFILLED verdict (nothing is open) and on authors that record no condition. |
confidence - ConfidenceLevel
|
The author's ordinal confidence in the verdict. Null when the author recorded none. |
createdAt - DateTimeISO!
|
When this assertion was written. |
disputes - [Dispute!]!
|
The dispute acts pinned to this assertion. |
documents - [LoanDocument!]!
|
The input documents this assertion's author consumed. Unresolvable references are skipped (and logged server-side), never surfaced as errors. |
endorsesSuperseded - Boolean!
|
True when this assertion endorses a prior assertion that has been invalidated or is no longer current — the endorsement carries no fold authority. |
id - ID!
|
Stable content-addressed identifier, resolvable via the root node(id) query. |
reasoning - String
|
The author's reasoning narrative. Null when a redaction has tombstoned the text (the entry remains verifiable). |
verdict - AssertionVerdict!
|
The author's verdict on the claim. |
Example
{
"author": Contributor,
"authoritative": true,
"citations": [Citation],
"condition": AssertionCondition,
"confidence": "CERTAIN",
"createdAt": "2007-12-03T10:15:30Z",
"disputes": [Dispute],
"documents": [LoanDocument],
"endorsesSuperseded": true,
"id": 4,
"reasoning": "abc123",
"verdict": "FULFILLED"
}
AssertionCondition
Description
The open condition an unmet assertion states: what must change for the claim to hold. Distinct from reasoning (why the author reached this verdict) — this is the actionable ask.
Example
{
"provenance": "xyz789",
"text": "xyz789"
}
AssertionVerdict
Description
An assertion's verdict on its claim: FULFILLED (the claim holds), UNFULFILLED (it does not), NEEDS_HUMAN (a human must judge).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FULFILLED"
Asset
Description
Interface with fields shared across all asset types
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Asset ID |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Possible Types
| Asset Types |
|---|
Example
{
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
AssetDataSource
Description
PLAID identifies a linked Plaid account. MANUAL identifies an asset without a Plaid account link, including imported assets.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MANUAL"
AssetMutations
Description
Asset mutations
Fields
| Field Name | Description |
|---|---|
addNotableActivity - AddNotableActivityResponse
|
Add a notable activity to an asset |
Arguments
|
|
attachBorrower - AttachBorrowerAssetResponse
|
Attach a borrower to an asset |
Arguments
|
|
create - CreateAssetResponse
|
Create an asset |
Arguments
|
|
delete - DeleteAssetResponse
|
Delete an asset |
Arguments
|
|
deleteNotableActivity - DeleteNotableActivityResponse
|
Delete a notable activity |
Arguments
|
|
detachBorrower - DetachBorrowerAssetResponse
|
Detach a borrower from an asset |
Arguments
|
|
explainAssetTransaction - ExplainAssetTransactionResponse
|
Submit an explanation for a large deposit asset transaction |
Arguments
|
|
update - UpdateAssetResponse
|
Update an asset. Fields with non-null values will be updated, the rest will be ignored. The input is a 'oneOf' type where exactly one field must be populated. The populated input field must match the type of the asset to update. |
Arguments
|
|
updateNotableActivity - UpdateNotableActivityResponse
|
Update a notable activity |
Arguments
|
|
Example
{
"addNotableActivity": AddNotableActivityResponse,
"attachBorrower": AttachBorrowerAssetResponse,
"create": CreateAssetResponse,
"delete": DeleteAssetResponse,
"deleteNotableActivity": DeleteNotableActivityResponse,
"detachBorrower": DetachBorrowerAssetResponse,
"explainAssetTransaction": ExplainAssetTransactionResponse,
"update": UpdateAssetResponse,
"updateNotableActivity": UpdateNotableActivityResponse
}
AssetTransaction
Description
A transaction associated with an asset from a Plaid Asset Report
Fields
| Field Name | Description |
|---|---|
amount - Int!
|
Transaction amount in dollars |
asset - Asset!
|
The asset this transaction belongs to |
assetId - ID!
|
ID of the asset this transaction belongs to Use asset { id }.
|
category - [String!]
|
List of categories associated with the transaction |
date - Date!
|
Date when the transaction occurred |
id - ID!
|
Asset Transaction ID |
merchantName - String
|
Merchant name associated with the transaction |
Example
{
"amount": 987,
"asset": Asset,
"assetId": 4,
"category": ["xyz789"],
"date": "2007-12-03",
"id": "4",
"merchantName": "abc123"
}
AssetVerificationItem
Description
A live linked institution for the refresh list.
Example
{
"accountCount": 123,
"institutionLogo": "xyz789",
"institutionName": "xyz789",
"institutionPrimaryColor": "abc123",
"itemId": "4",
"linkedAt": "2007-12-03T10:15:30Z"
}
AssetVerificationLinkKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONNECT"
AssetVerificationLinkStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
AssetVerificationLinkSummary
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
expiresAt - DateTime!
|
|
hostedUrl - String
|
The borrower-facing hosted link, null unless the link is pending and unexpired. |
itemId - ID
|
The bank connection this link concerns: set when a refresh link is created or after a connect link adds a bank connection; null until then. |
kind - AssetVerificationLinkKind!
|
Whether this link adds a new bank connection or refreshes an existing bank connection. |
linkId - String!
|
|
status - AssetVerificationLinkStatus!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"hostedUrl": "xyz789",
"itemId": 4,
"kind": "CONNECT",
"linkId": "abc123",
"status": "COMPLETED"
}
AssetVerificationMutations
Fields
| Field Name | Description |
|---|---|
detachItem - DetachItemResponse
|
Detaches a bank connection from the borrower. Its accounts leave the borrower's assets and the asset report is rebuilt from the remaining bank connections, so they do not come back on the next sync. |
Arguments
|
|
refreshLink - RefreshLinkResponse
|
|
Arguments
|
|
requestLink - RequestLinkResponse
|
|
Arguments
|
|
Example
{
"detachItem": DetachItemResponse,
"refreshLink": RefreshLinkResponse,
"requestLink": RequestLinkResponse
}
AssetVerificationQueries
Fields
| Field Name | Description |
|---|---|
items - [AssetVerificationItem!]!
|
|
Arguments
|
|
links - [AssetVerificationLinkSummary!]!
|
Returns the borrower's 10 most recent hosted links, newest first. |
Arguments
|
|
Example
{
"items": [AssetVerificationItem],
"links": [AssetVerificationLinkSummary]
}
AssignLoanOfficerInput
AssignLoanOfficerResponse
Description
Response of the assignLoanOfficer mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan the loan officer was assigned to. |
loanId - ID!
|
The ID or friendly ID of the loan. Use loan { id }.
|
loanOfficer - GlobalLoanOfficer!
|
The primary loan officer assigned to the loan. |
loanOfficerId - ID!
|
The ID of the primary loan officer assigned to the loan. Use loanOfficer { id }.
|
Example
{
"loan": Loan,
"loanId": 4,
"loanOfficer": GlobalLoanOfficer,
"loanOfficerId": 4
}
AssignedRequirement
Description
A published requirement on a loan that is assigned to one party: what it asks for, its categories and its phase.
Fields
| Field Name | Description |
|---|---|
assigneeParty - AssignedRequirementParty!
|
The party the requirement is assigned to. |
categories - [RequirementCategory!]!
|
The categories the requirement belongs to, in display order. Empty when it is uncategorised. |
description - String
|
What the requirement asks for, as published to the party. Null when there is no text for it. |
documents - [CitedDocument!]
|
The documents filed or cited by this requirement's live submissions and its live assertions that are not unfulfilled, in the order first named, each once. A document that only a live rejection, challenge, waiver, invalidation or unfulfilled assertion names is not listed, though that evidence still moves updatedAt. Retracted evidence is left out, and so is a document not filed on this loan, whose filing is archived, or that the loan's documents list hides. Null when the service cannot say which of this requirement's evidence is live (an older service, or evidence it cannot fold), so retracted evidence is never served as live. |
id - ID!
|
|
parentRequirement - AssignedRequirement
|
The parent requirement from the same published, party-assigned read. Null for a root or a parent outside that read. |
phase - RequirementPhase!
|
|
standing - AssignedRequirementStanding
|
Where the requirement stands, as underwriting reads it from its whole evidence history, including evidence this read does not show. Null when underwriting did not say: an older service, or a requirement whose evidence it cannot read. |
title - String
|
The title the requirement was created with, as revised. Null when it has none. |
updatedAt - DateTimeISO
|
When the newest live evidence on this requirement was recorded. Null when none of it is live, and when the service cannot say which of this requirement's evidence is live (an older service, or evidence it cannot fold), so retracted evidence is never served as live. |
uploadPrompt - String
|
The borrower-facing upload ask. Null when the requirement has no upload affordance. |
Example
{
"assigneeParty": "BORROWER",
"categories": ["ASSETS"],
"description": "xyz789",
"documents": [CitedDocument],
"id": 4,
"parentRequirement": AssignedRequirement,
"phase": "OPEN",
"standing": "MET",
"title": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uploadPrompt": "abc123"
}
AssignedRequirementParty
Description
A party that reads the requirements assigned to it: BORROWER or LOAN_OFFICER.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BORROWER"
AssignedRequirementStanding
Description
Where a requirement stands, as underwriting reads it from its whole evidence history.
Values
| Enum Value | Description |
|---|---|
|
|
The requirement is satisfied. |
|
|
Something waits on an underwriter, such as an upload no decision has settled yet. |
|
|
The newest decision is against it and nothing waits on an underwriter. |
|
|
Nothing waits on an underwriter and no decision is against it: it waits on someone else. |
|
|
The requirement is waived. |
Example
"MET"
AttachBorrowerAssetInput
AttachBorrowerAssetResponse
Description
Response of the attachBorrowerAsset mutation.
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The asset that was updated |
Example
{"asset": Asset}
AttachBorrowerLiabilitiesInput
AttachBorrowerLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The updated Borrower |
Example
{"borrower": Borrower}
AttachBorrowerNonBorrowingSpouseInput
AttachBorrowerNonBorrowingSpouseResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The updated Borrower |
Example
{"borrower": Borrower}
AttachContributorToDealInput
AttachContributorToDealResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
|
deal - Deal!
|
Example
{
"contributor": Contributor,
"deal": Deal
}
AttachLoanContactInput
AttachLoanContactResponse
Description
Response of the loan.attachContact mutation.
Fields
| Field Name | Description |
|---|---|
contact - Contact!
|
The contact that was successfully attached to the loan. |
Example
{"contact": Contact}
AttachLoanNoteInput
Description
Input to the attachLoanNote mutation.
Example
{
"loanId": "4",
"notes": "abc123"
}
AttachLoanNoteResponse
Description
Response of the attachLoanNote mutation.
Fields
| Field Name | Description |
|---|---|
notes - String
|
Note attached to the loan |
Example
{"notes": "abc123"}
AttachOwnedPropertyLiabilitiesInput
AttachOwnedPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The updated OwnedProperty |
Example
{"ownedProperty": OwnedProperty}
AttachOwnedPropertyLiabilityInput
AttachOwnedPropertyLiabilityResponse
Description
Response of the attachOwnedPropertyLiability mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
AttachOwnedPropertyNonBorrowingOwnerInput
AttachOwnedPropertyNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
AttachProductPricingRateInput
Description
Input to the attachProductPricingRate mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the product pricing rate to attach |
loanId - ID!
|
The ID or friendly ID of the loan. |
overrideExistingRateLock - Boolean
|
Proceed even though the loan's rate is already locked, replacing the terms the borrower was locked at. Allowed with the process:committed-rate-lock scope, or, for customers with automatic redisclosure enabled, on a loan that is not frozen (Loan.isFrozen is false). A replacement obliges the borrower a revised Loan Estimate, which is raised with the disclosure desk before the new lock commits. Applies only to a loan that already carries a lock; sending it for a loan's first lock is rejected, since there are no committed terms to replace. |
Example
{"id": 4, "loanId": 4, "overrideExistingRateLock": true}
AttachProductPricingRateResponse
Description
Response of the attachProductPricingRate mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan the product pricing rate was attached to. |
loanId - ID!
|
The ID or friendly ID of the loan. Use loan { id }.
|
productPricingRate - ProductPricingRate!
|
The latest pricing run outputs |
productStructure - ProductPricingRate!
|
The latest version of pricing-related fields. |
Example
{
"loan": Loan,
"loanId": 4,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate
}
AttachSubjectPropertyAddressInput
Description
Input to the attachSubjectPropertyAddress mutation.
Fields
| Input Field | Description |
|---|---|
city - String
|
City |
country - String
|
Country |
fipsCountyCode - String
|
County-level FIPS code |
id - ID!
|
The ID of the subject property to which the address should be attached |
line - String
|
Street address line 1 |
line2 - String
|
Street address line 2 |
zipCode - String
|
Zip code |
Example
{
"city": "abc123",
"country": "xyz789",
"fipsCountyCode": "xyz789",
"id": "4",
"line": "xyz789",
"line2": "abc123",
"zipCode": "xyz789"
}
AttachSubjectPropertyAddressResponse
Description
Response of the attachSubjectPropertyAddress mutation.
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The SubjectProperty that was updated |
Example
{"subjectProperty": SubjectProperty}
AttachSubjectPropertyInput
AttachSubjectPropertyLiabilitiesInput
AttachSubjectPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The updated SubjectProperty |
Example
{"subjectProperty": SubjectProperty}
AttachSubjectPropertyResponse
Description
Response of the attachSubjectProperty mutation.
Fields
| Field Name | Description |
|---|---|
loan - PickLoanId!
|
The updated loan |
subjectProperty - PickSubjectPropertyId!
|
The subject property |
Example
{
"loan": PickLoanId,
"subjectProperty": PickSubjectPropertyId
}
AttachTitleCompanyInput
AttachTitleCompanyResponse
Description
Response of the attachTitleCompany mutation.
Fields
| Field Name | Description |
|---|---|
fulfillmentParty - FulfillmentParty!
|
The fulfillment party attached as title company. |
fulfillmentPartyId - ID!
|
The ID of the fulfillment party attached as title company Use fulfillmentParty { id }.
|
loan - Loan!
|
The loan the title company was attached to. |
loanId - ID!
|
The ID or friendly ID of the loan. Use loan { id }.
|
Example
{
"fulfillmentParty": FulfillmentParty,
"fulfillmentPartyId": 4,
"loan": Loan,
"loanId": 4
}
AttachmentEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ATTACHED"
Aus
Fields
| Field Name | Description |
|---|---|
ausRequiredForLoan - Boolean!
|
Whether the loan's selected product must pass automated underwriting before it can lock. False for manually underwritten products; true when no rate has been selected yet. |
Arguments
|
|
ausRunJob - AusRunJob
|
Fetch an AUS run by its ID. |
Arguments
|
|
latestAusRunForLoan - AusRunJob
|
Fetch the latest AUS run for a loan. |
Arguments
|
|
Example
{
"ausRequiredForLoan": false,
"ausRunJob": AusRunJob,
"latestAusRunForLoan": AusRunJob
}
AusConditionAgentEvaluation
Description
The evaluation agent's assessment of an AUS condition: verdict, confidence, reasoning, and the passages it relied on. Present once the agent has evaluated the condition against the loan's uploaded documents; null before then.
Fields
| Field Name | Description |
|---|---|
confidence - Float!
|
The agent's calibrated confidence in its verdict, 0–1. |
evidence - [AusConditionEvidenceExcerpt!]!
|
Passages the verdict rests on. An excerpt of a file the documents listing hides is left out, so an empty list means either that the verdict rests on an absence (nothing to quote) or that every cited file is hidden. |
reasoning - String!
|
The agent's explanation for the verdict. |
verdict - AusConditionVerdict!
|
Whether the documents satisfy the condition, per the agent. |
Example
{
"confidence": 123.45,
"evidence": [AusConditionEvidenceExcerpt],
"reasoning": "abc123",
"verdict": "FULFILLED"
}
AusConditionEvidenceExcerpt
Description
A verbatim passage the evaluation agent cited from a parsed document to support its verdict. Anchored to a document plus an optional section/page; when the citation resolved to a concrete block it also carries page-space coordinates (boundingBox/polygon) for a reviewer overlay.
Fields
| Field Name | Description |
|---|---|
boundingBox - AusEvidenceBoundingBox
|
Axis-aligned page-space bounding box of the cited block, for a reviewer overlay. Null when the citation did not resolve to a concrete block location. |
documentId - ID!
|
The parsed document the quote was taken from. |
pageHeight - Float
|
Height of the page the boundingBox/polygon coordinates are expressed in, so a consumer can normalize them. Null when unknown. |
pageNumber - NonNegativeInt
|
1-based page number within the document, when known. |
pageWidth - Float
|
Width of the page the boundingBox/polygon coordinates are expressed in, so a consumer can normalize them. Null when unknown. |
polygon - [AusEvidencePagePoint!]
|
Ordered page-space outline (polygon) of the cited block. Null when the citation did not resolve to a concrete block location. |
quote - String!
|
Verbatim passage from the document supporting the verdict. |
section - String
|
Section label within the document, when known. |
Example
{
"boundingBox": AusEvidenceBoundingBox,
"documentId": "4",
"pageHeight": 987.65,
"pageNumber": 123,
"pageWidth": 987.65,
"polygon": [AusEvidencePagePoint],
"quote": "xyz789",
"section": "abc123"
}
AusConditionVerdict
Description
The evaluation agent's three-way verdict on whether the uploaded documents satisfy an AUS condition.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FULFILLED"
AusEvidenceBoundingBox
Description
Axis-aligned page-space bounding box of a cited block — the simplification of its polygon outline, for a quick rectangular reviewer overlay. Coordinates are in the page coordinate system given by the surrounding evidence's pageWidth/pageHeight. Each edge is null when the citation did not resolve to a concrete block location.
Example
{"bottom": 123.45, "left": 123.45, "right": 123.45, "top": 987.65}
AusEvidencePagePoint
Description
A single vertex of a cited block's outline, in the page coordinate system given by the surrounding evidence's pageWidth/pageHeight. The ordered set of these points is the block's polygon outline; boundingBox is its axis-aligned simplification. Points are concrete — the polygon is only present at all when the citation resolved to a block.
Example
{"x": 987.65, "y": 987.65}
AusFailureBlocker
AusFindingProvenance
Description
Provenance from an automated underwriting finding. The requirement exists because an AUS run (DU/LPA) returned an actionable condition.
Fields
| Field Name | Description |
|---|---|
ausRunId - ID!
|
The AUS run that produced this finding. |
ausSystem - AusSystem!
|
Which automated underwriting system produced the finding (DU vs LPA). |
description - String!
|
Human-readable explanation of WHERE this requirement came from (the AUS run/finding). Distinct from the requirement's own as-seen condition text. |
evidence - [GuidelineReference!]!
|
Supporting evidence. Typically empty for AUS findings. |
messageId - String
|
The vendor message code, when the finding carries one. Null otherwise. |
messageKey - String!
|
The finding's stable message-type identity (the AUS message code, or a content hash when no code is present). |
section - String
|
The section of the AUS response the finding appeared under, as seen. Null when unavailable. |
Example
{
"ausRunId": "4",
"ausSystem": "DESKTOP_ORIGINATOR",
"description": "xyz789",
"evidence": [GuidelineReference],
"messageId": "xyz789",
"messageKey": "xyz789",
"section": "xyz789"
}
AusMutations
Fields
| Field Name | Description |
|---|---|
triggerAusRun - TriggerAusRunResponse
|
|
Arguments
|
|
Example
{"triggerAusRun": TriggerAusRunResponse}
AusResult
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPT_ELIGIBLE"
AusRunJob
Fields
| Field Name | Description |
|---|---|
errors - [String!]!
|
|
id - ID!
|
Job ID |
lockAllowed - Boolean
|
|
reportUrl - String
|
|
result - AusResult
|
|
status - JobStatus!
|
Job status |
system - AusSystem!
|
Example
{
"errors": ["abc123"],
"id": 4,
"lockAllowed": false,
"reportUrl": "xyz789",
"result": "ACCEPT_ELIGIBLE",
"status": "FAILED",
"system": "DESKTOP_ORIGINATOR"
}
AusSystem
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DESKTOP_ORIGINATOR"
AusUserError
Example
MissingAttachmentTypeError
AuthImpersonation
AuthMutations
Description
Auth mutations
Fields
| Field Name | Description |
|---|---|
createLease - CreateLeaseResponse
|
Create a lease for a borrower. This will automatically create a Pylon user for this borrower if one does not already exist. |
Arguments
|
|
Example
{"createLease": CreateLeaseResponse}
AuthQueries
Description
Auth queries
Fields
| Field Name | Description |
|---|---|
impersonation - AuthImpersonation
|
The active super-admin user impersonation, or null when the caller is simply themselves. |
scopes - [String!]!
|
The scopes (permissions) assigned to the current API user or session. |
viewer - AuthViewer
|
The effective authenticated user — the impersonation target while impersonating, the real user otherwise. Null for machine (M2M) tokens, which act as a customer rather than as a person. |
Example
{
"impersonation": AuthImpersonation,
"scopes": ["abc123"],
"viewer": AuthViewer
}
AuthViewer
Description
The EFFECTIVE authenticated Command Center user: the impersonation target while a super-admin impersonation is active, the real user otherwise.
Fields
| Field Name | Description |
|---|---|
auth0UserId - ID
|
Auth0 identity id of the effective user, when one is linked. Users-list row ids are auth0_identities_id ?? commandCenterUserId, so a row id may live in either id space — compare it against this AND userId together. Under impersonation this is the TARGET's linked identity, never the actor's. Null when no Auth0 identity is linked. |
customerId - ID!
|
The effective customer id |
customerSlug - String!
|
The effective customer slug |
email - String!
|
Email address of the effective user |
firstName - String
|
First name, if known |
lastName - String
|
Last name, if known |
roleTypes - [String!]!
|
Role types held by the effective user at the effective customer (e.g. "super_admin", "loan") |
userId - ID
|
Command Center user id of the effective user. Null under the legacy customer-level masquerade, which acts as a customer rather than as a specific user. |
viewScope - ViewScopeKind!
|
The session's view scope (PAPI-369): CUSTOMER for an ordinary workspace, or ALL_CUSTOMERS while the session is reading every customer organization at once (the omni-customer pseudo-tenant, surfaced above as customerSlug: "omni"). |
Example
{
"auth0UserId": 4,
"customerId": "4",
"customerSlug": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"roleTypes": ["xyz789"],
"userId": 4,
"viewScope": "ALL_CUSTOMERS"
}
AutoConditionalApprovalBlocker
Description
A blocker preventing automatic conditional approval of a loan application
Fields
| Field Name | Description |
|---|---|
type - String!
|
Possible Types
| AutoConditionalApprovalBlocker Types |
|---|
Example
{"type": "abc123"}
AutomobileAllowanceIncome
Description
Automobile allowance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
AutomobileAsset
Description
Automobile asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
AuxiliaryEmploymentIncomeMutations
Fields
| Field Name | Description |
|---|---|
create - CreateAuxiliaryEmploymentIncomeResponse
|
Create bonus, commissions, overtime, or tip income associated with an employment. The input is a 'oneOf' type where exactly one field must be populated. |
Arguments |
|
Example
{"create": CreateAuxiliaryEmploymentIncomeResponse}
AvailableAmc
AvailableAmcsInput
AvailableAppraisalType
Description
An appraisal product type available for ordering.
Example
{
"appraisalTypeId": 123,
"estimatedDeliveryDays": 987,
"fee": 987.65,
"name": "abc123"
}
BankruptcyChapterType
Description
The type of bankruptcy filed, if any.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHAPTER_ELEVEN"
BankruptcyType
Description
Types of bankruptcy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BankruptcyChapter7"
BlockedLoan
BoarderIncome
Description
Boarder income from renting to boarders
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
BondAsset
Description
Bond asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "abc123",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
BonusIncome
Description
Bonus income from employment
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment
|
The employment this income is associated with |
employmentId - ID
|
The employment this income is associated with Use employment { id }.
|
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": Employment,
"employmentId": "4",
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
Boolean
Description
The Boolean scalar type represents true or false.
BooleanComparator
Description
Comparisons available on a boolean field.
Fields
| Input Field | Description |
|---|---|
eq - Boolean
|
|
in - [Boolean!]
|
|
isNull - Boolean
|
|
neq - Boolean
|
|
nin - [Boolean!]
|
|
null - Boolean
|
Example
{
"eq": true,
"in": [true],
"isNull": false,
"neq": false,
"nin": [false],
"null": false
}
Borrower
Description
A borrower or potential borrower
Fields
| Field Name | Description |
|---|---|
assets - [Asset!]!
|
|
borrowerTasks - [BorrowerTask!]!
|
|
createdOn - DateTime!
|
|
credit - BorrowerCredit
|
|
Arguments
|
|
creditInquiries - [CreditInquiry!]!
|
|
creditPullStatus - CreditPullStatus
|
The status of the latest credit pull, including a pull that has not started. Null when no pull exists. |
deal - Deal!
|
|
demographicInfo - DemographicInfo!
|
|
dependentAges - [Float!]
|
|
econsentCaptureMethod - EconsentCaptureMethodType
|
How the borrower's consent to electronic disclosures was captured. |
econsentStatus - EconsentStatusType
|
The borrower's answer to electronic disclosures. |
emailVerified - Boolean!
|
|
employments - [Employment!]!
|
The borrower's employments, including those without income, in creation order. |
externalUserId - String
|
|
financialDeclarations - BorrowerFinancialDeclarations!
|
|
hardCreditConsentDate - DateTimeISO
|
When consent for hard credit pulls was captured. |
hardCreditConsentType - CreditPullConsentType
|
Consent captured for hard credit pulls. |
id - ID!
|
|
incomeVerificationConsentDate - DateTimeISO
|
When consent for income verification was captured. |
incomeVerificationConsentType - CreditPullConsentType
|
Consent captured for income verification. |
incomes - IncomeConnection!
|
|
Arguments
|
|
isFirstTimeHomeBuyer - Boolean
|
|
liabilities - LiabilityConnection!
|
|
Arguments
|
|
mailingAddress - Address
|
|
maritalStatus - MaritalStatusType
|
|
militaryService - BorrowerMilitaryService
|
Use militaryServiceDeclaration instead. |
militaryServiceDeclaration - MilitaryServiceDeclaration
|
The borrower's military service declaration. |
ownedProperties - OwnedPropertyConnection!
|
|
Arguments
|
|
personalInformation - BorrowerPersonalInformation!
|
|
plaid - BorrowerPlaid!
|
|
pointOfContact - Boolean!
|
|
propertyDeclarations - BorrowerPropertyDeclarations!
|
|
softCreditConsentDate - DateTimeISO
|
When consent for soft credit pulls was captured. |
softCreditConsentType - CreditPullConsentType
|
Consent captured for soft credit pulls. |
spouse - BorrowerSpouse
|
|
useOwnTitleCompany - Boolean
|
|
Example
{
"assets": [Asset],
"borrowerTasks": [BorrowerTask],
"createdOn": "2007-12-03T10:15:30Z",
"credit": BorrowerCredit,
"creditInquiries": [CreditInquiry],
"creditPullStatus": "COMPLETE",
"deal": Deal,
"demographicInfo": DemographicInfo,
"dependentAges": [987.65],
"econsentCaptureMethod": "ELECTRONIC",
"econsentStatus": "ACCEPT",
"emailVerified": false,
"employments": [Employment],
"externalUserId": "abc123",
"financialDeclarations": BorrowerFinancialDeclarations,
"hardCreditConsentDate": "2007-12-03T10:15:30Z",
"hardCreditConsentType": "ELECTRONIC",
"id": 4,
"incomeVerificationConsentDate": "2007-12-03T10:15:30Z",
"incomeVerificationConsentType": "ELECTRONIC",
"incomes": IncomeConnection,
"isFirstTimeHomeBuyer": false,
"liabilities": LiabilityConnection,
"mailingAddress": Address,
"maritalStatus": "DIVORCED",
"militaryService": BorrowerMilitaryService,
"militaryServiceDeclaration": MilitaryService,
"ownedProperties": OwnedPropertyConnection,
"personalInformation": BorrowerPersonalInformation,
"plaid": BorrowerPlaid,
"pointOfContact": false,
"propertyDeclarations": BorrowerPropertyDeclarations,
"softCreditConsentDate": "2007-12-03T10:15:30Z",
"softCreditConsentType": "ELECTRONIC",
"spouse": BorrowerSpouse,
"useOwnTitleCompany": true
}
BorrowerAddress
Description
Borrower Address
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
borrower - Borrower!
|
The borrower that lives or lived in the address |
id - ID!
|
Borrower Address ID |
isCurrentAddress - Boolean!
|
Indicates if the address is current |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"borrower": Borrower,
"id": 4,
"isCurrentAddress": true,
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
BorrowerAddressMutations
Fields
| Field Name | Description |
|---|---|
createPrevious - CreatePreviousBorrowerAddressResponse
|
Create borrower's previous address |
Arguments |
|
deletePrevious - DeletePreviousBorrowerAddressResponse
|
Delete borrower's previous address |
Arguments |
|
updateCurrent - UpdateCurrentBorrowerAddressResponse
|
Update borrower's current address |
Arguments |
|
updatePrevious - UpdatePreviousBorrowerAddressResponse
|
Update borrower's previous address |
Arguments |
|
Example
{
"createPrevious": CreatePreviousBorrowerAddressResponse,
"deletePrevious": DeletePreviousBorrowerAddressResponse,
"updateCurrent": UpdateCurrentBorrowerAddressResponse,
"updatePrevious": UpdatePreviousBorrowerAddressResponse
}
BorrowerBankruptcyBlocker
Description
One or more borrowers have a bankruptcy on record
Fields
| Field Name | Description |
|---|---|
bankruptcyType - BankruptcyType!
|
The type of bankruptcy |
borrowerIds - [ID!]!
|
The IDs of borrowers with bankruptcy Use borrowers { id }.
|
borrowers - [Borrower!]!
|
The borrowers with bankruptcy |
type - String!
|
Example
{
"bankruptcyType": "BankruptcyChapter7",
"borrowerIds": ["4"],
"borrowers": [Borrower],
"type": "xyz789"
}
BorrowerBusiness
Description
A borrower-owned business
Fields
| Field Name | Description |
|---|---|
address - Address
|
US Address |
businessType - BusinessType!
|
The type of business |
id - ID!
|
Borrower Business ID |
name - String!
|
Name |
ownerships - [BusinessOwnership!]!
|
Borrower ownerships of the business |
Example
{
"address": Address,
"businessType": "CORPORATION",
"id": "4",
"name": "xyz789",
"ownerships": [BusinessOwnership]
}
BorrowerConnection
Fields
| Field Name | Description |
|---|---|
edges - [BorrowerEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [BorrowerEdge],
"pageInfo": PageInfo
}
BorrowerCredit
Description
An individual's credit score
Fields
| Field Name | Description |
|---|---|
bankruptcy - Boolean
|
|
creditFreeze - CreditFreezeVerdict
|
Whether a security freeze prevented this borrower's credit file from being returned on the latest pull; null when no verdict was recorded for the borrower. |
creditPullId - ID
|
The ID of the most recent completed credit pull |
creditReport - String
|
|
creditScores - [CreditScore!]!
|
|
frozenBureaus - [CreditBureau!]
|
Bureaus that refused this borrower's credit file because of a security freeze. Empty when the bureaus reported no freeze; null when the latest pull recorded no per-bureau verdict, which readers must render as unknown rather than as no freeze. |
lastPulledDate - DateTime
|
|
lastStatus - JobStatus
|
|
numberOfLatePayments - Int
|
|
pullType - CreditPullType!
|
|
qualifyingScore - Float
|
|
recentLatePayment - String
|
Example
{
"bankruptcy": true,
"creditFreeze": "FROZEN",
"creditPullId": 4,
"creditReport": "xyz789",
"creditScores": [CreditScore],
"frozenBureaus": ["EQUIFAX"],
"lastPulledDate": "2007-12-03T10:15:30Z",
"lastStatus": "FAILED",
"numberOfLatePayments": 987,
"pullType": "HARD",
"qualifyingScore": 123.45,
"recentLatePayment": "abc123"
}
BorrowerEdge
BorrowerEstimatedTotalMonthlyIncome
Description
Borrower estimated total monthly income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
BorrowerFinancialDeclarations
Description
Borrower financial declarations
Fields
| Field Name | Description |
|---|---|
bankruptcyChapterType - BankruptcyChapterType
|
The type of bankruptcy filed, if any. |
bankruptcyIndicator - Boolean
|
Indicates if the borrower has filed for bankruptcy. |
homeownerPastThreeYears - Boolean
|
Indicates if the borrower has been a homeowner in the past three years. |
intentToOccupy - Boolean
|
Indicates if the borrower intends to occupy the property. |
outstandingJudgmentsIndicator - Boolean
|
Indicates if the borrower has outstanding judgments. |
partyToLawsuitIndicator - Boolean
|
Indicates if the borrower is currently a party to a lawsuit. |
presentlyDelinquentIndicator - Boolean
|
Indicates if the borrower is presently delinquent on any obligations. |
priorPropertyDeedInLieuConveyedIndicator - Boolean
|
Indicates if the borrower has conveyed a prior property deed in lieu of foreclosure. |
priorPropertyForeclosureCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property foreclosure. |
priorPropertyShortSaleCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property short sale. |
priorPropertyTitleType - PriorPropertyTitleType
|
Indicates the type of title ownership for the borrower's prior property, such as sole ownership or joint ownership. |
priorPropertyUsageType - PriorPropertyUsageType
|
Specifies how the borrower's prior property was used, such as primary residence, investment, or second home. |
undisclosedComakerOfNoteIndicator - Boolean
|
Indicates if the borrower is an undisclosed co-maker of a note. |
undisclosedCreditApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed credit application. |
undisclosedMortgageApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed mortgage application. |
Example
{
"bankruptcyChapterType": "CHAPTER_ELEVEN",
"bankruptcyIndicator": true,
"homeownerPastThreeYears": true,
"intentToOccupy": false,
"outstandingJudgmentsIndicator": false,
"partyToLawsuitIndicator": false,
"presentlyDelinquentIndicator": false,
"priorPropertyDeedInLieuConveyedIndicator": true,
"priorPropertyForeclosureCompletedIndicator": true,
"priorPropertyShortSaleCompletedIndicator": true,
"priorPropertyTitleType": "JOINT_WITH_OTHER_THAN_SPOUSE",
"priorPropertyUsageType": "FHA_SECONDARY_RESIDENCE",
"undisclosedComakerOfNoteIndicator": false,
"undisclosedCreditApplicationIndicator": false,
"undisclosedMortgageApplicationIndicator": false
}
BorrowerFinancialDeclarationsInput
Fields
| Input Field | Description |
|---|---|
bankruptcyChapterType - BankruptcyChapterType
|
The type of bankruptcy filed, if any. |
bankruptcyIndicator - Boolean
|
Indicates if the borrower has filed for bankruptcy. |
homeownerPastThreeYears - Boolean
|
Indicates if the borrower has been a homeowner in the past three years. |
intentToOccupy - Boolean
|
Indicates if the borrower intends to occupy the property. |
outstandingJudgmentsIndicator - Boolean
|
Indicates if the borrower has outstanding judgments. |
partyToLawsuitIndicator - Boolean
|
Indicates if the borrower is currently a party to a lawsuit. |
presentlyDelinquentIndicator - Boolean
|
Indicates if the borrower is presently delinquent on any obligations. |
priorPropertyDeedInLieuConveyedIndicator - Boolean
|
Indicates if the borrower has conveyed a prior property deed in lieu of foreclosure. |
priorPropertyForeclosureCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property foreclosure. |
priorPropertyShortSaleCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property short sale. |
priorPropertyTitleType - PriorPropertyTitleType
|
Indicates the type of title ownership for the borrower's prior property, such as sole ownership or joint ownership. |
priorPropertyUsageType - PriorPropertyUsageType
|
Specifies how the borrower's prior property was used, such as primary residence, investment, or second home. |
undisclosedComakerOfNoteIndicator - Boolean
|
Indicates if the borrower is an undisclosed co-maker of a note. |
undisclosedCreditApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed credit application. |
undisclosedMortgageApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed mortgage application. |
Example
{
"bankruptcyChapterType": "CHAPTER_ELEVEN",
"bankruptcyIndicator": true,
"homeownerPastThreeYears": false,
"intentToOccupy": true,
"outstandingJudgmentsIndicator": false,
"partyToLawsuitIndicator": false,
"presentlyDelinquentIndicator": true,
"priorPropertyDeedInLieuConveyedIndicator": false,
"priorPropertyForeclosureCompletedIndicator": false,
"priorPropertyShortSaleCompletedIndicator": true,
"priorPropertyTitleType": "JOINT_WITH_OTHER_THAN_SPOUSE",
"priorPropertyUsageType": "FHA_SECONDARY_RESIDENCE",
"undisclosedComakerOfNoteIndicator": false,
"undisclosedCreditApplicationIndicator": false,
"undisclosedMortgageApplicationIndicator": false
}
BorrowerIncome
Description
Borrower income interface. This is for income types that area associated with a single borrower. As opposed to other income types such as RentalIncome which can be associated with multiple borrowers.
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Possible Types
| BorrowerIncome Types |
|---|
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
BorrowerMilitaryService
Description
A borrower's military status
Fields
| Field Name | Description |
|---|---|
militaryServiceExpectedCompletionDate - Date
|
|
militaryStatusType - MilitaryStatusType
|
|
survivingSpouseIndicator - Boolean
|
Example
{
"militaryServiceExpectedCompletionDate": "2007-12-03",
"militaryStatusType": "ACTIVE_DUTY",
"survivingSpouseIndicator": true
}
BorrowerMutations
Fields
| Field Name | Description |
|---|---|
attachLiabilities - AttachBorrowerLiabilitiesResponse
|
Attach liabilities to borrower. |
Arguments
|
|
attachNonBorrowingSpouse - AttachBorrowerNonBorrowingSpouseResponse
|
Attach non borrowing spouse to borrower. |
Arguments |
|
create - CreateBorrowerResponse
|
Create a borrower. When the customer's autoSendBorrowerPortalInvite comms setting is on, an org-user creation also auto-sends the borrower their portal invite email (best-effort; a send failure never fails the creation). |
Arguments
|
|
declareMilitaryService - DeclareMilitaryServiceResponse
|
Declare a borrower's military service details. |
Arguments
|
|
declareNoMilitaryService - DeclareNoMilitaryServiceResponse
|
Declare that a borrower has no military service. |
Arguments
|
|
delete - DeleteBorrowerResponse
|
Delete a borrower |
Arguments
|
|
detachLiabilities - DetachBorrowerLiabilitiesResponse
|
Detach liabilities from borrower. |
Arguments
|
|
linkBorrowersAsSpouses - LinkBorrowersAsSpousesResponse
|
Link 2 borrowers as spouses of each other |
Arguments
|
|
rejectDocument - RejectDocumentResponse
|
Reject a document and update its status |
Arguments
|
|
sendEmailVerificationCode - SendBorrowerEmailVerificationCodeResponse
|
Email a verification code to the borrower's email address. setEmailVerified checks the code. Only a borrower or contributor session that owns the loan may call it. |
Arguments |
|
sendPortalInvite - SendBorrowerPortalInviteResponse
|
Send the borrower their portal invite email carrying a one-time claim link. Gated by the borrower-portal-invite feature flag; each send mints a fresh link that supersedes any prior one. |
Arguments
|
|
setEmailVerified - SetBorrowerEmailVerifiedResponse
|
Mark a borrower's email address verified or unverified. A borrower or contributor session may only mark the address verified, with a code from sendEmailVerificationCode. |
Arguments
|
|
unsetMilitaryService - UnsetBorrowerMilitaryServiceResponse
|
Unset a borrower's military service information. Use declareNoMilitaryService instead. |
Arguments |
|
updateBorrower - UpdateBorrowerResponse
|
Update a borrower's information. Supports isFirstTimeHomeBuyer, maritalStatus, and pointOfContact. |
Arguments
|
|
updateConsent - UpdateBorrowerConsentResponse
|
Update a borrower's consent. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateDemographicInfo - UpdateDemographicInfoResponse
|
Update a borrower's demographic info. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateDependents - UpdateBorrowerDependentsResponse
|
Update a borrower's dependents. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateFinancialDeclarations - UpdateBorrowerFinancialDeclarationsResponse
|
Update a borrower's financial declarations. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updateMailingAddress - UpdateBorrowerMailingAddressResponse
|
Update a borrower's mailing address. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updateMilitaryService - UpdateBorrowerMilitaryServiceResponse
|
Update a borrower's military service. Fields with non-null values will be updated, the rest will be ignored. Use declareMilitaryService or declareNoMilitaryService instead. |
Arguments |
|
updatePersonalInformation - UpdateBorrowerPersonalInformationResponse
|
Update a borrower's personal information. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
updatePhoneNumber - UpdateBorrowerPhoneNumberResponse
|
Upsert a borrower's phone number. Creates a new record if the borrower has none, otherwise updates the existing record. Legacy callers may pass id (a phone number id) instead of borrowerId. |
Arguments
|
|
updatePlaid - UpdateBorrowerPlaidResponse
|
Update the borrower's Plaid consent and Plaid asset report state. |
Arguments
|
|
updatePropertyDeclarations - UpdateBorrowerPropertyDeclarationsResponse
|
Update a borrower's declarations. Fields with non-null values will be updated, the rest will be ignored. The exception is undisclosedBorrowedFundsAmount: null clears it. |
Arguments |
|
Example
{
"attachLiabilities": AttachBorrowerLiabilitiesResponse,
"attachNonBorrowingSpouse": AttachBorrowerNonBorrowingSpouseResponse,
"create": CreateBorrowerResponse,
"declareMilitaryService": DeclareMilitaryServiceResponse,
"declareNoMilitaryService": DeclareNoMilitaryServiceResponse,
"delete": DeleteBorrowerResponse,
"detachLiabilities": DetachBorrowerLiabilitiesResponse,
"linkBorrowersAsSpouses": LinkBorrowersAsSpousesResponse,
"rejectDocument": RejectDocumentResponse,
"sendEmailVerificationCode": SendBorrowerEmailVerificationCodeResponse,
"sendPortalInvite": SendBorrowerPortalInviteResponse,
"setEmailVerified": SetBorrowerEmailVerifiedResponse,
"unsetMilitaryService": UnsetBorrowerMilitaryServiceResponse,
"updateBorrower": UpdateBorrowerResponse,
"updateConsent": UpdateBorrowerConsentResponse,
"updateDemographicInfo": UpdateDemographicInfoResponse,
"updateDependents": UpdateBorrowerDependentsResponse,
"updateFinancialDeclarations": UpdateBorrowerFinancialDeclarationsResponse,
"updateMailingAddress": UpdateBorrowerMailingAddressResponse,
"updateMilitaryService": UpdateBorrowerMilitaryServiceResponse,
"updatePersonalInformation": UpdateBorrowerPersonalInformationResponse,
"updatePhoneNumber": UpdateBorrowerPhoneNumberResponse,
"updatePlaid": UpdateBorrowerPlaidResponse,
"updatePropertyDeclarations": UpdateBorrowerPropertyDeclarationsResponse
}
BorrowerPersonalInformation
Description
A borrower's personal information
Fields
| Field Name | Description |
|---|---|
addressHistory - [BorrowerAddress!]!
|
The borrower's address history (current and previous addresses) |
aliases - [String!]
|
|
citizenshipResidencyType - CitizenshipResidencyType
|
|
currentAddress - BorrowerAddress
|
The borrower's current address |
dateOfBirth - Date
|
|
email - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
middleName - String
|
|
phoneNumbers - [BorrowerPhoneNumber!]!
|
|
suffix - String
|
|
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"addressHistory": [BorrowerAddress],
"aliases": ["xyz789"],
"citizenshipResidencyType": "NON_PERMANENT_RESIDENT_ALIEN",
"currentAddress": BorrowerAddress,
"dateOfBirth": "2007-12-03",
"email": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"middleName": "abc123",
"phoneNumbers": [BorrowerPhoneNumber],
"suffix": "xyz789",
"taxIdentifierNumber": "abc123",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
BorrowerPersonalInformationInput
Fields
| Input Field | Description |
|---|---|
aliases - [String!]
|
|
citizenshipResidencyType - CitizenshipResidencyType
|
|
currentAddress - AddressInput
|
|
dateOfBirth - Date
|
|
email - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
middleName - String
|
|
phoneNumber - CreateBorrowerPhoneNumberInput
|
|
socialSecurityNumber - String
|
|
suffix - String
|
|
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"aliases": ["abc123"],
"citizenshipResidencyType": "NON_PERMANENT_RESIDENT_ALIEN",
"currentAddress": AddressInput,
"dateOfBirth": "2007-12-03",
"email": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"middleName": "abc123",
"phoneNumber": CreateBorrowerPhoneNumberInput,
"socialSecurityNumber": "xyz789",
"suffix": "xyz789",
"taxIdentifierNumber": "xyz789",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
BorrowerPhoneNumber
Description
A US phone number for a borrower
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Phone number id |
number - String!
|
Phone Number |
type - PhoneNumberType
|
Phone number type |
Example
{
"id": "4",
"number": "xyz789",
"type": "CELL"
}
BorrowerPlaid
Description
The borrower's Plaid consent and Plaid report states
Fields
| Field Name | Description |
|---|---|
assetReportStatus - PlaidAssetReportStatus!
|
|
consentedProducts - [EnabledPlaidProduct!]!
|
The Plaid products the borrower consented to. |
incomeReportStatus - PlaidIncomeReportStatus!
|
Example
{
"assetReportStatus": "CANCELED",
"consentedProducts": ["ASSETS"],
"incomeReportStatus": "CANCELED"
}
BorrowerPreferences
Description
Borrower preferences related to loan applications.
Fields
| Field Name | Description |
|---|---|
applyOutOfPocketToLoan - Boolean
|
Represents if Out Of Pocket cash will be applied to reduce loan cost |
closingCosts - NonNegativeFloat
|
The maximum allowable closing costs. |
downPaymentAmount - NonNegativeFloat
|
The down payment amount. |
maxDiscountPoints - Float
|
Limit number of rate point buys to not exceed this value. |
maxLtv - NonNegativeFloat
|
Max loan-to-value ratio allowed. Will not override takeout requirements. |
maxOutOfPocket - NonNegativeFloat
|
Out of pocket maximum in dollars. |
monthlyPayment - NonNegativeFloat
|
The maximum allowable monthly payment. |
monthlyPaymentAsPercentageOfIncome - Boolean!
|
Interpret monthly payment field as a percentage instead of dollar amount. |
mortgageInsurance - Boolean
|
Indicates whether mortgage insurance is required. |
principal - NonNegativeFloat
|
The maximum allowable principal amount. |
rate - NonNegativeFloat
|
The preferred interest rate as a percentage (e.g., 5.0 for 5%). |
rollInClosingCosts - Boolean
|
Represents if closing costs will be rolled into loan amount on a ReFi |
totalCost - Float
|
The cost of points for the loan. |
totalPoints - NonNegativeFloat
|
The number of points required for the loan. |
Example
{
"applyOutOfPocketToLoan": true,
"closingCosts": 123.45,
"downPaymentAmount": 123.45,
"maxDiscountPoints": 987.65,
"maxLtv": 123.45,
"maxOutOfPocket": 123.45,
"monthlyPayment": 123.45,
"monthlyPaymentAsPercentageOfIncome": false,
"mortgageInsurance": true,
"principal": 123.45,
"rate": 123.45,
"rollInClosingCosts": true,
"totalCost": 123.45,
"totalPoints": 123.45
}
BorrowerPropertyDeclarations
Description
Borrower property declarations
Fields
| Field Name | Description |
|---|---|
otherMortgageOnSubjectPropertyIndicator - Boolean
|
Is there any other mortgage loan on the subject property? |
propertySubjectToPriorityLienIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
specialBorrowerSellerRelationshipIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsAmount - Float
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
Example
{
"otherMortgageOnSubjectPropertyIndicator": false,
"propertySubjectToPriorityLienIndicator": false,
"specialBorrowerSellerRelationshipIndicator": true,
"undisclosedBorrowedFundsAmount": 987.65,
"undisclosedBorrowedFundsIndicator": false
}
BorrowerPropertyDeclarationsInput
Fields
| Input Field | Description |
|---|---|
otherMortgageOnSubjectPropertyIndicator - Boolean
|
Is there any other mortgage loan on the subject property? |
propertySubjectToPriorityLienIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
specialBorrowerSellerRelationshipIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsAmount - Float
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
Example
{
"otherMortgageOnSubjectPropertyIndicator": false,
"propertySubjectToPriorityLienIndicator": false,
"specialBorrowerSellerRelationshipIndicator": true,
"undisclosedBorrowedFundsAmount": 123.45,
"undisclosedBorrowedFundsIndicator": false
}
BorrowerResidencyBasis
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIVING_RENT_FREE"
BorrowerSpouse
Description
A borrower's spouse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
personalInformation - BorrowerPersonalInformation
|
Example
{
"id": "4",
"personalInformation": BorrowerPersonalInformation
}
BorrowerTask
Description
A borrower's task
Fields
| Field Name | Description |
|---|---|
accessToken - String
|
Access token for SSO PDF viewer or any third-party access, if applicable. |
borrower - Borrower
|
The borrower this task is assigned to. Null, with an error, when the user cannot read borrowers. |
borrowerFacingDescription - String
|
|
borrowerId - ID!
|
Use borrower { id }.
|
clearedAt - DateTimeISO
|
When an underwriter (or the requirement's own rules) last cleared this task's condition. Requires read:loan-events; borrowers are refused. Null unless the task is completed. Null after a person or an integration reopened the task or withdrew its condition, until it is cleared again. Reopens the loan system makes on its own are not recorded, so a task completed again after one keeps its earlier clearance. Also null for a task cleared before late September 2026, when clearances were first recorded. |
completedAt - DateTime
|
|
createdOn - DateTime
|
|
details - TaskEntityDetails
|
Details about the entity this task is associated with Use relatedEntity instead, which resolves the associated entity as a Node whose own fields (including borrower and display name) can be queried directly.
|
documentLinks - [DocumentLink!]!
|
|
documentUploadPath - String
|
|
dueDate - DateTime
|
|
fields - [String!]
|
|
id - ID!
|
|
note - String
|
|
priority - Float
|
|
relatedEntity - Node
|
The entity this task is about (e.g. the Asset for a bank-statement upload task, or the AssetTransaction for a large-deposit task), resolvable as a Node. Prefer this over the deprecated details field. |
relatedEntityId - String
|
Related entity ID (e.g., assetTransactionId for large deposit tasks) Use relatedEntity { id } instead — relatedEntity resolves the entity itself (its id plus all its other fields) in one query.
|
reopenedAt - DateTime
|
When the task was most recently reopened after having been completed or cancelled. Null if the task has never been reopened. |
requiredFor1003Form - Boolean
|
|
status - String!
|
|
title - String
|
|
type - String!
|
Example
{
"accessToken": "xyz789",
"borrower": Borrower,
"borrowerFacingDescription": "abc123",
"borrowerId": "4",
"clearedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"details": TaskEntityDetails,
"documentLinks": [DocumentLink],
"documentUploadPath": "xyz789",
"dueDate": "2007-12-03T10:15:30Z",
"fields": ["abc123"],
"id": 4,
"note": "abc123",
"priority": 987.65,
"relatedEntity": Node,
"relatedEntityId": "abc123",
"reopenedAt": "2007-12-03T10:15:30Z",
"requiredFor1003Form": true,
"status": "abc123",
"title": "abc123",
"type": "abc123"
}
BorrowerUser
Description
Borrower user object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
loanApplications - [BorrowerUserLoanApplicationSummary!]!
|
Example
{
"id": 4,
"loanApplications": [BorrowerUserLoanApplicationSummary]
}
BorrowerUserLoanApplicationSummary
Description
Borrower user object
Example
{
"archiveDate": "2007-12-03",
"creationDate": "2007-12-03",
"currentStage": "abc123",
"friendlyId": "4",
"id": 4,
"lastPreApprovalRunAt": "2007-12-03T10:15:30Z",
"submitted": true
}
BrandingLogoExtension
Description
File type of a branding logo asset.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PNG"
BrandingLogoUpload
Description
A target for uploading a branding logo.
Fields
| Field Name | Description |
|---|---|
expiresAt - String!
|
When the upload slot expires if unused (ISO-8601). Slots are single-use. |
uploadId - ID!
|
Id of the minted upload slot. |
uploadUrl - String!
|
URL to POST the file to as multipart/form-data (a single "files" field), authenticated the same way as this request. |
Example
{
"expiresAt": "abc123",
"uploadId": "4",
"uploadUrl": "xyz789"
}
BridgeLoanNotDepositedAsset
Description
Bridge loan not deposited asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "abc123",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
BulkLoanDocumentsExportFailureReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BULK_EXPORT_SIZE_LIMIT_EXCEEDED"
BulkLoanDocumentsExportJob
Description
Bulk loan documents export job.
Fields
| Field Name | Description |
|---|---|
completedAt - DateTime
|
When the export finished processing. |
documentCount - NonNegativeInt
|
Number of loan documents included in the export. |
downloadUrl - String
|
A temporary URL for downloading the generated ZIP file. Present only when the job succeeded and the object still exists. |
failureReason - BulkLoanDocumentsExportFailureReason
|
Machine-readable failure reason when the export failed. |
id - ID!
|
Job ID |
status - JobStatus!
|
Job status |
zipSizeBytes - NonNegativeInt
|
Generated ZIP file size in bytes. |
Example
{
"completedAt": "2007-12-03T10:15:30Z",
"documentCount": 123,
"downloadUrl": "xyz789",
"failureReason": "BULK_EXPORT_SIZE_LIMIT_EXCEEDED",
"id": "4",
"status": "FAILED",
"zipSizeBytes": 123
}
BureauFileStatus
Description
Per-bureau file status from a credit pull
Fields
| Field Name | Description |
|---|---|
bureau - String!
|
Bureau name |
errorMessages - [String!]!
|
Error messages from the bureau (may be empty) |
fileReturned - Boolean!
|
Whether the bureau successfully returned a credit file |
message - String
|
LO-friendly error message (null when fileReturned is true) |
resultStatus - String!
|
MISMO CreditFileResultStatusType enum value |
variations - [String!]!
|
Demographic discrepancy flags (e.g. DifferentAddress, DifferentSSN) |
Example
{
"bureau": "abc123",
"errorMessages": ["abc123"],
"fileReturned": false,
"message": "xyz789",
"resultStatus": "abc123",
"variations": ["abc123"]
}
BusinessOwnership
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that owns a percentage of the business |
business - BorrowerBusiness!
|
The borrower business |
percentOwnership - NonNegativeFloat!
|
Percent of the business that the borrower owns. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"borrower": Borrower,
"business": BorrowerBusiness,
"percentOwnership": 123.45
}
BusinessType
Description
The type of business
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CORPORATION"
CalculateOptimalStructureInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID of the loan to base calculations off of. |
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
pricingConstraints - PricingConstraints
|
Configure constraints to run pricing under. Uses the BorrowerPreferences associated with a loan as a fallback if unset. |
Example
{
"loanId": "4",
"objectiveIntent": "MIN_DOWN_PAYMENT",
"pricingConstraints": PricingConstraints
}
CalculateOptimalStructureResponse
Fields
| Field Name | Description |
|---|---|
job - OptimalStructure!
|
Example
{"job": OptimalStructure}
CancelDocumentSeedingInput
Description
Ask to stop one exact in-flight seed-from-documents run.
Example
{"documentSeedingId": "4", "loanId": 4}
CancelDocumentSeedingOutcome
Description
How a request to stop one exact seed run landed: CANCEL_REQUESTED (the matching run accepted the signal), NOT_RUNNING (that run is not active), or NOT_FENCE_CAPABLE (an earlier worker cannot safely honor a run-specific request).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CANCEL_REQUESTED"
CancelDocumentSeedingResponse
Description
The acknowledgement of a run-fenced cancellation request. Poll documentIntake.seeding for the terminal result; this operation never touches uploaded files.
Fields
| Field Name | Description |
|---|---|
outcome - CancelDocumentSeedingOutcome!
|
CANCEL_REQUESTED acknowledges delivery to the matching run, not its terminal outcome. |
Example
{"outcome": "CANCEL_REQUESTED"}
CancelFloodInput
Description
Input for cancelling a flood determination order.
Fields
| Input Field | Description |
|---|---|
floodOrderId - ID!
|
ID of the flood order to cancel. |
Example
{"floodOrderId": "4"}
CancelFloodResponse
Description
Response from cancelling a flood determination order.
Fields
| Field Name | Description |
|---|---|
floodOrder - FloodOrder!
|
The flood order being cancelled. |
Example
{"floodOrder": FloodOrder}
CancelOrderInput
Description
Input for cancelling an income verification order.
Fields
| Input Field | Description |
|---|---|
orderId - ID!
|
ID of the income verification order to cancel. |
Example
{"orderId": 4}
CancelOrderResponse
Description
Response from cancelling an income verification order.
Fields
| Field Name | Description |
|---|---|
orderId - ID!
|
ID of the cancelled income verification order. |
status - IncomeVerificationOrderStatus!
|
Current status of the income verification order. |
Example
{"orderId": 4, "status": "CANCELED"}
CancelSeedFromDocumentsInput
Description
Ask to cancel an in-flight seed-from-documents run.
Fields
| Input Field | Description |
|---|---|
loanId - ID
|
The ID or friendly ID of the loan. Provide this or the deprecated loanApplicationId, not both. The loan whose seed run to cancel. |
Example
{"loanId": "4"}
CancelSeedFromDocumentsOutcome
Description
How a cancel request landed: CANCELLED (the run will stop at its next boundary — poll documentIntake.seeding for what had already landed) or NOT_RUNNING (nothing to cancel).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CANCELLED"
CancelSeedFromDocumentsResponse
Description
The outcome of a cancel request. Never discards the loan's uploaded files — this mutation only ever affects the read/seed workflow, whatever it decides.
Fields
| Field Name | Description |
|---|---|
outcome - CancelSeedFromDocumentsOutcome!
|
How the request landed. |
userErrors - [GenericUserError!]!
|
Empty on every outcome above; reserved for a future refusal. |
Example
{"outcome": "CANCELLED", "userErrors": [GenericUserError]}
CapitalGainsIncome
Description
Capital gains income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
CashOnHandAsset
Description
Cash on hand asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "xyz789",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
CashOutTypeComparator
Description
Comparisons available on the cash-out type.
Fields
| Input Field | Description |
|---|---|
eq - RefinanceCashOutType
|
|
in - [RefinanceCashOutType!]
|
|
isNull - Boolean
|
|
neq - RefinanceCashOutType
|
|
nin - [RefinanceCashOutType!]
|
|
null - Boolean
|
Example
{
"eq": "CASH_OUT",
"in": ["CASH_OUT"],
"isNull": true,
"neq": "CASH_OUT",
"nin": ["CASH_OUT"],
"null": true
}
CashToCloseExceedsOwnFundsViolation
Description
Cash to close exceeds the funds the borrower holds in verified assets. Outside funds that pay cash to close (down payment assistance, an earnest money deposit not yet credited) cover the difference, so no reserve rule is at issue.
Fields
| Field Name | Description |
|---|---|
additionalOwnFundsNeeded - Float!
|
Additional dollars of verified assets the borrower needs for cash to close without outside funds. |
downPaymentAssistance - Float!
|
Dollars of down payment assistance paying cash to close, which never count as the borrower's own funds. |
uncreditedEarnestMoney - Float!
|
Dollars of the earnest money deposit that pay cash to close but are not yet credited as the borrower's own funds. |
Example
{
"additionalOwnFundsNeeded": 987.65,
"downPaymentAssistance": 123.45,
"uncreditedEarnestMoney": 123.45
}
CertificateOfDepositTimeDepositAsset
Description
Certificate of deposit or time deposit asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "xyz789",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
ChangeOfCircumstanceForm
Description
A Change of Circumstances Request Form as it was filed on the loan.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
ChangeOfCircumstanceReason
Description
TRID's changed-circumstance categories (§1026.19(e)(3)(iv)) — the justifications that permit resetting a fee's tolerance baseline. Pylon's own vocabulary rather than a passthrough of any downstream system's spelling.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY"
ChangeOfCircumstanceRequest
Description
The §1026.19(e)(3)(iv) justification a redisclosure was sent under.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
CheckingAccountAsset
Description
Checking account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "abc123",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
ChildSupportIncome
Description
Child support income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
Citation
Description
A context-free anchor into a file: geometry and/or text, plus meaning. Citations never reference a requirement — purpose lives on the citing evidence.
Fields
| Field Name | Description |
|---|---|
asOf - DateTimeISO
|
When the observed fact was true (statement date, balance as-of) — the freshness anchor. |
author - Contributor!
|
WHO authored this citation — always a Contributor, resolved from the writing context, never client-supplied. (The spec's AnyContributor interface stands in as the concrete Contributor type until the attribution project ships it.) |
document - LoanDocument!
|
The document this citation anchors into. |
fieldKey - String
|
Namespaced fact-taxonomy or doc-schema key; null = freehand annotation. |
id - ID!
|
Stable identifier for this citation, resolvable via the root node(id) query. |
label - String
|
What the cited region means (e.g. "Dwelling coverage amount"). |
ocrConfidence - Float
|
Measured OCR signal — legitimately numeric, never LLM-invented. |
page - PositiveInt
|
1-based page number; null = text-only citation. |
pageHeight - Float
|
|
pageWidth - Float
|
|
polygon - [PagePoint!]
|
Region outline in scale-1 pdf.js page units, y-down; null = textual/whole-document. |
quotedText - String
|
What the cited region says. |
redactedAt - DateTime
|
The time of the earliest completed personal-data purge of this citation's loan, or of a borrower on it, that ran after the citation was created and erased citation content, when the citation's value, quote, label and reasoning are all empty. Null otherwise. Because it is inferred from the purge record, a citation that was empty before the purge also reads as purged, and a citation written while the purge was running may read null. |
value - JSONObject
|
Optional typed value the region evidences. |
Example
{
"asOf": "2007-12-03T10:15:30Z",
"author": Contributor,
"document": LoanDocument,
"fieldKey": "abc123",
"id": "4",
"label": "abc123",
"ocrConfidence": 123.45,
"page": 123,
"pageHeight": 123.45,
"pageWidth": 987.65,
"polygon": [PagePoint],
"quotedText": "abc123",
"redactedAt": "2007-12-03T10:15:30Z",
"value": {}
}
CitationConnection
Description
A page of citation rows anchored into a document.
Fields
| Field Name | Description |
|---|---|
edges - [CitationEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [CitationEdge],
"pageInfo": PageInfo
}
CitationEdge
CitationsFilterInput
Description
Optional filters for a document's citations. The facts-decomposition pass writes an observation citation per extracted fact, so a long document can carry hundreds of rows; overlays should fetch only the visible page / focused field keys.
Fields
| Input Field | Description |
|---|---|
fieldKey - String
|
Only citations whose fieldKey equals this key. |
page - PositiveInt
|
Only citations anchored on this 1-based page. |
Example
{"fieldKey": "abc123", "page": 123}
CitationsMutations
Description
Citation mutations namespace.
Fields
| Field Name | Description |
|---|---|
createCitation - CreateCitationResponse
|
Persists a citation drawn by an underwriter and returns it typed. |
Arguments
|
|
Example
{"createCitation": CreateCitationResponse}
CitedDocument
Description
A document filed on a loan. Its id is the one DocumentLink.id carries.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
CitizenshipResidencyType
Description
An individual's US citizenship status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NON_PERMANENT_RESIDENT_ALIEN"
ClaimDealClaimTokenInput
Description
Input to the claimDealClaimToken mutation.
Fields
| Input Field | Description |
|---|---|
token - String!
|
The raw claim token the borrower received |
Example
{"token": "xyz789"}
ClaimDealClaimTokenResponse
Description
Result of a borrower claiming a one-time deal claim token
Fields
| Field Name | Description |
|---|---|
deal - Deal!
|
Deal the claiming borrower now has access to |
dealId - ID!
|
Deal the claiming borrower now has access to Use deal { id }.
|
newlyClaimed - Boolean!
|
True when this call performed the claim; false when it was an idempotent no-op (the same borrower had already claimed it). |
Example
{
"deal": Deal,
"dealId": "4",
"newlyClaimed": false
}
CloseRequirementConversationSessionInput
CloseRequirementConversationSessionResponse
Fields
| Field Name | Description |
|---|---|
session - RequirementConversationSession
|
The conversation, or null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused: REQUIREMENT_CONVERSATION_STATE_CONFLICT (the conversation can't take this step now) or REQUIREMENT_CONVERSATION_REQUEST_ID_REUSED (the request id was used for a different request). Empty on success. |
Example
{
"session": RequirementConversationSession,
"userErrors": [UserError]
}
ClosingCostPayer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BORROWER"
CommissionsIncome
Description
Commission-based income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment
|
The employment this income is associated with |
employmentId - ID
|
The employment this income is associated with Use employment { id }.
|
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": Employment,
"employmentId": "4",
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
CommsMutations
Fields
| Field Name | Description |
|---|---|
toggleCustomerCommsOptIn - ToggleCustomerCommsOptInResponse
|
Toggle customer comms opt-in status for the current organization |
Arguments
|
|
updateCommsRecipients - UpdateCommsRecipientsResponse
|
Update which role types receive a communication |
Arguments
|
|
updateCommsSettings - UpdateCommsSettingsResponse
|
Update the comms settings for the current organization |
Arguments
|
|
updateCommsTemplate - UpdateCommsTemplateResponse
|
Update comms template |
Arguments
|
|
Example
{
"toggleCustomerCommsOptIn": ToggleCustomerCommsOptInResponse,
"updateCommsRecipients": UpdateCommsRecipientsResponse,
"updateCommsSettings": UpdateCommsSettingsResponse,
"updateCommsTemplate": UpdateCommsTemplateResponse
}
CommsRecipient
Description
Role types that can receive communications
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER"
CommsSettings
Fields
| Field Name | Description |
|---|---|
autoSendBorrowerPortalInvite - Boolean!
|
When on, creating a borrower or co-borrower in Command Center also emails that borrower their portal invite. Off by default, and the only gate on that auto-send — the borrower-portal-invite feature flag governs the explicit borrower.sendPortalInvite mutation, not this. |
customerId - ID!
|
Example
{"autoSendBorrowerPortalInvite": false, "customerId": 4}
CommsTemplate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of comms template |
name - String!
|
Name of the comms template |
recipients - [CommsRecipient!]!
|
Role types that receive this communication |
subject - String!
|
Subject line of comms |
template - String!
|
Comms template |
Example
{
"id": 4,
"name": "abc123",
"recipients": ["BORROWER"],
"subject": "abc123",
"template": "abc123"
}
CommsWithOptInStatus
Company
Description
Company
Fields
| Field Name | Description |
|---|---|
businessType - BusinessType
|
Business type |
id - ID!
|
The ID of the Company |
name - String
|
Company name |
Example
{
"businessType": "CORPORATION",
"id": "4",
"name": "abc123"
}
CompanyMutations
Description
Company mutations
Fields
| Field Name | Description |
|---|---|
create - CreateCompanyResponse
|
Create a company |
Arguments
|
|
Example
{"create": CreateCompanyResponse}
CompleteWireInPurchaseInput
CompleteWireInPurchaseResponse
Fields
| Field Name | Description |
|---|---|
fundingSettlement - FundingSettlement!
|
Example
{"fundingSettlement": FundingSettlement}
CompositeFulfillment
Description
A fulfillment path composed of sub-requirements. Satisfied when every child is resolved, either by satisfaction or waiver.
Fields
| Field Name | Description |
|---|---|
description - String!
|
What this path involves. |
name - String!
|
Short name for this path, e.g. "Complete all checks". |
requirements - [Requirement!]!
|
Child requirements, each with its own phase. A partially-satisfied composite lists SatisfiedRequirement children alongside OpenRequirement ones. |
satisfied - Boolean!
|
Whether every child requirement is resolved, either by satisfaction or waiver. |
Example
{
"description": "xyz789",
"name": "xyz789",
"requirements": [Requirement],
"satisfied": true
}
Concession
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt
|
|
approvedAt - DateTime
|
|
approvedBy - String
|
|
id - ID!
|
|
loan - Loan
|
The loan the concession is for. |
loanId - ID
|
Use loan { id }.
|
reason - String
|
|
requestedAt - DateTime
|
|
requestedBy - String
|
|
revocationReason - ConcessionRevocationReason
|
|
revokedAt - DateTime
|
|
revokedBy - String
|
Example
{
"amount": 123,
"approvedAt": "2007-12-03T10:15:30Z",
"approvedBy": "xyz789",
"id": "4",
"loan": Loan,
"loanId": "4",
"reason": "abc123",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "abc123",
"revocationReason": "BETTER_LOAN_STRUCTURE",
"revokedAt": "2007-12-03T10:15:30Z",
"revokedBy": "abc123"
}
ConcessionExceedsCompensationViolation
Description
The concession exceeds the lender-paid compensation available after the underwriting fee, so the loan would fund at negative net revenue.
Fields
| Field Name | Description |
|---|---|
concessionReductionNeeded - Float!
|
Dollars by which the concession must be reduced so that lender-paid compensation still covers the underwriting fee. |
Example
{"concessionReductionNeeded": 987.65}
ConcessionLog
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt
|
|
approvedAt - DateTime
|
|
approvedBy - String
|
|
history - [ConcessionLogItem!]
|
|
id - ID!
|
|
loan - Loan
|
The loan the concession is for. |
loanId - ID
|
Use loan { id }.
|
reason - String
|
|
requestedAt - DateTime
|
|
requestedBy - String
|
|
revocationReason - ConcessionRevocationReason
|
|
revokedAt - DateTime
|
|
revokedBy - String
|
Example
{
"amount": 123,
"approvedAt": "2007-12-03T10:15:30Z",
"approvedBy": "abc123",
"history": [ConcessionLogItem],
"id": 4,
"loan": Loan,
"loanId": "4",
"reason": "xyz789",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "abc123",
"revocationReason": "BETTER_LOAN_STRUCTURE",
"revokedAt": "2007-12-03T10:15:30Z",
"revokedBy": "xyz789"
}
ConcessionLogItem
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt
|
|
approvedAt - DateTime
|
|
approvedBy - String
|
|
reason - String
|
|
requestedAt - DateTime
|
|
requestedBy - String
|
|
revocationReason - ConcessionRevocationReason
|
|
revokedAt - DateTime
|
|
revokedBy - String
|
Example
{
"amount": 123,
"approvedAt": "2007-12-03T10:15:30Z",
"approvedBy": "abc123",
"reason": "abc123",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "xyz789",
"revocationReason": "BETTER_LOAN_STRUCTURE",
"revokedAt": "2007-12-03T10:15:30Z",
"revokedBy": "abc123"
}
ConcessionMutations
Fields
| Field Name | Description |
|---|---|
approveConcession - ApproveConcessionResponse
|
|
Arguments
|
|
requestConcession - RequestConcessionResponse
|
|
Arguments
|
|
revokeConcession - RevokeConcessionResponse
|
|
Arguments
|
|
updateConcession - UpdateConcessionResponse
|
|
Arguments
|
|
Example
{
"approveConcession": ApproveConcessionResponse,
"requestConcession": RequestConcessionResponse,
"revokeConcession": RevokeConcessionResponse,
"updateConcession": UpdateConcessionResponse
}
ConcessionRevocationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BETTER_LOAN_STRUCTURE"
ConfidenceLevel
Description
Ordinal author confidence in an assertion: CERTAIN, HIGH, MODERATE, LOW.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CERTAIN"
ConfirmAssessmentInput
ConfirmAssessmentResponse
Description
Result of confirming an assessment.
Fields
| Field Name | Description |
|---|---|
evidence - Evidence!
|
The endorsement assertion the confirmation wrote. |
evidenceId - ID!
|
The endorsement assertion's content-addressed edge id. A re-confirm of the same target by the same author returns the same id (no-op). Use evidence { id }.
|
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"evidence": Evidence,
"evidenceId": 4,
"requirement": Requirement,
"warnings": ["TARGET_SUPERSEDED"]
}
ConfirmIntakeDraftBorrowerInput
Description
The borrower to create when confirming a draft.
Fields
| Input Field | Description |
|---|---|
dependentAges - [Float!]
|
|
econsentCaptureMethod - EconsentCaptureMethodType
|
How the borrower's consent to electronic disclosures was captured. |
econsentStatus - EconsentStatusType
|
The borrower's answer to electronic disclosures. |
financialDeclarations - BorrowerFinancialDeclarationsInput
|
|
incomeVerificationConsentDate - DateTime
|
When consent for income verification was captured. |
incomeVerificationConsentType - CreditPullConsentType
|
Consent captured for income verification. |
mailingAddress - AddressInput
|
|
personalInformation - BorrowerPersonalInformationInput!
|
|
pointOfContact - Boolean
|
|
propertyDeclarations - BorrowerPropertyDeclarationsInput
|
Example
{
"dependentAges": [987.65],
"econsentCaptureMethod": "ELECTRONIC",
"econsentStatus": "ACCEPT",
"financialDeclarations": BorrowerFinancialDeclarationsInput,
"incomeVerificationConsentDate": "2007-12-03T10:15:30Z",
"incomeVerificationConsentType": "ELECTRONIC",
"mailingAddress": AddressInput,
"personalInformation": BorrowerPersonalInformationInput,
"pointOfContact": true,
"propertyDeclarations": BorrowerPropertyDeclarationsInput
}
ConfirmIntakeDraftInput
Fields
| Input Field | Description |
|---|---|
borrower - ConfirmIntakeDraftBorrowerInput!
|
|
loanId - ID!
|
The ID or friendly ID of the draft's loan. |
Example
{"borrower": ConfirmIntakeDraftBorrowerInput, "loanId": 4}
ConfirmIntakeDraftResponse
Description
The confirmed loan and its original borrower.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
The borrower created by the original confirmation. Null when userErrors is non-empty. |
loan - Loan
|
The confirmed loan. Null when userErrors is non-empty. |
userErrors - [UserError!]!
|
Empty on success, including a repeated confirmation. DOCUMENT_INTAKE_DRAFT_EXPIRED means the draft expired and was left unchanged. |
Example
{
"borrower": Borrower,
"loan": Loan,
"userErrors": [UserError]
}
ConfirmRateLockInput
Description
Input to the confirmRateLock mutation.
Fields
| Input Field | Description |
|---|---|
changeRequestDescription - String
|
When replacing a committed lock, the final description of the standing change request that names a changed circumstance, replacing the template it was opened with once the lock commits. Non-blank, with no bracketed placeholder such as [date] left in it. Omitted leaves the description as opened, which is refused while it still holds a placeholder. Ignored when the lock is not replaced or no standing request names a changed circumstance. |
feeChangedCircumstanceReasons - [RedisclosureFeeReasonInput!]
|
When replacing a committed lock sends its revised Loan Estimate automatically, the reason chosen for each changed fee in Loan.redisclosureFeeChanges. Omitted sends every fee under the standing change request's reason. A changed fee left out of a supplied list is treated as not a valid change. Restricted to internal Pylon operators; ignored when no redisclosure is sent automatically. |
loanId - ID!
|
The ID or friendly ID of the loan. |
overrideExistingRateLock - Boolean
|
Proceed even though the loan's rate is already locked, replacing the terms the borrower was locked at. Allowed with the process:committed-rate-lock scope, or, for customers with automatic redisclosure enabled, on a loan that is not frozen (Loan.isFrozen is false). A replacement obliges the borrower a revised Loan Estimate, which is raised with the disclosure desk before the new lock commits. Applies only to a loan that already carries a lock; sending it for a loan's first lock is rejected, since there are no committed terms to replace. |
overrideIneligibility - Boolean
|
If set to true, this mutation ignores the ineligibility status of the chosen rate and allows it to be locked. Only available to internal Pylon admins. |
Example
{
"changeRequestDescription": "xyz789",
"feeChangedCircumstanceReasons": [
RedisclosureFeeReasonInput
],
"loanId": "4",
"overrideExistingRateLock": true,
"overrideIneligibility": true
}
ConfirmRateLockResponse
Description
Response of the confirmRateLock mutation.
Fields
| Field Name | Description |
|---|---|
changeOfCircumstanceTicketId - ID
|
The support ticket opened for the revised Loan Estimate this lock owes the borrower, when the lock was a change of circumstance — either locking a floated loan, or replacing a committed lock. Null when the lock owes no revised disclosure or the ticket is not enabled for the customer. Present only once the ticket exists: the lock is refused if it cannot be opened. |
disclosuresRunId - ID
|
The ID of the initial-disclosures run this lock dispatched, as on floatStructure. Poll disclosuresRunStatus with it to learn whether the initial Loan Estimate was sent, and why not if it failed. Null when the lock dispatched none: the loan was already disclosed, or the subject property has no street address yet. |
loan - Loan!
|
The loan whose rate lock the mutation changed. |
loanId - ID!
|
The ID or friendly ID of the loan. Use loan { id }.
|
lockUnchanged - Boolean!
|
Always false. Always false: confirming a committed lock's replacement always replaces the lock. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the confirmRateLock mutation. At most one; when present, no rate lock was committed. |
Example
{
"changeOfCircumstanceTicketId": "4",
"disclosuresRunId": "4",
"loan": Loan,
"loanId": 4,
"lockUnchanged": false,
"userErrors": [UserError]
}
ConformingMarketingRate
Description
Conforming marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 123,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"ltv": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rate": 987.65,
"salesContractAmount": 123
}
ConformingMarketingRateInput
Description
Conforming marketing rate input
Fields
| Input Field | Description |
|---|---|
calculateApr - Boolean
|
Should closing costs be fetched in order to calculate an APR?. Default = true |
concessions - NonNegativeInt
|
Lender concession in dollars. Reduces the rate cost (points) the borrower would otherwise pay, but never below zero. Default = 0 |
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
propertyUsageType - PropertyUsageType
|
|
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"calculateApr": false,
"concessions": 123,
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"loanTermYears": 987.65,
"ltv": 123.45,
"maxDiscountPointsTotal": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 123.45
}
Contact
Description
Represents a contact entity with details like name, email, phone, company, address, and role.
Fields
| Field Name | Description |
|---|---|
address - Address
|
Address of the contact |
companyLicenseNumber - String
|
License number of the company the contact represents |
companyLicenseState - StateAbbreviated
|
State where the company's license was issued |
companyName - String
|
Company which the contact is from |
email - String
|
Email address of the contact |
firstName - String
|
First name of the contact |
hazardInsuranceCoverage - HazardInsuranceCoverageType
|
Coverage provided by a hazard insurer |
id - ID!
|
id of the contact |
individualLicenseNumber - String
|
Professional license number of the individual contact |
individualLicenseState - StateAbbreviated
|
State where the individual's professional license was issued |
lastName - String
|
Last name of the contact |
middleName - String
|
Middle name of the contact |
phoneNumber - String
|
Phone number of the contact |
role - ContactRole
|
Role of the contact |
Example
{
"address": Address,
"companyLicenseNumber": "xyz789",
"companyLicenseState": "AK",
"companyName": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"hazardInsuranceCoverage": "EARTHQUAKE",
"id": 4,
"individualLicenseNumber": "abc123",
"individualLicenseState": "AK",
"lastName": "abc123",
"middleName": "xyz789",
"phoneNumber": "xyz789",
"role": "APPRAISER"
}
ContactRole
Description
Role of the contact in the context of a loan application.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPRAISER"
ContractBasisIncome
Description
Contract-based employment income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
Contributor
Fields
| Field Name | Description |
|---|---|
contactInfo - ContributorContactInfo!
|
|
deals - DealConnection
|
|
Arguments
|
|
disabledAt - DateTime
|
|
displayName - String!
|
|
id - ID!
|
|
role - String!
|
|
roleId - ID!
|
|
Example
{
"contactInfo": ContributorContactInfo,
"deals": DealConnection,
"disabledAt": "2007-12-03T10:15:30Z",
"displayName": "abc123",
"id": "4",
"role": "abc123",
"roleId": 4
}
ContributorConnection
Fields
| Field Name | Description |
|---|---|
edges - [ContributorEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ContributorEdge],
"pageInfo": PageInfo
}
ContributorContactInfo
ContributorCreateLeaseInput
Description
Input to create a contributor lease
Fields
| Input Field | Description |
|---|---|
contributorId - ID!
|
Example
{"contributorId": 4}
ContributorCreateLeaseResponse
Description
Contributor lease response
Fields
| Field Name | Description |
|---|---|
lease - ContributorLease
|
Lease that was created |
Example
{"lease": ContributorLease}
ContributorEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - Contributor!
|
Example
{
"cursor": "4",
"node": Contributor
}
ContributorFilter
Fields
| Input Field | Description |
|---|---|
email - String
|
Example
{"email": "abc123"}
ContributorLease
ContributorMutations
Fields
| Field Name | Description |
|---|---|
attachContributorToDeal - AttachContributorToDealResponse
|
|
Arguments
|
|
createContributor - CreateContributorResponse
|
|
Arguments
|
|
createLease - ContributorCreateLeaseResponse
|
|
Arguments
|
|
detachContributorFromDeal - DetachContributorFromDealResponse
|
|
Arguments
|
|
disableContributor - DisableContributorResponse
|
|
Arguments
|
|
enableContributor - EnableContributorResponse
|
|
Arguments
|
|
updateContributor - UpdateContributorResponse
|
|
Arguments
|
|
Example
{
"attachContributorToDeal": AttachContributorToDealResponse,
"createContributor": CreateContributorResponse,
"createLease": ContributorCreateLeaseResponse,
"detachContributorFromDeal": DetachContributorFromDealResponse,
"disableContributor": DisableContributorResponse,
"enableContributor": EnableContributorResponse,
"updateContributor": UpdateContributorResponse
}
ContributorRole
ContributorRoleConnection
Fields
| Field Name | Description |
|---|---|
edges - [ContributorRoleEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ContributorRoleEdge],
"pageInfo": PageInfo
}
ContributorRoleEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - ContributorRole!
|
Example
{"cursor": 4, "node": ContributorRole}
ContributorSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMMAND_CENTER"
ConventionalPreQualification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Job ID |
parameters - ConventionalPreQualificationParameters!
|
|
productBreakdown - [PreQualificationProductResult!]!
|
|
result - PreQualificationBestEligibleResult
|
|
status - JobStatus!
|
Job status |
Example
{
"id": 4,
"parameters": ConventionalPreQualificationParameters,
"productBreakdown": [PreQualificationProductResult],
"result": PreQualificationBestEligibleResult,
"status": "FAILED"
}
ConventionalPreQualificationInput
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt
|
|
maxDiscountPointsTotal - Float
|
|
neighborhoodHousingType - NeighborhoodHousingType
|
|
propertyUsageType - PropertyUsageType
|
|
qualifyingAssetsTotalAmount - NonNegativeInt!
|
|
qualifyingFicoScore - Int!
|
|
qualifyingMonthlyExpenses - NonNegativeInt!
|
|
qualifyingMonthlyIncome - NonNegativeInt!
|
Example
{
"fipsCountyCode": "abc123",
"hoaDues": 123,
"maxDiscountPointsTotal": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"qualifyingAssetsTotalAmount": 123,
"qualifyingFicoScore": 987,
"qualifyingMonthlyExpenses": 123,
"qualifyingMonthlyIncome": 123
}
ConventionalPreQualificationParameters
Fields
| Field Name | Description |
|---|---|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt!
|
|
maxDiscountPointsTotal - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingAssetsTotalAmount - NonNegativeInt!
|
|
qualifyingFicoScore - Int!
|
|
qualifyingMonthlyExpenses - NonNegativeInt!
|
|
qualifyingMonthlyIncome - NonNegativeInt!
|
Example
{
"fipsCountyCode": "xyz789",
"hoaDues": 123,
"maxDiscountPointsTotal": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"qualifyingAssetsTotalAmount": 123,
"qualifyingFicoScore": 123,
"qualifyingMonthlyExpenses": 123,
"qualifyingMonthlyIncome": 123
}
ConventionalPreQualificationResult
Types
| Union Types |
|---|
Example
EligiblePreQualification
ConventionalResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
ConversationAuthorParty
Description
Who wrote a conversation message.
Values
| Enum Value | Description |
|---|---|
|
|
Pylon, reviewing the conversation on the underwriter's behalf. |
|
|
The loan officer in the conversation. |
|
|
An underwriter. |
Example
"AGENT"
ConversationMessageKind
Description
What a conversation message is.
Values
| Enum Value | Description |
|---|---|
|
|
An underwriter's note on the outcome of a disputed requirement, for underwriting staff. |
|
|
An ordinary message. |
|
|
Pylon's review of the conversation, for underwriting staff. |
Example
"CONTEST_OUTCOME"
ConversationSessionState
Values
| Enum Value | Description |
|---|---|
|
|
Closed by an underwriter; reopening it allows new messages again. |
|
|
Open for new messages. |
Example
"CLOSED"
ConversationTargetKind
Values
| Enum Value | Description |
|---|---|
|
|
The conversation is about one evidence item on a requirement. |
|
|
The conversation is about a requirement on the loan. |
Example
"EVIDENCE"
ConversationVisibility
Description
Who can read a conversation message.
Values
| Enum Value | Description |
|---|---|
|
|
The loan officer and underwriting staff. |
|
|
Underwriting staff only. Never returned to a loan officer. |
Example
"LO_VISIBLE"
CorrectDocumentKindInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
The uploaded file whose kind is being corrected. |
documentKind - DocumentKind!
|
What the file actually is. The file is read again as this kind, and a person's choice wins over the classifier's. Only these kinds can be read: W2, PAYSTUB, LETTER_OF_EXPLANATION, CREDIT_REPORT, GOVERNMENT_ID, PAYOFF_QUOTE, MORTGAGE_STATEMENT, HOI_POLICY, HOI_PAYMENT_RECEIPT. Any other kind is refused with DOCUMENT_INTAKE_KIND_NOT_READABLE and nothing is changed. |
Example
{
"documentId": "4",
"documentKind": "BANK_STATEMENT"
}
CorrectDocumentKindOutcome
Description
What came of correcting a file's kind. READ_STARTED: the correction was recorded and a fresh read started. REFUSED: nothing was changed (userErrors says why). READ_NOT_STARTED: the correction was recorded but the fresh read could not be started, so the file shows as unread with the corrected type kept and asking for it to be read again retries it.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"READ_NOT_STARTED"
CorrectDocumentKindResponse
Description
The outcome of correcting a file's kind. Resolves once the correction is recorded and a fresh read has been started, NOT once the file has been re-read — poll the status for that.
Fields
| Field Name | Description |
|---|---|
attempt - Int!
|
The attempt number now in flight. Unchanged when the request was refused. For a file that had no intake record before this request (an upload straight to a loan), its first read counts as attempt 1: a refusal, or a re-read that could not be started, answers 1, and a re-read that started answers 2. |
outcome - CorrectDocumentKindOutcome!
|
What came of the request; see the enum. |
userErrors - [UserError!]!
|
Why the correction was refused or its read could not be started. Empty exactly when the outcome is READ_STARTED. |
Example
{
"attempt": 987,
"outcome": "READ_NOT_STARTED",
"userErrors": [UserError]
}
CorrectPrepaidEntryInput
Fields
| Input Field | Description |
|---|---|
correctedAmount - MonetaryAmount!
|
What the entry should stand at, from 0.00 to 999,999,999,999.99. A correction records the difference from what it stands at now. |
customerId - ID!
|
The seller the entry belongs to. |
idempotencyKey - String!
|
A retry key unique to the entries of this seller. Repeating the call with the same key and corrected amount returns the correction already recorded. |
prepaidEntryId - ID!
|
The original entry to correct. A correction itself cannot be corrected; correct the original again. |
reason - String!
|
Why the amount is being corrected. |
Example
{
"correctedAmount": MonetaryAmount,
"customerId": 4,
"idempotencyKey": "abc123",
"prepaidEntryId": "4",
"reason": "xyz789"
}
CorrectPrepaidEntryResponse
Fields
| Field Name | Description |
|---|---|
outcome - FundingPrepaidEntryOutcome!
|
RECORDED when this request recorded the entry. REPLAYED when the same idempotency key had already recorded it, so nothing new was recorded. |
prepaidEntry - FundingPrepaidEntry!
|
Example
{
"outcome": "RECORDED",
"prepaidEntry": FundingPrepaidEntry
}
CorrectWireInRemittanceInput
Fields
| Input Field | Description |
|---|---|
effectiveDate - Date
|
The accounting date for the correction. Defaults to today's date in Pylon's local time zone when omitted. |
idempotencyKey - String!
|
A retry key unique to this loan's wire-in records. |
loanId - ID!
|
The loan with the recorded remittance. |
reason - FundingCorrectionReason!
|
Why Pylon is negating the recorded remittance. |
remittanceId - ID!
|
The ordinary wire-in remittance to negate. |
Example
{
"effectiveDate": "2007-12-03",
"idempotencyKey": "abc123",
"loanId": 4,
"reason": "DUPLICATE_REPORT",
"remittanceId": "4"
}
CorrectWireInRemittanceResponse
Fields
| Field Name | Description |
|---|---|
correction - FundingRemittance!
|
|
fundingSettlement - FundingSettlement!
|
Example
{
"correction": FundingRemittance,
"fundingSettlement": FundingSettlement
}
CorrectWireOutRemittanceInput
Fields
| Input Field | Description |
|---|---|
effectiveDate - Date
|
The accounting date for the correction. Defaults to today's date in Pylon's local time zone when omitted. |
idempotencyKey - String!
|
A retry key unique to this loan's wire-out records. |
loanId - ID!
|
The loan with the reported remittance. |
reason - FundingCorrectionReason!
|
Why Pylon is negating the reported remittance. |
remittanceId - ID!
|
The ordinary wire-out remittance to negate. |
Example
{
"effectiveDate": "2007-12-03",
"idempotencyKey": "abc123",
"loanId": 4,
"reason": "DUPLICATE_REPORT",
"remittanceId": "4"
}
CorrectWireOutRemittanceResponse
Fields
| Field Name | Description |
|---|---|
correction - FundingRemittance!
|
|
fundingSettlement - FundingSettlement!
|
Example
{
"correction": FundingRemittance,
"fundingSettlement": FundingSettlement
}
CostAbsorption
Description
Organization cost absorptions per product.
Fields
| Field Name | Description |
|---|---|
points - NonNegativeFloat!
|
|
product - String!
|
Example
{"points": 123.45, "product": "abc123"}
CounterAssessmentCitationInput
Description
A citation grounding a counter-assessment: a region on a document page, plus optional meaning.
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
The document being cited. |
label - String
|
What the region means (e.g. "Dwelling coverage amount"). |
page - PositiveInt!
|
1-based page number. |
pageHeight - Float!
|
|
pageWidth - Float!
|
|
polygon - [PagePointInput!]!
|
Region outline in scale-1 pdf.js page units, y-down. |
quotedText - String
|
What the region says. |
value - JSONObject
|
Optional typed value the region evidences. |
Example
{
"documentId": 4,
"label": "xyz789",
"page": 123,
"pageHeight": 987.65,
"pageWidth": 123.45,
"polygon": [PagePointInput],
"quotedText": "xyz789",
"value": {}
}
County
Description
US County
Fields
| Field Name | Description |
|---|---|
fipsCountyCode - String!
|
County-level FIPS code |
name - String!
|
County name |
state - StateAbbreviated!
|
Abbreviated US state name (including DC) |
Example
{
"fipsCountyCode": "abc123",
"name": "abc123",
"state": "AK"
}
CreatableFeeSection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
CreateAccessoryUnitIncomeInput
Description
Input for creating an AccessoryUnitIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateAlimonyIncomeInput
Description
Input for creating an AlimonyIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateApplicationInput
Fields
| Input Field | Description |
|---|---|
contacts - [BorrowerPersonalInformationInput!]!
|
The applicants, one borrower each, in order. The first is the loan's point of contact. |
idempotencyKey - String!
|
A UUID the caller mints once per application and sends again on every retry. A retry with the same contacts, source and loan-officer slug returns the application the key first opened once creation effects finish. While the first request is still finishing, a retry returns LOAN_APPLICATION_CREATION_IN_PROGRESS (retryable, HTTP 503); retry with the same key until the loan is returned. Reusing the key with different input returns IDEMPOTENCY_KEY_REUSED in userErrors and no loan. Keys have no time-to-live. |
loanOfficerSlug - String
|
URL slug of the loan officer who referred the borrower. The officer is assigned when the loan is created. An unknown slug returns LOAN_OFFICER_SLUG_NOT_FOUND; an assignment failure returns LOAN_OFFICER_ASSIGNMENT_FAILED. Neither error creates a loan. |
source - ContributorSource
|
Origin system attributed to the loan's contributor (e.g. COMMAND_CENTER). |
Example
{
"contacts": [BorrowerPersonalInformationInput],
"idempotencyKey": "abc123",
"loanOfficerSlug": "xyz789",
"source": "COMMAND_CENTER"
}
CreateApplicationResponse
Fields
| Field Name | Description |
|---|---|
loan - Loan
|
The created or replayed loan, or null when refused. |
userErrors - [UserError!]!
|
Example
{
"loan": Loan,
"userErrors": [UserError]
}
CreateAssetInput
Description
Input to the createAsset mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
Example
{
"automobile": CreateAutomobileAssetInput,
"bond": CreateBondAssetInput,
"bridgeLoanNotDeposited": CreateBridgeLoanNotDepositedAssetInput,
"cashOnHand": CreateCashOnHandAssetInput,
"certificateOfDepositTimeDeposit": CreateCertificateOfDepositTimeDepositAssetInput,
"checkingAccount": CreateCheckingAccountAssetInput,
"cryptocurrency": CreateCryptocurrencyAssetInput,
"gift": CreateGiftAssetInput,
"grant": CreateGrantAssetInput,
"individualDevelopmentAccount": CreateIndividualDevelopmentAccountAssetInput,
"lifeInsurance": CreateLifeInsuranceAssetInput,
"moneyMarketFund": CreateMoneyMarketFundAssetInput,
"mutualFund": CreateMutualFundAssetInput,
"other": CreateOtherAssetInput,
"pendingNetSaleProceedsFromRealEstate": CreatePendingNetSaleProceedsFromRealEstateAssetInput,
"proceedsFromSaleOfNonRealEstateAsset": CreateProceedsFromSaleOfNonRealEstateAssetInput,
"proceedsFromSecuredLoan": CreateProceedsFromSecuredLoanAssetInput,
"proceedsFromUnsecuredLoan": CreateProceedsFromUnsecuredLoanAssetInput,
"retirementFund": CreateRetirementFundAssetInput,
"savingsAccount": CreateSavingsAccountAssetInput,
"stock": CreateStockAssetInput,
"stockOptions": CreateStockOptionsAssetInput,
"trustAccount": CreateTrustAccountAssetInput
}
CreateAssetResponse
Description
Response of the createAsset mutation
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The created asset |
Example
{"asset": Asset}
CreateAutomobileAllowanceIncomeInput
Description
Input for creating an AutomobileAllowanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateAutomobileAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"borrowerIds": ["4"],
"nonBorrowerOwnerNames": ["abc123"]
}
CreateAuxiliaryEmploymentIncomeInput
Description
Input to the createAuxiliaryEmploymentIncome mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
| Input Field | Description |
|---|---|
bonus - CreateAuxiliaryEmploymentIncomeTypeInput
|
|
commissions - CreateAuxiliaryEmploymentIncomeTypeInput
|
|
overtime - CreateAuxiliaryEmploymentIncomeTypeInput
|
|
tipIncome - CreateAuxiliaryEmploymentIncomeTypeInput
|
Example
{
"bonus": CreateAuxiliaryEmploymentIncomeTypeInput,
"commissions": CreateAuxiliaryEmploymentIncomeTypeInput,
"overtime": CreateAuxiliaryEmploymentIncomeTypeInput,
"tipIncome": CreateAuxiliaryEmploymentIncomeTypeInput
}
CreateAuxiliaryEmploymentIncomeResponse
Fields
| Field Name | Description |
|---|---|
income - Income!
|
The income entity that was created |
Example
{"income": Income}
CreateAuxiliaryEmploymentIncomeTypeInput
Description
Input for creating an auxiliary employment income
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
employmentId - ID!
|
The employment this income is associated with |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"employmentId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateBoarderIncomeInput
Description
Input for creating a BoarderIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateBondAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateBorrowerEstimatedTotalMonthlyIncomeInput
Description
Input for creating a BorrowerEstimatedTotalMonthlyIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateBorrowerInput
Fields
| Input Field | Description |
|---|---|
dealId - ID!
|
ID of the deal |
dependentAges - [Float!]
|
|
econsentCaptureMethod - EconsentCaptureMethodType
|
How the borrower's consent to electronic disclosures was captured. |
econsentStatus - EconsentStatusType
|
The borrower's answer to electronic disclosures. |
financialDeclarations - BorrowerFinancialDeclarationsInput
|
|
incomeVerificationConsentDate - DateTime
|
When consent for income verification was captured. |
incomeVerificationConsentType - CreditPullConsentType
|
Consent captured for income verification. |
mailingAddress - AddressInput
|
|
personalInformation - BorrowerPersonalInformationInput!
|
|
pointOfContact - Boolean
|
|
propertyDeclarations - BorrowerPropertyDeclarationsInput
|
Example
{
"dealId": 4,
"dependentAges": [987.65],
"econsentCaptureMethod": "ELECTRONIC",
"econsentStatus": "ACCEPT",
"financialDeclarations": BorrowerFinancialDeclarationsInput,
"incomeVerificationConsentDate": "2007-12-03T10:15:30Z",
"incomeVerificationConsentType": "ELECTRONIC",
"mailingAddress": AddressInput,
"personalInformation": BorrowerPersonalInformationInput,
"pointOfContact": true,
"propertyDeclarations": BorrowerPropertyDeclarationsInput
}
CreateBorrowerPhoneNumberInput
Description
A phone number
Fields
| Input Field | Description |
|---|---|
number - String!
|
Phone Number |
type - PhoneNumberType
|
Phone number type |
Example
{"number": "xyz789", "type": "CELL"}
CreateBorrowerResponse
Description
Response of the create borrower mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the borrower |
Example
{"id": "4"}
CreateBridgeLoanNotDepositedAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateCapitalGainsIncomeInput
Description
Input for creating a CapitalGainsIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateCashOnHandAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateCertificateOfDepositTimeDepositAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateCheckingAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateChildSupportIncomeInput
Description
Input for creating a ChildSupportIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateCitationInput
Description
A citation drawn by an underwriter: a region on a document page, plus optional meaning. Geometry is required — freehand text-only notes are not part of this input (they arrive with the assertion write surface).
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
The document being cited. |
label - String
|
What the region means (e.g. "Dwelling coverage amount"). |
page - PositiveInt!
|
1-based page number. |
pageHeight - Float!
|
|
pageWidth - Float!
|
|
polygon - [PagePointInput!]!
|
Region outline in scale-1 pdf.js page units, y-down. |
quotedText - String
|
What the region says. |
value - JSONObject
|
Optional typed value the region evidences. |
Example
{
"documentId": 4,
"label": "abc123",
"page": 123,
"pageHeight": 987.65,
"pageWidth": 987.65,
"polygon": [PagePointInput],
"quotedText": "abc123",
"value": {}
}
CreateCitationResponse
Description
Result of creating a citation.
Fields
| Field Name | Description |
|---|---|
citation - Citation!
|
The persisted citation, typed. |
Example
{"citation": Citation}
CreateCompanyInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Company address |
businessType - BusinessType
|
Business type |
dealId - ID!
|
ID of the deal |
name - String
|
Company name |
Example
{
"address": AddressInput,
"businessType": "CORPORATION",
"dealId": "4",
"name": "abc123"
}
CreateCompanyResponse
Fields
| Field Name | Description |
|---|---|
company - Company!
|
Example
{"company": Company}
CreateContactInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Optional U.S. address to create with the contact. |
companyLicenseNumber - String
|
License number of the company the contact represents |
companyLicenseState - StateAbbreviated
|
State where the company's license was issued |
companyName - String
|
Company which the contact is from |
email - String
|
Email address of the contact |
firstName - String
|
First name of the contact |
hazardInsuranceCoverage - HazardInsuranceCoverageType
|
Coverage provided by a hazard insurer |
individualLicenseNumber - String
|
Professional license number of the individual contact |
individualLicenseState - StateAbbreviated
|
State where the individual's professional license was issued |
lastName - String
|
Last name of the contact |
middleName - String
|
Middle name of the contact |
phoneNumber - String
|
Phone number of the contact |
role - OrganizationContactRole!
|
Contact's role, limited to supported values. |
Example
{
"address": AddressInput,
"companyLicenseNumber": "xyz789",
"companyLicenseState": "AK",
"companyName": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"hazardInsuranceCoverage": "EARTHQUAKE",
"individualLicenseNumber": "xyz789",
"individualLicenseState": "AK",
"lastName": "xyz789",
"middleName": "xyz789",
"phoneNumber": "xyz789",
"role": "ATTORNEY"
}
CreateContactResponse
Fields
| Field Name | Description |
|---|---|
created - Contact!
|
The newly created contact. |
Example
{"created": Contact}
CreateContractBasisIncomeInput
Description
Input for creating a ContractBasisIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateContributorContactInfoInput
CreateContributorInput
Fields
| Input Field | Description |
|---|---|
contactInfo - CreateContributorContactInfoInput!
|
|
role - String
|
|
roleId - ID
|
|
source - ContributorSource
|
Example
{
"contactInfo": CreateContributorContactInfoInput,
"role": "xyz789",
"roleId": "4",
"source": "COMMAND_CENTER"
}
CreateContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
CreateCryptocurrencyAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
description - String
|
Description of the asset (e.g. coin and platform) |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"description": "abc123",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateCustomerApiClientInput
Description
Input for creating an additional machine-to-machine API client for an existing customer.
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
The customer the API client acts for. |
scopeBundles - [OauthClientScopeBundle!]!
|
Scope bundles granted to the machine-to-machine API client. The bundles are stored on the oauth_client row and the matching scopes are granted to the Auth0 application. Must not be empty. |
Example
{"customerId": 4, "scopeBundles": ["MTM_LOAN_FILE_READ"]}
CreateCustomerApiClientResponse
Description
Result of creating an additional machine-to-machine API client for an existing customer.
Fields
| Field Name | Description |
|---|---|
oauthClientId - OpaqueToken
|
The Auth0 OAuth client id created for direct API access, when creation succeeded. |
userErrors - [GenericUserError!]!
|
User errors that prevented creation (e.g. no scope bundles were given). Empty when creation succeeded. |
Example
{
"oauthClientId": OpaqueToken,
"userErrors": [GenericUserError]
}
CreateDealResponse
Fields
| Field Name | Description |
|---|---|
deal - Deal!
|
Example
{"deal": Deal}
CreateDefinedContributionPlanIncomeInput
Description
Input for creating a DefinedContributionPlanIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateDisabilityIncomeInput
Description
Input for creating a DisabilityIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateDividendsInterestIncomeInput
Description
Input for creating a DividendsInterestIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateEmploymentRelatedAccountIncomeInput
Description
Input for creating an EmploymentRelatedAccountIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateFeeInput
Description
Input to the fee.create mutation.
Fields
| Input Field | Description |
|---|---|
description - String!
|
The fee's name as disclosed. It must differ from every other fee on the loan. |
loanId - ID!
|
The ID or friendly ID of the loan. |
paidToName - String
|
Who the fee is paid to. |
payerShares - [FeePaymentInput!]!
|
Who pays this fee at closing, and how much each party pays. The shares' sum becomes the fee's fixed amount; a payer left out pays 0. |
section - CreatableFeeSection!
|
The disclosure section the fee appears in. |
Example
{
"description": "abc123",
"loanId": "4",
"paidToName": "xyz789",
"payerShares": [FeePaymentInput],
"section": "OTHER"
}
CreateFeeResponse
Fields
| Field Name | Description |
|---|---|
fee - Fee!
|
Example
{"fee": Fee}
CreateFeeSheetRequestForLoanInput
Description
Input for requesting a fee sheet for a loan. Pricing parameters are derived server-side from the loan's own data.
Example
{"loanId": 4, "productStructureId": "4"}
CreateFeeSheetRequestForLoanResponse
Description
Response for a loan fee sheet request
Example
{
"errorMessage": "abc123",
"feeSheetRequestId": "4"
}
CreateFeeSheetRequestInput
Description
Input for requesting a fee sheet
Fields
| Input Field | Description |
|---|---|
productStructure - FeeSheetStructureInput!
|
Product structure for the fee sheet |
purchasePricing - FeeSheetPurchasePricingInput
|
Purchase pricing details |
refinancePricing - FeeSheetRefinancePricingInput
|
Refinance pricing details |
Example
{
"productStructure": FeeSheetStructureInput,
"purchasePricing": FeeSheetPurchasePricingInput,
"refinancePricing": FeeSheetRefinancePricingInput
}
CreateFeeSheetRequestResponse
CreateFosterCareIncomeInput
Description
Input for creating a FosterCareIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateFulfillmentPartyInput
Fields
| Input Field | Description |
|---|---|
companyId - ID
|
The ID of the associated company |
dealId - ID!
|
|
role - FulfillmentPartyRole
|
The role of the fulfillment party |
Example
{"companyId": 4, "dealId": 4, "role": "NOTARY"}
CreateFulfillmentPartyResponse
Fields
| Field Name | Description |
|---|---|
fulfillmentParty - FulfillmentParty!
|
Example
{"fulfillmentParty": FulfillmentParty}
CreateGiftAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"borrowerIds": [4],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "abc123",
"donorPhoneNumber": "abc123",
"isIncludedInAssetAccount": true,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["abc123"],
"source": "COMMUNITY_NON_PROFIT"
}
CreateGrantAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"borrowerIds": [4],
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "abc123",
"donorPhoneNumber": "xyz789",
"isIncludedInAssetAccount": false,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["xyz789"],
"source": "COMMUNITY_NON_PROFIT"
}
CreateHousingAllowanceIncomeInput
Description
Input for creating a HousingAllowanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateHousingChoiceVoucherProgramIncomeInput
Description
Input for creating a HousingChoiceVoucherProgramIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateIncomeInput
Description
Input to the createIncome mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
Example
{
"accessoryUnitIncome": CreateAccessoryUnitIncomeInput,
"alimony": CreateAlimonyIncomeInput,
"automobileAllowance": CreateAutomobileAllowanceIncomeInput,
"boarder": CreateBoarderIncomeInput,
"borrowerEstimatedTotalMonthlyIncome": CreateBorrowerEstimatedTotalMonthlyIncomeInput,
"capitalGains": CreateCapitalGainsIncomeInput,
"childSupport": CreateChildSupportIncomeInput,
"contractBasis": CreateContractBasisIncomeInput,
"definedContributionPlan": CreateDefinedContributionPlanIncomeInput,
"disability": CreateDisabilityIncomeInput,
"dividendsInterest": CreateDividendsInterestIncomeInput,
"employmentRelatedAccount": CreateEmploymentRelatedAccountIncomeInput,
"fosterCare": CreateFosterCareIncomeInput,
"housingAllowance": CreateHousingAllowanceIncomeInput,
"housingChoiceVoucherProgram": CreateHousingChoiceVoucherProgramIncomeInput,
"militaryBasePay": CreateMilitaryBasePayIncomeInput,
"militaryClothesAllowance": CreateMilitaryClothesAllowanceIncomeInput,
"militaryCombatPay": CreateMilitaryCombatPayIncomeInput,
"militaryFlightPay": CreateMilitaryFlightPayIncomeInput,
"militaryHazardPay": CreateMilitaryHazardPayIncomeInput,
"militaryOverseasPay": CreateMilitaryOverseasPayIncomeInput,
"militaryPropPay": CreateMilitaryPropPayIncomeInput,
"militaryQuartersAllowance": CreateMilitaryQuartersAllowanceIncomeInput,
"militaryRationsAllowance": CreateMilitaryRationsAllowanceIncomeInput,
"militaryVariableHousingAllowance": CreateMilitaryVariableHousingAllowanceIncomeInput,
"miscellaneousIncome": CreateMiscellaneousIncomeInput,
"mortgageCreditCertificate": CreateMortgageCreditCertificateIncomeInput,
"mortgageDifferential": CreateMortgageDifferentialIncomeInput,
"netRentalIncome": CreateNetRentalIncomeInput,
"nonBorrowerContribution": CreateNonBorrowerContributionIncomeInput,
"nonBorrowerHouseholdIncome": CreateNonBorrowerHouseholdIncomeInput,
"notesReceivableInstallment": CreateNotesReceivableInstallmentIncomeInput,
"other": CreateOtherIncomeInput,
"pension": CreatePensionIncomeInput,
"proposedGrossRentForSubjectProperty": CreateProposedGrossRentForSubjectPropertyIncomeInput,
"publicAssistance": CreatePublicAssistanceIncomeInput,
"realEstateOwnedGrossRentalIncome": CreateRealEstateOwnedGrossRentalIncomeInput,
"retirement": CreateRetirementIncomeInput,
"royalties": CreateRoyaltiesIncomeInput,
"selfEmployment": CreateSelfEmploymentIncomeInput,
"selfEmploymentLoss": CreateSelfEmploymentLossIncomeInput,
"separateMaintenance": CreateSeparateMaintenanceIncomeInput,
"socialSecurity": CreateSocialSecurityIncomeInput,
"standardEmployment": CreateStandardEmploymentIncomeInput,
"subjectPropertyNetCashFlow": CreateSubjectPropertyNetCashFlowIncomeInput,
"temporaryLeave": CreateTemporaryLeaveIncomeInput,
"trailingCoBorrower": CreateTrailingCoBorrowerIncomeInput,
"trust": CreateTrustIncomeInput,
"unemployment": CreateUnemploymentIncomeInput,
"vaBenefitsNonEducational": CreateVaBenefitsNonEducationalIncomeInput,
"workersCompensation": CreateWorkersCompensationIncomeInput
}
CreateIncomeResponse
Description
Response of the createIncome mutation
Fields
| Field Name | Description |
|---|---|
income - Income!
|
The income entity that was created |
Example
{"income": Income}
CreateIndividualDevelopmentAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateInitializationTokenInput
Description
Input to the createInitializationToken mutation.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower |
clientUserId - String
|
Client user ID for Plaid Layer |
templateId - String
|
Optional Template ID for Plaid Layer integration |
vendor - VendorName!
|
Vendor to use (PLAID or TRUV) |
Example
{
"borrowerId": 4,
"clientUserId": "xyz789",
"templateId": "abc123",
"vendor": "PLAID"
}
CreateInitializationTokenResponse
Description
Token for initializing verification widget
Types
| Union Types |
|---|
Example
PlaidLinkToken
CreateLeaseInput
Description
Input to create a borrower lease
Example
{
"email": "abc123",
"externalUserId": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789"
}
CreateLeaseResponse
Description
Borrower lease response
Fields
| Field Name | Description |
|---|---|
lease - Lease
|
Lease that was created |
Example
{"lease": Lease}
CreateLiabilityInput
Description
Input to the createLiability mutation.
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
Account identifier |
balance - NonNegativeFloat
|
Unpaid balance |
bankName - String
|
Bank name |
borrowerIds - [ID!]!
|
Liability-owning borrower IDs |
exclusionReason - LiabilityExclusionReason
|
The reason this liability should be excluded from total debt |
intent - LiabilityIntent
|
The intent regarding liability |
lienPriorityType - LienPriorityType
|
Lien priority; overrides the one a positional type implies, and moves a positional type to match. Null is the same as omitted. Only mortgage loans can hold a position, and a HELOC only below first lien; any other type is rejected with LIEN_POSITION_NOT_ALLOWED_FOR_TYPE. |
monthlyPayment - NonNegativeFloat
|
Monthly payment |
type - LiabilityType
|
The type of liability |
Example
{
"accountIdentifier": "abc123",
"balance": 123.45,
"bankName": "abc123",
"borrowerIds": ["4"],
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"intent": "DO_NOTHING",
"lienPriorityType": "FIRST_LIEN",
"monthlyPayment": 123.45,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
CreateLiabilityResponse
Description
Response of the createLiability mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The created liability |
Example
{"liability": Liability}
CreateLifeInsuranceAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateLoanAssignmentInput
CreateLoanAssignmentResponse
Fields
| Field Name | Description |
|---|---|
assignment - LoanAssignment
|
|
feeWaived - Boolean!
|
True when the assignment succeeded but the processor's fee was not applied because initial disclosures have already been sent. The processor is still added to the loan team without the fee. |
userErrors - [UserError!]!
|
Example
{
"assignment": LoanAssignment,
"feeWaived": true,
"userErrors": [UserError]
}
CreateLoanInput
Description
Input to the createLoan mutation.
Fields
| Input Field | Description |
|---|---|
cashOutType - RefinanceCashOutType
|
LO-set refinance/cash-out type (distinct from the pricing-derived value) |
closingDate - Date
|
The date that the purchase is set to close. |
dealId - ID!
|
|
loanOfficerSlug - String
|
URL slug of the loan officer who referred the borrower. The officer is assigned when the loan is created. An unknown slug returns LOAN_OFFICER_SLUG_NOT_FOUND; an assignment failure returns LOAN_OFFICER_ASSIGNMENT_FAILED. Neither error creates a loan. |
loanPurpose - LoanPurposeType
|
The purpose for which the loan proceeds will be used. |
loanTermYears - PositiveFloat
|
The term of this loan in years. Default = 30 |
outOfPocketMax - NonNegativeInt
|
The maximum amount of assets (in dollars) to be used towards the loan. |
purchasePrice - NonNegativeInt
|
The actual purchase price (in dollars). |
refinanceCashOutProceeds - NonNegativeInt
|
Refinance cash out proceeds not used towards paying off existing liens. |
source - ContributorSource
|
Origin system attributed to the loan's contributor (e.g. COMMAND_CENTER). |
Example
{
"cashOutType": "CASH_OUT",
"closingDate": "2007-12-03",
"dealId": 4,
"loanOfficerSlug": "abc123",
"loanPurpose": "PURCHASE",
"loanTermYears": 123.45,
"outOfPocketMax": 123,
"purchasePrice": 123,
"refinanceCashOutProceeds": 123,
"source": "COMMAND_CENTER"
}
CreateLoanPreApprovalLetterError
Description
Union of possible user errors that can occur during execution of the createLoanPreApprovalLetter mutation.
Example
ExpiredCreditPullError
CreateLoanPreApprovalLetterInput
Description
Input to the createLoanPreApprovalLetter mutation.
Fields
| Input Field | Description |
|---|---|
loanAmount - NonNegativeInt!
|
Loan amount (in dollars) to display on the letter. Cannot exceed the maximum pre-approved loan amount. |
loanId - ID!
|
The ID or friendly ID of the loan. |
purchasePrice - NonNegativeInt!
|
Purchase price (in dollars) to display on the letter. Cannot exceed the maximum pre-approved purchase price. |
styles - PreApprovalLetterStylesInput
|
Styles for the letter. Omit to use the default styles. |
Example
{
"loanAmount": 123,
"loanId": 4,
"purchasePrice": 123,
"styles": PreApprovalLetterStylesInput
}
CreateLoanPreApprovalLetterResponse
Description
Response of the createLoanPreApprovalLetter mutation.
Fields
| Field Name | Description |
|---|---|
letterUrl - String
|
A download URL for the pre-approval letter. The value will be null if the loan has not been pre-approved. |
userErrors - [CreateLoanPreApprovalLetterError!]!
|
A list of user errors that occurred while executing the createLoanPreApprovalLetter mutation. |
Example
{
"letterUrl": "abc123",
"userErrors": [ExpiredCreditPullError]
}
CreateLoanResponse
Description
Response of the createLoan mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The newly created loan. |
Example
{"loan": Loan}
CreateLoanScriptInput
Description
Input for creating a loan script.
Fields
| Input Field | Description |
|---|---|
description - String!
|
What the script builds and verifies. |
scenarioId - String!
|
Unique, stable identifier for the new script. |
spec - JSONObject!
|
The script payload (steps, and assertions and/or expected). Validated against the strict loan-script schema. |
Example
{
"description": "abc123",
"scenarioId": "abc123",
"spec": {}
}
CreateLoanScriptResponse
Description
Result of creating a loan script.
Fields
| Field Name | Description |
|---|---|
loanScript - LoanScript!
|
The created script. |
Example
{"loanScript": LoanScript}
CreateMaxLoanPreApprovalLetterError
Description
Union of possible user errors that can occur during execution of the createMaxLoanPreApprovalLetter mutation.
Example
ExpiredCreditPullError
CreateMaxLoanPreApprovalLetterInput
Description
Input to the createMaxLoanPreApprovalLetter mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
styles - PreApprovalLetterStylesInput
|
Styles for the letter. Omit to use the default styles. |
Example
{"loanId": 4, "styles": PreApprovalLetterStylesInput}
CreateMaxLoanPreApprovalLetterResponse
Description
Response of the createMaxLoanPreApprovalLetter mutation.
Fields
| Field Name | Description |
|---|---|
letterUrl - String
|
A download URL for a pre-approval letter with the maximum pre-approved loan amount and purchase price for the loan. |
userErrors - [CreateMaxLoanPreApprovalLetterError!]!
|
A list of user errors that occurred while executing the createMaxLoanPreApprovalLetter mutation. |
Example
{
"letterUrl": "abc123",
"userErrors": [ExpiredCreditPullError]
}
CreateMilitaryBasePayIncomeInput
Description
Input for creating a MilitaryBasePayIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryClothesAllowanceIncomeInput
Description
Input for creating a MilitaryClothesAllowanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryCombatPayIncomeInput
Description
Input for creating a MilitaryCombatPayIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryFlightPayIncomeInput
Description
Input for creating a MilitaryFlightPayIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryHazardPayIncomeInput
Description
Input for creating a MilitaryHazardPayIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryOverseasPayIncomeInput
Description
Input for creating a MilitaryOverseasPayIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryPropPayIncomeInput
Description
Input for creating a MilitaryPropPayIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryQuartersAllowanceIncomeInput
Description
Input for creating a MilitaryQuartersAllowanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryRationsAllowanceIncomeInput
Description
Input for creating a MilitaryRationsAllowanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMilitaryVariableHousingAllowanceIncomeInput
Description
Input for creating a MilitaryVariableHousingAllowanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMiscellaneousIncomeInput
Description
Input for creating a MiscellaneousIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMoneyMarketFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateMortgageCreditCertificateIncomeInput
Description
Input for creating a MortgageCreditCertificateIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
percentageOfInterest - NonNegativeFloat
|
The percentage of interest that the mortgage credit certificate will cover. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"percentageOfInterest": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMortgageDifferentialIncomeInput
Description
Input for creating a MortgageDifferentialIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateMutualFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateNetRentalIncomeInput
Description
Input for creating a NetRentalIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
ownedPropertyId - ID!
|
The owned property to link this rental income to |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"ownedPropertyId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateNonBorrowerContributionIncomeInput
Description
Input for creating a NonBorrowerContributionIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateNonBorrowerHouseholdIncomeInput
Description
Input for creating a NonBorrowerHouseholdIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateNonBorrowingOwnerInput
Fields
| Input Field | Description |
|---|---|
dealId - ID!
|
|
personalInformation - PersonalInformationInput!
|
|
phoneNumber - String
|
The non-borrowing owner’s phone number. |
Example
{
"dealId": 4,
"personalInformation": PersonalInformationInput,
"phoneNumber": "abc123"
}
CreateNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
nonBorrowingOwner - NonBorrowingOwner!
|
Example
{"nonBorrowingOwner": NonBorrowingOwner}
CreateNotesReceivableInstallmentIncomeInput
Description
Input for creating a NotesReceivableInstallmentIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateOrganizationRoleInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
name - String!
|
|
permissions - [String!]!
|
Example
{
"description": "xyz789",
"name": "abc123",
"permissions": ["xyz789"]
}
CreateOrganizationRoleResponse
Fields
| Field Name | Description |
|---|---|
organizationRole - OrganizationRole
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationRole": OrganizationRole,
"userErrors": [GenericUserError]
}
CreateOrganizationUserInput
Fields
| Input Field | Description |
|---|---|
accessType - OrganizationUserAccessType
|
Whether to provision the user with Command Center access (login + internal) or as an internal-only record. Defaults to Command Center access. Default = CommandCenterAccess |
companyAddress - AddressInput
|
The company's NMLS address. We auto-fill company fields like this one from your organization's records to the best of our ability; supply this field to override the value we have on file. |
companyName - String
|
Payee company name for processor-type roles. Only applicable when the assigned role is processor or third_party_processor. |
email - String!
|
|
firstName - String!
|
|
individualNmlsId - String
|
The user's individual NMLS identifier. |
lastName - String!
|
|
licenses - [OrganizationUserLicenseInput!]
|
Individual state licenses for the user. Required for loan officers, optional for admins, and rejected for all other roles. |
organizationRoles - [ID!]!
|
|
phoneNumber - String
|
The user's phone number. |
processorFeeAmount - Float
|
Processing fee in dollars for processor-type roles. Only applicable when the assigned role is processor or third_party_processor. |
status - LoanOfficerStatus
|
Whether the loan officer starts active or inactive in this organization. Omitted: active, unless your organization requires it. Inactive only while dual comp is on for your organization. |
Example
{
"accessType": "CommandCenterAccess",
"companyAddress": AddressInput,
"companyName": "xyz789",
"email": "xyz789",
"firstName": "abc123",
"individualNmlsId": "xyz789",
"lastName": "abc123",
"licenses": [OrganizationUserLicenseInput],
"organizationRoles": ["4"],
"phoneNumber": "abc123",
"processorFeeAmount": 123.45,
"status": "ACTIVE"
}
CreateOrganizationUserResponse
Fields
| Field Name | Description |
|---|---|
internalUserCreated - Boolean!
|
True when a new internal user was successfully created as part of this operation. For users without a Command Center login, this is the primary success signal since there is no organizationUser to return. |
organizationUser - OrganizationUser
|
|
userErrors - [GenericUserError!]!
|
Example
{
"internalUserCreated": false,
"organizationUser": OrganizationUser,
"userErrors": [GenericUserError]
}
CreateOtherAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
description - String
|
Description of the asset |
institutionName - String
|
Institution name |
isLiquid - Boolean
|
Indicates whether or not the asset is liquid |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"description": "abc123",
"institutionName": "abc123",
"isLiquid": false,
"nonBorrowerOwnerNames": ["abc123"]
}
CreateOtherIncomeInput
Description
Input for creating an OtherIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
description - String
|
Information about the income type |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"description": "xyz789",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateOwnedPropertyInput
Description
Input to the createOwnedProperty mutation.
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US Address |
currentUsageType - PropertyUsageType
|
How the owner is using this property. |
homeInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly home insurance premium. |
intendedDisposition - PropertyDisposition
|
The intended disposition of the property. Indicates whether the borrowers will be retaining or selling (or sold) the property. |
intendedUsageType - PropertyUsageType
|
How the owner intends to use this property. |
monthlyAssociationDues - NonNegativeInt
|
Monthly association dues (in dollars) |
monthlyRentalIncome - NonNegativeInt
|
The expected monthly rental income (in dollars) |
mortgageInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly mortgage insurance monthly premium. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing (e.g. single or multi-family) |
ownerIds - [ID!]!
|
IDs of the borrowers who own this property |
propertyTaxMonthlyPayment - NonNegativeInt
|
The dollar amount of property taxes due per month. |
propertyValue - NonNegativeInt
|
The estimated value of the owned property, in whole dollars |
purchaseDate - Date
|
The date when the property was originally purchased. |
sellDate - Date
|
The date when the property was sold. Only relevant for previously owned properties. |
Example
{
"address": AddressInput,
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"monthlyAssociationDues": 123,
"monthlyRentalIncome": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"ownerIds": [4],
"propertyTaxMonthlyPayment": 123,
"propertyValue": 123,
"purchaseDate": "2007-12-03",
"sellDate": "2007-12-03"
}
CreateOwnedPropertyResponse
Description
Response of the createOwnedProperty mutation.
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The created OwnedProperty |
Example
{"ownedProperty": OwnedProperty}
CreatePartyInput
Fields
| Input Field | Description |
|---|---|
dealId - ID!
|
The ID of the deal to which the party will be associated. Note that the deal must have exactly one loan already. In the future, attaching a party to a loan will be done explicitly. |
party - CreatePartyInputParty!
|
Example
{"dealId": 4, "party": CreatePartyInputParty}
CreatePartyInputParty
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update. Fields with non-null values will be updated, the rest will be ignored. |
individual - PartyIndividualInput
|
Details about the party, if the party is an individual (rather than a company) |
legalEntity - PartyLegalEntityInput
|
Details about the party, if the party is a legal entity |
role - PartyRole
|
Indicates the type of relationship between the party and the loan. |
Example
{
"address": AddressInput,
"individual": PartyIndividualInput,
"legalEntity": PartyLegalEntityInput,
"role": "APPRAISER"
}
CreatePartyResponse
Fields
| Field Name | Description |
|---|---|
party - Party
|
|
userErrors - [UserError!]!
|
Example
{
"party": Party,
"userErrors": [UserError]
}
CreatePendingNetSaleProceedsFromRealEstateAssetInput
Description
Input for creating a PendingNetSaleProceedsFromRealEstateAsset. The amount is the expected proceeds from the sale and should be less than or equal to the salePrice.
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
ownedPropertyId - ID
|
The ID of the associated OwnedProperty that is pending sale |
salePrice - NonNegativeInt
|
Sale price of the property in dollars. The salePrice must be greater than or equal to the asset amount (the expected proceeds). |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"ownedPropertyId": "4",
"salePrice": 123
}
CreatePensionIncomeInput
Description
Input for creating a PensionIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreatePreviousBorrowerAddressInput
Description
Create previous borrower address input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update |
borrowerId - ID!
|
Borrower ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": AddressInput,
"borrowerId": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
CreatePreviousBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
id - ID!
|
Node ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"id": 4,
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
CreatePricingBatchUploadResponse
Description
Where to upload a pricing batch's input file, and the batch to start once it is uploaded.
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime!
|
When uploadUrl stops accepting the file. It can stop sooner; if it does, create a new upload. |
pricingBatch - PricingBatch!
|
The batch to start once the file is uploaded. |
uploadUrl - String!
|
A URL to PUT the batch's input file to: one JSON line per loan, each {requestId, input}, where input is a purchase pricing input. |
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"pricingBatch": PricingBatch,
"uploadUrl": "abc123"
}
CreateProceedsFromSaleOfNonRealEstateAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"borrowerIds": ["4"],
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateProceedsFromSecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateProceedsFromUnsecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateProposedGrossRentForSubjectPropertyIncomeInput
Description
Input for creating a ProposedGrossRentForSubjectPropertyIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
ownedPropertyId - ID!
|
The owned property to link this rental income to |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"ownedPropertyId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreatePublicAssistanceIncomeInput
Description
Input for creating a PublicAssistanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateRealEstateOwnedGrossRentalIncomeInput
Description
Input for creating a RealEstateOwnedGrossRentalIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
ownedPropertyId - ID!
|
The owned property to link this rental income to |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"ownedPropertyId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateRequirementConversationSessionInput
Fields
| Input Field | Description |
|---|---|
evidenceId - ID
|
Required when targetKind is EVIDENCE; omitted otherwise. |
loanId - ID!
|
The loan the conversation is on. |
loanOfficerId - ID
|
The loan officer the conversation is with: the loan's assigned loan officer. Required when an underwriter starts the conversation. A loan officer starts conversations only for themselves and omits it. |
requestId - ID!
|
Caller-chosen idempotency key. Retrying with the same key and input returns the original conversation; reusing it for a different input is refused. |
requirementId - ID
|
Required when targetKind is REQUIREMENT; omitted otherwise. |
targetKind - ConversationTargetKind!
|
Example
{
"evidenceId": "4",
"loanId": "4",
"loanOfficerId": "4",
"requestId": "4",
"requirementId": "4",
"targetKind": "EVIDENCE"
}
CreateRequirementConversationSessionResponse
Fields
| Field Name | Description |
|---|---|
session - RequirementConversationSession
|
The conversation, or null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused: REQUIREMENT_CONVERSATION_STATE_CONFLICT (the conversation can't take this step now) or REQUIREMENT_CONVERSATION_REQUEST_ID_REUSED (the request id was used for a different request). Empty on success. |
Example
{
"session": RequirementConversationSession,
"userErrors": [UserError]
}
CreateRetirementFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateRetirementIncomeInput
Description
Input for creating a RetirementIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateRoyaltiesIncomeInput
Description
Input for creating a RoyaltiesIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateSavingsAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateSelfEmploymentIncomeInput
Description
Input for creating a SelfEmploymentIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
business - SelfEmploymentBusinessInput
|
The associated self-employment business (if one exists) |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer. Default = PRIMARY |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
externalId - String
|
External ID from third-party services |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"business": SelfEmploymentBusinessInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"externalId": "xyz789",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "abc123",
"startDate": "2007-12-03",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateSelfEmploymentLossIncomeInput
Description
Input for creating a SelfEmploymentLossIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateSeparateMaintenanceIncomeInput
Description
Input for creating a SeparateMaintenanceIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateSessionResponse
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
Example
{"advisorSession": AdvisorSession}
CreateSocialSecurityIncomeInput
Description
Input for creating a SocialSecurityIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateStandardEmploymentIncomeInput
Description
Input for creating a StandardEmploymentIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerHasSpecialRelationshipWithEmployer - Boolean!
|
When true, indicates that the borrower has a special relationship with the employer, such as familial ties. Default = false |
borrowerId - ID!
|
The borrower associated with the income |
employer - EmployerInput
|
Employer details |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer. Default = PRIMARY |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
externalId - String
|
External ID from third-party services |
incomePayType - IncomePayType
|
The type of pay (hourly or salaried) |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerHasSpecialRelationshipWithEmployer": true,
"borrowerId": "4",
"employer": EmployerInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"externalId": "abc123",
"incomePayType": "HOURLY",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "xyz789",
"startDate": "2007-12-03",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateStockAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
CreateStockOptionsAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": ["4"],
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
CreateSubjectPropertyInput
Description
Input to the createSubjectProperty mutation
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US Address |
attachmentType - AttachmentEnum
|
Whether the property is physically attached to neighboring units |
dealId - ID!
|
The ID of the deal |
manuallyEstimatedValue - NonNegativeInt
|
The manually estimated value of the property |
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Is Property taxes and insurance included in payment |
rentalEstimatedGrossMonthlyRentAmount - NonNegativeInt
|
The estimated gross monthly rent amount (for investment properties) |
Example
{
"address": AddressInput,
"attachmentType": "ATTACHED",
"dealId": 4,
"manuallyEstimatedValue": 123,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"rentalEstimatedGrossMonthlyRentAmount": 123
}
CreateSubjectPropertyNetCashFlowIncomeInput
Description
Input for creating a SubjectPropertyNetCashFlowIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateSubjectPropertyResponse
Description
Response of the createSubjectProperty mutation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the SubjectProperty that was created |
Example
{"id": "4"}
CreateSupportTicketInput
Description
Input for filing a loan-specific support ticket.
Fields
| Input Field | Description |
|---|---|
additionalRecipients - [SupportRecipientInput!]
|
Extra addresses to copy on the ticket's opening message; at most 10. Later messages carry the recipients given to addSupportMessage. |
attachmentDocumentIds - [ID!]
|
Loan documents to attach: ids returned by requestSupportDocumentUpload's file POST, or document ids from this loan's documents. Documents are reusable across tickets and messages; at most 20 per message. |
body - String!
|
The question / ticket body. |
issueType - ID!
|
Key of the issue type uniquely identifying this ticket (from the issueTypes query, e.g. PRE_LOCK). |
loanId - ID
|
The ID or friendly ID of the loan. Provide this or the deprecated loanApplicationId, not both. The loan this ticket is about. |
requesterEmail - String!
|
Email of the person filing the ticket. |
requesterName - String!
|
Name of the person filing the ticket (the LO or processor). |
Example
{
"additionalRecipients": [SupportRecipientInput],
"attachmentDocumentIds": [4],
"body": "abc123",
"issueType": 4,
"loanId": 4,
"requesterEmail": "abc123",
"requesterName": "abc123"
}
CreateSupportTicketResponse
Description
Response from filing a support ticket.
Fields
| Field Name | Description |
|---|---|
ticket - SupportTicket!
|
The created ticket. |
Example
{"ticket": SupportTicket}
CreateTemporaryLeaveIncomeInput
Description
Input for creating a TemporaryLeaveIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateTrailingCoBorrowerIncomeInput
Description
Input for creating a TrailingCoBorrowerIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateTrustAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
borrowerIds - [ID!]!
|
Asset-owning borrower IDs |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
trusteeName - String
|
The legal name of the trustee |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"borrowerIds": [4],
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"trusteeName": "xyz789"
}
CreateTrustIncomeInput
Description
Input for creating a TrustIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateUnemploymentIncomeInput
Description
Input for creating an UnemploymentIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateUpdateModeTokenInput
CreateUpdateModeTokenResponse
Description
Response for createUpdateModeToken mutation
Fields
| Field Name | Description |
|---|---|
linkToken - String!
|
Link token for Plaid Link update mode |
Example
{"linkToken": "xyz789"}
CreateVaBenefitsNonEducationalIncomeInput
Description
Input for creating a VaBenefitsNonEducationalIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
CreateWebhookSigningKeyInput
Description
Mints a new signing key for a webhook subscription.
Fields
| Input Field | Description |
|---|---|
subscriptionId - ID!
|
The subscription to mint the key for. |
Example
{"subscriptionId": "4"}
CreateWebhookSigningKeyResponse
Description
The result of minting a webhook signing key.
Fields
| Field Name | Description |
|---|---|
secret - String
|
The key's signing secret. Shown here once and never retrievable again: store it where your receiver can verify signatures with it. Null only when userErrors is non-empty. |
signingKey - WebhookSigningKey
|
The new key, in the PENDING state. Null only when userErrors is non-empty. A subscription that does not exist or belongs to another organization is a not-found GraphQL error, not a refusal. |
userErrors - [UserError!]!
|
Reasons the request was refused. Empty on success; an unknown subscription is reported as a GraphQL error instead. |
Example
{
"secret": "xyz789",
"signingKey": WebhookSigningKey,
"userErrors": [UserError]
}
CreateWebhookSubscriptionInput
Description
Registers a webhook endpoint for the organization: where deliveries go and which events are sent. An organization can have several, each with its own signing keys. Its first signing key is minted in the same step.
Fields
| Input Field | Description |
|---|---|
callbackUrl - String!
|
The https URL to deliver to. It must be a public address, with no embedded credentials, at most 2048 characters. |
eventTypes - [WebhookEventType!]!
|
The events to deliver; repeats are ignored. Each listed type needs every read scope its record is read under on this key, or the request is refused with WEBHOOK_TOPIC_SCOPE_MISSING on input.eventTypes. An endpoint delivers at least one event type or topic: empty here with no topics is refused with WEBHOOK_EVENT_TYPES_EMPTY. To stop deliveries, delete the endpoint. |
topics - [WebhookTopic!]!
|
Topics to deliver beside eventTypes. Repeats are ignored. Each topic event delivers only while your organization's API keys hold every read scope its record is read under, checked at delivery time, not when the topics were set. This key must hold every read scope of every event the endpoint will deliver through its topics under your organization's keys, or the request is refused with WEBHOOK_TOPIC_SCOPE_MISSING: whoever registers an endpoint can read what it delivers. Default = [] |
Example
{
"callbackUrl": "xyz789",
"eventTypes": ["APPRAISAL_ORDER_CHANGED"],
"topics": ["BORROWERS"]
}
CreateWebhookSubscriptionResponse
Description
The result of registering a webhook endpoint.
Fields
| Field Name | Description |
|---|---|
secret - String
|
The first key's signing secret, generated by Pylon. Shown here once and never retrievable again: store it where your receiver can verify signatures with it. If it is lost, mint a new signing key. Null when the request was refused. |
signingKey - WebhookSigningKey
|
The endpoint's first signing key, in the PENDING state: it signs nothing until it has been tested and promoted. Null when the request was refused. |
subscription - WebhookSubscription
|
The new subscription, REGISTERED, with its first signing key PENDING: it receives no deliveries until that key has been tested and promoted. Null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused, if it was. Empty on success. Codes: WEBHOOK_CALLBACK_URL_INVALID, WEBHOOK_EVENT_TYPES_EMPTY, WEBHOOK_SUBSCRIPTION_LIMIT_REACHED, WEBHOOK_TOPIC_SCOPE_MISSING, WEBHOOK_TOPIC_KEY_SCOPE_MISSING. |
Example
{
"secret": "abc123",
"signingKey": WebhookSigningKey,
"subscription": WebhookSubscription,
"userErrors": [UserError]
}
CreateWorkersCompensationIncomeInput
Description
Input for creating a WorkersCompensationIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID!
|
The borrower associated with the income |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income. Default = MONTHLY |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
Credit
Description
Credit related fields
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job |
Arguments
|
|
missingFieldsForCreditPull - [CreditPullRequiredField!]!
|
Required fields that are missing for a credit pull. Empty array means all required fields are present. |
Arguments
|
|
report - CreditReport
|
Credit report |
Arguments
|
|
udnMonitors - [UdnMonitorGql!]
|
|
Arguments
|
|
Example
{
"job": CreditPullJob,
"missingFieldsForCreditPull": ["BORROWER_CURRENT_ADDRESS"],
"report": CreditReport,
"udnMonitors": [UdnMonitorGql]
}
CreditBureau
Description
The name of a credit bureau
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQUIFAX"
CreditBusinessType
Description
The business type of a credit inquiry
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERTISING"
CreditExpiryStatus
Description
Expiry status of a credit report based on days since pull
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
CreditFreezeVerdict
Description
Whether a security freeze prevented every bureau from returning this borrower's credit file.
Values
| Enum Value | Description |
|---|---|
|
|
No bureau returned a file and at least one bureau reported a freeze. |
|
|
A file was returned, or no bureau reported a freeze. |
Example
"FROZEN"
CreditInquiry
Description
Credit inquiry type
Fields
| Field Name | Description |
|---|---|
creditBusinessType - CreditBusinessType
|
The business type of the credit inquiry |
creditInquiryResultType - CreditInquiryResultType
|
The result type of the credit inquiry |
date - DateTime
|
Date of the credit inquiry |
detailCreditBusinessType - DetailCreditBusinessType
|
The detailed business type of the credit inquiry |
id - ID!
|
Credit inquiry ID |
name - String
|
Name of the creditor |
Example
{
"creditBusinessType": "ADVERTISING",
"creditInquiryResultType": "ACCOUNT_CLOSED",
"date": "2007-12-03T10:15:30Z",
"detailCreditBusinessType": "ADVERTISING_AGENCIES",
"id": "4",
"name": "xyz789"
}
CreditInquiryMutations
Fields
| Field Name | Description |
|---|---|
updateCreditInquiry - UpdateCreditInquiryResponse
|
Update a credit inquiry with an explanation and generate a Letter of Explanation PDF |
Arguments
|
|
Example
{"updateCreditInquiry": UpdateCreditInquiryResponse}
CreditInquiryResultType
Description
The result type of a credit inquiry
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT_CLOSED"
CreditMutations
Description
Credit mutations
Fields
| Field Name | Description |
|---|---|
deactivateUdnMonitoring - DeactivateUdnMonitoringResponse
|
Deactivate UDN monitoring for a borrower |
Arguments
|
|
invalidateCreditCache - InvalidateCreditCacheResponse
|
Invalidate cached credit pull results for the given borrower(s). Future credit pulls will perform a fresh pull instead of returning cached results. |
Arguments
|
|
refreshCreditReport - RefreshCreditReportResponse
|
Refresh an existing completed credit report |
Arguments
|
|
startIndividualCreditPullJob - StartIndividualCreditPullJobResponse
|
Start a hard credit pull for an individual |
Arguments |
|
startJointCreditPullJob - StartJointCreditPullJobResponse
|
Start a joint hard credit pull for two co-borrowers on the same loan application |
Arguments
|
|
unmergeCreditReport - UnmergeCreditReportResponse
|
Unmerge a joint credit report into individual reports |
Arguments
|
|
updateUdnNotificationEmails - UpdateUdnNotificationEmailsResponse
|
Update notification emails for a UDN monitor |
Arguments |
|
upgradeCreditReport - UpgradeCreditReportResponse
|
Upgrade an existing credit report to include all three bureaus |
Arguments
|
|
Example
{
"deactivateUdnMonitoring": DeactivateUdnMonitoringResponse,
"invalidateCreditCache": InvalidateCreditCacheResponse,
"refreshCreditReport": RefreshCreditReportResponse,
"startIndividualCreditPullJob": StartIndividualCreditPullJobResponse,
"startJointCreditPullJob": StartJointCreditPullJobResponse,
"unmergeCreditReport": UnmergeCreditReportResponse,
"updateUdnNotificationEmails": UpdateUdnNotificationEmailsResponse,
"upgradeCreditReport": UpgradeCreditReportResponse
}
CreditPullBorrowerInput
Description
Borrower with fields required for a credit pull
Fields
| Input Field | Description |
|---|---|
consentType - CreditPullConsentType
|
Credit pull consent type |
id - ID!
|
Borrower ID |
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"consentType": "ELECTRONIC",
"id": 4,
"taxIdentifierNumber": "abc123",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
CreditPullConsentType
Description
Credit pull consent type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ELECTRONIC"
CreditPullJob
Description
Credit pull job
Fields
| Field Name | Description |
|---|---|
failureReason - String
|
Human-readable reason the credit pull failed. Populated only when status is FAILED; null otherwise. |
id - ID!
|
Job ID |
result - CreditReport
|
The credit report. This field will be populated only if the credit pull job status is SUCCEEDED. Otherwise it will be null. |
status - JobStatus!
|
Job status |
Example
{
"failureReason": "xyz789",
"id": 4,
"result": CreditReport,
"status": "FAILED"
}
CreditPullRequiredField
Description
Required fields for a credit pull
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_CURRENT_ADDRESS"
CreditPullScope
Description
Credit pulls eligible to make borrower credit available.
Values
| Enum Value | Description |
|---|---|
|
|
Also expose undated pulls when a bureau result was recorded for this borrower. |
|
|
Require a credit pull with a recorded pull date. |
Example
"ALL_PULLS"
CreditPullStatus
Description
The status of a borrower's latest credit pull, including a pull that has not started.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
CreditPullType
Description
The type of credit pull performed on a borrower
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HARD"
CreditReport
Description
Credit report
Fields
| Field Name | Description |
|---|---|
bureauStatuses - [BureauFileStatus!]
|
Per-bureau file statuses. Null for legacy pulls that predate bureau status tracking. |
expiryStatus - CreditExpiryStatus!
|
Expiry status derived from pullTime: ACTIVE (<83d), EXPIRING_SOON (83-89d), EXPIRED (90-119d), CONSENT_EXPIRED (120d+, consent re-gating required). |
id - ID!
|
Credit report ID |
pullTime - DateTime!
|
Time of credit pull |
Example
{
"bureauStatuses": [BureauFileStatus],
"expiryStatus": "ACTIVE",
"id": 4,
"pullTime": "2007-12-03T10:15:30Z"
}
CreditScore
Description
An individual's credit score as reported by a specific credit bureau
Fields
| Field Name | Description |
|---|---|
bureau - CreditBureau!
|
|
score - Float!
|
Example
{"bureau": "EQUIFAX", "score": 123.45}
CryptocurrencyAsset
Description
Cryptocurrency holdings
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
description - String
|
Description of the asset (e.g. coin and platform) |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"description": "abc123",
"id": 4,
"institutionLogoUrl": "abc123",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
CurrentMarketRepricing
Description
The lock expired outside the relock window: today's rate sheet priced this structure.
Fields
| Field Name | Description |
|---|---|
worstCaseAdjustmentPoints - Float!
|
The points that worst-case pricing adds to this rate's price; 0 when none. Already included in totalPoints and ratePoints. |
Example
{"worstCaseAdjustmentPoints": 987.65}
CustomMarketingRate
Description
Custom marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 123,
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"ltv": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rate": 987.65,
"salesContractAmount": 123
}
CustomMarketingRateInput
Description
Custom marketing rate input
Fields
| Input Field | Description |
|---|---|
calculateApr - Boolean
|
Should closing costs be fetched in order to calculate an APR?. Default = true |
concessions - NonNegativeInt
|
Lender concession in dollars. Reduces the rate cost (points) the borrower would otherwise pay, but never below zero. Default = 0 |
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
propertyUsageType - PropertyUsageType
|
|
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"calculateApr": false,
"concessions": 123,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"loanTermYears": 123.45,
"ltv": 123.45,
"maxDiscountPointsTotal": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 123.45
}
CustomerAccountStatus
Description
Where an organization is in its life with Pylon. ONBOARDING: being set up, no real volume yet. ACTIVE: originating real loans. TEST: a demo or internal workspace whose loans are never real. INACTIVE: no longer originating. Cross-organization pipeline reads cover ACTIVE organizations unless the caller widens them.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
CustomerAccountStatusComparator
Description
Comparisons available on the account status of the loan's organization.
Fields
| Input Field | Description |
|---|---|
eq - CustomerAccountStatus
|
|
in - [CustomerAccountStatus!]
|
|
isNull - Boolean
|
|
neq - CustomerAccountStatus
|
|
nin - [CustomerAccountStatus!]
|
|
null - Boolean
|
Example
{
"eq": "ACTIVE",
"in": ["ACTIVE"],
"isNull": true,
"neq": "ACTIVE",
"nin": ["ACTIVE"],
"null": true
}
CustomerApiAccessStatus
Description
Whether an organization's API access is active, paused, or inactive.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
CustomerCommsOptIns
Fields
| Field Name | Description |
|---|---|
comms - [CommsWithOptInStatus!]!
|
|
customerId - ID!
|
|
customerName - String!
|
Example
{
"comms": [CommsWithOptInStatus],
"customerId": "4",
"customerName": "xyz789"
}
CustomerFeePayType
Description
Who pays a customer fee, and to whom.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_TO_BROKER"
CustomerIdComparator
CustomerLockDocumentGenerationJob
Description
A job generating the lock confirmation document for a loan's rate lock. Lender-only: an organization principal with access to the loan reads it; a borrower does not.
Fields
| Field Name | Description |
|---|---|
completedAt - DateTime
|
When the job finished, succeeded or failed. |
effectiveAt - DateTime!
|
The lock state the document describes is as of this time. |
id - ID!
|
Job ID |
releasedAt - DateTime
|
When the generated document was released to the loan. |
status - JobStatus!
|
Job status |
Example
{
"completedAt": "2007-12-03T10:15:30Z",
"effectiveAt": "2007-12-03T10:15:30Z",
"id": "4",
"releasedAt": "2007-12-03T10:15:30Z",
"status": "FAILED"
}
CustomerMembership
Description
Lightweight summary of an organization the requesting user has access to via a role relation. Used by the org switcher.
Fields
| Field Name | Description |
|---|---|
accountStatus - CustomerAccountStatus!
|
Where the organization is in its life with Pylon; the switcher badges anything other than ACTIVE. |
companyName - String!
|
|
customerSlug - String!
|
|
id - ID!
|
Example
{
"accountStatus": "ACTIVE",
"companyName": "abc123",
"customerSlug": "abc123",
"id": 4
}
CustomerPointAdjustment
Fields
| Field Name | Description |
|---|---|
costAbsorption - [CostAbsorption!]
|
Always empty: cost absorption is no longer reported per loan. Cost absorption is no longer reported per loan; this field is always empty and will be removed. |
costMultiplier - Float!
|
Multiplier applied to warehousing costs. Always 0: Pylon no longer rolls warehousing costs into rate points. Warehousing costs are never applied; this field is always 0 and will be removed. |
margin - Float
|
The margin from the customer on the loan |
Example
{
"costAbsorption": [CostAbsorption],
"costMultiplier": 123.45,
"margin": 987.65
}
CustomerPointAdjustmentsContext
Description
The price whose customer adjustments are being requested.
Values
| Enum Value | Description |
|---|---|
|
|
The loan's committed price, or current pricing if unlocked. |
|
|
The price options currently available for the loan. |
Example
"COMMITTED"
CustomerProvisioningMutations
Description
Customer provisioning mutations (internal Pylon administrators only).
Fields
| Field Name | Description |
|---|---|
createCustomerApiClient - CreateCustomerApiClientResponse
|
Create an additional machine-to-machine Auth0 application for an existing customer, granted the given scope bundles (e.g. MTM_LOAN_FILE_READ for a read-only key). Only available to internal Pylon administrators. |
Arguments
|
|
provisionCustomer - ProvisionCustomerResponse
|
Provision a new customer: creates the customer record (and default related rows) plus a machine-to-machine Auth0 application for direct API access. Only available to internal Pylon administrators. |
Arguments
|
|
Example
{
"createCustomerApiClient": CreateCustomerApiClientResponse,
"provisionCustomer": ProvisionCustomerResponse
}
DataEntryResolution
Description
Resolved by data entry — fields were filled in directly. No evidence produced.
Fields
| Field Name | Description |
|---|---|
assertions - [Assertion!]!
|
The satisfying assertion(s) pinned at resolution time. Always empty for data-entry resolutions, which produce no evidence. |
description - String!
|
Human-readable summary. |
method - String!
|
Resolution method identifier. Superseded by assertions. Retained temporarily for already-shipped clients and removed after one release.
|
Example
{
"assertions": [Assertion],
"description": "abc123",
"method": "xyz789"
}
Date
Description
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03"
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
DateTimeComparator
Description
Comparisons available on an instant-valued field. Bounds may be absolute or given as an ISO 8601 duration relative to now.
Fields
| Input Field | Description |
|---|---|
eq - RelativeDateTime
|
|
gt - RelativeDateTime
|
|
gte - RelativeDateTime
|
|
in - [RelativeDateTime!]
|
|
isNull - Boolean
|
|
lt - RelativeDateTime
|
|
lte - RelativeDateTime
|
|
neq - RelativeDateTime
|
|
nin - [RelativeDateTime!]
|
|
null - Boolean
|
Example
{
"eq": RelativeDateTime,
"gt": RelativeDateTime,
"gte": RelativeDateTime,
"in": [RelativeDateTime],
"isNull": false,
"lt": RelativeDateTime,
"lte": RelativeDateTime,
"neq": RelativeDateTime,
"nin": [RelativeDateTime],
"null": false
}
DateTimeISO
Description
An exact point in time, serialized as an ISO 8601 / RFC 3339 compliant UTC date-time string (e.g. 2007-12-03T10:15:30Z).
Example
"2007-12-03T10:15:30Z"
DayComparator
Description
Comparisons on a field that is stored as an instant but read back as a calendar day. Bounds are days, in UTC, so a value read off a row can be handed straight back.
Example
{
"eq": "2007-12-03",
"gt": "2007-12-03",
"gte": "2007-12-03",
"isNull": false,
"lt": "2007-12-03",
"lte": "2007-12-03",
"null": false
}
DeactivateUdnMonitoringInput
Description
Input to deactivate UDN monitoring
Fields
| Input Field | Description |
|---|---|
monitorId - ID!
|
The UDN monitor ID to deactivate |
Example
{"monitorId": 4}
DeactivateUdnMonitoringResponse
Deal
Fields
| Field Name | Description |
|---|---|
borrowers - BorrowerConnection!
|
|
Arguments
|
|
creationTime - DateTime!
|
The time when the deal was created |
friendlyId - String!
|
An alternative ID that might be more aesthetically pleasing. |
id - ID!
|
Deal ID |
loans - [LoanApplication!]!
|
|
parties - [Party!]
|
|
Example
{
"borrowers": BorrowerConnection,
"creationTime": "2007-12-03T10:15:30Z",
"friendlyId": "abc123",
"id": 4,
"loans": [LoanApplication],
"parties": [Party]
}
DealClaimTokenMutations
Description
One-time deal claim-link mutations
Fields
| Field Name | Description |
|---|---|
claim - ClaimDealClaimTokenResponse
|
|
Arguments
|
|
issue - IssueDealClaimTokenResponse
|
|
Arguments
|
|
Example
{
"claim": ClaimDealClaimTokenResponse,
"issue": IssueDealClaimTokenResponse
}
DealConnection
Fields
| Field Name | Description |
|---|---|
edges - [DealEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [DealEdge],
"pageInfo": PageInfo
}
DealEdge
DealMutations
Fields
| Field Name | Description |
|---|---|
create - CreateDealResponse
|
Example
{"create": CreateDealResponse}
DebtToIncomeViolation
Description
Optimizer could not find a solution without exceeding the DTI limit.
Fields
| Field Name | Description |
|---|---|
debtExceededDollars - Float!
|
Minimum dollar amount needed in monthly debt reduction get to the allowed DTI. |
dti - Float!
|
Borrower's DTI in decimals, including this product. |
dtiLimit - Float!
|
Maximum allowed DTI in decimals, per the guidelines. |
increaseMonthlyIncome - Float!
|
Minimum dollar amount of extra monthly income needed to reach DTI limit. |
Example
{
"debtExceededDollars": 123.45,
"dti": 123.45,
"dtiLimit": 123.45,
"increaseMonthlyIncome": 987.65
}
DeclareMilitaryServiceInput
Description
Input to declare a borrower's military service details.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
militaryServiceExpectedCompletionDate - Date
|
|
militaryStatusType - MilitaryStatusType!
|
|
survivingSpouseIndicator - Boolean
|
Example
{
"borrowerId": "4",
"militaryServiceExpectedCompletionDate": "2007-12-03",
"militaryStatusType": "ACTIVE_DUTY",
"survivingSpouseIndicator": true
}
DeclareMilitaryServiceResponse
Description
Response from the declareMilitaryService mutation.
Fields
| Field Name | Description |
|---|---|
militaryServiceDeclaration - MilitaryServiceDeclaration
|
Example
{"militaryServiceDeclaration": MilitaryService}
DeclareNoMilitaryServiceInput
DeclareNoMilitaryServiceResponse
Description
Response from the declareNoMilitaryService mutation.
Fields
| Field Name | Description |
|---|---|
militaryServiceDeclaration - MilitaryServiceDeclaration
|
Example
{"militaryServiceDeclaration": MilitaryService}
DeclinedPreApprovalRun
Description
A declined pre-approval run
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
ineligibleProducts - [IneligibleProduct!]!
|
Example
{
"id": "4",
"ineligibleProducts": [IneligibleProduct]
}
DefinedContributionPlanIncome
Description
Income from defined contribution plans
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
DegradedProductStructure
Description
A loan's attached product structure rendered without its rate-sheet detail, because the pinned rate could not be resolved. Deal facts come from the structure's own row; rate-derived fields are absent. Surface as a degraded card, not an error page.
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
The APR at which the deal was priced. |
closingCosts - Float!
|
The closing costs, in dollars. |
downPaymentAmount - Float!
|
The down payment, in dollars. |
dti - Float!
|
The debt-to-income ratio, as a percentage. |
id - ID!
|
The unique ID of this product structure. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars. |
loanTermYears - PositiveInt!
|
The loan term, in whole years. |
ltv - Float!
|
The loan-to-value ratio, as a percentage. |
monthlyPayment - Float!
|
The monthly payment, in dollars. |
pricedAsOf - DateTime
|
When the rate sheet these figures were priced against was received, when the structure recorded it. |
principal - PositiveFloat!
|
The total principal, in dollars. |
rateDetailUnavailable - Boolean!
|
Always true on this type: the pinned rate could not be resolved, so rate-sheet-derived detail is unavailable. Render a degraded card. |
rateId - ID!
|
The ID of the pinned rate that could not be resolved. |
totalPoints - Float!
|
The total points paid, as a percentage of the principal. |
Example
{
"apr": 123.45,
"closingCosts": 987.65,
"downPaymentAmount": 987.65,
"dti": 987.65,
"id": "4",
"interest": 123,
"loanTermYears": 123,
"ltv": 987.65,
"monthlyPayment": 123.45,
"pricedAsOf": "2007-12-03T10:15:30Z",
"principal": 123.45,
"rateDetailUnavailable": true,
"rateId": 4,
"totalPoints": 123.45
}
DelegatedBorrowerContributor
Example
{
"borrower": Borrower,
"borrowerId": 4,
"displayName": "abc123",
"id": 4
}
DeleteAssetInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the asset to delete |
Example
{"id": 4}
DeleteAssetResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the asset that was deleted |
Example
{"id": 4}
DeleteBorrowerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the borrower to delete |
Example
{"id": "4"}
DeleteBorrowerResponse
Description
Response of the delete borrower mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the borrower that was deleted |
Example
{"id": "4"}
DeleteFeeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteFeeResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteFulfillmentPartyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteFulfillmentPartyResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteIncomeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the income to delete |
Example
{"id": 4}
DeleteIncomeResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the deleted income |
Example
{"id": 4}
DeleteIssueTypeInput
Description
Input for deleting an issue type.
Fields
| Input Field | Description |
|---|---|
key - ID!
|
Key of the issue type to retire. |
Example
{"key": 4}
DeleteIssueTypeResponse
Description
Response from deleting an issue type.
Fields
| Field Name | Description |
|---|---|
label - SupportIssueType!
|
The retired issue type. |
Example
{"label": SupportIssueType}
DeleteLiabilityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Liability ID |
Example
{"id": 4}
DeleteLiabilityResponse
Description
Response of the deleteLiability mutation.
Fields
| Field Name | Description |
|---|---|
id - ID
|
Liability ID |
userErrors - [GenericUserError!]!
|
Example
{"id": 4, "userErrors": [GenericUserError]}
DeleteLoanScriptInput
Description
Input for deleting a loan script.
Fields
| Input Field | Description |
|---|---|
scenarioId - String!
|
The scenarioId of the script to delete. |
Example
{"scenarioId": "abc123"}
DeleteLoanScriptResponse
Description
Result of deleting a loan script.
Fields
| Field Name | Description |
|---|---|
loanScript - LoanScript!
|
The script as it was at deletion. |
Example
{"loanScript": LoanScript}
DeleteNonBorrowingOwnerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteNotableActivityInput
Description
Input to the deleteNotableActivity mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the activity to delete |
Example
{"id": "4"}
DeleteNotableActivityResponse
Description
Response of the deleteNotableActivity mutation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the activity that was deleted |
Example
{"id": 4}
DeleteOrganizationRoleInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteOrganizationRoleResponse
Fields
| Field Name | Description |
|---|---|
deletedOrganizationRole - DeletedOrganizationRole!
|
Example
{"deletedOrganizationRole": DeletedOrganizationRole}
DeleteOrganizationStateLicensesInput
Fields
| Input Field | Description |
|---|---|
stateLicenses - [ID!]!
|
Example
{"stateLicenses": ["4"]}
DeleteOrganizationStateLicensesResponse
Fields
| Field Name | Description |
|---|---|
licensing - OrganizationLicensing
|
|
userErrors - [GenericUserError!]!
|
Example
{
"licensing": OrganizationLicensing,
"userErrors": [GenericUserError]
}
DeleteOrganizationUserInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteOrganizationUserResponse
Fields
| Field Name | Description |
|---|---|
deletedOrganizationUser - DeletedOrganizationUser!
|
Use deletedUser. Selecting this field discards userErrors on a refused delete, because it cannot be null.
|
deletedUser - DeletedOrganizationUser
|
Identity of the removed user, or null when the delete was refused (see userErrors). |
userErrors - [GenericUserError!]!
|
Example
{
"deletedOrganizationUser": DeletedOrganizationUser,
"deletedUser": DeletedOrganizationUser,
"userErrors": [GenericUserError]
}
DeleteOwnedPropertyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the owned property to delete |
Example
{"id": "4"}
DeleteOwnedPropertyResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the deleted owned property |
Example
{"id": 4}
DeletePartyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeletePartyResponse
Fields
| Field Name | Description |
|---|---|
party - Party!
|
Example
{"party": Party}
DeletePreviousBorrowerAddressInput
Description
Delete previous borrower address Input
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Borrower Address ID |
Example
{"id": "4"}
DeletePreviousBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Borrower Address ID |
Example
{"id": 4}
DeleteWebhookSubscriptionInput
Description
Deletes a webhook endpoint and its signing keys. Deliveries to it stop, and any still waiting are dropped.
Fields
| Input Field | Description |
|---|---|
subscriptionId - ID!
|
The subscription to delete. |
Example
{"subscriptionId": "4"}
DeleteWebhookSubscriptionResponse
Description
The result of deleting a webhook endpoint.
Fields
| Field Name | Description |
|---|---|
deletedSubscription - WebhookSubscription
|
The subscription as it was when it was deleted, signing keys included. Null when the request was refused. |
userErrors - [UserError!]!
|
Always empty: a delete is never refused through this list. An unknown or another organization's subscription is a not-found error, and a delete that keeps racing new signing keys fails with WEBHOOK_SUBSCRIPTION_DELETE_CONTENDED and can be retried; both arrive as top-level errors. |
Example
{
"deletedSubscription": WebhookSubscription,
"userErrors": [UserError]
}
DeletedOrganizationRole
Fields
| Field Name | Description |
|---|---|
name - String!
|
Example
{"name": "xyz789"}
DeletedOrganizationUser
DelinquentLiabilityBlocker
Description
A liability has a delinquent status
Fields
| Field Name | Description |
|---|---|
delinquencyType - DelinquentReportStatus!
|
The type of delinquency |
liability - Liability
|
The delinquent liability |
liabilityId - ID!
|
The ID of the delinquent liability Use liability { id }.
|
type - String!
|
Example
{
"delinquencyType": "Delinquent30",
"liability": Liability,
"liabilityId": "4",
"type": "xyz789"
}
DelinquentReportStatus
Description
Types of delinquent liability report statuses
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Delinquent30"
DeliveryCommitmentStatus
Description
A product's delivery commitment at an instant. UNKNOWN when no period covers it; never defaulted to either type.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BEST_EFFORTS"
DeliveryCommitmentType
Description
How loans on a product are committed for delivery to the investor.
Values
| Enum Value | Description |
|---|---|
|
|
The loan is delivered to the product's investor on a best-efforts basis. |
|
|
Pylon commits the loan to the investor at lock. |
Example
"BEST_EFFORTS"
DemoAusConditionPreview
Description
A single AUS condition preview within a scenario.
Example
{
"fallbackKey": "xyz789",
"section": "abc123",
"text": "abc123"
}
DemoAusConditionScenario
Description
A named AUS-condition scenario available for seeding.
Fields
| Field Name | Description |
|---|---|
conditions - [DemoAusConditionPreview!]!
|
The conditions this scenario will seed. |
description - String!
|
Human-readable description of the scenario. |
name - String!
|
The unique scenario key. |
Example
{
"conditions": [DemoAusConditionPreview],
"description": "xyz789",
"name": "xyz789"
}
DemoSeedMutations
Description
Root object for demo seed mutations (internal use only).
Fields
| Field Name | Description |
|---|---|
seedAusRun - SeedAusRunResponse
|
Seed a SUCCEEDED LPA AUS run + actionable conditions onto a loan so AUS_CONDITION requirements surface, then reconcile. Internal use only. |
Arguments
|
|
seedWireOutWorksheetCase - SeedWireOutWorksheetCaseResponse
|
Populate a fresh development loan with a synthetic wire-out case copied from the funding worksheet. Internal use only. |
Arguments
|
|
Example
{
"seedAusRun": SeedAusRunResponse,
"seedWireOutWorksheetCase": SeedWireOutWorksheetCaseResponse
}
DemoSeedQueries
Description
Root object for demo seed queries (internal use only).
Fields
| Field Name | Description |
|---|---|
ausConditionScenarios - [DemoAusConditionScenario!]!
|
List all available AUS-condition scenarios for seeding. |
wireOutWorksheetScenarios - [DemoWireOutWorksheetScenario!]!
|
List the synthetic wire-out cases available from the funding worksheet. |
Example
{
"ausConditionScenarios": [DemoAusConditionScenario],
"wireOutWorksheetScenarios": [
DemoWireOutWorksheetScenario
]
}
DemoWireOutWorksheetScenario
Description
A synthetic wire-out case copied from the funding worksheet.
Fields
| Field Name | Description |
|---|---|
expectedWireOutAmount - MonetaryAmount!
|
The wire-out amount expected for this case. |
sourceRow - Int!
|
The source worksheet row number. |
Example
{
"expectedWireOutAmount": MonetaryAmount,
"sourceRow": 987
}
DemographicInfo
Description
Demographic information
Fields
| Field Name | Description |
|---|---|
asianOther - String
|
|
asianRace - [AsianRace!]
|
|
ethnicity - [Ethnicity!]
|
|
ethnicityNotDisclosed - Boolean
|
|
hispanicOrigin - [HispanicOrigin!]
|
|
hispanicOther - String
|
|
pacificIslanderOther - String
|
|
pacificIslanderRace - [PacificIslanderRace!]
|
|
race - [Race!]
|
|
raceNotDisclosed - Boolean
|
|
sex - [Sex!]
|
|
sexNotDisclosed - Boolean
|
|
tribe - String
|
Example
{
"asianOther": "xyz789",
"asianRace": ["CHINESE"],
"ethnicity": ["HISPANIC"],
"ethnicityNotDisclosed": true,
"hispanicOrigin": ["CUBA"],
"hispanicOther": "xyz789",
"pacificIslanderOther": "xyz789",
"pacificIslanderRace": ["GUAMANIAN_OR_CHAMORRO"],
"race": ["AM_INDIAN_ALASKAN"],
"raceNotDisclosed": true,
"sex": ["FEMALE"],
"sexNotDisclosed": true,
"tribe": "xyz789"
}
DenyRateLockInput
Description
Input to the denyRateLock mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
DenyRateLockResponse
DependencyProvenance
Description
Provenance from a data dependency. The process needs this information to proceed.
Fields
| Field Name | Description |
|---|---|
description - String!
|
Human-readable explanation. |
evidence - [GuidelineReference!]!
|
Supporting evidence. Typically empty. |
Example
{
"description": "xyz789",
"evidence": [GuidelineReference]
}
DetachBorrowerAssetInput
DetachBorrowerAssetResponse
Description
Response of the detachBorrowerAsset mutation.
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The asset that was updated |
Example
{"asset": Asset}
DetachBorrowerLiabilitiesInput
DetachBorrowerLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The updated Borrower |
Example
{"borrower": Borrower}
DetachContributorFromDealInput
DetachContributorFromDealResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
|
deal - Deal!
|
Example
{
"contributor": Contributor,
"deal": Deal
}
DetachItemInput
DetachItemResponse
Fields
| Field Name | Description |
|---|---|
item - AssetVerificationItem!
|
The detached bank connection. Its accounts are no longer live, so accountCount is 0. |
Example
{"item": AssetVerificationItem}
DetachLoanContactInput
DetachLoanContactResponse
Description
Response of the loan.detachContact mutation.
Fields
| Field Name | Description |
|---|---|
contact - Contact!
|
The contact that was successfully detached from the loan. |
Example
{"contact": Contact}
DetachOwnedPropertyLiabilitiesInput
DetachOwnedPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The updated OwnedPropertyIntent |
Example
{"ownedProperty": OwnedProperty}
DetachSubjectPropertyAddressInput
Description
Input to the detachSubjectPropertyAddress mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the subject property from which the address should be detached |
Example
{"id": "4"}
DetachSubjectPropertyAddressResponse
Description
Response of the detachSubjectPropertyAddress mutation.
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The SubjectProperty that was updated |
Example
{"subjectProperty": SubjectProperty}
DetachSubjectPropertyLiabilitiesInput
DetachSubjectPropertyLiabilitiesResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The updated SubjectProperty |
Example
{"subjectProperty": SubjectProperty}
DetailCreditBusinessType
Description
The detailed business type of a credit inquiry
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERTISING_AGENCIES"
DisabilityIncome
Description
Disability income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
DisableContributorInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DisableContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
DiscardIntakeDraftInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the draft's loan. Missing or unreadable loans return DISCARDED without revealing whether anything exists. |
Example
{"loanId": "4"}
DiscardIntakeDraftOutcome
Description
The accepted result of a discard request. DISCARDED also covers a draft or loan the caller cannot see, and makes no change in that case. CLEANUP_PENDING means the visible draft was expired but retained for the cleanup sweep to finish.
Values
| Enum Value | Description |
|---|---|
|
|
The caller's draft was expired and cleanup will finish during the hourly sweep. |
|
|
The caller's draft was removed, or the target was missing or unreadable and no changes were made. |
Example
"CLEANUP_PENDING"
DiscardIntakeDraftResponse
Description
The outcome of a private discard attempt for an operator document-intake draft.
Fields
| Field Name | Description |
|---|---|
outcome - DiscardIntakeDraftOutcome!
|
DISCARDED when the caller's own draft was removed, when the named loan is missing, or when the named loan exists but is invisible to the caller. CLEANUP_PENDING when that caller's visible draft was expired and the hourly sweep must finish removing it. Readable ordinary loans and adopted drafts are forbidden and never deleted. |
userErrors - [UserError!]!
|
Empty when the discard request was accepted, including cleanup pending and private no-ops. |
Example
{"outcome": "CLEANUP_PENDING", "userErrors": [UserError]}
DisclosedAmortizationType
Description
The loan type half of TRID's Product (§1026.37(a)(10)(ii)). A normalization of MISMO's AmortizationType — OTHER is a product outside TRID's loan types, not an absent value.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADJUSTABLE_RATE"
DisclosedAmountChange
Description
One money figure a disclosure printed, beside where the loan stands now. A null on either side is a figure that side did not state, which stays distinguishable from a real zero.
Fields
| Field Name | Description |
|---|---|
currentAmount - MonetaryAmount
|
|
disclosedAmount - MonetaryAmount
|
|
figureType - DisclosedFigureType!
|
Never NOTE_RATE_PERCENT, which is not money. |
Example
{
"currentAmount": MonetaryAmount,
"disclosedAmount": MonetaryAmount,
"figureType": "CASH_TO_CLOSE_TOTAL"
}
DisclosedFee
Description
One fee line as a disclosure package printed it, kept verbatim from the MISMO FEE_DETAIL rather than mapped onto the closing-cost vocabulary.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DisclosedFigureChange
Types
| Union Types |
|---|
Example
DisclosedAmountChange
DisclosedFigureType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CASH_TO_CLOSE_TOTAL"
DisclosedFormType
Description
Which of the two TRID forms a disclosure package printed.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLOSING_DISCLOSURE"
DisclosedLoanProduct
Description
TRID's Product (§1026.37(a)(10)) on one side of a comparison: the loan type, and the payment features that qualify it. A null component is one that side did not state, and is compared as unstated rather than as false.
Fields
| Field Name | Description |
|---|---|
amortizationType - DisclosedAmortizationType
|
|
balloonIndicator - Boolean
|
|
interestOnlyIndicator - Boolean
|
|
negativeAmortizationIndicator - Boolean
|
|
seasonalPaymentFeatureIndicator - Boolean
|
Example
{
"amortizationType": "ADJUSTABLE_RATE",
"balloonIndicator": false,
"interestOnlyIndicator": false,
"negativeAmortizationIndicator": false,
"seasonalPaymentFeatureIndicator": true
}
DisclosedLoanStructure
Description
A TRID package as it was recorded: the terms and fee lines that package printed.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DisclosedRateChange
Description
The note rate a disclosure printed, beside the loan's current rate.
Fields
| Field Name | Description |
|---|---|
currentRatePercent - Float
|
This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
disclosedRatePercent - Float
|
This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
figureType - DisclosedFigureType!
|
Always NOTE_RATE_PERCENT. |
Example
{
"currentRatePercent": 987.65,
"disclosedRatePercent": 987.65,
"figureType": "CASH_TO_CLOSE_TOTAL"
}
Disclosure
Fields
| Field Name | Description |
|---|---|
cancelledOn - DateTime
|
|
combinedPdfDownloadUrl - String
|
Presigned download URL for the combined signed-package PDF — every document in the package merged into one file, with the e-sign certificate as the final section. Null until the package is fully signed and the certificate has been received, at which point the artifact is generated automatically. |
completedOn - DateTime
|
|
createdOn - DateTime
|
When the package was generated, as reported by the document provider. Every package reachable through disclosuresHistory has one, so this is the only moment guaranteed to be present — notably on manually delivered (wet-sign) packages, which report SENT with a null sentOn. |
documentLinks - [DocumentLink!]
|
|
electronicToPaperSentOn - DateTime
|
When the package was re-sent to the recipient on paper after electronic delivery, if tracked by the provider. |
id - ID!
|
The ID of the disclosure. |
packageType - DisclosurePackageType!
|
|
provider - String!
|
|
receivedOn - DateTime
|
|
recipients - [DisclosureRecipient!]
|
|
sentOn - DateTime
|
|
status - DisclosureStatus
|
The status of the disclosure package. For manually delivered packages (e.g. wet-sign closings in states that do not permit eClosings), a package that has been generated but not yet marked delivered is reported as SENT with a null sentOn. |
Example
{
"cancelledOn": "2007-12-03T10:15:30Z",
"combinedPdfDownloadUrl": "xyz789",
"completedOn": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"documentLinks": [DocumentLink],
"electronicToPaperSentOn": "2007-12-03T10:15:30Z",
"id": 4,
"packageType": "ADVERSE_ACTION",
"provider": "xyz789",
"receivedOn": "2007-12-03T10:15:30Z",
"recipients": [DisclosureRecipient],
"sentOn": "2007-12-03T10:15:30Z",
"status": "CANCELLED"
}
DisclosureDrift
Description
What measuring the loan against its baseline concluded.
Types
| Union Types |
|---|
Example
DisclosureDriftAssessed
DisclosureDriftAddedBorrower
Description
A borrower added to the loan since its last package went out, whom no package has reached.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower added. |
Example
{"borrower": Borrower}
DisclosureDriftAssessed
Description
The loan was measured against its most recently disclosed package. Nothing drifted only when reasons and addedBorrowers are both empty and addedBorrowersKnown is true.
Fields
| Field Name | Description |
|---|---|
addedBorrowers - [DisclosureDriftAddedBorrower!]!
|
Borrowers added since the last package went out, whom no package has reached. A change reasons never lists, though it owes them a package. Also empty when who was added cannot be told; addedBorrowersKnown says which. |
addedBorrowersKnown - Boolean!
|
Whether braid could tell who was added since the last package went out. When false, addedBorrowers is empty though borrowers may have been added. |
baseline - DisclosureDriftBaseline!
|
|
outcome - DisclosureDriftOutcome!
|
|
reasons - [DisclosureDriftReason!]!
|
|
titleFeeBaseline - TitleFeeDisclosureBaseline
|
The disclosure package that last disclosed the loan's title fees, whose loan amount a restructure is measured against to decide whether title fees need revising. Null when no uncancelled package is recorded. |
Example
{
"addedBorrowers": [DisclosureDriftAddedBorrower],
"addedBorrowersKnown": true,
"baseline": DisclosureDriftBaseline,
"outcome": "ASSESSED",
"reasons": [AprInaccurateReason],
"titleFeeBaseline": TitleFeeDisclosureBaseline
}
DisclosureDriftBaseline
Description
The disclosure package the assessment measured drift against.
Fields
| Field Name | Description |
|---|---|
disclosedLoanStructure - DisclosedLoanStructure!
|
The recorded package the drift was measured against. |
disclosedOn - DateTimeISO!
|
|
formType - DisclosedFormType!
|
|
packageType - DisclosurePackageType!
|
Always one of the four package types that print TRID terms. |
Example
{
"disclosedLoanStructure": DisclosedLoanStructure,
"disclosedOn": "2007-12-03T10:15:30Z",
"formType": "CLOSING_DISCLOSURE",
"packageType": "ADVERSE_ACTION"
}
DisclosureDriftFeeIdentity
Description
Enough of a fee line to name it in a reason. Exactly one of disclosedFee and closingCost is set: a closingCost names a charge the loan carries that the disclosure never printed.
Fields
| Field Name | Description |
|---|---|
closingCost - Fee
|
The closing cost the reason cites, set only where there is no disclosed line to cite instead. |
disclosedFee - DisclosedFee
|
The disclosed line the reason cites. Null when the loan carries a charge the disclosure never printed. |
feeDescription - String
|
|
feeType - FeeType
|
|
integratedDisclosureLineNumberValue - String
|
The only stable line identity across two disclosures. |
integratedDisclosureSectionType - IntegratedDisclosureSectionType
|
Example
{
"closingCost": Fee,
"disclosedFee": DisclosedFee,
"feeDescription": "xyz789",
"feeType": "APPLICATION_FEE",
"integratedDisclosureLineNumberValue": "xyz789",
"integratedDisclosureSectionType": "DUE_FROM_BORROWER_AT_CLOSING"
}
DisclosureDriftNoBaseline
Description
The loan has no recorded TRID package, so it owes an initial Loan Estimate rather than a redisclosure. Not the same as nothing having drifted.
Fields
| Field Name | Description |
|---|---|
outcome - DisclosureDriftOutcome!
|
Example
{"outcome": "ASSESSED"}
DisclosureDriftOutcome
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASSESSED"
DisclosureDriftReason
Example
AprInaccurateReason
DisclosureDriftReasonKind
Description
Discriminates a DisclosureDriftReason, so a consumer can branch without an inline fragment per member.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APR_INACCURATE"
DisclosureLink
DisclosurePackageType
Description
Stage of a disclosure package.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERSE_ACTION"
DisclosurePreview
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
|
documentLinks - [DocumentLink!]
|
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"documentLinks": [DocumentLink]
}
DisclosureRecipient
Description
A recipient of a disclosure package.
Fields
| Field Name | Description |
|---|---|
displayName - String
|
The full name of the disclosure recipient. |
email - String
|
The email address of the disclosure recipient. |
link - DisclosureLink
|
Link with access information for the disclosure recipient. May be null if the signing URL is not yet available. |
linkExpiresOn - DateTime
|
When this recipient's signing link expires, if tracked by the provider. |
receivedOn - DateTime
|
When this recipient received (was sent) the disclosure package, if tracked by the provider. |
signatureRequired - Boolean!
|
Indicates whether the recipient is required to sign the disclosure. Some recipients receive a package for reference only and are never expected to sign it (for example, the lender on a redisclosure); for those, signed stays false without the package being incomplete. |
signed - Boolean!
|
Indicates whether the recipient has signed the disclosure. |
signedOn - DateTime
|
When this recipient signed/completed the disclosure package, if tracked by the provider. |
type - DisclosureRecipientType
|
The enum type of the disclosure recipient. |
Example
{
"displayName": "xyz789",
"email": "xyz789",
"link": DisclosureLink,
"linkExpiresOn": "2007-12-03T10:15:30Z",
"receivedOn": "2007-12-03T10:15:30Z",
"signatureRequired": false,
"signed": true,
"signedOn": "2007-12-03T10:15:30Z",
"type": "BORROWER"
}
DisclosureRecipientType
Description
Type of a recipient of a disclosure package.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BORROWER"
DisclosureSendAttention
Description
The latest disclosure send attempt requiring attention. Does not authorize resending.
Fields
| Field Name | Description |
|---|---|
attemptedAt - DateTime!
|
|
disclosureType - DisclosuresStage!
|
|
failedAt - DateTime
|
When failure was recorded. Null for unconfirmed delivery and historical failures without a recorded failure time. |
reason - DisclosureSendFailureReason!
|
|
status - DisclosureSendAttentionStatus!
|
Example
{
"attemptedAt": "2007-12-03T10:15:30Z",
"disclosureType": "ADVERSE_ACTION_DISCLOSURES",
"failedAt": "2007-12-03T10:15:30Z",
"reason": "ESCROW_ELECTION_MISSING",
"status": "DELIVERY_UNCONFIRMED"
}
DisclosureSendAttentionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DELIVERY_UNCONFIRMED"
DisclosureSendFailureReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ESCROW_ELECTION_MISSING"
DisclosureStatus
Description
The status of a disclosure package.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
Disclosures
Fields
| Field Name | Description |
|---|---|
adverseAction - Disclosure
|
|
closingDisclosure - Disclosure
|
|
initialDisclosure - Disclosure
|
|
redisclosure - Disclosure
|
Example
{
"adverseAction": Disclosure,
"closingDisclosure": Disclosure,
"initialDisclosure": Disclosure,
"redisclosure": Disclosure
}
DisclosuresHistory
Fields
| Field Name | Description |
|---|---|
disclosures - [Disclosure!]!
|
Example
{"disclosures": [Disclosure]}
DisclosuresPreviews
Fields
| Field Name | Description |
|---|---|
adverseAction - DisclosurePreview
|
|
closingDisclosure - DisclosurePreview
|
|
initialDisclosure - DisclosurePreview
|
|
redisclosure - DisclosurePreview
|
Example
{
"adverseAction": DisclosurePreview,
"closingDisclosure": DisclosurePreview,
"initialDisclosure": DisclosurePreview,
"redisclosure": DisclosurePreview
}
DisclosuresRunStatus
Description
The status of an asynchronous disclosures run. Disclosure generation and sending happen on a background worker after a mutation such as floatStructure returns, so this is how a caller observes the eventual outcome — including the failure reason when a send does not go out.
Fields
| Field Name | Description |
|---|---|
disclosuresRunId - ID!
|
The ID of the disclosures run. |
documentLinks - [DocumentLink!]!
|
The package a succeeded redisclosure preview generated, as one PDF whose link expires an hour after it is read. Empty for every other run. |
errors - [String!]!
|
Human-readable failure reasons, populated when status is FAILED. Empty for runs that are still processing or that succeeded. |
failureCode - String
|
A stable code for why the run FAILED, for clients to key their own message on: the homeowner's insurance premium or property tax escrow could not be reconciled before generating or sending, or the loan system rejected or did not complete the send. A run still processing carries a code only when its send failed but may have been delivered. Null once the run succeeds and for failures with no code. |
stage - DisclosuresStage
|
The disclosure stage this run is generating. |
status - JobStatus!
|
PROCESSING while the package is still being generated/sent, SUCCEEDED once the package has been sent, or FAILED if the send did not complete (see errors for the reason). |
Example
{
"disclosuresRunId": "4",
"documentLinks": [DocumentLink],
"errors": ["xyz789"],
"failureCode": "xyz789",
"stage": "ADVERSE_ACTION_DISCLOSURES",
"status": "FAILED"
}
DisclosuresStage
Description
Stage of disclosure generation (INITIAL_DISCLOSURES, REDISCLOSURES, CLOSING_DISCLOSURES, ADVERSE_ACTION_DISCLOSURES).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERSE_ACTION_DISCLOSURES"
DismissDuplicateSuggestionInput
DismissDuplicateSuggestionResponse
Description
Response of the dismissDuplicateSuggestion mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
DismissPricingChangeFindingInput
Example
{
"findingId": 4,
"loanId": 4,
"reason": "xyz789"
}
DismissPricingChangeFindingResponse
Fields
| Field Name | Description |
|---|---|
finding - PricingChangeFinding
|
The finding after the dismissal. Null when it was refused, or when the finding could not be read back. |
userErrors - [UserError!]!
|
Example
{
"finding": PricingChangeFinding,
"userErrors": [UserError]
}
Dispute
Description
A dispute act in the evidence log: a CHALLENGE/REJECTION/INVALIDATION pinned to a prior entry, or a WAIVE targeting the requirement itself.
Fields
| Field Name | Description |
|---|---|
author - Contributor!
|
WHO authored this act — always a Contributor, resolved from the writing context, never client-supplied. |
cause - InvalidationCause
|
Why the invalidation was written. Populated for INVALIDATION only. |
createdAt - DateTimeISO!
|
When this act was written. |
id - ID!
|
Stable content-addressed identifier, resolvable via the root node(id) query. |
kind - DisputeKind!
|
The dispute act being recorded. |
reasoning - String
|
The author's reasoning narrative. Null when a redaction has tombstoned the text. |
target - Evidence
|
The pinned edge this act targets. Null for WAIVE, which targets the requirement itself. |
targetSuperseded - Boolean!
|
True when the pinned target is no longer current-in-slot per the fold (with this act itself excluded): something else — a newer assertion or another act — has displaced it, so this dispute is historical. False for WAIVE. |
Example
{
"author": Contributor,
"cause": "ENV_CHANGE",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"kind": "CHALLENGE",
"reasoning": "abc123",
"target": Evidence,
"targetSuperseded": true
}
DisputeKind
Description
The kind of dispute act: CHALLENGE or REJECTION of a prior assertion, WAIVE of a requirement, or a system INVALIDATION of an assertion whose inputs may no longer hold.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHALLENGE"
DividendsInterestIncome
Description
Dividends interest income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
Document
Description
Represents a document entity that groups one or more related files.
Fields
| Field Name | Description |
|---|---|
associatedEntities - [DocumentEntity!]!
|
The entities (like borrowers) associated with this document. |
category - String!
|
The category of the document, such as Borrower, Credit, or Disclosure. |
documentLink - DocumentLink!
|
The link corresponding to the document. |
id - ID!
|
The ID of the document. |
name - String!
|
The display name of the document. |
uploadedAt - DateTime!
|
The date and time the document was uploaded. |
Example
{
"associatedEntities": [DocumentEntity],
"category": "xyz789",
"documentLink": DocumentLink,
"id": 4,
"name": "xyz789",
"uploadedAt": "2007-12-03T10:15:30Z"
}
DocumentByIdInput
Description
Input to fetch a single document by its ID.
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
The document ID. |
Example
{"documentId": 4}
DocumentDroppedValue
Description
A value or row of a read document that the extraction's validation removed, so it was not read from the document. Names where the value was, never the value.
Fields
| Field Name | Description |
|---|---|
fieldPath - String!
|
Where the dropped value sat in the extraction of this document's kind, such as ending_balance or transactions[3] (a row, numbered as the extraction returned it). |
reason - DocumentSeedingValueDropReason!
|
Why the value was removed. |
Example
{
"fieldPath": "xyz789",
"reason": "ACCOUNT_UNVERIFIED"
}
DocumentEntity
Description
Represents an entity (like a borrower) that is associated with a document.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the entity. |
kind - DocumentEntityKind!
|
The type of entity this represents (e.g., BORROWER). |
Example
{"id": 4, "kind": "APPRAISAL"}
DocumentEntityKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPRAISAL"
DocumentIntakeDocument
Description
Where one uploaded file has got to in the intake pipeline.
Fields
| Field Name | Description |
|---|---|
attempt - Int!
|
Which read attempt this describes: 1 for the original, incremented by each accepted retry. Polling is sampling, so a second attempt that fails exactly as the first did is otherwise indistinguishable from no retry at all. |
detailsFound - Int
|
How many values were located in this file, counted as its citations. Null while the file is still working and null wherever the server is not counting — never estimated, and null is not zero. |
document - LoanDocument
|
The uploaded file. Null, with an error, when it is gone or the user can no longer access its loan. |
documentId - ID!
|
The uploaded file — the same id the upload returned. Split sections are folded into their packet and never appear on their own. Use document { id }.
|
documentKind - String
|
The classifier's answer, or null until the splitter has one. An upper-snake token; for a packet split into several kinds, the kind of its first section. |
droppedValues - [DocumentDroppedValue!]!
|
Values and rows the extraction's validation removed from this document, with why: a person should confirm or supply them. For a packet, every section's, section by section. Empty when nothing was dropped, and for every document that is not READ. |
failureReason - DocumentIntakeFailureReason
|
Set only when state is FAILED. |
fileName - String!
|
The name the file was uploaded under. |
receivedAt - DateTime!
|
Server clock: when the upload was taken delivery of. |
retryable - Boolean!
|
Whether asking for this file to be read again would do anything. False for every state but FAILED, so a client never offers a button that no-ops. |
seedTypingDecision - SeedTypingDecision
|
The seed's suggestion for a document it read but whose loan-system document type it deliberately left as it found it, or null when the seed typed it, never read it, or the document has since been given another loan-system type. For a packet split into several documents, the first declined section's. |
state - DocumentIntakeState!
|
Where this file has got to. |
unreadPages - [DocumentIntakeUnreadPage!]!
|
Pages of this document that were not read in full, in page order, with why: a statement read with a page missing is READ, and these are the pages to doubt. Empty when every page was read, and for every document that is not READ. |
unreadReason - DocumentIntakeUnreadReason
|
Set only when state is FAILED and the extraction gave a typed answer for not reading the file; null for every other failure. For a packet, the first failing section's. |
Example
{
"attempt": 987,
"detailsFound": 123,
"document": LoanDocument,
"documentId": "4",
"documentKind": "xyz789",
"droppedValues": [DocumentDroppedValue],
"failureReason": "DOCUMENT_BLURRY",
"fileName": "xyz789",
"receivedAt": "2007-12-03T10:15:30Z",
"retryable": true,
"seedTypingDecision": SeedTypingDecision,
"state": "FAILED",
"unreadPages": [DocumentIntakeUnreadPage],
"unreadReason": "ANSWER_UNUSABLE"
}
DocumentIntakeFailureReason
Description
Why a file could not be read. The same closed set as ExtractionFailureReason, so one client mapping serves both surfaces.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENT_BLURRY"
DocumentIntakeMutations
Description
Document-intake mutations namespace.
Fields
| Field Name | Description |
|---|---|
cancelDocumentSeeding - CancelDocumentSeedingResponse
|
Request that one exact seed-from-documents run stop at its next safe boundary. A stale modal cannot stop a replacement run on the same loan. This resolves when the matching run accepts the signal, not when it has settled; poll documentIntake.seeding for the terminal outcome. Never touches uploaded files. |
Arguments
|
|
cancelSeedFromDocuments - CancelSeedFromDocumentsResponse
|
Cancel an in-flight seed-from-documents run. The cancel always works: the run stops at its very next boundary, whether that is before any write or after at most the cluster it is mid-read on — there is no refusal outcome. This resolves once the signal is accepted, not once the run has finished stopping; poll documentIntake.seeding for exactly what had already been applied when it did. Never touches the loan's uploaded files either way. |
Arguments
|
|
confirmIntakeDraft - ConfirmIntakeDraftResponse
|
Confirm your document-intake draft and create its borrower. Requires the draft's Command Center user, including a masquerading admin, and ordinary deal, loan, and borrower creation permissions. Preserves the loan ID and uploaded documents. Repeated confirmation returns the original loan and borrower without creating them again. Expired drafts return DOCUMENT_INTAKE_DRAFT_EXPIRED without changes. |
Arguments
|
|
correctDocumentKind - CorrectDocumentKindResponse
|
Say what an uploaded file really is after it was classified as something else, and read it again as that. The correction is recorded as a person's reading, which wins over the classifier's by construction, and every correction is kept so misclassification can be measured per document type. Resolves once the fresh read has been started, not once it has finished; poll documentIntake.status for the outcome. Works on any document you can see on a loan, including one document of a split upload: that document alone is read again, and the upload's other documents and its split are left as they are. For a document uploaded straight to a loan, the progress and attempt count shown while it is read again are best-effort: they can lag, and settle to finished the next time documentIntake.status is polled after the read ends. Refused through userErrors when the file is still being read (for a document uploaded straight to a loan, until its first read has finished; for one document of a split upload, until its own read and the upload's processing have finished), already has that type, has no type yet, is a whole upload that was split into several documents (correct one of those documents instead), or has several parts with different types. Each refusal's field names the input it is about: input.documentKind for a type that is unchanged or cannot be read, input.documentId otherwise. A refusal is always a payload; an unreachable file or a caller without access is a thrown error, and the field is then null. A correction also withdraws what the file's earlier reading alone wrote onto the borrowers: each such value is kept, and gains a RETRACTION receipt, so its provenance shows that no reading backs it. |
Arguments
|
|
discardIntakeDraft - DiscardIntakeDraftResponse
|
Discard your document-intake draft in the current organization. Requires a Command Center user, including a masquerading admin; machine principals are forbidden. A missing or unreadable ID or friendly ID receives DISCARDED with no changes. A caller's own draft returns DISCARDED when removed and CLEANUP_PENDING when the hourly sweep must finish cleanup. Readable ordinary loans and adopted drafts are forbidden and never deleted. |
Arguments
|
|
mergeSeededBorrower - MergeSeededBorrowerResponse
|
Fold a co-borrower that document seeding created into another borrower on the same loan, recorded under the caller as a person. The co-borrower's documents and its employer, income and W-2 records move to the surviving borrower, the evidence already recorded for them is kept unchanged and is read for the survivor, and the co-borrower is then removed. Refused through userErrors, changing nothing: SEED_DECISION_MERGE_SOURCE_NOT_SEEDED, SEED_DECISION_INPUT_INVALID (including an employer both borrowers hold, or records a merge cannot carry over), SEED_DECISION_CANDIDATE_UNAVAILABLE, SEED_DECISION_ALREADY_RESOLVED, SEED_DECISION_LOAN_FROZEN and SEED_DECISION_RUN_ACTIVE. Repeating a recorded merge returns its survivor. Borrowers on different loans, or a loan the caller cannot reach, are a thrown denial, and the field is then null. |
Arguments
|
|
openIntakeDraft - OpenIntakeDraftResponse
|
Open or reuse your document-intake draft in the current organization. Requires a Command Center user, including a masquerading admin; machine principals are forbidden. An unexpired draft keeps its loan and expiry. An expired draft is removed before a new one is opened; if cleanup is pending, userErrors contains DOCUMENT_INTAKE_DRAFT_CLEANUP_PENDING and no draft is returned. Try again after cleanup. |
resolveFieldProvenance - ResolveFieldProvenanceResponse
|
Atomically resolve a contested borrower field from one still-current candidate citation. The selected citation/document pair and the exact candidate-set version are verified under the same loan lock that refreshes candidate sets; a stale set returns STALE_CANDIDATE_SET and writes nothing. |
Arguments
|
|
resolveSeedPersonDecision - ResolveSeedPersonDecisionResponse
|
Settle one PERSON_CONTESTED decision of a seed-from-documents run: assign its document to a borrower on the loan, create a co-borrower for it, or ignore it. Recorded under the caller as a human resolution, against the decision version the caller read; the document is then read into the chosen borrower with operator-attributed receipts, and a value a person already typed is held, never overwritten. The loan's freeze applies to the write. Refused through userErrors, leaving the decision unchanged: SEED_DECISION_STALE, SEED_DECISION_ALREADY_RESOLVED, SEED_DECISION_SUPERSEDED, SEED_DECISION_ACTION_INVALID, SEED_DECISION_INPUT_INVALID, SEED_DECISION_ATTRIBUTION_CONFLICT, SEED_DECISION_LOAN_FROZEN, SEED_DECISION_RUN_ACTIVE. An unknown decision, or one on a loan the caller cannot reach, is a thrown denial, and the field is then null. |
Arguments
|
|
resolveSeedValueDecision - ResolveSeedValueDecisionResponse
|
Settle a document-seeding value decision: use the document's value, keep the current value, or discard it. Resolution uses the version read by the caller and respects the loan's freeze and active write lock. |
Arguments
|
|
retry - RetryDocumentIntakeResponse
|
Read one uploaded file again. Resolves once a fresh read has been started, not once it has finished; poll documentIntake.status for the outcome. A file that is not in a state a re-read could improve is refused rather than silently accepted. |
Arguments
|
|
seedFromDocuments - SeedFromDocumentsResponse
|
Replaced by seedLoanFromDocuments/documentIntake.seeding (PAPI-321). This member no longer does anything. |
Arguments
|
|
seedLoanFromDocuments - SeedLoanFromDocumentsResponse
|
Seed a loan from an explicit set of its uploaded documents (PAPI-125, PAPI-321). Resolves once the run has STARTED, not once it has finished — poll documentIntake.seeding for that. A call arriving while a prior run is still active on this loan cancels it (ending it CANCELLED) and starts fresh: there is no once-per-loan limit and no loan-level eligibility refusal (never-override makes serving any loan, already filled or not, safe); the only refusals are the two document-level ones below. Refused through userErrors, before any run or row exists, in exactly two cases: SEED_NO_DOCUMENTS when none of the given documentIds resolve to this loan's own uploads, and SEED_PACKET_NOT_ON_SEED_LANE when none of those that do was read in a form this import can use. |
Arguments
|
|
Example
{
"cancelDocumentSeeding": CancelDocumentSeedingResponse,
"cancelSeedFromDocuments": CancelSeedFromDocumentsResponse,
"confirmIntakeDraft": ConfirmIntakeDraftResponse,
"correctDocumentKind": CorrectDocumentKindResponse,
"discardIntakeDraft": DiscardIntakeDraftResponse,
"mergeSeededBorrower": MergeSeededBorrowerResponse,
"openIntakeDraft": OpenIntakeDraftResponse,
"resolveFieldProvenance": ResolveFieldProvenanceResponse,
"resolveSeedPersonDecision": ResolveSeedPersonDecisionResponse,
"resolveSeedValueDecision": ResolveSeedValueDecisionResponse,
"retry": RetryDocumentIntakeResponse,
"seedFromDocuments": SeedFromDocumentsResponse,
"seedLoanFromDocuments": SeedLoanFromDocumentsResponse
}
DocumentIntakeQueries
Description
Root type for per-file intake status queries.
Fields
| Field Name | Description |
|---|---|
fieldProvenance - [FieldProvenance!]!
|
What evidence backs each field's current value, over the write-receipt/live-entity substrate: the write receipt that landed it (or nothing, for a purely contested field), its citation, and every losing reading's citation beside it. Resolves for any loan, seeded or not. |
Arguments
|
|
seedOutcome - SeedOutcomeResponse!
|
Replaced by seedLoanFromDocuments/documentIntake.seeding (PAPI-321). This member no longer does anything. |
Arguments
|
|
seeding - DocumentSeeding
|
The loan's most recent seed-from-documents run: its progress, documents, field-key counts and outcomes. Review decisions expose field values and their evidence; the write-receipt trail records what was applied to the application. Null when the loan has never been seeded. |
Arguments
|
|
status - DocumentIntakeStatusResponse!
|
Every uploaded file in the loan and what came of it: where each is in the pipeline, how it was classified, how many values it yielded, and — for a file that could not be read — why, and whether asking again would help. |
Arguments
|
|
Example
{
"fieldProvenance": [FieldProvenance],
"seedOutcome": SeedOutcomeResponse,
"seeding": DocumentSeeding,
"status": DocumentIntakeStatusResponse
}
DocumentIntakeState
Description
Where one uploaded file has got to. QUEUED and READING are working states; READ, FILED_NOT_READ and FAILED are terminal. FILED_NOT_READ means the file was classified as a kind we do not extract — it is not an error and offers no retry.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FAILED"
DocumentIntakeStatusInput
Description
Scope for a per-file intake status read.
Fields
| Input Field | Description |
|---|---|
loanId - ID
|
The ID or friendly ID of the loan. Provide this or the deprecated loanApplicationId, not both. Every file the loan holds appears, whichever upload lane brought it in. |
Example
{"loanId": 4}
DocumentIntakeStatusResponse
Description
Every uploaded file in one scope, and what came of it.
Fields
| Field Name | Description |
|---|---|
detailsFound - Int
|
Values located across the whole scope. Null when nothing has been counted yet; a zero means zero. |
documents - [DocumentIntakeDocument!]!
|
One entry per uploaded file, oldest first. |
observedAt - DateTime!
|
Server clock: when this snapshot was taken. Both timestamps come from here so a client judging how long a file has been reading never subtracts a device clock from a server one. |
Example
{
"detailsFound": 987,
"documents": [DocumentIntakeDocument],
"observedAt": "2007-12-03T10:15:30Z"
}
DocumentIntakeUnreadPage
Description
A page of a read document that was not read in full. The document's other pages were read.
Fields
| Field Name | Description |
|---|---|
page - Int!
|
The page, as numbered in the packet. |
reason - DocumentIntakeUnreadPageReason!
|
Why the page was not read in full. |
rowsRead - Int!
|
Transactions of the page that are in the document: 0 when none were read, else the first this many. |
Example
{"page": 987, "reason": "ANSWER_UNUSABLE", "rowsRead": 123}
DocumentIntakeUnreadPageReason
Description
Why one page of a read document was not read in full: PAGE_TOO_DENSE (more transactions than could be read, or more text than fits the model), THROTTLED (the model provider kept asking to wait), MODEL_TIMED_OUT, ANSWER_UNUSABLE (the reading stayed unusable after a second try), PROVIDER_UNAVAILABLE, CONTINUATION_INCONSISTENT (a continuation went back over rows already read, twice), CHANNEL_REJECTED (asking again for the page was rejected by the service for good), or UNRECOGNIZED.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANSWER_UNUSABLE"
DocumentIntakeUnreadReason
Description
The typed answer that left a document unread, when there is one: why seed-from-documents' extraction could not read it. A closed set to branch on — REQUEST_INVALID, DENIED, DOCUMENT_MISSING, DOCUMENT_TOMBSTONED, PARSE_PENDING, PARSE_UNAVAILABLE, PAGE_OUT_OF_RANGE, PACKET_TOO_LONG (more than 200 pages), SECTION_TOO_LONG (more than 40) or CONTEXT_TOO_LARGE (the text does not fit the model), ANSWER_UNUSABLE (the reading stayed unusable after a second try), CONTENT_INVALID (the reading is not a valid document of its kind), NOT_JUDGED_UNAVAILABLE or NOT_JUDGED_FAILED (a letter of explanation read while its sufficiency judge's flag is on for the customer, which the judge did not judge because it is not configured or it failed) or UNRECOGNIZED. Always accompanies failureReason EXTRACTION_FAILED.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANSWER_UNUSABLE"
DocumentKind
Description
The extractable document kind a classified section routes to. Null on a section means no extractor exists for it yet (recorded as OTHER_DOCUMENT for review).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BANK_STATEMENT"
DocumentLink
Fields
| Field Name | Description |
|---|---|
archived - DocumentLinkArchive
|
Set when this document was archived (e.g. an underwriter marked it Duplicate). Null for live documents. |
id - String
|
|
review - DocumentReview
|
The document reviewer's read of this document — its status and, when ready, a plain-English summary. Null when the document has no review to show. |
Arguments
|
|
source - DocumentLinkSource
|
How this document is joined to the task: uploaded against it, matched by its filed type/entity, or both. Null when the link is not scoped to a task (the loan documents wire). |
title - String!
|
|
uploadStatus - DocumentUploadStatus
|
|
url - String!
|
|
Example
{
"archived": DocumentLinkArchive,
"id": "abc123",
"review": DocumentReview,
"source": "MATCHED_BY_TYPE",
"title": "abc123",
"uploadStatus": "COMPLETE",
"url": "xyz789"
}
DocumentLinkArchive
Description
Why an archived document was archived, carried on the link so the uploader can see what became of it.
Fields
| Field Name | Description |
|---|---|
reasonCategory - ArchiveReasonCategory
|
|
reasonNotes - String
|
Free-text notes recorded when the document was archived or rejected (a rejection is recorded with the Illegible category). Null when no notes were recorded, and for callers other than Command Center users. |
Example
{
"reasonCategory": "AssociatedToDifferentAspect",
"reasonNotes": "xyz789"
}
DocumentLinkSource
Description
How the document is joined to this task. UPLOADED_TO_TASK: it was uploaded against this task and the link rests on that claim alone — either its filed document type/entity does NOT match the task (it lives elsewhere on the loan) or it has since been archived. MATCHED_BY_TYPE: its filed type/entity matches the task, but it was not uploaded against it (uploaded elsewhere, or generated). UPLOADED_AND_MATCHED: both — the upload landed where the uploader intended.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MATCHED_BY_TYPE"
DocumentRequiredCondition
Fields
| Field Name | Description |
|---|---|
numberOfRequiredDocumentTypes - Int
|
|
requireDistinctDocumentTypes - Boolean
|
|
requiredDocumentTypes - [DocumentType!]!
|
Example
{
"numberOfRequiredDocumentTypes": 123,
"requireDistinctDocumentTypes": false,
"requiredDocumentTypes": [DocumentType]
}
DocumentReview
Description
The review of a single document: its status and, when ready, a plain-English summary of the document and the actions taken.
Fields
| Field Name | Description |
|---|---|
audience - DocumentReviewAudience!
|
Which reader scope this summary was written for. |
declaredTaskRefusal - DocumentReviewDeclaredTaskRefusal
|
Set when the review refused the task the uploader declared. Null means the uploader declared no task or the review honored the declaration. On CONDITION_MISMATCH the document was filed on the loan under its classified type and is NOT attached to the declared condition — an underwriter looking at that condition will not see it there. |
reviewedAt - DateTime
|
When the review's summary was recorded — the instant the reviewer's READY summary was first received. Present only when the status is READY; a pending or not-completed review has no timestamp. |
status - DocumentReviewStatus!
|
Whether the review is pending, not completed, or ready. |
summary - String
|
The review's plain-English summary of the document and the actions taken. Present only when the status is READY. |
taskConfidence - DocumentReviewTaskConfidence
|
The review's stated confidence that this document answers the task it was uploaded against, with the agent's rationale. Null when the review stated no confidence — a review recorded before confidence existed, or an agent that declined to state one. Absence means "not stated", never a low score. |
Example
{
"audience": "BORROWER",
"declaredTaskRefusal": DocumentReviewDeclaredTaskRefusal,
"reviewedAt": "2007-12-03T10:15:30Z",
"status": "NOT_COMPLETED",
"summary": "xyz789",
"taskConfidence": DocumentReviewTaskConfidence
}
DocumentReviewAudience
Description
Which reader scope a document's review summary was written for.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER"
DocumentReviewDeclaredTaskRefusal
Description
A declared task the review refused: the uploader chose a request task and the review filed the document elsewhere on the loan instead of attaching it to that task.
Fields
| Field Name | Description |
|---|---|
kind - DocumentReviewDeclaredTaskRefusalKind!
|
Why the declared task was not honored. |
reason - String!
|
Human-readable reason the declared task was refused, e.g. which document type the condition requires versus what was classified. |
Example
{
"kind": "ALREADY_TERMINAL",
"reason": "xyz789"
}
DocumentReviewDeclaredTaskRefusalKind
Description
Why the review did not honor the task the uploader declared. CONDITION_MISMATCH means the classified document type is not one the declared condition admits, so the document was filed on the loan under its own classified type and is NOT attached to the declared condition. NOT_ON_LOAN and NOT_A_REQUEST_TASK mean the declared task could not take a document at all; ALREADY_TERMINAL means it was already completed or cancelled when the review ran.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALREADY_TERMINAL"
DocumentReviewStatus
Description
The state of a document's review: PENDING while the summary is still being generated, NOT_COMPLETED once a dispatched review has gone past its pending window without producing a summary, and READY when the summary is available.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOT_COMPLETED"
DocumentReviewTaskConfidence
Description
The review's stated confidence that the document answers the task it was uploaded against: an integer percent and the reviewing agent's own one-sentence rationale, recorded as evidence for a human reviewer. Suitable for sorting or badging a review queue; not a machine gate.
Example
{"rationale": "xyz789", "score": 123}
DocumentSeeding
Description
One seed-from-documents RUN — never deleted, so a loan may hold several across its life, each a permanent part of its record.
Fields
| Field Name | Description |
|---|---|
cancelledAppliedPersonCount - Int
|
Of cancelledResolvedPersonCount, how many people's documents were already read and applied to the loan when an operator's cancel request stopped this run. Null unless cancelledKind is READING — reading had not yet started for SETTLING or RESOLVING. |
cancelledCoBorrowersMintedCount - Int
|
Co-borrowers already minted when an operator's cancel request stopped this run — an already-committed act, reported honestly rather than reverted. Null unless cancelledKind is RESOLVING or READING. |
cancelledKind - SeedCancelledKind
|
The closed-set, typed reason an operator's cancel request stopped this run — SETTLING, RESOLVING or READING. Null unless status is CANCELLED. The contract to branch on; the three cancelledXCount fields below are typed supplements, never a message to parse. |
cancelledResolvedPersonCount - Int
|
People already resolved into clusters when an operator's cancel request stopped this run. Null unless cancelledKind is RESOLVING or READING — nothing had been resolved yet for SETTLING. |
decisions - DocumentSeedingDecisionConnection!
|
|
Arguments |
|
documents - [DocumentIntakeDocument!]!
|
This run's own documents and their intake status. |
fields - [IntakeFieldOutcome!]!
|
Empty until status is COMPLETED. |
id - ID!
|
This run's own id. |
mintedBorrowers - [Borrower!]
|
The co-borrowers this run minted for people the documents named who were not yet on the loan, in mint order. Written as each is minted, so a RUNNING run already lists the ones so far; one since removed from or moved off the loan is omitted. Null only when this field itself could not be answered (the caller lacks read:borrower, or a borrower failed to load); the run's other fields still answer. |
outcome - DocumentSeedingOutcome!
|
Zeroed counts until status is COMPLETED. |
processing - SeedProcessingProgress
|
Live phase and progress while status is RUNNING. Null for every other status — a settled, refused, failed or cancelled run has nothing left to report progress on. |
refusal - String
|
The typed refusal code (e.g. SEED_NO_NAMED_DOCUMENTS). Null unless status is REFUSED. |
status - DocumentSeedingStatus!
|
Where this run stands. |
Example
{
"cancelledAppliedPersonCount": 987,
"cancelledCoBorrowersMintedCount": 987,
"cancelledKind": "READING",
"cancelledResolvedPersonCount": 123,
"decisions": DocumentSeedingDecisionConnection,
"documents": [DocumentIntakeDocument],
"fields": [IntakeFieldOutcome],
"id": 4,
"mintedBorrowers": [Borrower],
"outcome": DocumentSeedingOutcome,
"processing": SeedProcessingProgress,
"refusal": "abc123",
"status": "CANCELLED"
}
DocumentSeedingCoBorrowerNameInput
Description
The name to create a co-borrower under when the documents' extracted name should not be used as is.
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"middleName": "abc123",
"suffix": "xyz789"
}
DocumentSeedingDecision
Fields
| Field Name | Description |
|---|---|
allowedActions - [DocumentSeedingDecisionAction!]!
|
|
id - ID!
|
|
kind - DocumentSeedingDecisionKind!
|
|
resolution - DocumentSeedingDecisionResolution
|
|
sources - [DocumentSeedingDecisionSource!]!
|
|
status - DocumentSeedingDecisionStatus!
|
|
subject - DocumentSeedingDecisionSubject!
|
|
version - OpaqueToken!
|
Example
{
"allowedActions": ["ASSIGN"],
"id": 4,
"kind": "PERSON_CONTESTED",
"resolution": DocumentSeedingDecisionResolution,
"sources": [DocumentSeedingDecisionSource],
"status": "OPEN",
"subject": DocumentSeedingPersonDecision,
"version": OpaqueToken
}
DocumentSeedingDecisionAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSIGN"
DocumentSeedingDecisionConnection
Fields
| Field Name | Description |
|---|---|
edges - [DocumentSeedingDecisionEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [DocumentSeedingDecisionEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DocumentSeedingDecisionEdge
Fields
| Field Name | Description |
|---|---|
cursor - OpaqueToken!
|
|
node - DocumentSeedingDecision!
|
Example
{
"cursor": OpaqueToken,
"node": DocumentSeedingDecision
}
DocumentSeedingDecisionErrorCode
Description
Why a seed-decision resolution was refused. Every value is also the entry's code, so a client keying copy on the UserError interface alone reads the same registered code.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SEED_DECISION_ACTION_INVALID"
DocumentSeedingDecisionKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PERSON_CONTESTED"
DocumentSeedingDecisionResolution
Fields
| Field Name | Description |
|---|---|
action - DocumentSeedingDecisionAction!
|
|
borrower - Borrower
|
|
candidate - DocumentSeedingValueCandidate
|
|
resolvedAt - DateTimeISO!
|
|
resolvedBy - FieldProvenanceAuthor
|
Example
{
"action": "ASSIGN",
"borrower": Borrower,
"candidate": DocumentSeedingValueCandidate,
"resolvedAt": "2007-12-03T10:15:30Z",
"resolvedBy": FieldProvenanceAuthor
}
DocumentSeedingDecisionSource
Fields
| Field Name | Description |
|---|---|
document - LoanDocument
|
|
fieldKey - DocumentSeedingFieldKey
|
|
location - FieldProvenanceCitation
|
Example
{
"document": LoanDocument,
"fieldKey": "BORROWER_ANNUAL_WAGES_AMOUNT",
"location": FieldProvenanceCitation
}
DocumentSeedingDecisionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
DocumentSeedingDecisionSubject
Types
| Union Types |
|---|
Example
DocumentSeedingPersonDecision
DocumentSeedingDecisionUserError
Description
A refusal of a seed-decision resolution. Correctable by the caller: re-read the decision and resolve it again, or choose another action. Authorization, an unknown decision and system faults are thrown, never returned here.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
decisionCode - DocumentSeedingDecisionErrorCode!
|
The typed refusal. Always the same registered value as code. |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"decisionCode": "SEED_DECISION_ACTION_INVALID",
"errorId": 4,
"field": ["abc123"],
"message": "xyz789"
}
DocumentSeedingFieldKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_ANNUAL_WAGES_AMOUNT"
DocumentSeedingInput
Description
Scope for a document-seeding read.
Fields
| Input Field | Description |
|---|---|
loanId - ID
|
The ID or friendly ID of the loan. Provide this or the deprecated loanApplicationId, not both. The loan whose most recent seeding run to report. |
Example
{"loanId": 4}
DocumentSeedingNameChoice
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPLICATION"
DocumentSeedingOutcome
Description
Counts of field KEYS a settled run landed, NEVER field values. Zeroed until status is COMPLETED. Deliberately narrow and must not grow into an audit trail: what landed where, with which citations, is the write-receipt record's to answer, not a polling endpoint's.
Fields
| Field Name | Description |
|---|---|
appliedCount - Int!
|
Fields written onto the application, counted across every seeded borrower. |
coBorrowerCreated - Boolean!
|
Whether the run minted at least one co-borrower for a second person the documents named. Use DocumentSeeding.mintedBorrowers, which names who was minted. The two disagree once every minted borrower has since been removed from or moved off the loan: this stays true while mintedBorrowers is empty.
|
contestedCount - Int!
|
Distinct fields the documents contradicted each other about, left for a person to settle. |
contestedPersonCount - Int!
|
People the packet named who read too much like an existing borrower to mint and not enough to match — left for a person to settle. Their documents are attached but joined to nobody. |
heldCount - Int!
|
Fields held by a loan freeze, counted across borrowers. |
preexistingCount - Int!
|
Fields already holding somebody's typed value, held rather than overwritten — typed values always win. |
unattributedDocumentCount - Int!
|
Documents naming nobody the run could compare — a nameless paystub, a name outside the comparable alphabet. Attached to the loan, joined to no borrower; somebody should file them by hand. |
withheldCount - Int!
|
Distinct fields read and deliberately not written — income, today. |
Example
{
"appliedCount": 123,
"coBorrowerCreated": false,
"contestedCount": 987,
"contestedPersonCount": 123,
"heldCount": 987,
"preexistingCount": 987,
"unattributedDocumentCount": 987,
"withheldCount": 123
}
DocumentSeedingPersonDecision
Fields
| Field Name | Description |
|---|---|
assignmentTargets - [Borrower!]!
|
Every active borrower on the decision's loan, any of which the documents may be assigned to. |
confidence - Float!
|
The person-resolution confidence recorded with the hold. |
documentName - DocumentSeedingPersonName
|
|
holdReason - DocumentSeedingPersonHoldReason!
|
|
reason - String
|
The explanation recorded with the hold. Null when the caller cannot read every document the decision cites. |
Example
{
"assignmentTargets": [Borrower],
"confidence": 123.45,
"documentName": DocumentSeedingPersonName,
"holdReason": "BORROWER_CONFLICT",
"reason": "xyz789"
}
DocumentSeedingPersonHoldReason
Description
Why document seeding held a person's documents for an operator instead of attributing them.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_CONFLICT"
DocumentSeedingPersonName
DocumentSeedingStatus
Description
Where one seed-from-documents RUN stands. PENDING/RUNNING cover a live run; COMPLETED/REFUSED/FAILED are terminal; CANCELLED is a run a later seedLoanFromDocuments call on the same loan preempted (cancel-and-replace) before it reached a terminal state of its own.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
DocumentSeedingValueCandidate
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount
|
|
sources - [DocumentSeedingDecisionSource!]!
|
Example
{
"amount": MonetaryAmount,
"sources": [DocumentSeedingDecisionSource]
}
DocumentSeedingValueDecision
Fields
| Field Name | Description |
|---|---|
candidates - [DocumentSeedingValueCandidate!]!
|
|
current - FieldProvenance!
|
|
currentAmount - MonetaryAmount
|
|
dateOfTransfer - Date
|
The date the gift was or will be transferred. Null when the caller cannot read every document the decision cites. |
donorName - String
|
The gift's donor, as the gift letter names them. Null when the caller cannot read every document the decision cites. |
donorRelationship - String
|
The donor's relationship to the borrower, as the letter states it. Null when the caller cannot read every document the decision cites. |
fieldKey - DocumentSeedingFieldKey!
|
|
taxYear - Int
|
The tax year an annual figure is for; null for monthly income, and when the caller cannot read every document the decision cites. |
Example
{
"candidates": [DocumentSeedingValueCandidate],
"current": FieldProvenance,
"currentAmount": MonetaryAmount,
"dateOfTransfer": "2007-12-03",
"donorName": "xyz789",
"donorRelationship": "xyz789",
"fieldKey": "BORROWER_ANNUAL_WAGES_AMOUNT",
"taxYear": 123
}
DocumentSeedingValueDropReason
Description
Why the extraction's validation removed a value or row before seed-from-documents read the document: NOT_ON_CITED_BLOCKS (the value is not on the blocks it cited), QUOTE_DOES_NOT_SHOW_VALUE (its quote does not show the value), CITED_BLOCK_IS_AN_INSTRUCTION (it cited the form's instructions), SHORT_QUOTE_WITHOUT_LABEL (its quote is too short to place without a label), ROW_NOT_CITED (a row with no citation), DIFFERENT_ACCOUNT (a value or row of another account), INFERENCE_NOT_SUPPORTED (an inferred value the document does not support), VALUE_NOT_CITED (a value with no citation), DATE_NOT_ISO_CALENDAR (a date that is not a calendar date), ACCOUNT_UNVERIFIED (a row not verified as the statement's account), SOURCE_VALUE_INVALID (the extraction returned a value its own schema rejects), or UNRECOGNIZED.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT_UNVERIFIED"
DocumentType
DocumentUploadFulfillment
Description
Fulfill a requirement by uploading a document.
Fields
| Field Name | Description |
|---|---|
description - String!
|
What document is needed. |
name - String!
|
Short name, e.g. "Upload W2". |
requirements - [Requirement!]!
|
Sub-requirements for this option. Each carries its own phase - a partially-satisfied composite lists SatisfiedRequirement children alongside OpenRequirement ones. Empty when the option itself is directly actionable. |
satisfied - Boolean!
|
Whether the document has been uploaded and accepted. |
uploadUrl - String!
|
URL to POST the document to (multipart/form-data). |
Example
{
"description": "xyz789",
"name": "abc123",
"requirements": [Requirement],
"satisfied": false,
"uploadUrl": "abc123"
}
DocumentUploadResolution
Description
Resolved by uploading documents. Carries evidence linking to the uploaded files.
Fields
| Field Name | Description |
|---|---|
assertions - [Assertion!]!
|
The satisfying assertion(s) pinned at resolution time. |
description - String!
|
Human-readable summary. |
method - String!
|
Resolution method identifier. Superseded by assertions. Retained temporarily for already-shipped clients and removed after one release.
|
Example
{
"assertions": [Assertion],
"description": "abc123",
"method": "xyz789"
}
DocumentUploadStatus
Description
The status of a document upload.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
DuplicateLiabilitySuggestion
Fields
| Field Name | Description |
|---|---|
duplicateOf - Liability!
|
A possible matching credit-report liability |
liability - Liability!
|
The self-reported liability to review |
Example
{
"duplicateOf": Liability,
"liability": Liability
}
EconsentCaptureMethodType
Description
How the borrower's consent to electronic disclosures was captured.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ELECTRONIC"
EconsentStatusType
Description
The borrower's answer to electronic disclosures.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPT"
EligiblePreQualification
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
Example
{
"apr": 987.65,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 987,
"loanAmount": 123,
"ltv": 123.45,
"rate": 987.65,
"salesContractAmount": 123
}
EligibleProductPricing
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate |
id - ID
|
The unique ID of this product pricing result. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
rateStack - [StructuringResult!]!
|
|
rates - [ProductPricingRate!]!
|
A list of rates available for this loan. The first rate in the list is the best rate available given the provided points buy. Each subsequent rate is better but requires additional points buy in order for the borrower to qualify. Use rateStack, which carries the same eligible structures plus ineligible and error entries; filter by __typename for EligibleProductStructure. This field will be removed once external usage has stopped. |
term - PositiveInt!
|
The term of the loan being considered in years. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"id": 4,
"lock": 123,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"rateStack": [EligibleProductStructure],
"rates": [ProductPricingRate],
"term": 123
}
EligibleProductStructure
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate mortgage |
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
appliedMargin - AppliedMargin
|
The margin applied when this rate or structure was priced, derived on read from the effective-dated margin window in force at the loan's lock (its original lock for a company that reads margin at the original lock, its current lock otherwise), or now for an unlocked loan. Identical for a loan's current product structure and for the candidates of a pricing run on the same loan. Every caller reads loanOfficerMargin; split is null unless the caller may read the margin breakdown. Null for results priced outside a loan context (e.g. scenarios). |
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
llpasWaived - Boolean!
|
Whether LLPAs were waived for this rate due to low-income borrower eligibility |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
lockCharges - [ProductPricingCharge!]
|
The rate lock fees priced inside this structure's points: the lock's relock fee, charged on a relock or a live investor change, and each extension's fee. Already included in totalPoints, each shown as its own row in the points breakdown; never a separate closing cost. Empty when there are none. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
repricing - StructureRepricing
|
How this structure was priced against the loan's expired rate lock: the worse of the lock-day and today's rate sheets inside the relock window, or today's rate sheet after it. Null when no repricing outcome is recorded for this structure. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"appliedMargin": AppliedMargin,
"apr": 123.45,
"cashFromToBorrower": 123.45,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 123.45,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": 4,
"interest": 123,
"llpasWaived": false,
"loanTermYears": 123,
"lock": 123,
"lockCharges": [ProductPricingCharge],
"ltv": 123.45,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"rate": 123.45,
"rateId": "4",
"ratePoints": 987.65,
"repricing": StructureRepricing,
"totalCost": 987.65,
"totalPoints": 123.45
}
EmergencyRevokeWebhookSigningKeyInput
Description
Revokes a signing key immediately, outside the normal overlap window. Use it when a key may be compromised.
Fields
| Input Field | Description |
|---|---|
signingKeyId - ID!
|
The signing key to revoke. |
Example
{"signingKeyId": "4"}
EmergencyRevokeWebhookSigningKeyResponse
Description
The result of revoking a webhook signing key in an emergency.
Fields
| Field Name | Description |
|---|---|
subscription - WebhookSubscription
|
The subscription after the revocation. If the revoked key was the active one, its status is DISABLED and deliveries stop until a new key is tested and promoted. Null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused, if it was. Empty on success. Code: WEBHOOK_KEY_ALREADY_REVOKED. |
Example
{
"subscription": WebhookSubscription,
"userErrors": [UserError]
}
Employer
Description
Employer
Fields
| Field Name | Description |
|---|---|
address - Address
|
Employer's address |
contact - EmployerContact
|
Employer contact |
id - ID!
|
Employer ID |
name - String!
|
Name of the employer |
Example
{
"address": Address,
"contact": EmployerContact,
"id": 4,
"name": "xyz789"
}
EmployerContact
EmployerContactInput
EmployerInput
Description
Employer input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Employer's address |
contact - EmployerContactInput
|
Employer contact |
name - String
|
Name of the employer |
Example
{
"address": AddressInput,
"contact": EmployerContactInput,
"name": "xyz789"
}
EmployerRelationship
Description
The borrower's stated relationship with the employer.
Values
| Enum Value | Description |
|---|---|
|
|
The borrower reported no special relationship with the employer. |
|
|
The borrower has a special relationship with the employer, such as employment by a family member, the property seller, a real estate agent, or another party to the transaction. |
Example
"NO_SPECIAL_RELATIONSHIP"
Employment
Description
Employment interface
Fields
| Field Name | Description |
|---|---|
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. Will be null if the employment is current. |
id - ID!
|
Employment ID |
isCurrentEmployment - Boolean!
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
Possible Types
| Employment Types |
|---|
Example
{
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": "4",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"position": "xyz789",
"startDate": "2007-12-03"
}
EmploymentClassificationType
Description
Whether this is the borrower's primary or secondary employer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRIMARY"
EmploymentGapMutations
Fields
| Field Name | Description |
|---|---|
explainEmploymentGap - ExplainEmploymentGapResponse
|
Generate employment gap explanation letter |
Arguments
|
|
Example
{"explainEmploymentGap": ExplainEmploymentGapResponse}
EmploymentIncome
Description
Interface for employment incomes types
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment!
|
The associated employment |
externalId - OpaqueToken
|
The employment identifier assigned by the income verification provider. |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Possible Types
| EmploymentIncome Types |
|---|
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": Employment,
"externalId": OpaqueToken,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
EmploymentRelatedAccountIncome
Description
Income from employment-related accounts
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
EnableContributorInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
EnableContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
EnabledPlaidProduct
Description
Plaid products that can be enabled for a customer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ASSETS"
EnterPrepaidAmountInput
Fields
| Input Field | Description |
|---|---|
amount - MonetaryAmount!
|
The amount the seller prepaid, from 0.00 to 999,999,999,999.99. It is added to the seller one balance, whether it is a first entry or a renewal. |
customerId - ID!
|
The seller whose prepaid balance grows. |
idempotencyKey - String!
|
A retry key unique to the entries of this seller. Repeating the call with the same key and amount returns the entry already recorded. |
Example
{
"amount": MonetaryAmount,
"customerId": "4",
"idempotencyKey": "xyz789"
}
EnterPrepaidAmountResponse
Fields
| Field Name | Description |
|---|---|
outcome - FundingPrepaidEntryOutcome!
|
RECORDED when this request recorded the entry. REPLAYED when the same idempotency key had already recorded it, so nothing new was recorded. |
prepaidEntry - FundingPrepaidEntry!
|
Example
{
"outcome": "RECORDED",
"prepaidEntry": FundingPrepaidEntry
}
EntityEventsResponse
Fields
| Field Name | Description |
|---|---|
batch - NodeChangedEventBatch!
|
Batch of changed entities |
next - String!
|
A cursor that can be used to fetch the next batch. |
Example
{
"batch": NodeChangedEventBatch,
"next": "abc123"
}
EscrowItemType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSESSMENT_TAX"
EstimatedLoanRatios
Description
Live estimates of the loan's DTI and LTV ratios, computed on demand from the loan's current incomes, liabilities, and property value against the selected product structure's housing payment.
These are display-oriented approximations that move as loan inputs change; the authoritative ratios are computed during pricing and exposed on the product structure.
Example
{"dti": 987.65, "ltv": 123.45}
Ethnicity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HISPANIC"
EventLogQueries
Description
Replay of the event log. Experimental. Reading by event id never skips an event: store the id of the last event you processed, and after any outage resume from it. Events are kept for at least 90 days; after that they are removed a whole calendar month at a time, so an event older than 90 days may no longer be available: an after that is not a retained event of yours (dropped by retention, unknown, or not yours) is refused with EVENT_LOG_CURSOR_TOO_OLD rather than resumed silently, and you restart from cursorAt.
Fields
| Field Name | Description |
|---|---|
cursorAt - PylonEvent
|
The event immediately before since: pass its id as page(after:) and every event recorded at or after since is delivered. Events recorded shortly before since may also be delivered. Null when no event precedes since: omit after to start from the beginning. A since older than the retained history gives null; one after the last event gives the last event. |
Arguments
|
|
page - PylonEventPage!
|
The events strictly after the event whose id is after, oldest first. Omit after to start from the oldest retained event. An after that is not a retained event of yours (older than the 90-day retention, unknown, or not yours) is refused with EVENT_LOG_CURSOR_TOO_OLD: events may have been missed, restart from cursorAt. |
Example
{
"cursorAt": PylonEvent,
"page": PylonEventPage
}
Evidence
Description
An entry in a requirement's evidence log — evidence IS the edge: an authored assertion or a dispute act, interleaved in creation order.
Fields
| Field Name | Description |
|---|---|
author - Contributor!
|
WHO authored this entry — always a Contributor, resolved from the writing context, never client-supplied. |
createdAt - DateTimeISO!
|
When this entry was written. |
id - ID!
|
Stable content-addressed identifier, resolvable via the root node(id) query. |
Example
{
"author": Contributor,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4"
}
ExchangePublicTokenInput
Description
Input to the exchangePublicToken mutation.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower |
plaidMetadata - PlaidExchangeMetadata
|
Plaid-specific metadata (required when vendor is PLAID) |
publicToken - String!
|
Public token from widget |
truvMetadata - TruvExchangeMetadata
|
Truv-specific metadata (required when vendor is TRUV) |
vendor - VendorName!
|
Vendor to use (PLAID or TRUV) |
Example
{
"borrowerId": "4",
"plaidMetadata": PlaidExchangeMetadata,
"publicToken": "abc123",
"truvMetadata": TruvExchangeMetadata,
"vendor": "PLAID"
}
ExchangePublicTokenResponse
Description
Result of exchanging public token
Types
| Union Types |
|---|
Example
PlaidItemAccess
ExpiredCreditPullError
Description
User error indicating that credit pulls are expired for one or more borrowers
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
ExplainAssetTransactionInput
ExplainAssetTransactionResponse
ExplainEmploymentGapInput
Description
Input for employment gap explanation
Example
{
"borrowerId": "4",
"endDate": "2007-12-03",
"explanation": "xyz789",
"startDate": "2007-12-03"
}
ExplainEmploymentGapResponse
Description
Response for employment gap explanation
Example
{
"documentUploadId": 4,
"errorMessage": "abc123",
"url": "abc123"
}
ExportLoanInput
Description
Input to the export mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID of the loan to export |
Example
{"loanId": 4}
ExportLoanResponse
Description
Response of the export mutation.
Fields
| Field Name | Description |
|---|---|
downloadUrl - String!
|
A temporary URL for downloading the exported loan file |
Example
{"downloadUrl": "abc123"}
ExtendRateLockInput
Description
Input to the loan.extendRateLock mutation.
Fields
| Input Field | Description |
|---|---|
expiresOn - Date!
|
The lock's new expiration: one of its extension terms' option dates. |
feePayer - RateLockExtensionFeePayer!
|
Who pays the extension's fee. PYLON leaves the loan's pricing and disclosures unchanged, and is refused unless the requester is Pylon staff. BROKER saves an approved broker concession of the fee's amount that pays it, leaving the borrower's price unchanged; it is refused where it isn't enabled, where the loan's channel pays the broker no compensation, and where the concession would need review. Default = BORROWER |
latestPeriodId - ID!
|
The id of the lock's latest period as last read. Repeating the same id and expiresOn returns the extension that the first request made. |
loanId - ID!
|
The ID or friendly ID of the loan. |
token - OpaqueToken!
|
The token of the extension option the expiresOn came from, sent unchanged. If the option's price or rules changed since, the request is refused with RATE_LOCK_EXTENSION_TERMS_CHANGED and nothing is written. |
Example
{
"expiresOn": "2007-12-03",
"feePayer": "BORROWER",
"latestPeriodId": "4",
"loanId": "4",
"token": OpaqueToken
}
ExtendRateLockResponse
Description
Response of the loan.extendRateLock mutation.
Fields
| Field Name | Description |
|---|---|
period - RateLockPeriodEntry
|
The saved extension. Null exactly when userErrors is non-empty. |
terms - RateLockExtensionTerms
|
The lock's terms after the extension. Null exactly when userErrors is non-empty. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the loan.extendRateLock mutation. At most one; nothing was written. |
Example
{
"period": RateLockPeriodEntry,
"terms": RateLockExtensionTerms,
"userErrors": [UserError]
}
ExtractDocumentFailure
Description
Structured failure details for a document extraction that did not succeed.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A human-readable description of the failure. |
reason - ExtractionFailureReason!
|
A categorized failure reason code. |
Example
{
"message": "xyz789",
"reason": "DOCUMENT_BLURRY"
}
ExtractDocumentQueries
Description
Root type for document extraction queries.
Fields
| Field Name | Description |
|---|---|
status - ExtractDocumentStatusResponse!
|
Get the current status of a document extraction workflow. |
Arguments
|
|
Example
{"status": ExtractDocumentStatusResponse}
ExtractDocumentStatusInput
Description
Input for querying the status of a document extraction workflow.
Fields
| Input Field | Description |
|---|---|
workflowId - ID!
|
The workflow ID returned when extraction was started. |
Example
{"workflowId": 4}
ExtractDocumentStatusResponse
Description
Response containing the current status of a document extraction.
Fields
| Field Name | Description |
|---|---|
failure - ExtractDocumentFailure
|
Failure details when status is FAILED. Null when status is PROCESSING or SUCCEEDED. |
status - JobStatus!
|
Current status of the extraction workflow. |
Example
{"failure": ExtractDocumentFailure, "status": "FAILED"}
ExtractionFailureReason
Description
The categorized reason why a document extraction failed. Allows consumers to branch on specific failure modes without parsing free-text messages.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENT_BLURRY"
FeatureFlagResult
Fee
Fields
| Field Name | Description |
|---|---|
escrowItemType - EscrowItemType
|
|
feeActualTotalAmount - NonNegativeInt
|
|
feeDescription - String
|
|
feePaidToType - FeePaidToType
|
|
feePayments - [FeePayment!]
|
|
feeSpecifiedFixedAmount - NonNegativeInt
|
If set, this field represents a fixed amount due at closing. |
feeTotalPercent - NonNegativeInt
|
If set, this field represents a fee as a percentage of the loan amount, due at closing. |
feeType - FeeType
|
|
id - ID!
|
|
integratedDisclosureSectionType - IntegratedDisclosureSectionType
|
|
monthlyAmount - NonNegativeInt
|
|
monthsPaid - NonNegativeInt
|
|
paidTo - PaidTo
|
|
prepaidItemType - PrepaidItemType
|
Example
{
"escrowItemType": "ASSESSMENT_TAX",
"feeActualTotalAmount": 123,
"feeDescription": "abc123",
"feePaidToType": "BROKER",
"feePayments": [FeePayment],
"feeSpecifiedFixedAmount": 123,
"feeTotalPercent": 123,
"feeType": "APPLICATION_FEE",
"id": "4",
"integratedDisclosureSectionType": "DUE_FROM_BORROWER_AT_CLOSING",
"monthlyAmount": 123,
"monthsPaid": 123,
"paidTo": PaidTo,
"prepaidItemType": "BOROUGH_PROPERTY_TAX"
}
FeeMutations
Fields
| Field Name | Description |
|---|---|
create - CreateFeeResponse
|
|
Arguments
|
|
delete - DeleteFeeResponse
|
|
Arguments
|
|
update - UpdateFeeResponse
|
|
Arguments
|
|
Example
{
"create": CreateFeeResponse,
"delete": DeleteFeeResponse,
"update": UpdateFeeResponse
}
FeePaidToType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BROKER"
FeePayment
Fields
| Field Name | Description |
|---|---|
creditAmount - NonNegativeInt
|
|
feeActualTotalAmount - NonNegativeInt
|
|
feePaymentPaidByType - FeePaymentPaidByTypeEnum
|
|
feePaymentPaidOutsideOfClosingIndicator - Boolean
|
|
feePaymentResponsiblePartyType - FeePaymentResponsiblePartyType
|
|
paymentIncludedInAprIndicator - Boolean
|
Example
{
"creditAmount": 123,
"feeActualTotalAmount": 123,
"feePaymentPaidByType": "BORROWER",
"feePaymentPaidOutsideOfClosingIndicator": true,
"feePaymentResponsiblePartyType": "BRANCH",
"paymentIncludedInAprIndicator": false
}
FeePaymentInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt!
|
|
paidBy - ClosingCostPayer!
|
Example
{"amount": 123, "paidBy": "BORROWER"}
FeePaymentPaidByTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER"
FeePaymentResponsiblePartyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BRANCH"
FeeSheetData
Description
Structured contents of a generated fee sheet
Fields
| Field Name | Description |
|---|---|
disclaimerText - String!
|
The compliance disclaimer printed on the sheet |
fees - [Fee!]!
|
Itemized fees — the same Fee type as loan.fees |
generatedAt - DateTime
|
|
isCountyLevelEstimate - Boolean
|
True when the quote was priced from a county rather than a street address; null on sheets that predate this field |
loanOfficer - FeeSheetLoanOfficer
|
|
loanPurpose - LoanPurposeType
|
|
property - Address
|
|
qualifyingFicoScore - Int
|
|
ratesEffectiveDate - Date
|
When the rate sheet backing this quote was ingested |
structure - FeeSheetStructure!
|
Example
{
"disclaimerText": "xyz789",
"fees": [Fee],
"generatedAt": "2007-12-03T10:15:30Z",
"isCountyLevelEstimate": true,
"loanOfficer": FeeSheetLoanOfficer,
"loanPurpose": "PURCHASE",
"property": Address,
"qualifyingFicoScore": 123,
"ratesEffectiveDate": "2007-12-03",
"structure": FeeSheetStructure
}
FeeSheetLoanOfficer
FeeSheetMutations
Fields
| Field Name | Description |
|---|---|
createFeeSheetRequest - CreateFeeSheetRequestResponse
|
Create request to generate fee sheet |
Arguments
|
|
createFeeSheetRequestForLoan - CreateFeeSheetRequestForLoanResponse
|
Create a request to generate a fee sheet for a loan. Pricing parameters are derived from the loan's own data on the server. |
Arguments |
|
Example
{
"createFeeSheetRequest": CreateFeeSheetRequestResponse,
"createFeeSheetRequestForLoan": CreateFeeSheetRequestForLoanResponse
}
FeeSheetPurchasePricingInput
Description
Purchase pricing parameters for a fee sheet
Fields
| Input Field | Description |
|---|---|
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean!
|
|
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
numberOfUnits - NonNegativeInt
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
outOfPocketMax - Float!
|
|
pricingConstraints - PricingConstraints
|
|
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Whether property taxes and insurance are included in the monthly payment (impounded). Defaults to impounded when omitted. |
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"concessions": 123,
"fipsCountyCode": "xyz789",
"isBorrowerSelfEmployed": true,
"isFirstTimeHomeBuyer": false,
"loanTermYears": 123.45,
"monthlyDebt": 123.45,
"monthlyIncome": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"objectiveIntent": "MIN_DOWN_PAYMENT",
"outOfPocketMax": 123.45,
"pricingConstraints": PricingConstraints,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 987.65,
"salesContractAmount": 123
}
FeeSheetQueries
Fields
| Field Name | Description |
|---|---|
feeSheetRequestStatus - FeeSheetRequestStatus
|
|
Arguments
|
|
Example
{"feeSheetRequestStatus": FeeSheetRequestStatus}
FeeSheetRefinancePricingInput
Description
Refinance pricing parameters for a fee sheet
Fields
| Input Field | Description |
|---|---|
cashOut - NonNegativeInt
|
The amount of cash to be returned to the borrower from the equity. Default = 0 |
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
firstLienAmount - NonNegativeInt!
|
The remaining balance on the first lien of the property |
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean
|
This field is irrelevant for refinance and will be ignored. |
loanAmount - NonNegativeInt
|
The desired loan amount in dollars. When provided, pins the solver to this exact loan amount and the out-of-pocket cost is derived from it. When omitted, the solver determines the optimal loan amount. |
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
numberOfUnits - NonNegativeInt
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
pricingConstraints - PricingConstraints
|
|
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Whether property taxes and insurance are included in the monthly payment (impounded). Defaults to impounded when omitted. |
propertyUsageType - PropertyUsageType!
|
|
propertyValue - NonNegativeInt!
|
The value of the property being refinanced in dollars. |
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
Example
{
"cashOut": 123,
"concessions": 123,
"fipsCountyCode": "xyz789",
"firstLienAmount": 123,
"isBorrowerSelfEmployed": true,
"isFirstTimeHomeBuyer": false,
"loanAmount": 123,
"loanTermYears": 123.45,
"monthlyDebt": 987.65,
"monthlyIncome": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"objectiveIntent": "MIN_DOWN_PAYMENT",
"pricingConstraints": PricingConstraints,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"propertyUsageType": "INVESTMENT",
"propertyValue": 123,
"qualifyingFicoScore": 123,
"rateLockDays": 987.65
}
FeeSheetRequestState
Description
Processing state of a fee sheet request
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FAILED"
FeeSheetRequestStatus
Fields
| Field Name | Description |
|---|---|
data - FeeSheetData
|
Structured contents of the sheet; populated once status is SUCCEEDED |
id - ID!
|
|
status - FeeSheetRequestState
|
Processing state of the request, distinguishing in-progress from failed while the URL is absent |
url - String
|
A download URL for a fee sheet |
Example
{
"data": FeeSheetData,
"id": "4",
"status": "FAILED",
"url": "xyz789"
}
FeeSheetStructure
Description
Product structure snapshot on a fee sheet
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
interest - Float
|
|
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - Float
|
|
prepaidInterestDaysPaid - Float
|
|
prepaidInterestTotalAmount - Float
|
|
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
sellerCredit - Float
|
Seller credits applied, in dollars. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"apr": 987.65,
"cashFromToBorrower": 123.45,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"interest": 123.45,
"loanTermYears": 123,
"ltv": 123.45,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 987.65,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 987.65,
"principal": 123.45,
"rate": 987.65,
"rateId": 4,
"ratePoints": 987.65,
"sellerCredit": 987.65,
"totalCost": 123.45,
"totalPoints": 123.45
}
FeeSheetStructureInput
Description
Product structure input for fee sheet requests
Fields
| Input Field | Description |
|---|---|
aporId - ID!
|
|
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"aporId": "4",
"apr": 987.65,
"cashFromToBorrower": 123.45,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"interest": 123,
"loanTermYears": 123,
"ltv": 123.45,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"rateId": 4,
"ratePoints": 123.45,
"totalCost": 987.65,
"totalPoints": 123.45
}
FeeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLICATION_FEE"
FhaMarketingRate
Description
FHA marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 987.65,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 987,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"ltv": 987.65,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rate": 987.65,
"salesContractAmount": 123
}
FhaMarketingRateInput
Description
FHA marketing rate input
Fields
| Input Field | Description |
|---|---|
calculateApr - Boolean
|
Should closing costs be fetched in order to calculate an APR?. Default = true |
concessions - NonNegativeInt
|
Lender concession in dollars. Reduces the rate cost (points) the borrower would otherwise pay, but never below zero. Default = 0 |
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
propertyUsageType - PropertyUsageType
|
|
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"calculateApr": false,
"concessions": 123,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"loanTermYears": 987.65,
"ltv": 987.65,
"maxDiscountPointsTotal": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 123.45
}
FieldProvenance
Description
What evidence backs one field's current value: the write receipt that landed it (or null for a purely contested field), the citation behind that receipt, and every losing reading's citation beside it.
Fields
| Field Name | Description |
|---|---|
author - WriteReceiptKind
|
TRANSCRIPTION, HUMAN_EDIT, HUMAN_RESOLUTION, or RETRACTION. Null exactly when the field is purely contested: losing readings exist, but nothing ever landed a value, so no receipt was ever minted. |
authoredAt - DateTimeISO
|
When the winning receipt was authored. Null alongside author. |
authoredBy - FieldProvenanceAuthor
|
WHO wrote the field's current value, by name only: the person for HUMAN_EDIT and HUMAN_RESOLUTION, the machine persona for TRANSCRIPTION. Shown only to your own lending team (loan officers, processors, assistants, underwriters and admins). Null for a borrower, and for outside parties limited to the loans they are assigned, such as a third-party processor. Null alongside author, or when that contributor is gone. |
candidateSetVersion - String!
|
Opaque version of this field's exact current candidate-citation set. Send it unchanged when resolving a candidate; a changed set is refused rather than letting a selection made against stale evidence write. |
candidates - [FieldProvenanceCandidate!]!
|
Every losing reading's citation for this field — documents that said something else and did not win. Empty when nothing disagreed. |
citation - FieldProvenanceCitation
|
Derived from the winning receipt's citation row at read time. Null alongside author; for a HUMAN_EDIT or a RETRACTION, which cite nothing; and for a TRANSCRIPTION or a HUMAN_RESOLUTION when every reading it cited is gone because a person re-typed the document it was read from. Its quote follows the same withholding as FieldProvenanceCitation.quote. |
confidence - Float
|
The winning citation row's measured OCR confidence, 0-1. |
document - LoanDocument
|
The uploaded file the winning citation anchors into: where to open the document that proves this value. Its id is the id of the uploaded FILE. It is not the documentId of a losing reading, which names how a file was read (one file can be read as several documents), so the two ids do not match. Null, never an error, when there is nothing to show you: alongside author and citation, when the citation anchors to no document, without read:document, for a borrower, when the document is on another loan or gone, and for a file the document listing hides from the customer. |
field - String!
|
The LoanApplicationField wire key this record is about (e.g. personalInformation.firstName). |
targetBorrower - Borrower
|
The borrower this field belongs to. Null, with an error, when that borrower is no longer on the loan. |
targetBorrowerId - ID!
|
The borrower this field belongs to. Use targetBorrower { id }.
|
targetEmployment - Employment
|
The employment row this field belongs to, when the write created an employment. |
value - String
|
The field's current value, read from the live borrower or employment row at request time — never cached from a receipt or a citation. |
Example
{
"author": "HUMAN_EDIT",
"authoredAt": "2007-12-03T10:15:30Z",
"authoredBy": FieldProvenanceAuthor,
"candidateSetVersion": "xyz789",
"candidates": [FieldProvenanceCandidate],
"citation": FieldProvenanceCitation,
"confidence": 123.45,
"document": LoanDocument,
"field": "xyz789",
"targetBorrower": Borrower,
"targetBorrowerId": 4,
"targetEmployment": Employment,
"value": "abc123"
}
FieldProvenanceAuthor
Description
Who wrote a field's current value, narrowed to a name. Deliberately NOT the full Contributor: contact details and role stay out of a provenance read.
Example
{"displayName": "xyz789", "id": 4}
FieldProvenanceCandidate
Description
One losing reading's citation for a field: a document that spoke to the field and did not win. Every value here is read from the citation row at the moment of resolution; none is stored anywhere beyond that row.
Fields
| Field Name | Description |
|---|---|
citation - Citation!
|
The citation naming this losing reading. |
citationId - ID!
|
The citation naming this losing reading. Use citation { id }.
|
confidence - Float
|
The citation's measured OCR confidence, 0-1. |
document - LoanDocument
|
The uploaded file this losing reading came from. Its id is the id of the uploaded FILE, while this reading's documentId names how that file was read (one file can be read as several documents), so the two ids do not match. Null, never an error, when there is nothing to show you: when the citation anchors to no document, without read:document, for a borrower, when the document is on another loan or gone, and for a file the document listing hides from the customer. |
documentId - ID
|
How the document the citation anchors into was read, when it anchors to one: the id of that reading, which is NOT the id of the uploaded file (one file can be read as several documents). Use document { id } for the file's id. |
value - String
|
The candidate's own value, derived from its citation row at read time. It is withheld (null) from a borrower, and from an outside party limited to their assigned loans, when it was read from a document the document listing hides from the customer, such as a lock confirmation or underwriting summary. Your own lending team still sees it. |
Example
{
"citation": Citation,
"citationId": 4,
"confidence": 987.65,
"document": LoanDocument,
"documentId": 4,
"value": "xyz789"
}
FieldProvenanceCitation
Description
Where a field-provenance citation locates its evidence, and what it quotes — derived from the citation row at read time, never cached.
Fields
| Field Name | Description |
|---|---|
page - Int
|
1-based page number. |
pageHeight - Float
|
Set only at REGION precision. |
pageWidth - Float
|
Set only at REGION precision. |
polygon - [PagePoint!]
|
Set only at REGION precision. |
precision - FieldProvenanceCitationPrecision!
|
Which fields below are meaningful. |
quote - String
|
What the citation quotes, read from the citation row fresh on every resolution. May carry data from the mortgage document itself (e.g. a name, an address) — never logged, never cached, never persisted anywhere beyond the citation row it already lived in. It is withheld (null) from a borrower, and from an outside party limited to their assigned loans, when it was read from a document the document listing hides from the customer, such as a lock confirmation or underwriting summary. Your own lending team still sees it. Every digit of a long number (an SSN, an account number) but its last four reads as *, and a quote is at most 160 characters. |
Example
{
"page": 123,
"pageHeight": 123.45,
"pageWidth": 987.65,
"polygon": [PagePoint],
"precision": "PAGE",
"quote": "xyz789"
}
FieldProvenanceCitationPrecision
Description
How precisely a field-provenance citation locates its evidence: REGION (a polygon on a page), PAGE (a page number alone), or TEXT (a quote with no page).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PAGE"
FieldProvenanceInput
Description
Scope for a field-provenance read.
Fields
| Input Field | Description |
|---|---|
loanId - ID
|
The ID or friendly ID of the loan. Provide this or the deprecated loanApplicationId, not both. The loan whose field provenance to report. |
Example
{"loanId": "4"}
FieldProvenanceResolutionStatus
Description
The result of an evidence-bound contested-field resolution. STALE_CANDIDATE_SET means no borrower value or receipt was written; reload the field before asking a person to choose again — a retry of the SAME request can succeed once it does. The other non-RESOLVED statuses are permanent refusals of this exact request: UNSUPPORTED_FIELD (no write mapping for field), EMPTY_CITATION_TEXT (the selected citation has no usable text), CANDIDATE_DOCUMENT_MISMATCH (the citation no longer matches the claimed document), BORROWER_LOAN_MISMATCH (the borrower is not on this loan), and HUMAN_EDIT_EXISTS (a person already edited this exact field outside this flow, which permanently forecloses automated resolution of it). None of these five are resolved by reloading and resubmitting the identical request; each needs a different citation, field, or borrower — HUMAN_EDIT_EXISTS needs a person to resolve the field directly instead.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_LOAN_MISMATCH"
FinancialAccountActivity
Description
Activity associated with a financial account asset
Fields
| Field Name | Description |
|---|---|
activityType - FinancialAccountActivityType
|
Activity type |
amount - Int
|
The amount of money in dollars |
date - Date
|
The date when the activity occurred |
description - String
|
Description of the activity |
id - ID!
|
The ID of the FinancialAccountActivity |
Example
{
"activityType": "LARGE_DEPOSIT",
"amount": 123,
"date": "2007-12-03",
"description": "abc123",
"id": "4"
}
FinancialAccountActivityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LARGE_DEPOSIT"
FinancialAccountAsset
Description
Interface for financial account assets
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Asset ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Possible Types
| FinancialAccountAsset Types |
|---|
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "xyz789",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
FixedAmountPurchasePricingInput
Fields
| Input Field | Description |
|---|---|
amortizationTypes - [PricingAmortizationType!]
|
The amortization types to price. Defaults to fixed-only; request ADJUSTABLE_RATE (typically in a separate sequential call) to price ARM products, so one request never solves both halves of the sheet at once. Default = [FIXED] |
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt
|
Monthly homeowners association dues in dollars. When omitted, pricing behaves as if the property has no HOA dues. |
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean!
|
|
loanAmount - NonNegativeInt!
|
The desired loan amount in dollars. Pins the solver to this exact loan amount and the out-of-pocket cost is derived from it. |
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
numberOfUnits - NonNegativeInt
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
pricingConstraints - FixedPricingConstraints
|
|
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Whether property taxes and insurance are included in the monthly payment (impounded). Defaults to impounded when omitted. |
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"amortizationTypes": ["ADJUSTABLE_RATE"],
"concessions": 123,
"fipsCountyCode": "abc123",
"hoaDues": 123,
"isBorrowerSelfEmployed": true,
"isFirstTimeHomeBuyer": true,
"loanAmount": 123,
"loanTermYears": 987.65,
"monthlyDebt": 987.65,
"monthlyIncome": 987.65,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"objectiveIntent": "MIN_DOWN_PAYMENT",
"pricingConstraints": FixedPricingConstraints,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rateLockDays": 987.65,
"salesContractAmount": 123
}
FixedPricingConstraints
Fields
| Input Field | Description |
|---|---|
applyOutOfPocketToLoan - Boolean
|
Represents if Out Of Pocket cash will be applied to reduce loan cost |
closingCosts - NonNegativeFloat
|
The maximum allowable closing costs. |
downPaymentAmount - NonNegativeFloat
|
The down payment amount. |
maxDiscountPoints - Float
|
Limit number of rate point buys to not exceed this value. |
maxOutOfPocket - NonNegativeFloat
|
Out of pocket maximum in dollars. |
monthlyPayment - NonNegativeFloat
|
The maximum allowable monthly payment. |
monthlyPaymentAsPercentageOfIncome - Boolean!
|
Interpret monthly payment field as a percentage instead of dollar amount. Default = false |
mortgageInsurance - Boolean
|
Indicates whether mortgage insurance is required. |
principal - NonNegativeFloat
|
The maximum allowable principal amount. |
rate - NonNegativeFloat
|
The preferred interest rate as a percentage (e.g., 5.0 for 5%). |
rollInClosingCosts - Boolean
|
Represents if closing costs will be rolled into loan amount on a ReFi |
totalCost - Float
|
The cost of points for the loan. |
totalPoints - NonNegativeFloat
|
The number of points required for the loan. |
Example
{
"applyOutOfPocketToLoan": false,
"closingCosts": 123.45,
"downPaymentAmount": 123.45,
"maxDiscountPoints": 987.65,
"maxOutOfPocket": 123.45,
"monthlyPayment": 123.45,
"monthlyPaymentAsPercentageOfIncome": false,
"mortgageInsurance": true,
"principal": 123.45,
"rate": 123.45,
"rollInClosingCosts": true,
"totalCost": 123.45,
"totalPoints": 123.45
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FloatStructureInput
Description
Input to the floatStructure mutation.
Example
{
"loanId": "4",
"overrideIneligibility": true
}
FloatStructureResponse
Description
Response of the floatStructure mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRunId - ID!
|
The ID of the initial-disclosures run dispatched by this call. Disclosure generation runs asynchronously, so a successful mutation only means the run was enqueued — poll disclosuresRunStatus with this ID to observe whether the package was actually sent or failed (including the failure reason). |
loan - Loan!
|
The loan whose product structure was floated. |
loanId - ID!
|
The ID or friendly ID of the loan. Use loan { id }.
|
Example
{"disclosuresRunId": 4, "loan": Loan, "loanId": 4}
FloodMutations
Description
Root type for flood mutations.
Fields
| Field Name | Description |
|---|---|
cancelFlood - CancelFloodResponse
|
Cancel a flood determination order. |
Arguments
|
|
orderFlood - OrderFloodResponse
|
Order a flood determination for a loan. |
Arguments
|
|
Example
{
"cancelFlood": CancelFloodResponse,
"orderFlood": OrderFloodResponse
}
FloodOrder
Description
A flood determination order placed with a vendor to determine whether a property lies within a designated flood zone.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime!
|
When the order was created. |
id - ID!
|
Unique identifier of the flood order. |
loan - Loan!
|
Loan the order belongs to. |
loanApplicationId - ID!
|
Loan application the order belongs to. Use loan { id }.
|
result - FloodResult
|
Parsed determination result, once the order is completed. |
status - FloodOrderStatusEnum!
|
Current status of the flood order. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"id": "4",
"loan": Loan,
"loanApplicationId": "4",
"result": FloodResult,
"status": "CANCELLED"
}
FloodOrderStatusEnum
Description
Status of a flood order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
FloodProductType
Description
Type of flood determination product to order. Basic products are a one-time determination; Life of Loan products are monitored for the life of the loan.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Basic"
FloodQueries
Description
Root type for flood queries.
Fields
| Field Name | Description |
|---|---|
floodOrder - FloodOrder
|
Look up a flood determination order by its ID. |
Arguments
|
|
Example
{"floodOrder": FloodOrder}
FloodResult
Description
Parsed determination result from a completed flood order. Fields are nullable as they are only populated once the vendor returns a result.
Fields
| Field Name | Description |
|---|---|
floodCertificationIdentifier - String
|
Vendor-issued flood certification identifier. |
floodPartialIndicator - Boolean
|
Whether the property is only partially within the flood zone. |
floodProductCertifyDate - Date
|
When the flood product certification was issued. |
nfipCommunityIdentifier - String
|
Identifier of the NFIP community the property belongs to. |
nfipCommunityName - String
|
Name of the NFIP community the property belongs to. |
nfipCommunityParticipationStatusType - String
|
NFIP flood program the community participates in (e.g. Regular, Emergency, NonParticipating). |
nfipFloodDataRevisionType - String
|
Type of flood-map revision FEMA issued (LOMA amendment or LOMR revision); null means no revision. |
nfipFloodZoneIdentifier - String
|
NFIP flood zone the property falls within. |
nfipMapPanelDate - Date
|
Effective date of the NFIP flood map panel. |
nfipMapPanelIdentifier - String
|
Identifier of the NFIP flood map panel covering the property. |
nfipMapPanelSuffixIdentifier - String
|
Suffix of the NFIP flood map panel identifier. |
protectedAreaIndicator - Boolean
|
Whether the property is in a federally protected area (CBRA / Otherwise Protected Area). |
specialFloodHazardAreaIndicator - Boolean
|
Whether the property lies within a Special Flood Hazard Area (SFHA). |
Example
{
"floodCertificationIdentifier": "xyz789",
"floodPartialIndicator": false,
"floodProductCertifyDate": "2007-12-03",
"nfipCommunityIdentifier": "xyz789",
"nfipCommunityName": "xyz789",
"nfipCommunityParticipationStatusType": "xyz789",
"nfipFloodDataRevisionType": "xyz789",
"nfipFloodZoneIdentifier": "xyz789",
"nfipMapPanelDate": "2007-12-03",
"nfipMapPanelIdentifier": "abc123",
"nfipMapPanelSuffixIdentifier": "xyz789",
"protectedAreaIndicator": true,
"specialFloodHazardAreaIndicator": false
}
ForceGenerateDisclosurePackageInput
Description
Input to the forceGenerateDisclosurePackage mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID of the loan. |
stage - DisclosuresStage!
|
The disclosure stage to generate (INITIAL_DISCLOSURES, REDISCLOSURES, CLOSING_DISCLOSURES, ADVERSE_ACTION_DISCLOSURES). |
Example
{
"loanId": "4",
"stage": "ADVERSE_ACTION_DISCLOSURES"
}
ForceGenerateDisclosurePackageResponse
Description
Response of the forceGenerateDisclosurePackage mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRunId - ID!
|
The ID of the disclosure run created. |
Example
{"disclosuresRunId": "4"}
ForceIcdSendInput
Description
Input to the loan.forceIcdSend mutation.
Fields
| Input Field | Description |
|---|---|
bypassedItems - [IcdForcedSendBypassedItemInput!]!
|
Every item being bypassed, each named once: exactly the items that are BLOCKED or PRESENCE_ONLY in those evaluations. |
evaluationIds - [OpaqueToken!]!
|
The IcdReadinessGate.evaluationId of every gate, as read before forcing. Refused unless they are still the loan's current evaluations. |
loanId - ID!
|
The ID or friendly ID of the loan. |
reason - String!
|
Why the initial CD should go out although readiness blocks it. Shown to the closer who finishes the bypassed items. |
Example
{
"bypassedItems": [IcdForcedSendBypassedItemInput],
"evaluationIds": [OpaqueToken],
"loanId": "4",
"reason": "abc123"
}
ForceIcdSendResponse
Description
Response of the loan.forceIcdSend mutation.
Fields
| Field Name | Description |
|---|---|
forcedSend - IcdForcedSend
|
The recorded forced send; null when it was refused. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the loan.forceIcdSend mutation. |
Example
{
"forcedSend": IcdForcedSend,
"userErrors": [UserError]
}
FosterCareIncome
Description
Foster care income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
FraudNotRunBlocker
Description
Fraud check has not been run
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "xyz789"}
FreezeLoanInput
Description
Input to the freeze mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": 4}
FreezeLoanResponse
Description
Response of the freeze mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan |
Example
{"loan": Loan}
FulfillmentOption
Description
A path to satisfying a requirement. Multiple options represent alternatives (OR semantics).
Fields
| Field Name | Description |
|---|---|
description - String!
|
What this path involves — enough context for the consumer to decide. |
name - String!
|
Short name for this path, e.g. "Upload W2", "Payroll connection". |
requirements - [Requirement!]!
|
Sub-requirements for this option. Each carries its own phase - a partially-satisfied composite lists SatisfiedRequirement children alongside OpenRequirement ones. Empty when the option itself is directly actionable. |
satisfied - Boolean!
|
Whether this fulfillment path has been completed. |
Possible Types
| FulfillmentOption Types |
|---|
Example
{
"description": "xyz789",
"name": "abc123",
"requirements": [Requirement],
"satisfied": false
}
FulfillmentParty
Description
FulfillmentParty
Fields
| Field Name | Description |
|---|---|
company - Company
|
The associated company. |
companyId - ID
|
The ID of the associated company Use company { id }.
|
fulfillmentParty - FulfillmentParty
|
|
id - ID!
|
The ID of the FulfillmentParty |
role - FulfillmentPartyRole
|
The role of the fulfillment party |
Example
{
"company": Company,
"companyId": 4,
"fulfillmentParty": FulfillmentParty,
"id": "4",
"role": "NOTARY"
}
FulfillmentPartyMutations
Description
FulfillmentParty mutations
Fields
| Field Name | Description |
|---|---|
create - CreateFulfillmentPartyResponse
|
|
Arguments
|
|
delete - DeleteFulfillmentPartyResponse
|
|
Arguments
|
|
Example
{
"create": CreateFulfillmentPartyResponse,
"delete": DeleteFulfillmentPartyResponse
}
FulfillmentPartyRole
Description
The role of the fulfillment party
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOTARY"
FulfillmentResolution
Description
How a requirement was resolved. The completed-side counterpart to FulfillmentOption.
Fields
| Field Name | Description |
|---|---|
assertions - [Assertion!]!
|
The satisfying assertion(s) pinned at resolution time. |
description - String!
|
Human-readable summary, e.g. "Verified via uploaded W2 and paystub". |
method - String!
|
Stable identifier for the resolution method: "DOCUMENT_UPLOAD", "DATA_ENTRY", "SYSTEM", etc. Superseded by assertions. Retained temporarily for already-shipped clients and removed after one release.
|
Possible Types
| FulfillmentResolution Types |
|---|
Example
{
"assertions": [Assertion],
"description": "abc123",
"method": "xyz789"
}
FundingActivityEntry
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan this activity belongs to. |
wireIn - FundingActivityLeg!
|
|
wireOut - FundingActivityLeg!
|
Example
{
"loan": Loan,
"wireIn": FundingActivityLeg,
"wireOut": FundingActivityLeg
}
FundingActivityLeg
Fields
| Field Name | Description |
|---|---|
adjustments - [FundingAdjustment!]!
|
The adjustments Pylon recorded on this leg inside the window, oldest record first. Empty for wire-out. |
completedAt - DateTime
|
When the wire-in purchase was completed within this activity window. Null for wire-out or no completion in the window. |
issuedFigures - [FundingFigure!]!
|
The figures this leg issued inside the window, oldest issue first. A figure appears here once, on the window that contains its issuedAt, even if a later window supersedes it. |
latestIssuedAt - DateTime
|
The newest issuedAt inside the window, or null when the leg issued no figure in it. |
latestRecordedAt - DateTime
|
The newest recordedAt of a remittance, correction or adjustment inside the window, or null when the leg recorded nothing in it. |
remittances - [FundingRemittance!]!
|
The remittances and corrections Pylon recorded on this leg inside the window, oldest record first. |
Example
{
"adjustments": [FundingAdjustment],
"completedAt": "2007-12-03T10:15:30Z",
"issuedFigures": [FundingFigure],
"latestIssuedAt": "2007-12-03T10:15:30Z",
"latestRecordedAt": "2007-12-03T10:15:30Z",
"remittances": [FundingRemittance]
}
FundingActivityPage
Fields
| Field Name | Description |
|---|---|
entries - [FundingActivityEntry!]!
|
Loans with funding activity in the window, ordered by loan identifier. A page holds first loans unless it is the last page. |
next - String
|
Pass as after to read the next page. Null when the walk has reached the end. |
windowEnd - DateTime!
|
The exclusive upper bound this walk reports through: the requested to, or the time the walk started when to is in the future. Every page of one walk uses this same bound, so activity recorded during the walk cannot shift a page. |
Example
{
"entries": [FundingActivityEntry],
"next": "abc123",
"windowEnd": "2007-12-03T10:15:30Z"
}
FundingAdjustment
Description
A signed true-up recorded after a wire-in purchase was completed. It changes the wire balance without changing the figure, remittances or completion it refers to.
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount!
|
The signed amount. A positive amount adds to the net amount of the figure it refers to and a negative amount reduces it. |
category - FundingAdjustmentCategory!
|
What the adjustment is for. |
effectiveDate - Date!
|
The accounting date the adjustment belongs to, assigned when it was recorded. It does not depend on when it was recorded. |
figure - FundingFigure!
|
The completed wire-in figure this adjustment refers to. |
id - ID!
|
|
recordedAt - DateTime!
|
Example
{
"amount": MonetaryAmount,
"category": "ESCROW",
"effectiveDate": "2007-12-03",
"figure": FundingFigure,
"id": "4",
"recordedAt": "2007-12-03T10:15:30Z"
}
FundingAdjustmentCategory
Description
What a post-purchase adjustment is for.
Values
| Enum Value | Description |
|---|---|
|
|
A true-up of non-pass-through escrow amounts. |
|
|
A true-up of non-pass-through fees. |
|
|
A true-up of interest, such as a missing day. |
Example
"ESCROW"
FundingAvailability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLOCKED"
FundingBalanceState
Description
Where a wire leg's recorded transfers stand against its current figure plus adjustments.
Values
| Enum Value | Description |
|---|---|
|
|
Recorded transfers exceed the current figure plus adjustments. The excess is an expected return, shown in expectedReturnAmount, until an adjustment, figure or recorded transfer changes the balance. |
|
|
Recorded transfers are below the current figure plus adjustments. |
|
|
Recorded transfers equal the current figure plus adjustments. This does not mean the purchase is complete; read wireIn.settlementStatus for that. |
Example
"EXPECTED_RETURN"
FundingBlockedReason
Fields
| Field Name | Description |
|---|---|
code - FundingBlockedReasonCode!
|
|
description - String!
|
A fixed explanation of the code, safe to show to a user. |
Example
{
"code": "CAUSE_UNAVAILABLE",
"description": "xyz789"
}
FundingBlockedReasonCode
Description
Why a wire leg is blocked, as a kind of input rather than a specific field. More codes will be added, so treat a code you do not know as CAUSE_UNAVAILABLE.
Values
| Enum Value | Description |
|---|---|
|
|
This figure is blocked, and the specific cause could not be determined. |
|
|
A closing cost needed to calculate this figure has a value that cannot be used. |
|
|
A closing cost needed to calculate this figure is incomplete. |
|
|
The disbursement amount for the loan has a value that cannot be used. |
|
|
The disbursement amount for the loan has not been provided. |
|
|
The disbursement date for the loan is not a valid date. |
|
|
The disbursement date for the loan has not been provided. |
|
|
Escrow details needed to calculate this figure have a value or date that cannot be used. |
|
|
Escrow details needed to calculate this figure have not been provided. |
|
|
The date of the loan's first payment is not a valid date. |
|
|
The date of the loan's first payment has not been provided. |
|
|
An input needed to calculate this figure has a value that cannot be used. |
|
|
An input needed to calculate this figure has not been provided. |
|
|
A loan term needed to calculate this figure has a value that cannot be used. |
|
|
A loan term needed to calculate this figure, such as the loan amount, rate or term, has not been provided. |
|
|
A pricing detail needed to calculate this figure has a value that cannot be used. |
|
|
A pricing detail needed to calculate this figure has not been provided. |
|
|
Seller terms needed to calculate this figure have a value that cannot be used. |
|
|
Seller terms needed to calculate this figure are not set up yet. They are set up on our side, so contact support if the figure stays blocked. |
Example
"CAUSE_UNAVAILABLE"
FundingClosingFeeType
Description
The stable type of an itemized closing cost.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ApplicationFee"
FundingConcessionDetails
Fields
| Field Name | Description |
|---|---|
appliedRatePercent - Float!
|
A signed percentage equivalent to the recorded concession, for example -1.66 for a 1.66% deduction. The line amount is authoritative. |
calculationBasisAmount - MonetaryAmount!
|
The original principal basis for the equivalent concession rate. Do not add this basis to the figure total. |
Example
{
"appliedRatePercent": 987.65,
"calculationBasisAmount": MonetaryAmount
}
FundingCorrectionReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DUPLICATE_REPORT"
FundingDayCountConvention
Values
| Enum Value | Description |
|---|---|
|
|
Actual calendar days and a 360-day year. Used by the wire-out interestDetails. |
|
|
A 30-day accounting month and a 360-day year, counted by the rule on FundingWireInInterestDetails.dayCount. Used by the wire-in wireInInterestDetails. It is not claimed to match 30/360 US, 30E/360 or ISDA conventions. |
Example
"ACTUAL_360"
FundingEconomics
Fields
| Field Name | Description |
|---|---|
appliedConcessionAmount - MonetaryAmount!
|
The signed sum of the wire-in CONCESSION lines. |
interestIncomeAmount - MonetaryAmount!
|
The interest the seller keeps: the prepaid interest the wire out holds back at closing plus the signed wire-in INTEREST_TRANSFERRED line. A retained first payment adds nothing of its own. That line is negative when the seller hands interest over at sale and positive when Pylon pays interest to the seller. |
lenderMarginAmount - MonetaryAmount
|
The seller's contractual margin, from the original loan principal and seller rate recorded with the contributing wire-in figure, rounded to cents. Null when the recorded inputs cannot supply it. |
lenderNetMarginAfterPrepaidsAmount - MonetaryAmount
|
Seller margin plus the signed applied concession and the prepaid margin credit. Null when the contributing figure cannot supply a component. |
netProceedsAtClosingAmount - MonetaryAmount!
|
Net proceeds at closing: the loan amount less the current wire-out figure, which is what the wire out holds back at closing, such as points, fees, escrow and prepaid interest. Some of it comes back in the wire in, so read it together with netProceedsAtSaleAmount. |
netProceedsAtSaleAmount - MonetaryAmount!
|
Net proceeds at sale: the current wire-in figure less the purchased unpaid principal balance. Negative when Pylon pays less than the balance it buys. |
prepaidBalanceAfterDrawAmount - MonetaryAmount
|
The prepaid balance left right after the contributing figure drew. Recorded when the figure was issued and unchanged by later activity. Null for a figure issued before it was recorded, unless its recorded cost and applied credits prove the draw exhausted the balance, which is zero. |
prepaidCreditsUsedAmount - MonetaryAmount!
|
The sum of the wire-in PLATFORM_FEE_CREDIT, DELIVERY_FEE_CREDIT and PREPAID_ADJUSTMENT lines: the credits applied, less any the seller's prepaid balance did not cover. |
prepaidMarginAmount - MonetaryAmount
|
The prepaid credit applied to the loan's margin component, after any contract-balance cap. Null when the contributing figure cannot identify the amount. |
totalNetProceedsAmount - MonetaryAmount!
|
netProceedsAtClosingAmount plus netProceedsAtSaleAmount, less escrow paid out before purchase: the seller's net across both wires. The wire-in escrow transfer line already subtracts that payout, so this term puts the total on the worksheet figure. A retained first payment adds nothing of its own.
|
wireInFigure - FundingFigure!
|
The wire-in figure this statement was computed from. |
wireOutFigure - FundingFigure!
|
The wire-out figure this statement was computed from. |
Example
{
"appliedConcessionAmount": MonetaryAmount,
"interestIncomeAmount": MonetaryAmount,
"lenderMarginAmount": MonetaryAmount,
"lenderNetMarginAfterPrepaidsAmount": MonetaryAmount,
"netProceedsAtClosingAmount": MonetaryAmount,
"netProceedsAtSaleAmount": MonetaryAmount,
"prepaidBalanceAfterDrawAmount": MonetaryAmount,
"prepaidCreditsUsedAmount": MonetaryAmount,
"prepaidMarginAmount": MonetaryAmount,
"totalNetProceedsAmount": MonetaryAmount,
"wireInFigure": FundingFigure,
"wireOutFigure": FundingFigure
}
FundingFeeSplit
Fields
| Field Name | Description |
|---|---|
nonPassthroughAmount - MonetaryAmount!
|
The signed share of the line that is fees that stay with the seller. Together with passthroughAmount it equals the line amount. |
passthroughAmount - MonetaryAmount!
|
The signed share of the line that is passthrough fees. Together with nonPassthroughAmount it equals the line amount. |
Example
{
"nonPassthroughAmount": MonetaryAmount,
"passthroughAmount": MonetaryAmount
}
FundingFeeSplitRole
Description
Whether a netted fee is owed to Pylon or stays with the seller. Explanatory metadata: sum line amounts, not items.
Values
| Enum Value | Description |
|---|---|
|
|
A fee the borrower pays at closing that stays with the seller. |
|
|
A fee the borrower pays at closing that is owed to Pylon; the seller collects it at closing and passes it on at purchase. |
Example
"NON_PASSTHROUGH"
FundingFigure
Fields
| Field Name | Description |
|---|---|
disclosedDisbursementDate - Date
|
The scheduled disbursement date disclosed when this wire-out figure was issued. This is null for wire-in figures or when the date is unavailable. |
effectiveDate - Date
|
The date Pylon used to price a wire-out figure, or the purchase date for a wire-in figure. |
id - ID!
|
The immutable figure identifier. |
issuedAt - DateTime!
|
The time when Pylon first made this figure current. |
lines - [FundingFigureLine!]
|
The accounting breakdown for this figure. This field always returns an array. It is empty when a valid breakdown cannot be reconstructed from the stored inputs. Components are still returned when their sum differs from netAmount; read linesReconciliation to learn whether they add up instead of summing them yourself. Always use netAmount as the amount to wire. The GraphQL type remains nullable for backward compatibility. |
linesReconciliation - FundingLinesReconciliation
|
Whether lines add up to netAmount, judged from the same stored inputs the lines were built from. This does not affect the figure's availability. The GraphQL type is nullable for backward compatibility; the server always returns a value. |
linesUnavailableReason - FundingLinesUnavailableReason
|
Why the breakdown could not be reconstructed. Present when linesReconciliation is UNAVAILABLE; otherwise null, including when returned lines are NON_RECONCILING. This does not affect netAmount or the figure's availability. |
netAmount - MonetaryAmount!
|
The full amount required for this figure. |
pinnedInputs - FundingFigurePinnedInputs
|
The loan terms recorded with this figure and, for a wire-in figure, the calculation evidence it was priced from. Null when the stored inputs cannot be read. A wire-out figure carries only its loan amount, note rate and first payment date, as recorded with it rather than the values its amount is computed from; termMonths, paymentStripCount, upbConfirmation and purchasedUnpaidPrincipalBalanceAmount are null. |
pricedFundingDate - Date
|
The date Pylon used to price this figure, when it was priced for one. For a wire-out figure it is the scheduled disbursement date, or the funded date for older figures. It is null for wire-in figures and for wire-out figures that were not priced for a funding date. |
recipientName - String
|
The recipient for this figure, when known. |
retainedFirstPayment - FundingRetainedFirstPaymentStatus!
|
Whether the issued wire-in calculation retained the first borrower payment. |
retainedFirstPaymentDetails - FundingRetainedFirstPaymentDetails
|
The components of a retained first payment, already included in the figure; do not add them to netAmount or lines. Null unless retainedFirstPayment is RETAINED; may also be null when RETAINED but the stored inputs cannot supply the breakdown. |
status - FundingFigureStatus!
|
In a historical settlement read, this figure's status at the requested instant. In a latest settlement read, its status within that read's consistent view. Activity figures show their status when read; the activity feed has no separate event for a prior figure's status change or a withdrawal without a new issuance. |
supersededReason - FundingFigureSupersededReason
|
Why this figure replaced the prior figure. Null when this is the first issued figure. |
supersedesFigureId - ID
|
The issued figure that this figure replaced. |
versionNumber - Int!
|
This figure's position among the figures issued on its wire leg: 1 for the first, one more for each later figure. It follows the order of figures. |
Example
{
"disclosedDisbursementDate": "2007-12-03",
"effectiveDate": "2007-12-03",
"id": 4,
"issuedAt": "2007-12-03T10:15:30Z",
"lines": [FundingFigureLine],
"linesReconciliation": "NON_RECONCILING",
"linesUnavailableReason": "CALCULATION_INCOMPLETE",
"netAmount": MonetaryAmount,
"pinnedInputs": FundingFigurePinnedInputs,
"pricedFundingDate": "2007-12-03",
"recipientName": "xyz789",
"retainedFirstPayment": "NOT_APPLICABLE",
"retainedFirstPaymentDetails": FundingRetainedFirstPaymentDetails,
"status": "FINAL",
"supersededReason": "CALCULATION_REVISION",
"supersedesFigureId": "4",
"versionNumber": 123
}
FundingFigureLine
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount!
|
The signed contribution to the figure total. Positive amounts add and negative amounts subtract. |
code - FundingFigureLineCode!
|
The stable accounting category for this amount. |
concessionDetails - FundingConcessionDetails
|
An equivalent concession rate and principal basis, when available for a wire-in CONCESSION line. Null on other lines or when unavailable. Use the line amount for reconciliation. |
feeSplit - FundingFeeSplit
|
The passthrough and non-passthrough parts of a wire-out NETTED_CLOSING_COSTS line. Null for other lines, for figures calculated before the split was recorded, and when any netted cost has no recorded fee type or is not a passthrough or non-passthrough fee. This is explanatory metadata; sum only line amounts to reconcile the figure. |
interestDetails - FundingInterestDetails
|
The recorded inputs for the full prepaid-interest period. Per diem times day count can exceed the line's deducted amount when part of the interest was paid before closing or by another payer. Null for other line codes or when the stored source does not describe one internally consistent interest period. |
items - [FundingFigureLineItem!]
|
The source costs included in this aggregate line. Null when the figure predates itemization or the amount was entered as an aggregate override. |
wireInInterestDetails - FundingWireInInterestDetails
|
The precise daily amount and signed interest period for a wire-in INTEREST_TRANSFERRED line, when available. The line amount remains authoritative. |
Example
{
"amount": MonetaryAmount,
"code": "BORROWER_POINTS",
"concessionDetails": FundingConcessionDetails,
"feeSplit": FundingFeeSplit,
"interestDetails": FundingInterestDetails,
"items": [FundingFigureLineItem],
"wireInInterestDetails": FundingWireInInterestDetails
}
FundingFigureLineCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Negative concession amount recorded by the issued figure, selected from the product structure or an approved override. |
|
|
Positive credit for the recorded delivery-fee margin when prepaid credits apply; zero otherwise. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Negative total of the fees netted against the wire out, as one line. When the figure records a fee split, each item names its passthrough role and feeSplit reports the passthrough and non-passthrough amounts; the split is all or nothing for the line. Both are explanatory, so sum only line amounts. |
|
|
Reserved for the wire out and not yet emitted on any figure: see feeSplit on NETTED_CLOSING_COSTS for fees the borrower pays at closing that stay with the seller. |
|
|
Negative total of fees the borrower pays at closing that are owed to Pylon. The seller collects them at closing and passes them on at purchase. On the wire out this code is reserved and not yet emitted: see feeSplit on NETTED_CLOSING_COSTS. |
|
|
|
|
|
Positive platform-fee credit when prepaid credits apply; zero otherwise. Separate from the platform-fee charge. |
|
|
Negative adjustment that brings the platform-fee and delivery-fee credits down to what the seller's prepaid balance covers, present only when the balance is smaller than their total. The credit lines keep their full amounts, and the three lines sum to the balance. Absent when the balance covers both credits. |
|
|
|
|
|
The remaining purchase-date price adjustment after a separately shown concession is removed. On a figure that carries the PYLON_MARGIN line it also includes that margin, so the lines still sum to the net amount; older figures keep their earlier amount. |
|
|
|
|
|
Negative margin charge that is included in the price adjustment line. Present on a wire-in figure that carries the margin line whenever a Pylon margin percent was recorded, including a zero margin; the delivery-fee credit line returns it when the approved credit selection applies. |
|
|
|
|
|
Example
"BORROWER_POINTS"
FundingFigureLineItem
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount!
|
The signed contribution to the parent line. Positive amounts add and negative amounts subtract. |
closingDisclosureSection - IntegratedDisclosureSectionType
|
The Closing Disclosure section, when available. |
feeSplitRole - FundingFeeSplitRole
|
Whether this fee is passthrough (owed to Pylon) or non-passthrough (stays with the seller). Null on every item of a line whose figure does not record the split: when any netted cost has no recorded fee type or is not a passthrough or non-passthrough fee, and for figures calculated before the split was recorded. Explanatory only: sum line amounts, not items. |
feeType - FundingClosingFeeType
|
The stable closing-cost type, when available. |
Example
{
"amount": MonetaryAmount,
"closingDisclosureSection": "DUE_FROM_BORROWER_AT_CLOSING",
"feeSplitRole": "NON_PASSTHROUGH",
"feeType": "ApplicationFee"
}
FundingFigurePinnedInputs
Fields
| Field Name | Description |
|---|---|
calculationRevision - NonNegativeInt!
|
The calculation revision that produced this figure. Figures on different revisions can differ for the same loan. |
interestRate - NonNegativeFloat
|
The annual note rate as a percentage, such as 4.99, recorded with this figure. Null on a wire-out figure recorded before the rate was stored. |
loanAmount - MonetaryAmount
|
The loan amount recorded with this figure, in dollars. |
paymentStripCount - NonNegativeInt
|
The number of payments counted as made before the purchase. Null when the figure has no calculation. |
purchasedUnpaidPrincipalBalanceAmount - MonetaryAmount
|
The unpaid principal balance used, in dollars rounded to cents as the PURCHASED_UNPAID_PRINCIPAL_BALANCE line is. Null when the figure has no calculation. |
scheduledFirstPaymentDate - Date
|
The scheduled first payment date recorded with this figure. |
sourceObservedAt - DateTime!
|
When the values this figure was priced from were last recorded. For a wire-out figure, the latest update time among the loan values it was read from. For a wire-in figure, the time its inputs were recorded. |
termMonths - NonNegativeInt
|
The loan term in months. |
upbConfirmation - FundingUpbConfirmation
|
The recorded payment-count confirmation used for the purchased balance. Null on wire-out figures and when complete matching evidence is not stored, including older wire-in figures. Null means unknown, not unconfirmed. |
Example
{
"calculationRevision": 123,
"interestRate": 123.45,
"loanAmount": MonetaryAmount,
"paymentStripCount": 123,
"purchasedUnpaidPrincipalBalanceAmount": MonetaryAmount,
"scheduledFirstPaymentDate": "2007-12-03",
"sourceObservedAt": "2007-12-03T10:15:30Z",
"termMonths": 123,
"upbConfirmation": FundingUpbConfirmation
}
FundingFigureStatus
Values
| Enum Value | Description |
|---|---|
|
|
The figure currently in force for its wire leg. |
|
|
Pylon withdrew this figure and had not issued a replacement at the time. A withdrawn figure is never the amount to wire; a later figure's supersedesFigureId may point to it. |
|
|
A later figure replaced this one. |
Example
"FINAL"
FundingFigureSupersededReason
Values
| Enum Value | Description |
|---|---|
|
|
The calculation changed while retained source inputs stayed equal. Newly read inputs use this reason only when selected amounts stay equal. Rounding or selection changes can still move the figure's amount. |
|
|
|
|
|
The figure reflects a recognized change in source inputs, including an already-read credit amount becoming known even when selected amounts stay equal. Newly read credit inputs use this reason when they change a selected amount. |
|
|
|
|
|
|
|
|
Example
"CALCULATION_REVISION"
FundingInterestDetails
Fields
| Field Name | Description |
|---|---|
dayCount - NonNegativeInt!
|
The number of actual calendar days charged. |
dayCountConvention - FundingDayCountConvention!
|
Always ACTUAL_360, which uses actual calendar days and a 360-day year to calculate the daily amount. The enum also has THIRTY_DAY_MONTH_360_DAY_YEAR, which wire-out never returns. |
fromDate - Date!
|
The first calendar date included in the interest charge. |
interestRate - NonNegativeFloat!
|
The annual note rate as a percentage, such as 4.99. |
perDiemAmount - MonetaryAmount!
|
The daily interest amount, rounded to the nearest cent before multiplication by day count. |
toDate - Date!
|
The exclusive end date of the interest period. This date is not charged. |
Example
{
"dayCount": 123,
"dayCountConvention": "ACTUAL_360",
"fromDate": "2007-12-03",
"interestRate": 123.45,
"perDiemAmount": MonetaryAmount,
"toDate": "2007-12-03"
}
FundingLinesReconciliation
Description
Whether the lines on a funding figure add up to its netAmount.
Values
| Enum Value | Description |
|---|---|
|
|
The returned lines do not sum to netAmount. Earlier figures may use a different rounding rule, or a component may be missing or inconsistent. netAmount is still the amount to wire. |
|
|
The returned lines sum exactly to netAmount. |
|
|
No breakdown could be reconstructed from the stored inputs, so lines is empty. |
Example
"NON_RECONCILING"
FundingManualFigureOutcome
Values
| Enum Value | Description |
|---|---|
|
|
The entry was recorded as a new figure. |
|
|
The retry key was already recorded. The stored figure is returned unchanged and is still the figure in force. |
|
|
The retry key was already recorded, but a later entry or recalculation has replaced that figure. The stored figure is returned and is no longer in force. |
Example
"CREATED"
FundingMutations
Fields
| Field Name | Description |
|---|---|
completeWireInPurchase - CompleteWireInPurchaseResponse
|
|
Arguments
|
|
correctPrepaidEntry - CorrectPrepaidEntryResponse
|
|
Arguments
|
|
correctWireInRemittance - CorrectWireInRemittanceResponse
|
|
Arguments
|
|
correctWireOutRemittance - CorrectWireOutRemittanceResponse
|
|
Arguments
|
|
enterPrepaidAmount - EnterPrepaidAmountResponse
|
|
Arguments
|
|
recordManualWireOutFigure - RecordManualWireOutFigureResponse
|
|
Arguments
|
|
recordWireInAdjustment - RecordWireInAdjustmentResponse
|
Records a true-up on a completed wire-in purchase. It changes the wire balance while preserving the figure, transfers and completion record. |
Arguments
|
|
recordWireInInputs - RecordWireInInputsResponse
|
|
Arguments
|
|
recordWireInRemittance - RecordWireInRemittanceResponse
|
|
Arguments
|
|
recordWireOutRemittance - RecordWireOutRemittanceResponse
|
Records a bank wire order. During a calculation rollout, FUNDING_CALCULATION_UPDATING in errors[].extensions.errorDetails.code means retry with the same inputs and idempotency key. |
Arguments
|
|
Example
{
"completeWireInPurchase": CompleteWireInPurchaseResponse,
"correctPrepaidEntry": CorrectPrepaidEntryResponse,
"correctWireInRemittance": CorrectWireInRemittanceResponse,
"correctWireOutRemittance": CorrectWireOutRemittanceResponse,
"enterPrepaidAmount": EnterPrepaidAmountResponse,
"recordManualWireOutFigure": RecordManualWireOutFigureResponse,
"recordWireInAdjustment": RecordWireInAdjustmentResponse,
"recordWireInInputs": RecordWireInInputsResponse,
"recordWireInRemittance": RecordWireInRemittanceResponse,
"recordWireOutRemittance": RecordWireOutRemittanceResponse
}
FundingPrepaidBalance
Fields
| Field Name | Description |
|---|---|
availableAmount - MonetaryAmount!
|
What is left after the credits drawn by figures that have not been given back. Negative when a correction took the balance below what was credited. |
enteredAmount - MonetaryAmount!
|
The sum of every row: what has been entered, corrections applied. |
entries - [FundingPrepaidEntry!]!
|
Every row of the seller, oldest first. |
id - ID!
|
The seller this balance belongs to: there is one balance per seller. |
Example
{
"availableAmount": MonetaryAmount,
"enteredAmount": MonetaryAmount,
"entries": [FundingPrepaidEntry],
"id": 4
}
FundingPrepaidEntry
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount!
|
The amount this row adds to the seller balance. A correction row is the signed difference from the entry it corrects. |
correctsEntry - FundingPrepaidEntry
|
The entry this row corrects; null for an original entry. |
enteredBy - String!
|
The Pylon user who entered this row. |
id - ID!
|
|
reason - String
|
Why a correction was made; null for an original entry. |
recordedAt - DateTime!
|
Example
{
"amount": MonetaryAmount,
"correctsEntry": FundingPrepaidEntry,
"enteredBy": "abc123",
"id": "4",
"reason": "abc123",
"recordedAt": "2007-12-03T10:15:30Z"
}
FundingPrepaidEntryOutcome
Description
What a prepaid entry request did.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RECORDED"
FundingPurchaseAdviceRefusalReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BINDING_CHANGED"
FundingPurchaseAdviceStatus
Values
| Enum Value | Description |
|---|---|
|
|
Generation failed. Repeat the recording mutation with the same idempotency key to retry. |
|
|
Generation is pending. Repeat the recording mutation with the same idempotency key later. |
|
|
Generation was refused. Resolve purchaseAdviceRefusalReason before trying again. |
|
|
Generation is in progress. Repeat the recording mutation with the same idempotency key later. |
|
|
The PDF is stored. Repeating the recording mutation returns the stored advice. |
Example
"FAILED"
FundingQueries
Fields
| Field Name | Description |
|---|---|
activity - FundingActivityPage!
|
Every loan that issued a funding figure, recorded a remittance or an adjustment, or completed a wire-in purchase between from (inclusive) and to (exclusive), so a close can take its population from Pylon's records rather than from the caller's own tracker. Read the pages by passing next back as after until it is null. Each entry reports the whole window; changedSince narrows only which loans are reported, so a nightly poll passes the close period as the window and its last run as changedSince. Activity is reported from Pylon's persisted records, so a loan appears for the window its figure was issued in even if a later figure has since replaced it. Activity includes issued figures, recorded remittances, recorded adjustments, and wire-in completion: a loan whose only change was a figure becoming unusable without a replacement being issued is not reported here. first defaults to 50 and a value above 100 is rejected. Requires a credential with access to every loan for the customer; a credential scoped to assigned loans is rejected. |
prepaidBalance - FundingPrepaidBalance!
|
A seller prepaid entries and balance, for Pylon operators: find the id of an entry to correct and confirm that an entry landed. |
Arguments
|
|
Example
{
"activity": FundingActivityPage,
"prepaidBalance": FundingPrepaidBalance
}
FundingRemittance
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount!
|
The signed event amount. Remittances and returns are positive; Pylon correction events are the exact negative of the event they correct. |
correctionReason - FundingCorrectionReason
|
Why Pylon corrected the reported remittance. |
correctsRemittanceId - ID
|
|
effectiveDate - Date
|
The accounting date for a correction. Null for an ordinary remittance. |
figureId - ID!
|
|
fundsOrderedAt - DateTime!
|
|
id - ID!
|
|
kind - FundingRemittanceKind!
|
REMITTANCE for money sent; RETURN_RECEIVED for money that came back. A correction has the kind of the event it corrects. |
recordedAt - DateTime!
|
Example
{
"amount": MonetaryAmount,
"correctionReason": "DUPLICATE_REPORT",
"correctsRemittanceId": 4,
"effectiveDate": "2007-12-03",
"figureId": "4",
"fundsOrderedAt": "2007-12-03T10:15:30Z",
"id": "4",
"kind": "REMITTANCE",
"recordedAt": "2007-12-03T10:15:30Z"
}
FundingRemittanceKind
Description
What a recorded remittance event stands for.
Values
| Enum Value | Description |
|---|---|
|
|
Money sent through the bank toward the figure. The amount is positive; a correction of it is negative. |
|
|
Money that came back after a wire exceeded the figure. The amount is the positive amount returned and it counts against the transferred total; a correction of it is negative. |
Example
"REMITTANCE"
FundingRetainedFirstPaymentDetails
Fields
| Field Name | Description |
|---|---|
escrowDepositRetained - MonetaryAmount!
|
The monthly escrow deposit collected with the retained first payment and included in the escrow transfer. This is the deposit before any escrow disbursements. |
interestRetained - MonetaryAmount!
|
A full 30/360 month of borrower interest on the original loan amount, collected with the retained first payment. This is not the prorated interest transfer or prepaid interest at closing. |
principalRetained - MonetaryAmount!
|
The principal portion of the first payment retained by the seller. Loan amount minus this amount equals the purchased principal line, including its cent rounding. |
Example
{
"escrowDepositRetained": MonetaryAmount,
"interestRetained": MonetaryAmount,
"principalRetained": MonetaryAmount
}
FundingRetainedFirstPaymentStatus
Values
| Enum Value | Description |
|---|---|
|
|
Wire-out figure; first-payment retention does not apply. |
|
|
The first borrower payment was not retained. |
|
|
The seller retained the first borrower payment under the servicing-transfer cutoff. |
|
|
The stored wire-in calculation is unavailable or unsupported. |
Example
"NOT_APPLICABLE"
FundingSettlement
Fields
| Field Name | Description |
|---|---|
asOf - DateTime!
|
The requested historical instant, or the latest source-observation, purchase-status or adjustment recording time. For a latest read, this is an observed-data watermark, not the time the read ran. |
economics - FundingEconomics
|
The seller's per-loan economics, derived from the current wire-out and wire-in figures. Null when economicsUnavailableReason says why. |
economicsUnavailableReason - FundingEconomicsUnavailableReason
|
Why economics is null. Null when economics is present. |
wireIn - FundingWireLeg!
|
|
wireOut - FundingWireLeg!
|
Example
{
"asOf": "2007-12-03T10:15:30Z",
"economics": FundingEconomics,
"economicsUnavailableReason": "CONCESSION_NOT_SEPARATED",
"wireIn": FundingWireLeg,
"wireOut": FundingWireLeg
}
FundingSettlementStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPLETED"
FundingSettlementStatusChange
Fields
| Field Name | Description |
|---|---|
fromStatus - FundingSettlementStatus!
|
|
id - ID!
|
|
recordedAt - DateTime!
|
|
toStatus - FundingSettlementStatus!
|
Example
{
"fromStatus": "COMPLETED",
"id": 4,
"recordedAt": "2007-12-03T10:15:30Z",
"toStatus": "COMPLETED"
}
FundingUpbConfirmation
Fields
| Field Name | Description |
|---|---|
paymentsReceivedBeforePurchase - WireInPaymentsReceivedBeforePurchase!
|
The operator's recorded choice of payments received before purchase. |
scheduledFirstPaymentDate - Date!
|
The scheduled first payment date that the operator confirmed this count against. |
Example
{
"paymentsReceivedBeforePurchase": "FIRST_PAYMENT",
"scheduledFirstPaymentDate": "2007-12-03"
}
FundingWireInInputVersion
Fields
| Field Name | Description |
|---|---|
applyCredits - Boolean!
|
|
concessionAmount - MonetaryAmount
|
|
escrowAtClosing - MonetaryAmount
|
|
globalMarginPercent - NonNegativeFloat
|
Operator-pinned global margin in percentage points: 2.75 means 2.75%. Null when the rate-lock margin lookup was used. |
id - ID!
|
|
monthlyEscrow - MonetaryAmount
|
|
passthroughFees - MonetaryAmount
|
|
paymentsReceivedBeforePurchase - WireInPaymentsReceivedBeforePurchase
|
Payments the seller received before the purchase date, as recorded. Null when no value was stated. |
perLoanPlatformFee - MonetaryAmount!
|
|
purchaseDate - Date!
|
|
recordedAt - DateTime!
|
|
sellerMarginShare - NonNegativeFloat
|
Operator-pinned seller fraction of the global margin: 0.8182 means 81.82%. Null when the rate-lock margin lookup was used. |
totalToleranceCures - MonetaryAmount
|
Example
{
"applyCredits": true,
"concessionAmount": MonetaryAmount,
"escrowAtClosing": MonetaryAmount,
"globalMarginPercent": 123.45,
"id": 4,
"monthlyEscrow": MonetaryAmount,
"passthroughFees": MonetaryAmount,
"paymentsReceivedBeforePurchase": "FIRST_PAYMENT",
"perLoanPlatformFee": MonetaryAmount,
"purchaseDate": "2007-12-03",
"recordedAt": "2007-12-03T10:15:30Z",
"sellerMarginShare": 123.45,
"totalToleranceCures": MonetaryAmount
}
FundingWireInInterestDetails
Fields
| Field Name | Description |
|---|---|
dayCount - Int!
|
The signed number of interest days, counted on a 30-day accounting month. Negative days subtract interest. When the interest month is the purchase month, it is the purchase day minus 1, so a purchase on the 31st counts 30 days. When the interest month is the following month, it is minus (30 minus (purchase day minus 1)): the purchase day through day 30 of its month, so a purchase on the 21st counts -10 days and a purchase on the 31st counts 0 days. |
dayCountConvention - FundingDayCountConvention!
|
THIRTY_DAY_MONTH_360_DAY_YEAR counts every month as 30 days and the year as 360 days. Counting forward from the 1st of the interest month, a purchase on May 31 with May interest gives 30 days; counting back from the purchase day, a purchase on May 31 with June interest gives 0 days. The rule is defined by dayCount, not by a standard convention. |
fromDate - Date!
|
The first day of the interest month. |
interestRate - NonNegativeFloat!
|
The annual note rate as a percentage, such as 4.99. |
perDiemAmount - PreciseDecimal!
|
The daily interest amount before currency rounding: the purchased unpaid principal balance times the annual note rate as a fraction (4.99% is 0.0499), divided by 360. Decimal arithmetic rounds to 40 significant digits, with ties rounded away from zero. The line amount remains authoritative. |
toDate - Date!
|
The purchase date. The period runs from the earlier of fromDate and toDate up to, but not including, the later one, using 30-day months. For positive dayCount, the purchase day is excluded (May 1 to May 21 gives 20 days). When the interest month follows the purchase month, the purchase day is counted unless it is the 31st: May 21 with June interest gives -10 days and May 31 gives 0 days; toDate is before fromDate. |
Example
{
"dayCount": 987,
"dayCountConvention": "ACTUAL_360",
"fromDate": "2007-12-03",
"interestRate": 123.45,
"perDiemAmount": PreciseDecimal,
"toDate": "2007-12-03"
}
FundingWireLeg
Fields
| Field Name | Description |
|---|---|
adjustments - [FundingAdjustment!]!
|
Adjustments recorded by the settlement's as-of instant, oldest first. Empty for wire-out. |
availability - FundingAvailability!
|
Whether this wire leg has a figure that can be used at the settlement's as-of instant. |
balanceState - FundingBalanceState
|
Whether recorded transfers are below (OWED), equal to (SETTLED) or above (EXPECTED_RETURN) the current figure plus adjustments. Null exactly when remainingAmount is null. |
blockedReasons - [FundingBlockedReason!]!
|
Why this leg has no figure. Empty unless availability is BLOCKED, and never empty when it is. |
completedAt - DateTime
|
When Pylon marked the wire-in purchase completed. Null until completion. |
currentFigure - FundingFigure
|
The issued figure current at the settlement's as-of instant. Present only when ready. |
expectedReturnAmount - MonetaryAmount
|
The amount recorded transfers exceed the current figure plus adjustments by. Null unless balanceState is EXPECTED_RETURN. |
figure - FundingFigure
|
An issued figure on this wire leg, or null when the ID does not belong to the leg. |
Arguments
|
|
figures - [FundingFigure!]!
|
Every issued figure for this wire leg, oldest first. |
remainingAmount - MonetaryAmount
|
The current figure amount plus adjustments minus the total remitted amount. Null unless READY. Negative means money is expected back. |
remittances - [FundingRemittance!]!
|
Remittance and correction records recorded by the settlement's as-of instant, oldest first. |
settlementStatus - FundingSettlementStatus
|
The purchase status at the settlement's as-of instant. COMPLETED closes wire-in to further figures; adjustments and their remittances, returns and corrections remain accepted. Null for wire-out or unavailable funding. |
statusChanges - [FundingSettlementStatusChange!]!
|
Recorded status changes through the settlement's as-of instant, oldest first. Empty for wire-out. |
totalAdjustmentAmount - MonetaryAmount!
|
The signed sum of adjustments, included in remainingAmount and separate from totalRemittedAmount. Zero for wire-out. |
totalRemittedAmount - MonetaryAmount!
|
The money sent minus the money returned: remittances add, returns subtract, and a correction cancels the event it corrects. |
Example
{
"adjustments": [FundingAdjustment],
"availability": "BLOCKED",
"balanceState": "EXPECTED_RETURN",
"blockedReasons": [FundingBlockedReason],
"completedAt": "2007-12-03T10:15:30Z",
"currentFigure": FundingFigure,
"expectedReturnAmount": MonetaryAmount,
"figure": FundingFigure,
"figures": [FundingFigure],
"remainingAmount": MonetaryAmount,
"remittances": [FundingRemittance],
"settlementStatus": "COMPLETED",
"statusChanges": [FundingSettlementStatusChange],
"totalAdjustmentAmount": MonetaryAmount,
"totalRemittedAmount": MonetaryAmount
}
GenerateClosingDisclosurePreviewInput
Description
Input to the generateClosingDisclosurePreview mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": 4}
GenerateClosingDisclosurePreviewResponse
Description
Response of the generateClosingDisclosurePreview mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRunId - ID!
|
The ID of the disclosure run created. |
pricedAsOf - DateTime
|
When the rate sheet the previewed figures were priced against was received. |
pricingStale - Boolean!
|
Whether the previewed figures are priced against a superseded rate sheet with no rate lock in force. The preview still renders; surface this as a banner. |
Example
{
"disclosuresRunId": "4",
"pricedAsOf": "2007-12-03T10:15:30Z",
"pricingStale": true
}
GenerateLoanEstimatePreviewInput
Description
Input to the generateLoanEstimatePreview mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID of the loan. |
Example
{"loanId": "4"}
GenerateLoanEstimatePreviewResponse
Description
Response of the generateLoanEstimatePreview mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRunId - ID!
|
The ID of the disclosure run created. |
pricedAsOf - DateTime
|
When the rate sheet the previewed figures were priced against was received. |
pricingStale - Boolean!
|
Whether the previewed figures are priced against a superseded rate sheet with no rate lock in force. The preview still renders; surface this as a banner. |
Example
{
"disclosuresRunId": 4,
"pricedAsOf": "2007-12-03T10:15:30Z",
"pricingStale": false
}
GenerateLockReplacementRedisclosurePreviewInput
Description
Input to the loan.generateLockReplacementRedisclosurePreview mutation.
Fields
| Input Field | Description |
|---|---|
changeRequestDescription - String
|
The standing change request's final description, as confirmRateLock would take it as changeRequestDescription, printed on the preview as the message to the borrower. Refused, as confirmRateLock refuses it, when blank or still holding a bracketed placeholder such as [date]. Omitted prints the description as opened, placeholders included. |
feeChangedCircumstanceReasons - [RedisclosureFeeReasonInput!]
|
The reason chosen for each changed fee in Loan.redisclosureFeeChanges, as confirmRateLock would take them. Omitted previews every fee under the standing change request's reason. Restricted to internal Pylon operators. |
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{
"changeRequestDescription": "abc123",
"feeChangedCircumstanceReasons": [
RedisclosureFeeReasonInput
],
"loanId": "4"
}
GenerateLockReplacementRedisclosurePreviewResponse
Description
Response of the loan.generateLockReplacementRedisclosurePreview mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRun - DisclosuresRunStatus
|
The PREVIEW run generating the package. Null exactly when userErrors is non-empty. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the loan.generateLockReplacementRedisclosurePreview mutation. |
Example
{
"disclosuresRun": DisclosuresRunStatus,
"userErrors": [UserError]
}
GenerateRedisclosurePreviewInput
Description
Input to the loan.generateRedisclosurePreview mutation.
Fields
| Input Field | Description |
|---|---|
changeDescription - String
|
The description of the change, as redisclose would take it as changeDescription, printed on the preview as the message to the borrower. Omitted or blank prints a generic message. |
changedCircumstanceReason - ChangeOfCircumstanceReason!
|
The changed-circumstance reason the redisclosure would be sent under: the one redisclose takes as changedCircumstanceReason or resolves from its changeEvent. |
feeChangedCircumstanceReasons - [RedisclosureFeeReasonInput!]
|
The reason chosen for each changed fee in Loan.redisclosureFeeChanges, as redisclose would take them. Omitted previews every fee under changedCircumstanceReason. |
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{
"changeDescription": "xyz789",
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"feeChangedCircumstanceReasons": [
RedisclosureFeeReasonInput
],
"loanId": "4"
}
GenerateRedisclosurePreviewResponse
Description
Response of the loan.generateRedisclosurePreview mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRun - DisclosuresRunStatus
|
The PREVIEW run generating the package. Null exactly when userErrors is non-empty. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the loan.generateRedisclosurePreview mutation. |
Example
{
"disclosuresRun": DisclosuresRunStatus,
"userErrors": [UserError]
}
GenericUserError
Description
Generic user error
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["abc123"],
"message": "abc123"
}
Geography
Fields
| Field Name | Description |
|---|---|
place - PlaceDetails
|
Address components for a place chosen from placeAutocomplete. Pass the sessionToken used for the autocomplete calls; this fetch ends that session. Null when the place ID is unknown. |
placeAutocomplete - [PlaceAutocompleteSuggestion!]!
|
US street-address autocomplete suggestions for a partial address. Group the keystrokes of one address entry under a single client-generated sessionToken (a UUID) and finish the session by fetching the chosen suggestion's place with the same token. |
usState - UsState!
|
|
Arguments
|
|
Example
{
"place": PlaceDetails,
"placeAutocomplete": [PlaceAutocompleteSuggestion],
"usState": UsState
}
GetAutoConditionalApprovalStatusInput
Fields
| Input Field | Description |
|---|---|
jobId - ID!
|
Example
{"jobId": "4"}
GetAutoConditionalApprovalStatusResponse
Fields
| Field Name | Description |
|---|---|
blockers - [AutoConditionalApprovalBlocker!]
|
|
status - JobStatus!
|
Example
{
"blockers": [AutoConditionalApprovalBlocker],
"status": "FAILED"
}
GetPlaidLayerSessionInput
GetPlaidLayerSessionResponse
Description
Response from processing a Plaid Layer session
Fields
| Field Name | Description |
|---|---|
items - [PlaidLayerItem!]!
|
Items linked during the Layer session |
Example
{"items": [PlaidLayerItem]}
GiftAsset
Description
Gift asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
Node ID |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
source - GiftSource
|
Gift/Grant source |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "xyz789",
"donorPhoneNumber": "abc123",
"id": "4",
"isIncludedInAssetAccount": true,
"isSellerFunded": false,
"nonBorrowerOwnerNames": ["xyz789"],
"qualifiedAmount": 123,
"source": "COMMUNITY_NON_PROFIT",
"verifiedAmount": 123
}
GiftOrGrantAsset
Description
Interface for gift or grant assets
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
Asset ID |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
source - GiftSource
|
Gift/Grant source |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Possible Types
| GiftOrGrantAsset Types |
|---|
Example
{
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "xyz789",
"donorPhoneNumber": "abc123",
"id": 4,
"isIncludedInAssetAccount": true,
"isSellerFunded": false,
"nonBorrowerOwnerNames": ["xyz789"],
"qualifiedAmount": 123,
"source": "COMMUNITY_NON_PROFIT",
"verifiedAmount": 123
}
GiftSource
Description
Gift/Grant source
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMMUNITY_NON_PROFIT"
GiveMessageFeedbackInput
Fields
| Input Field | Description |
|---|---|
messageId - ID!
|
|
note - String
|
|
sentiment - AdvisorSessionAdvisorMessageFeedbackSentiment!
|
Example
{
"messageId": "4",
"note": "abc123",
"sentiment": "NEGATIVE"
}
GiveMessageFeedbackResponse
Fields
| Field Name | Description |
|---|---|
advisorSession - AdvisorSession!
|
Example
{"advisorSession": AdvisorSession}
GlobalLoanOfficer
Description
Global loan officer
Fields
| Field Name | Description |
|---|---|
email - String
|
Email address |
firstName - String
|
First name |
id - ID!
|
The ID of the GlobalLoanOfficer |
lastName - String
|
Last name |
slug - String
|
URL-friendly identifier for the loan officer |
status - LoanOfficerStatus!
|
Whether the loan officer can be assigned new loans in this organization. |
statusChange - LoanOfficerStatusChange
|
The most recent recorded change to this loan officer's status in this organization. Null when none is recorded. A loan officer's status when they were added, and changes made before status history began, may not be recorded, so null does not mean the loan officer is active. |
statusHistory - LoanOfficerStatusChangeConnection
|
Every recorded change to this person's status, newest first, in this organization and in the other organizations that share loan officers with it. Null, with an error, when the loan officer is not in the caller's organization. |
Arguments
|
|
Example
{
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastName": "abc123",
"slug": "abc123",
"status": "ACTIVE",
"statusChange": LoanOfficerStatusChange,
"statusHistory": LoanOfficerStatusChangeConnection
}
GlobalLoanOfficerConnection
Description
A page of an organization's loan officers.
Fields
| Field Name | Description |
|---|---|
edges - [GlobalLoanOfficerEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [GlobalLoanOfficerEdge],
"pageInfo": PageInfo
}
GlobalLoanOfficerEdge
Fields
| Field Name | Description |
|---|---|
cursor - OpaqueToken!
|
|
node - GlobalLoanOfficer!
|
Example
{
"cursor": OpaqueToken,
"node": GlobalLoanOfficer
}
GrantAsset
Description
Grant asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
Node ID |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
source - GiftSource
|
Gift/Grant source |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "abc123",
"donorPhoneNumber": "abc123",
"id": "4",
"isIncludedInAssetAccount": false,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["xyz789"],
"qualifiedAmount": 123,
"source": "COMMUNITY_NON_PROFIT",
"verifiedAmount": 123
}
GuidelineAgency
Description
Agency that published a guideline: FNMA (Fannie Mae), FHLMC (Freddie Mac), FHA, VA, CFPB.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CFPB"
GuidelineReference
Description
A reference to an agency guideline or regulatory section. Structured for filtering and deep-linking.
Fields
| Field Name | Description |
|---|---|
agency - GuidelineAgency!
|
Which agency published this guideline. |
description - String!
|
Human-readable description, e.g. "FNMA B3-3.1-01: Employment Documentation". |
section - String!
|
Guideline section identifier, e.g. "B3-3.1-01". |
url - String
|
URL to the guideline section. Null if no public URL is available. |
Example
{
"agency": "CFPB",
"description": "xyz789",
"section": "abc123",
"url": "abc123"
}
GuidelineViolation
Description
Represents a violation of a prescription in a guideline document.
Fields
| Field Name | Description |
|---|---|
category - GuidelineViolationCategory!
|
The closed-set reason this violation was surfaced, computed from the solve's actual constraint rather than from description/constraint text. Drive UI behavior (for example, offering a credit-pull next step) on this field, never on the free-text ones. |
constraint - String
|
If a violated constraint is found, this is a serialized representation of said constraint. For internal use at Pylon; this field has no guarantees. |
description - String
|
A human-readable description of the encoded guideline. |
document - String
|
The URL for the specific guideline document or the specific section. |
pages - PageRange
|
For document-based guidelines, the page numbers on which a set of guidelines falls. |
section - String
|
The section number and title of the violated guideline. |
updatedAt - Date
|
The last date that Pylon's model was updated to match the guideline document. |
Example
{
"category": "CREDIT_SCORE",
"constraint": "abc123",
"description": "abc123",
"document": "abc123",
"pages": PageRange,
"section": "abc123",
"updatedAt": "2007-12-03"
}
GuidelineViolationCategory
Description
The closed-set reason a GuidelineViolation was surfaced. Consumers must select UI behavior (for example, whether to offer a credit-pull next step) on this field alone, never by inspecting description or constraint — those are free text with no contract to stay stable.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREDIT_SCORE"
HazardInsuranceCoverageType
Description
Coverage provided by a hazard insurer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EARTHQUAKE"
HispanicOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUBA"
HmdaDispositionCode
Description
Code for the HMDA action taken on a loan application.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLICATION_APPROVED_BUT_NOT_ACCEPTED"
HmdaDispositionComparator
Description
Comparisons available on the HMDA disposition code.
Fields
| Input Field | Description |
|---|---|
eq - HmdaDispositionCode
|
|
in - [HmdaDispositionCode!]
|
|
isNull - Boolean
|
|
neq - HmdaDispositionCode
|
|
nin - [HmdaDispositionCode!]
|
|
null - Boolean
|
Example
{
"eq": "APPLICATION_APPROVED_BUT_NOT_ACCEPTED",
"in": ["APPLICATION_APPROVED_BUT_NOT_ACCEPTED"],
"isNull": false,
"neq": "APPLICATION_APPROVED_BUT_NOT_ACCEPTED",
"nin": ["APPLICATION_APPROVED_BUT_NOT_ACCEPTED"],
"null": false
}
HomeBuyingProcess
Description
The stage of the borrower’s home search.
Values
| Enum Value | Description |
|---|---|
|
|
The borrower is looking for a home to purchase. |
|
|
The borrower has entered into a contract to purchase a home. |
Example
"ACTIVELY_LOOKING"
HousingAllowanceIncome
Description
Housing allowance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
HousingChoiceVoucherProgramIncome
Description
Housing Choice Voucher Program income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
IcdFieldAmount
Description
The value of an amount field.
Fields
| Field Name | Description |
|---|---|
amount - MonetaryAmount!
|
Example
{"amount": MonetaryAmount}
IcdFieldDate
Description
The value of a date field.
Fields
| Field Name | Description |
|---|---|
date - Date!
|
Example
{"date": "2007-12-03"}
IcdFieldHistory
Description
What Pylon wrote to the loan record from insurance documents, and what it read back, newest first.
Fields
| Field Name | Description |
|---|---|
verifications - [IcdFieldVerificationEntry!]!
|
The readbacks of the plans in writes, newest first: at most the newest 500. A plan's readback can cover fields it found already in sync, so a field here may have no write. |
writes - [IcdFieldWriteEntry!]!
|
The loan's planned writes, newest first: at most the newest 500. |
Example
{
"verifications": [IcdFieldVerificationEntry],
"writes": [IcdFieldWriteEntry]
}
IcdFieldValue
Description
A loan-record field's value, by the kind of field.
Types
| Union Types |
|---|
Example
IcdFieldAmount
IcdFieldVerificationEntry
Description
One readback of a planned field from the loan system, after a plan was applied.
Fields
| Field Name | Description |
|---|---|
evaluationId - OpaqueToken!
|
|
expected - IcdFieldValue!
|
The planned value. |
field - IcdWritableField!
|
|
observed - IcdFieldValue
|
What the loan system held; null when it held nothing or could not be read. |
reason - IcdFieldVerificationReason
|
Set exactly when the status is not VERIFIED. |
status - IcdFieldVerificationStatus!
|
|
verifiedAt - DateTimeISO!
|
Example
{
"evaluationId": OpaqueToken,
"expected": IcdFieldAmount,
"field": "HOI_ANNUAL_PREMIUM",
"observed": IcdFieldAmount,
"reason": "LOAN_SYSTEM_UNAVAILABLE",
"status": "MISMATCH",
"verifiedAt": "2007-12-03T10:15:30Z"
}
IcdFieldVerificationReason
Description
Why a readback is not VERIFIED.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LOAN_SYSTEM_UNAVAILABLE"
IcdFieldVerificationStatus
Description
Whether the loan system held the planned value when Pylon read it back. PENDING never counts as verified.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MISMATCH"
IcdFieldWriteEntry
Description
One write Pylon planned to a loan-record field, and its result.
Fields
| Field Name | Description |
|---|---|
evaluationId - OpaqueToken!
|
The evaluation whose plan made the write; verifications of the same plan carry the same one. |
field - IcdWritableField!
|
|
outcome - IcdFieldWriteOutcome!
|
|
previousValue - IcdFieldValue
|
What the loan system held when the write ran; null when it held nothing. |
run - IcdReadinessRunSummary
|
The run that made the plan; null when no run on record points to it. |
value - IcdFieldValue!
|
The value the write targeted, from the source document. |
writtenAt - DateTimeISO!
|
Example
{
"evaluationId": OpaqueToken,
"field": "HOI_ANNUAL_PREMIUM",
"outcome": "ALREADY_AT_TARGET",
"previousValue": IcdFieldAmount,
"run": IcdReadinessRunSummary,
"value": IcdFieldAmount,
"writtenAt": "2007-12-03T10:15:30Z"
}
IcdFieldWriteOutcome
Description
What became of one planned write, or of the readback after one. WRITTEN and ALREADY_AT_TARGET (the loan system already held the value) leave the field at the document's value; every SKIPPED_* outcome left it as it was. AUDIT_PASSED, AUDIT_UNREAD and TRIPPED_GUARD record a guarded field read back after a write, which Pylon never writes.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Read back after a write, the guarded field passed its check. |
|
|
The readback of a guarded field after a write could not be read or was not final, so a later run reads it again. |
|
|
The value changed after the plan was made, so it was left as it was. |
|
|
Pylon was not confident enough in the value read from the document, so it was left as it was. |
|
|
The loan system refused to create the row for this field, so Pylon does not try it again for this plan. |
|
|
Pylon has not been able to confirm the row it created for this field over three runs; it keeps trying. |
|
|
Pylon created the row for this field but could not yet confirm the row it made, so it was left for a later run. |
|
|
A field written together with this one was held back, so this one was too. |
|
|
Pylon found the row it created holding a different value from the latest plan, so a later run updates that row. |
|
|
The premium's paid-at-closing and paid-before-closing parts do not add up to the premium. |
|
|
The monthly payment had not synced yet, so Section F was left for a later run. |
|
|
Pylon cannot write this field to the loan system yet. |
|
|
Pylon held back creating this field's row while an earlier row it created of the same kind is unconfirmed or already holds these values. |
|
|
Pylon would have zeroed a row it must not: one it then adds again as a new row of the same kind, one it created, or one it would create only to zero. It wrote none of them. |
|
|
The loan system had no row to write to: the Section F homeowner's insurance row, or the subject property for a policy date. |
|
|
The write to the loan system failed, so a later run tries the field again. |
|
|
Pylon's write controls did not permit this field, so it was left as it was. |
|
|
Read back after a write, the guarded field failed its check, so Pylon stopped writing on the loan until a person clears it. |
|
|
Example
"ALREADY_AT_TARGET"
IcdForcedSend
Description
A Pylon operator's forced send of a loan's initial CD past its readiness gates. The evaluations keep their failures.
Fields
| Field Name | Description |
|---|---|
bypassedItems - [IcdForcedSendBypassedItem!]!
|
|
forcedAt - DateTimeISO!
|
|
handoffStatus - IcdForcedSendHandoffStatus!
|
|
id - ID!
|
|
reason - String!
|
Example
{
"bypassedItems": [IcdForcedSendBypassedItem],
"forcedAt": "2007-12-03T10:15:30Z",
"handoffStatus": "ACCEPTED",
"id": 4,
"reason": "xyz789"
}
IcdForcedSendBypassedItem
Description
A readiness item a forced send bypassed, as it stood then.
Fields
| Field Name | Description |
|---|---|
evaluationId - OpaqueToken!
|
|
gateKind - IcdReadinessGateKind!
|
|
kind - IcdReadinessItemKind!
|
|
owner - IcdReadinessOwner
|
|
reasonCodes - [IcdReadinessReasonCode!]!
|
Why the item had its status, as IcdReadinessItem.reasonCodes reads it. Empty on a SYSTEM-owned item. |
status - IcdReadinessStatus!
|
Example
{
"evaluationId": OpaqueToken,
"gateKind": "HOI",
"kind": "HOI_ANNUAL_PREMIUM",
"owner": "OPS",
"reasonCodes": ["ADDRESS_UNCONFIRMED"],
"status": "BLOCKED"
}
IcdForcedSendBypassedItemInput
Description
A readiness item being bypassed, named as IcdReadinessGate.kind and IcdReadinessItem.kind read it.
Fields
| Input Field | Description |
|---|---|
gateKind - IcdReadinessGateKind!
|
|
itemKind - IcdReadinessItemKind!
|
Example
{"gateKind": "HOI", "itemKind": "HOI_ANNUAL_PREMIUM"}
IcdForcedSendHandoffStatus
Description
Where a forced send's handoff to Closing stands.
Values
| Enum Value | Description |
|---|---|
|
|
Accepted: the loan is unchanged since the readiness the forced send bypassed. The initial CD goes out once the loan's other send checks pass. |
|
|
Recorded, and handed to the loan's initial CD send. |
|
|
The loan's initial CD send could not be reached, or failed while accepting the forced send; nothing was sent. Force the send again. |
|
|
Accepted, and the initial CD package is saved for the closer's review. |
|
|
Not applied: the loan changed after the readiness the forced send bypassed. Force the send again on its current readiness. |
|
|
Not used: the loan's initial CD package was saved through readiness before the forced send was accepted. |
Example
"ACCEPTED"
IcdReadiness
Description
Whether the loan's initial Closing Disclosure can go out, from the latest evaluation of each gate.
Fields
| Field Name | Description |
|---|---|
evaluatedAt - DateTimeISO!
|
When the oldest of the gates was evaluated. |
gates - [IcdReadinessGate!]!
|
|
outcome - IcdReadinessOutcome!
|
Example
{
"evaluatedAt": "2007-12-03T10:15:30Z",
"gates": [IcdReadinessGate],
"outcome": "BLOCKED"
}
IcdReadinessAction
Description
What clears an OPS-owned blocked item.
Values
| Enum Value | Description |
|---|---|
|
|
Correct a value on the loan application. |
|
|
Extend the rate lock. |
|
|
Finish a change in progress. |
|
|
Order or refresh something, such as a payoff. |
|
|
Upload a source document. |
Example
"CORRECT"
IcdReadinessDocumentKind
Description
The kind of loan-file document an item reconciles against. New kinds are added as gates change, so a client must handle a kind it does not know.
Values
| Enum Value | Description |
|---|---|
|
|
A homeowner's insurance binder. |
|
|
A policy's declarations page. |
|
|
A change to a bound policy, such as its premium or coverage. |
|
|
Evidence of insurance. |
|
|
A receipt for a homeowner's insurance premium payment. |
|
|
A homeowner's insurance document whose kind (quote, binder, declarations page, …) was not read. |
|
|
Another homeowner's insurance document. |
|
|
A property tax document whose kind (certificate or bill) was not read. |
|
|
A homeowner's insurance quote. |
|
|
A renewal policy's declarations page. |
|
|
A declarations page reissued mid-term, after a change to the policy. |
|
|
A property tax bill. |
|
|
A property tax certificate. |
Example
"BINDER"
IcdReadinessGate
Description
One group of readiness items, evaluated together.
Fields
| Field Name | Description |
|---|---|
evaluatedAt - DateTimeISO!
|
When the gate was evaluated. Reading never re-evaluates, so an old time means an old answer. |
evaluationId - OpaqueToken!
|
A version stamp for the evaluation this gate's result comes from, not a reference to another object. A newer evaluation has a different one. |
items - [IcdReadinessItem!]!
|
Every item, including those that pass and those that do not apply to this loan. |
kind - IcdReadinessGateKind!
|
|
rulesVersion - OpaqueToken!
|
Names the version of the gate's rules the evaluation ran. A rule change gives a different one. |
status - IcdReadinessStatus!
|
Example
{
"evaluatedAt": "2007-12-03T10:15:30Z",
"evaluationId": OpaqueToken,
"items": [IcdReadinessItem],
"kind": "HOI",
"rulesVersion": OpaqueToken,
"status": "BLOCKED"
}
IcdReadinessGateKind
Description
Which readiness gate a result is for. New gates are added over time, so a client must handle a kind it does not know.
Values
| Enum Value | Description |
|---|---|
|
|
Homeowner's insurance. |
|
|
Property tax: the tax certificate or current tax bill, and the loan's monthly property tax. |
Example
"HOI"
IcdReadinessItem
Description
One readiness item: a value on the loan and the document it must match.
Fields
| Field Name | Description |
|---|---|
action - IcdReadinessAction
|
What clears the item; set only when OPS owns it. |
filledFromDocument - Boolean!
|
True when the item passes because its values were filled in from sourceDocument. |
kind - IcdReadinessItemKind!
|
What this item checks. Identify the item by kind; each value's description names the loan values it checks. |
message - String
|
Display text: what blocks the item, or why it does not apply. Show it as written; do not parse it or match on it. |
owner - IcdReadinessOwner
|
Who clears the item; always set when it is blocked. |
reasonCodes - [IcdReadinessReasonCode!]!
|
Why the item has its status. Empty on a SYSTEM-owned item. |
reconciledAt - DateTimeISO
|
For a passing item with a source document, when the evaluation that found it in line with that document ran. |
sourceDocument - IcdReadinessSourceDocument
|
The document the item reconciles against, when there is one. |
status - IcdReadinessStatus!
|
Example
{
"action": "CORRECT",
"filledFromDocument": true,
"kind": "HOI_ANNUAL_PREMIUM",
"message": "xyz789",
"owner": "OPS",
"reasonCodes": ["ADDRESS_UNCONFIRMED"],
"reconciledAt": "2007-12-03T10:15:30Z",
"sourceDocument": IcdReadinessSourceDocument,
"status": "BLOCKED"
}
IcdReadinessItemKind
Description
Which readiness item a result is for. New items are added as gates change, so a client must handle a kind it does not know.
Values
| Enum Value | Description |
|---|---|
|
|
Loan application: homeowner's insurance, monthly housing expense. Itemization: Prepaids, homeowner's insurance premium (12 mo.) |
|
|
Itemization: Prepaids, homeowner's insurance premium, paid before closing vs. at closing |
|
|
Itemization: Prepaids, homeowner's insurance premium, paid to |
|
|
Loan application: homeowner's insurance policy effective and expiration dates |
|
|
Loan application: homeowner's insurance annual premium. Loan application: homeowner's insurance company |
|
|
Itemization: Prepaids, homeowner's insurance renewal premium |
|
|
Loan file: homeowner's insurance document |
|
|
Loan application: property taxes, monthly housing expense |
|
|
Loan application: property taxes, source document |
Example
"HOI_ANNUAL_PREMIUM"
IcdReadinessMode
Description
How a readiness run acted on its result.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ENFORCED"
IcdReadinessOutcome
Description
Whether the initial Closing Disclosure goes out on this evaluation.
Values
| Enum Value | Description |
|---|---|
|
|
At least one item blocks the initial CD. |
|
|
Every applicable item passes, but a timing hold delays the send. |
|
|
Nothing is blocked, but readiness cannot be confirmed: an item is on file and not yet checked against its source document, or a gate's result could not be read. |
|
|
Every applicable item passes; the initial CD goes out. |
Example
"BLOCKED"
IcdReadinessOwner
Description
Who clears an item. A SYSTEM-owned item has no action.
Values
| Enum Value | Description |
|---|---|
|
|
A person at Pylon must act; Ops relays document asks to the broker. |
|
|
Nobody acts; autofill, a retry or a read in flight clears it. |
Example
"OPS"
IcdReadinessReasonCode
Description
Why an item has its status. New codes are added as gates and rules change, so a client must handle a code it does not know.
Values
| Enum Value | Description |
|---|---|
|
|
The insurance document's address can't be confirmed as the subject property's, so Pylon does not fill in values from it. |
|
|
The current tax document states neither an annual total nor installments covering the whole year. |
|
|
The annual premium on the loan application disagrees with the source document. |
|
|
The loan's rate is locked, so Pylon does not fill in the value from the source document. Retired: Pylon writes on a rate-locked loan, so no current result gives it. |
|
|
The insurance document's coverage type is not stated and its form does not identify it, so Pylon does not fill in values from it. Retired: Pylon trusts the policy filed under an HOI type; it no longer holds for unconfirmed coverage. |
|
|
The policy dates on the loan disagree with the source document. Retired: Pylon writes the document's value whoever entered the loan's, so no current result gives it. |
|
|
The policy's effective or expiration date is not entered. |
|
|
Two source documents disagree: insurance documents for different policies on the premium, or tax documents for the latest tax period on the annual tax. |
|
|
A document that may be the current tax bill is of a kind Pylon does not recognize. Ops confirms whether it is the year's bill or certificate. |
|
|
No homeowner's insurance document is on file. |
|
|
A tax document on file could not be read. |
|
|
A document on file has not been read yet. |
|
|
A document on file is still being read. |
|
|
The item passes because its values were filled in from the source document. |
|
|
A loan value the item depends on is missing; the message names it. |
|
|
The insurance company on the loan application is not the source document's insurer. |
|
|
The insurance document does not name its insurer, so only whether an insurance company is entered is checked. |
|
|
An insurance company may or may not be the one a document names: the loan application's against the source document's, or a renewal's against the current policy's. Ops confirms. |
|
|
The loan's monthly property tax is not entered. |
|
|
The monthly homeowner's insurance payment disagrees with the document's annual premium. Retired: Pylon writes the document's value whoever entered the loan's, so no current result gives it. |
|
|
A new insurer's policy replaces the current one. |
|
|
No homeowner's policy is on file: the insurance document filed as one is a flood or wind/hail policy, a misfile. |
|
|
A value on the loan disagrees with the source document, and the loan record does not show who entered it, so a person reviews it. Retired: Pylon writes the document's value whoever entered the loan's, so no current result gives it. |
|
|
Whether the premium is paid before closing or due at closing disagrees with the documents. Retired: Pylon writes the document's value whoever entered the loan's, so no current result gives it. |
|
|
Whether the premium is paid before closing or due at closing is not recorded. |
|
|
Who the homeowner's insurance premium is paid to disagrees with the recipient the document names. |
|
|
No insurance document names who the premium is paid to, so only whether a payee is entered is checked. |
|
|
Who the homeowner's insurance premium is paid to is not entered, and no document names a recipient. |
|
|
The policy expires before the loan disburses. |
|
|
The insurance document does not state a premium. |
|
|
A tax document that may be newer than the one relied on can't be matched to the subject property. Ops confirms which property it is for. |
|
|
The policy expires soon after disbursement and its renewal is not on file. |
|
|
The escrow reserve's monthly amount disagrees with the loan's monthly payment. |
|
|
The item has no source document to check against until the insurance document item passes. On the insurance document item, a document on file could not be read. |
|
|
The loan's monthly property tax is not the tax document's annual amount divided by 12. |
|
|
No tax certificate or annual tax bill for the subject property is on file. A listing sheet, a Loan Estimate, or a supplemental or escape bill is not one. |
|
|
The latest tax period on file neither covers today nor is the period just before it; the current year's bill or certificate is needed. |
|
|
The tax period on file can't be relied on: it can't be read, the latest of several can't be told, or it is not under way. Ops confirms the period. |
|
|
A value entered on the loan disagrees with the source document. Retired: Pylon writes the document's value whoever entered the loan's, so no current result gives it. |
|
|
A value the source document requires is not entered. |
|
|
The item has no source document to check against until the tax document item passes. |
|
|
The insurance document is for a different property. |
Example
"ADDRESS_UNCONFIRMED"
IcdReadinessRunSummary
Description
The readiness run whose plan made a write.
Fields
| Field Name | Description |
|---|---|
mode - IcdReadinessMode!
|
|
startedAt - DateTimeISO!
|
|
trigger - IcdReadinessTrigger!
|
Example
{
"mode": "ENFORCED",
"startedAt": "2007-12-03T10:15:30Z",
"trigger": "EVIDENCE_EXPIRED"
}
IcdReadinessSourceDocument
Description
The loan-file document an item reconciles against.
Fields
| Field Name | Description |
|---|---|
document - LoanDocument
|
The document in the loan file. Null when the caller cannot read the loan's documents, and for a document the loan file holds no copy of. |
kind - IcdReadinessDocumentKind!
|
The kind of document. |
uploadedOn - Date!
|
When the document was filed on the loan. |
Example
{
"document": LoanDocument,
"kind": "BINDER",
"uploadedOn": "2007-12-03"
}
IcdReadinessStatus
Description
Where an item, or a gate as a whole, stands.
Values
| Enum Value | Description |
|---|---|
|
|
Blocks the initial CD until cleared. |
|
|
Does not apply to this loan. |
|
|
The loan application or closing cost itemization reflects the source document. |
|
|
The source document is on file, but its values are not yet checked against the loan application. |
Example
"BLOCKED"
IcdReadinessTrigger
Description
What started a readiness run. New triggers are added over time, so a client must handle one it does not know.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EVIDENCE_EXPIRED"
IcdWritableField
Description
A loan-record field Pylon writes from an insurance document. New fields are added as gates change, so a client must handle a field it does not know.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HOI_ANNUAL_PREMIUM"
IdentityFraudConditionBlocker
Description
Identity fraud condition detected
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
ImportIssueTypeInput
Description
Input for importing an existing Plain label type as an issue type.
Example
{
"key": "4",
"vendorId": "4"
}
ImportIssueTypeResponse
Description
Response from importing an issue type.
Fields
| Field Name | Description |
|---|---|
label - SupportIssueType!
|
The imported issue type. |
Example
{"label": SupportIssueType}
Income
Description
Income interface
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
id - ID!
|
Income ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Possible Types
| Income Types |
|---|
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
IncomeAmounts
Description
Stored income amounts in dollars. Self-employment losses retain their loss magnitude.
Example
{
"qualified": 987.65,
"stated": 987.65,
"statedMonthly": 123.45,
"verified": 987.65
}
IncomeConnection
Fields
| Field Name | Description |
|---|---|
edges - [IncomeEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [IncomeEdge],
"pageInfo": PageInfo
}
IncomeEdge
IncomeMutations
Fields
| Field Name | Description |
|---|---|
auxiliaryEmployment - AuxiliaryEmploymentIncomeMutations
|
Auxiliary employment income mutations |
create - CreateIncomeResponse
|
Create an income. The input is a 'oneOf' type where exactly one field must be populated. The type of income to be created depends on which input field is populated. Example: If socialSecurity is populated, a SocialSecurityIncome entity will be created. |
Arguments
|
|
delete - DeleteIncomeResponse
|
Delete an income |
Arguments
|
|
recompute - RecomputeIncomeResponse
|
Recompute and persist an income's verified and qualified amounts from existing paystub data. Does not re-pull from Truv and does not trigger pricing. Pylon super admins only. |
Arguments
|
|
update - UpdateIncomeResponse
|
Update income. |
Arguments
|
|
Example
{
"auxiliaryEmployment": AuxiliaryEmploymentIncomeMutations,
"create": CreateIncomeResponse,
"delete": DeleteIncomeResponse,
"recompute": RecomputeIncomeResponse,
"update": UpdateIncomeResponse
}
IncomePayType
Description
The type of pay for the income (hourly or salaried)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HOURLY"
IncomeVerificationMutations
Fields
| Field Name | Description |
|---|---|
cancelOrder - CancelOrderResponse
|
|
Arguments
|
|
requestOrder - RequestOrderResponse
|
|
Arguments
|
|
Example
{
"cancelOrder": CancelOrderResponse,
"requestOrder": RequestOrderResponse
}
IncomeVerificationOrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELED"
IncomeVerificationOrderSummary
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
expiresAt - DateTime!
|
|
id - ID!
|
Order ID |
orderId - String!
|
The order ID; the same value as id, kept for existing clients. |
shareUrl - String
|
The borrower-facing verification link, null unless the order is pending and unexpired. |
status - IncomeVerificationOrderStatus!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"id": 4,
"orderId": "abc123",
"shareUrl": "abc123",
"status": "CANCELED"
}
IncomeVerificationQueries
Fields
| Field Name | Description |
|---|---|
orders - [IncomeVerificationOrderSummary!]!
|
Returns the borrower's 10 most recent orders, newest first. |
Arguments
|
|
Example
{"orders": [IncomeVerificationOrderSummary]}
IndividualDevelopmentAccountAsset
Description
Individual development account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "xyz789",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
IneligibilityDetails
Description
Information providing extra detail as to why a borrower is ineligible for a loan-product.
Example
CashToCloseExceedsOwnFundsViolation
IneligibilityDetailsType
IneligiblePreQualification
Fields
| Field Name | Description |
|---|---|
details - [IneligibilityDetails!]!
|
Example
{"details": [CashToCloseExceedsOwnFundsViolation]}
IneligibleProduct
Fields
| Field Name | Description |
|---|---|
details - [IneligibilityDetails!]!
|
|
product - Product!
|
Example
{
"details": [CashToCloseExceedsOwnFundsViolation],
"product": Product
}
IneligibleProductPricing
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate |
details - [IneligibilityDetails!]!
|
|
id - ID
|
The unique ID of this product pricing result. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
term - PositiveInt!
|
The term of the loan being considered in years. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"details": [CashToCloseExceedsOwnFundsViolation],
"id": 4,
"lock": 123,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"term": 123
}
IneligibleProductStructure
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate mortgage |
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
appliedMargin - AppliedMargin
|
The margin applied when this rate or structure was priced, derived on read from the effective-dated margin window in force at the loan's lock (its original lock for a company that reads margin at the original lock, its current lock otherwise), or now for an unlocked loan. Identical for a loan's current product structure and for the candidates of a pricing run on the same loan. Every caller reads loanOfficerMargin; split is null unless the caller may read the margin breakdown. Null for results priced outside a loan context (e.g. scenarios). |
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
ineligibilityDetails - [ProductStructureIneligibilityDetails!]!
|
|
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
llpasWaived - Boolean!
|
Whether LLPAs were waived for this rate due to low-income borrower eligibility |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
lockCharges - [ProductPricingCharge!]
|
The rate lock fees priced inside this structure's points: the lock's relock fee, charged on a relock or a live investor change, and each extension's fee. Already included in totalPoints, each shown as its own row in the points breakdown; never a separate closing cost. Empty when there are none. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
repricing - StructureRepricing
|
How this structure was priced against the loan's expired rate lock: the worse of the lock-day and today's rate sheets inside the relock window, or today's rate sheet after it. Null when no repricing outcome is recorded for this structure. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"appliedMargin": AppliedMargin,
"apr": 987.65,
"cashFromToBorrower": 987.65,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 987.65,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": 4,
"ineligibilityDetails": [
CashToCloseExceedsOwnFundsViolation
],
"interest": 123,
"llpasWaived": true,
"loanTermYears": 123,
"lock": 123,
"lockCharges": [ProductPricingCharge],
"ltv": 123.45,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"rate": 987.65,
"rateId": "4",
"ratePoints": 123.45,
"repricing": StructureRepricing,
"totalCost": 123.45,
"totalPoints": 987.65
}
IneligibleStructureBlocker
Description
The product structure is ineligible
Fields
| Field Name | Description |
|---|---|
ineligibilityDetails - [IneligibilityDetailsType!]!
|
Details about the ineligibility |
type - String!
|
Example
{
"ineligibilityDetails": [IneligibilityDetailsType],
"type": "xyz789"
}
InsufficientFraudScoreBlocker
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntakeEntity
Description
The kind of record an intake non-adoption concerns — the eight kinds of record intake creates. A non-adoption names its entity even when no record was created, which is how a client knows which create mutation would close it.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSET"
IntakeField
Description
A target field: a column on a Pylon record that intake could not fill, described well enough for a client to render a control and let a human finish it.
Fields
| Field Name | Description |
|---|---|
column - String!
|
Braid's own column name, stable across releases. Not a display string, and not the name the uploaded file used for the same thing. |
valueKind - IntakeValueKind!
|
The kind of value the column holds, so a client can choose a control. |
values - IntakeValueSet
|
Permitted values or selectable records. Present exactly when valueKind is ENUM or REFERENCE, and null for every other kind. |
Example
{
"column": "abc123",
"valueKind": "BOOLEAN",
"values": IntakeInlineValues
}
IntakeFieldOutcome
Description
One field key's outcome from a settled run. Field keys and the outcome bucket only — never the value, its confidence, or what it beat (fieldProvenance's job, not this poll's).
Fields
| Field Name | Description |
|---|---|
fieldKey - String!
|
The wire field key. |
outcome - IntakeFieldOutcomeKind!
|
Which bucket this field key landed in. |
unreadableReason - IntakeFieldUnreadableReason
|
Why this field was unreadable. Only present for UNREADABLE outcomes. |
Example
{
"fieldKey": "xyz789",
"outcome": "APPLIED",
"unreadableReason": "DATE_OF_BIRTH_IN_FUTURE"
}
IntakeFieldOutcomeKind
Description
Which bucket a read field key landed in on a COMPLETED run. Never the value, its confidence, or what it beat — that is fieldProvenance's to answer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLIED"
IntakeFieldUnreadableReason
Description
Why a document field could not be read for automatic intake.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE_OF_BIRTH_IN_FUTURE"
IntakeInlineValues
Description
A small closed set of permitted values, sent with the non-adoption because sending it costs less than a round trip.
Fields
| Field Name | Description |
|---|---|
values - [String!]!
|
Wire values in the column's own vocabulary — what a mutation would accept, not what a user should read. Display copy is the client's. |
Example
{"values": ["abc123"]}
IntakeLookup
Description
The existing query a by-reference value set resolves through. Named rather than inlined because these sets are large, or because they name selectable records rather than plain values; either way the client pays for them when the field is edited and not on every read of the report. COUNTIES_BY_STATE resolves through UsState.counties and is keyed on the record's state column. LOAN_OFFICERS and LIABILITIES_FOR_OWNED_PROPERTY name record types, so a field carrying either is a REFERENCE field.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COUNTIES_BY_STATE"
IntakeNonAdoptionReason
Description
Why intake could not fill the field itself. Orthogonal to IntakeNonAdoptionSeverity, which says how much the non-adoption matters. Seven members are MISMO's alone, six are extraction's alone, and UNREADABLE is emitted by both — it names one event (a source stated a value the column's domain cannot hold, and nothing was written) that both paths reach by their own route. A non-adoption, in every member's case, means THIS RUN of intake did not adopt the file's claim for the field — not that the loan is necessarily left without a value: PREEXISTING is the one member where it already has one, held back rather than silently claimed by a run that cannot vouch for where it came from.
Values
| Enum Value | Description |
|---|---|
|
|
MISMO. The field or section was not in the file at all, so the non-adoption quotes no stated value. |
|
|
MISMO. The file gave nothing usable for this field — absent, or out of scope for the importer entirely — and a consumer downstream (pricing, most often) resolves it anyway without telling anyone: with a guessed value, or with an explicit but otherwise-invisible "unknown" that still drives real behavior. Distinct from DEFAULTED: the file did not state a value we misread, it stated nothing, and this reason describes what a downstream consumer does next rather than what the file said. |
|
|
Extraction. The loan's documents contradicted each other about this field and the ranking could not separate them, so the reading left it for a person to settle. Distinct from UNREADABLE: the column could have held what was said; the sources did not agree on what to say. Only a subset of contested fields is actually put to the borrower — which ones is the reading lane's decision, and it is not this reason's to report. |
|
|
MISMO. The file supplied a value we do not recognize; the entity was still imported, with a substitute in the field — a generic default (an asset or income typed as OTHER) or a value derived from the file's other signals (a housing type from the property's unit count). The file said something, and the non-adoption quotes the stated word we could not use. |
|
|
Extraction. The write is due and citation-backed but the loan is frozen. Nothing is wrong with the value; it lands when the freeze lifts. |
|
|
MISMO. The section or entity was present in the file, but without enough content to create the record — a property owner the file named with no name at all. There is nothing to build a record from; supply the missing detail if the owner matters to this loan. |
|
|
MISMO. A MISMO 3.6-only value with no 3.4 equivalent, dropped while normalizing the document to the 3.4 model the importer reads. |
|
|
MISMO. The section or entity was present in the file, and this importer deliberately does not carry it onto a loan — a party role outside what it tracks. Our boundary, not a defect in the file or a loss of anything the file supplied; add it by hand if it matters to this loan. |
|
|
Extraction. The field already held a value this lane has no write receipt for — somebody's typed data. Held and reported rather than overwritten, because the lane will not silently replace a value it cannot account for. |
|
|
Extraction. The field was resolved and citation-backed, but its source documents fall outside the adoption voucher, so it was reported and never written. This is the ordinary fate of anything read after the initial auto-fill: the lane writes only through the voucher over the documents it adopted, and every later upload is report-only by design. Not an error, and usually the most common reason on a loan that has been worked. |
|
|
Extraction. The reading decided a value but no citation rows stood behind it, so it was held rather than written: a write receipt could prove no provenance, and attribution is never inferred. The value exists and the field does not, so a human can still enter it — but unlike WITHHELD or REPORT_ONLY this is not a policy outcome. It means the citation join failed for that field, and a run producing it is reporting a defect as well as a non-adoption. |
|
|
MISMO. The section or entity was present in the file, but names no loan participant it could attach to — an asset or a rental income with no resolvable borrower. The relationship is required, so nothing was created; link it to a borrower to bring it onto the loan. |
|
|
Both paths. A source stated a value the column's domain cannot hold, and nothing was written for the field. MISMO reaches it when the file supplies a term the importer does not recognize; extraction reaches it when a document names a field but not in a form the column can take. The permitted set travels with the non-adoption so the user can pick the right one. Distinct from DEFAULTED, where the same unusable value still left a substitute written into the field, and from CONTESTED, where the column could have held any of the values offered and the sources disagreed about which. |
|
|
Extraction. A document kind reports this field but never writes it — income, today. Recorded so that "nothing happened" and "we read it and deliberately did not write it" stay distinguishable, and so a review surface knows to ask. A policy of the document kind, not a failure of this run. |
Example
"ABSENT"
IntakeNonAdoptionSeverity
Description
How much a non-adoption matters. Orthogonal to IntakeNonAdoptionReason, which says why the non-adoption exists.
Values
| Enum Value | Description |
|---|---|
|
|
The owning entity was created, but this field feeds a ratio a user reads straight off the loan — DTI today — and intake could not establish the true value, so something downstream (pricing, most often) silently resolves it on its own: with a guessed value, or with an explicit but otherwise-invisible "unknown" that still drives real, DTI-relevant behavior. Unlike RECOMMENDED, this is not "nice to fill in eventually": the ratio computed from this field may not be what a plain read of the loan would suggest, until a human resolves it. Reserved for non-adoptions with a known, silent effect on such a ratio — most non-adoptions that merely leave a field blank stay RECOMMENDED. |
|
|
The owning entity itself was never created. Intake merely reports the entity for the user's awareness and takes no further action. Reported at entity granularity, so the non-adoption names no fields. Whether the section was absent from the file or present but not importable is the reason's to say — ABSENT versus UNLINKED, INCOMPLETE or OUT_OF_SCOPE — not this severity's. |
|
|
The owning entity was created, but this specific field ended up empty. The user is advised to fill it in afterwards. |
Example
"CRITICAL"
IntakeValueKind
Description
The kind of value a column holds, so a client can choose a control without knowing the column. TAX_ID is a government tax-identifier number (an SSN, EIN, or ITIN) — a plain string to the database, but not safe to treat as free TEXT: it wants a masked, numeric-only control, distinct from a name or an address that happens to share the same underlying column type. ENUM means a closed vocabulary of plain values; REFERENCE means the value identifies another record (which loan officer, which liability) and the client renders a picker rather than a free field.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOLEAN"
IntakeValueSet
Description
Permitted values: inline when the set is small and made of plain values, by lookup when it is large or names records.
Types
| Union Types |
|---|
Example
IntakeInlineValues
IntakeValuesRef
Description
A set of permitted values the client resolves only when the field is actually edited: large vocabularies and record pickers, which would otherwise be paid for on every read of the report.
Fields
| Field Name | Description |
|---|---|
keyedOn - String
|
The column on the same record whose current value keys the lookup — counties key on state. Null when the lookup takes no key. |
lookup - IntakeLookup!
|
The existing query that supplies the values. For a REFERENCE field it names the record type too. |
Example
{
"keyedOn": "xyz789",
"lookup": "COUNTIES_BY_STATE"
}
IntegratedDisclosureSectionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DUE_FROM_BORROWER_AT_CLOSING"
InterestedPartyContributions
Description
The loan's interested party contributions: closing costs paid by the seller or another party with an interest in the transaction, as the system of record totals them.
Fields
| Field Name | Description |
|---|---|
excessAmount - Float
|
The amount by which the total exceeds what underwriting guidelines permit for the loan's mortgage type. Null when the system of record has not computed it. |
maximumAmount - Float
|
maximumPercentage applied to the lower of the sales price and the appraised value, in dollars. Null while either value is unknown, or when there is no maximumPercentage. |
maximumPercentage - Float
|
The most interested parties may contribute under the agency guideline for conventional loans, as a percentage of the lower of the sales price and the appraised value (3 means 3%). It depends on occupancy and combined loan-to-value. Null for other mortgage types, or while the occupancy or combined loan-to-value is unknown. |
percentageOfPurchasePrice - Float
|
The total as a percentage of the purchase price. Null when the system of record has not computed it, as on a loan with no purchase price. |
total - Float
|
The total of the closing-cost payments flagged as interested party contributions. Null when the system of record has no total for this loan. |
Example
{
"excessAmount": 987.65,
"maximumAmount": 987.65,
"maximumPercentage": 987.65,
"percentageOfPurchasePrice": 123.45,
"total": 987.65
}
InternalError1Blocker
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
InternalError2Blocker
Description
Internal error: Invalid fraud report response
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
InternalError3Blocker
Description
Internal error: Product incompatible with AUS
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
InvalidateCreditCacheInput
Description
Input for invalidating credit pull cache entries
Fields
| Input Field | Description |
|---|---|
borrowerIds - [ID!]!
|
Borrower ID(s) whose cache entries should be invalidated (1 or 2) |
Example
{"borrowerIds": ["4"]}
InvalidateCreditCacheResponse
Description
Response from invalidating credit pull cache entries
Fields
| Field Name | Description |
|---|---|
invalidatedCount - Int!
|
Number of cache entries that were invalidated |
Example
{"invalidatedCount": 987}
InvalidationCause
Description
Why an INVALIDATION was written: RESTORED (the requirement was restored by reconciliation), REINTERPRETATION (the claim's meaning changed), ENV_CHANGE (a loan-context input changed).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENV_CHANGE"
IssueDealClaimTokenInput
IssueDealClaimTokenResponse
Description
A freshly minted one-time claim token. The raw token is returned exactly once and never stored in plaintext; hand it to the borrower.
Fields
| Field Name | Description |
|---|---|
expiresAt - String!
|
ISO-8601 instant after which the token can no longer be claimed |
id - ID!
|
Id of the stored claim-token record |
token - String!
|
The raw, single-use claim token. Returned once; deliver to the borrower out-of-band (LO hand-off). Not recoverable after this call. |
Example
{
"expiresAt": "abc123",
"id": "4",
"token": "abc123"
}
JSONObject
Description
The JSONObject scalar type represents JSON objects as specified by ECMA-404.
Example
{}
Job
Description
Job interface
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Job ID |
status - JobStatus!
|
Job status |
Example
{"id": "4", "status": "FAILED"}
JobStatus
Description
Job status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FAILED"
JumboMarketingRate
Description
Jumbo marketing rate
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
fipsCountyCode - String!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int!
|
|
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"apr": 123.45,
"discountPointsTotal": 987.65,
"discountPointsTotalAmount": 987,
"fipsCountyCode": "abc123",
"loanAmount": 123,
"ltv": 123.45,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rate": 123.45,
"salesContractAmount": 123
}
JumboMarketingRateInput
Description
Jumbo marketing rate input
Fields
| Input Field | Description |
|---|---|
calculateApr - Boolean
|
Should closing costs be fetched in order to calculate an APR?. Default = true |
concessions - NonNegativeInt
|
Lender concession in dollars. Reduces the rate cost (points) the borrower would otherwise pay, but never below zero. Default = 0 |
fipsCountyCode - String!
|
The five-digit FIPS county code based on ANSI standard (INCITS 31:2009) |
loanAmount - NonNegativeInt!
|
Amount of the loan in dollars, also called principal |
loanTermYears - Float!
|
Loan term, in years. Default = 30 |
ltv - Float!
|
Loan to value ratio. Lower values get better rates. A typical value for a conforming conventional loan would be 0.8; values over that usually require mortgage insurance. |
maxDiscountPointsTotal - Float
|
Maximum total discount points. Default = 0 |
qualifyingFicoScore - Int
|
FICO score used to determine loan eligibility and interest rate |
rateLockDays - Float!
|
How long to lock the rate, in days. Default = 30 |
Example
{
"calculateApr": true,
"concessions": 123,
"fipsCountyCode": "xyz789",
"loanAmount": 123,
"loanTermYears": 123.45,
"ltv": 123.45,
"maxDiscountPointsTotal": 123.45,
"qualifyingFicoScore": 987,
"rateLockDays": 987.65
}
Lease
LegalEntity
Fields
| Field Name | Description |
|---|---|
fullName - String
|
Example
{"fullName": "abc123"}
LenderCreditDecreasedReason
Description
§1026.19(e)(3)(i): the total lender credit fell, which raises what the borrower pays. currentAmount is zero for a credit the loan no longer holds.
Fields
| Field Name | Description |
|---|---|
currentAmount - MonetaryAmount!
|
|
decreaseAmount - MonetaryAmount!
|
|
disclosedAmount - MonetaryAmount!
|
|
kind - DisclosureDriftReasonKind!
|
Example
{
"currentAmount": MonetaryAmount,
"decreaseAmount": MonetaryAmount,
"disclosedAmount": MonetaryAmount,
"kind": "APR_INACCURATE"
}
Liability
Description
Liability type
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
Account identifier |
balance - NonNegativeFloat
|
Unpaid balance |
bankName - String
|
Bank name |
borrowers - [Borrower!]!
|
The borrowers responsible for this liability. |
createdOn - DateTime!
|
When the liability was created. |
creditorName - String
|
Creditor name Use bankName instead |
exclusionReason - LiabilityExclusionReason
|
The reason why the liability is excluded |
id - ID!
|
Node ID |
intent - LiabilityIntent
|
The intent regarding liability |
lienPriorityType - LienPriorityType
|
The priority of the lien, when recorded. |
monthlyPayment - NonNegativeFloat
|
Monthly payment |
ownedProperty - OwnedProperty
|
The owned property securing this liability, if any. |
reportType - ReportType
|
Whether the liability was sourced from a credit report or self-reported |
subjectProperty - SubjectProperty
|
The subject property securing this liability, if any. |
type - LiabilityType
|
The type of liability |
Example
{
"accountIdentifier": "xyz789",
"balance": 123.45,
"bankName": "xyz789",
"borrowers": [Borrower],
"createdOn": "2007-12-03T10:15:30Z",
"creditorName": "xyz789",
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"id": "4",
"intent": "DO_NOTHING",
"lienPriorityType": "FIRST_LIEN",
"monthlyPayment": 123.45,
"ownedProperty": OwnedProperty,
"reportType": "CREDIT_REPORT",
"subjectProperty": SubjectProperty,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
LiabilityConnection
Fields
| Field Name | Description |
|---|---|
edges - [LiabilityEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [LiabilityEdge],
"pageInfo": PageInfo
}
LiabilityEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - Liability!
|
Example
{"cursor": 4, "node": Liability}
LiabilityExclusionReason
Description
The reason why the liability is excluded
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSIGNED_TO_ANOTHER_PARTY"
LiabilityIntent
Description
The intent regarding liability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DO_NOTHING"
LiabilityMutations
Description
Liability mutations
Fields
| Field Name | Description |
|---|---|
attachOwnedProperty - AttachOwnedPropertyLiabilityResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
create - CreateLiabilityResponse
|
Create a liability |
Arguments
|
|
delete - DeleteLiabilityResponse
|
Delete a liability |
Arguments
|
|
dismissDuplicateSuggestion - DismissDuplicateSuggestionResponse
|
Dismiss one possible duplicate liability pairing without excluding debt |
Arguments
|
|
setExclusionReason - SetExclusionReasonResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
setIntent - SetIntentResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
update - UpdateLiabilityResponse
|
Update a Liability. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
Example
{
"attachOwnedProperty": AttachOwnedPropertyLiabilityResponse,
"create": CreateLiabilityResponse,
"delete": DeleteLiabilityResponse,
"dismissDuplicateSuggestion": DismissDuplicateSuggestionResponse,
"setExclusionReason": SetExclusionReasonResponse,
"setIntent": SetIntentResponse,
"update": UpdateLiabilityResponse
}
LiabilityType
Description
The type of liability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
LienPriorityType
Description
The priority of a mortgage lien.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIRST_LIEN"
LifeInsuranceAsset
Description
Life insurance asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "xyz789",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
LinkBorrowersAsSpousesInput
LinkBorrowersAsSpousesResponse
Loan
Description
Loan
Fields
| Field Name | Description |
|---|---|
allowedStates - [StateAbbreviated!]!
|
The list of states where the organization is actively licensed. Empty when the organization has no active state with an unexpired license. A borrower or contributor session can read it for its own loan. |
appraisal - Appraisal
|
Get an Appraisal by ID |
Arguments
|
|
appraisalOrders - [AppraisalOrder!]!
|
Appraisal orders placed for this loan. Use orderOuts or appraisal(id) instead; Appraisal carries the order status, appraised value and effective date.
|
archiveDate - DateTime
|
When the loan was archived (closed), or null while it is open. Set exactly when isClosed is true, and cleared if the loan is reopened. |
assignedLoanOfficer - LoanOfficer
|
The mortgage broker assigned to the loan. |
availableGlobalLoanOfficers - [GlobalLoanOfficer!]
|
The list of global loan officers available to be assigned to the loan. This list will vary depending on the subject property state. |
availableLoanAssignments - [LoanAssignmentUser!]!
|
Users with an assignable role at this customer who are not yet assigned to this loan |
borrowerPreferences - BorrowerPreferences
|
Borrower preferences associated with the loan. |
borrowers - BorrowerConnection!
|
Borrowers on the loan |
Arguments
|
|
bulkLoanDocumentsExportJob - BulkLoanDocumentsExportJob
|
A bulk loan documents export job for this loan. |
Arguments
|
|
cashOutType - RefinanceCashOutType
|
LO-set refinance/cash-out type (distinct from the pricing-derived value) |
changeEventWordings - [LoanChangeEventWording!]!
|
The standard borrower wording of every change event but OTHER, prefilled with what braid already knows about this loan, for a requester to complete as openChangeRequest's or redisclose's description. |
Arguments
|
|
changeRequests - [LoanChangeRequest!]!
|
Change requests associated with this loan |
Arguments
|
|
closingDate - Date
|
The date that the purchase is set to close. |
concessions - [ConcessionLog!]!
|
A log of all lender-paid concessions that have been requested or applied to this loan. |
contacts - [Contact!]!
|
Contacts associated with the loan. |
currentStage - String
|
The current stage that the loan is in. |
customerPointAdjustments - CustomerPointAdjustment
|
Customer margins on the loan. Null when the caller may not read them or the margin cannot be read. |
Arguments
|
|
dealId - String!
|
The unique ID of the deal associated with this loan. |
disclosureDrift - DisclosureDrift!
|
Every reason the loan's current state departs from what was last disclosed to the borrower, measured against its most recently disclosed TRID package. Asking is side-effect free: it reports what a redisclosure would be owed for, and never sends one. |
disclosureSendAttention - DisclosureSendAttention
|
|
documents - [Document!]!
|
The list of documents associated with this loan. |
Arguments
|
|
dti - NonNegativeFloat
|
The debt-to-income ratio, expressed as a 0-1 fraction: the system of record's figure when it has supplied one, otherwise the attached product structure's pricing-time value. Null until a product structure is attached. |
duplicateLiabilitySuggestions - [DuplicateLiabilitySuggestion!]!
|
Possible duplicate liabilities for staff review; reading suggestions does not exclude debt |
earnestMoneyDeposit - NonNegativeFloat
|
The total amount of earnest money deposit |
effectiveAppraisalWaiver - AppraisalWaiver
|
The appraisal waivers applied to the loan. |
employmentsMissingStartDateCount - Int!
|
The number of employment records on the loan's borrowers that are missing a start date. Initial disclosures cannot be dispatched (via float or rate lock) until this is zero. Always zero once initial disclosures have been dispatched, since float / rate lock no longer need to send a new package. |
estimatedRatios - EstimatedLoanRatios
|
Live estimated DTI and LTV for this loan, recomputed from current incomes, liabilities, and property value on every read. Null until a product structure has been selected. Compare with productStructure.dti and productStructure.ltv, which are computed during pricing and fixed until the next pricing run. |
fees - [Fee!]
|
Fees associated with the loan. |
friendlyId - String!
|
An alternative ID that might be more aesthetically pleasing. May be shared by multiple objects representing the same loan. |
fundedDate - Date
|
The date the loan was funded (disbursed). |
fundingSettlement - FundingSettlement!
|
Funding state for both wire legs. Pass asOf to read the persisted state at that instant; omit it for the latest state. |
Arguments
|
|
getAutoConditionalApprovalStatus - GetAutoConditionalApprovalStatusResponse!
|
The automatic conditional approval feature has been removed. |
Arguments |
|
homeBuyingProcess - HomeBuyingProcess
|
The stage of the borrower’s home search. |
icdFieldHistory - IcdFieldHistory
|
What Pylon wrote to this loan's record from insurance documents, and what it read back. Restricted to internal Pylon admins. Null when Pylon has planned no write on the loan. |
icdReadiness - IcdReadiness
|
Whether the initial Closing Disclosure can go out, and what blocks it, from the latest evaluation of each readiness gate. Reading never re-evaluates. Null until readiness is available for this loan. |
id - ID!
|
The ID of the Loan |
intentToProceedDate - Date
|
The date the borrowers expressed intent to proceed after receiving initial disclosures. Unset until intent to proceed is received. |
interestedPartyContributions - InterestedPartyContributions
|
The loan's interested party contributions as the system of record computes them, kept current as fees and loan terms change. Null until the system of record has reported them for this loan. |
isClosed - Boolean
|
Whether the loan has been closed. |
isFirstTimeHomebuyer - Boolean
|
Is this for a first time homebuyer? |
isFloated - Boolean!
|
Whether the loan is floated: initial disclosures have been sent (loan is frozen) but the rate is not yet locked. Derived from disclosuresDate IS NOT NULL && rateLockStatus !== LOCKED. |
isFrozen - Boolean!
|
Whether the loan is frozen |
lastPreApprovalRunAt - DateTime
|
Time of the last saved pre-approval run, including a declined run. |
latestBulkLoanDocumentsExportJob - BulkLoanDocumentsExportJob
|
The latest bulk loan documents export job for this loan. |
latestPreApprovalRunTime - DateTime
|
Time of the latest successful pre-approval |
latestSuccessfulBulkLoanDocumentsExportJob - BulkLoanDocumentsExportJob
|
The latest successful bulk loan documents export job for this loan. |
legacyLoanStage - String
|
The locally recorded processing stage of the loan. |
liabilities - [Liability!]!
|
All liabilities associated with this loan |
loanAssignments - [LoanAssignment!]!
|
Current loan team assignments for this loan |
loanChannel - LoanChannel!
|
The origination channel the loan was submitted under. For customers with access to funding settlement, eligible loan channels are: Correspondent, NonDelegatedCorrespondent1, NonDelegatedCorrespondent2, NonDelegatedCorrespondent3. |
loanContact - LoanContact!
|
The contact for this loan |
loanDocuments - [LoanDocument!]!
|
Documents from the document evidence API for this loan. |
loanNumber - String
|
The current loan number for internal Pylon use. |
loanOfficerDocumentTasks - [LoanOfficerDocumentTask!]
|
The borrower tasks available to Loan Officers. |
loanProcess - LoanProcess
|
Process-level information for this loan. |
loanPurpose - LoanPurposeType
|
The purpose for which the loan proceeds will be used. |
loanStatus - String!
|
The loan approval status, accounting for its disposition and underwriting decision. |
loanTermYears - PositiveFloat
|
The term of this loan in years. |
lockReplacementChangeRequest - LockReplacementChangeRequest
|
The standing change request replacing this loan's committed lock would cite. Null when no standing request names a changed circumstance or the customer's lock replacements send no revised disclosure automatically. |
lockReplacementChangedCircumstanceReason - ChangeOfCircumstanceReason
|
The changed-circumstance reason the revised Loan Estimate sent automatically on replacing this loan's committed lock would carry: its standing change request's. Null when none would be sent automatically, leaving the redisclosure to a person. Restricted to internal Pylon operators. |
lockedSummary - LockedLoanSummary
|
Authoritative summary values for display once the rate is locked, sourced from the system of record (with fallback to internally-computed values). Null until the rate is locked. |
ltv - NonNegativeFloat
|
The loan-to-value ratio expressed as a percentage |
maxLoanAmount - Float
|
Maximum loan amount (in dollars) calculated by the preapproval engine. |
maxPurchasePrice - Float
|
Maximum purchase price (in dollars) calculated by the preapproval engine. |
mismoImport - MismoImport
|
The MISMO import that created this loan. Null when the loan was created some other way, and null again once the retention sweep has removed the report 24 hours after the import ran — so a client should treat its absence as ordinary rather than as a loan that was not imported. |
nonBorrowingOwners - [NonBorrowingOwner!]!
|
Non-borrowing owners on the loan. |
nonBorrowingOwnersTaskStatus - TaskCompletionStatus!
|
Status of providing the loan's non-borrowing owners. |
noteRatePercent - NonNegativeFloat
|
Interest rate. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
orderOuts - [OrderOut!]!
|
List of order outs on the loan. |
organization - Organization!
|
The organization that owns this loan. Unlike the organization root, which is the session's customer, this is the loan's own customer, so an all-customers view reads the right tenant's contacts, borrower portal URL and concession limit. A borrower or contributor session can read it for its own loan, but only the fields that borrower-facing screens show: the company names, support email, Plaid products, and policy and consent links. |
outOfPocketMax - NonNegativeInt
|
The maximum amount of assets (in dollars) to be used towards the loan. |
ownedProperties - [OwnedProperty!]!
|
All owned properties on the loan, including properties with no borrowing owner. |
pointOfContact - Borrower
|
The borrower who has been designated as the point of contact on the loan (or the first borrower on the loan if no borrower has been designated as the point of contact) |
preapprovalProduct - Product
|
The loan product with the optimal preapproval result. The value is null if the loan has not been preapproved (yet). |
pricingChangeFindings - [PricingChangeFinding!]
|
Every pricing change since a disclosure of the loan that needed a redisclosure, open or closed, oldest first. Null, with an error, when the findings cannot be read. Restricted to internal Pylon operators. |
pricingFreshness - LoanPricingFreshness
|
Whether the attached product structure is priced against the rate sheet current for the loan: the product's newest, or the lock's sheet while a rate lock is in force on a customer with automatic redisclosure enabled. Null when no product structure is attached. Float, rate lock, and relock are refused while pricingStale is true. |
productPricingRate - ProductPricingRate
|
The latest pricing run outputs. |
productStructure - ProductPricingRate
|
The latest version of pricing-related fields. |
productStructureDegraded - DegradedProductStructure
|
The attached structure's degraded render, when its pinned rate could not be resolved: deal facts from the structure's own row, no rate-sheet detail. Null whenever productStructure is served. Render as a degraded card on the affected option only. |
purchasePrice - NonNegativeInt
|
The actual purchase price (in dollars). |
pylonApproved - Boolean!
|
Must be approved before a rate lock can be requested |
rateLock - RateLockDetails!
|
Rate lock related fields |
rateLockExtensionTerms - RateLockExtensionTerms!
|
Whether this loan's rate lock can be extended now, and within what limits. Each option has its new expiration date and price. Doesn't check for undisclosed loan changes; extending does. |
rateLockHistory - RateLockHistoryConnection!
|
A page of the rate locks this loan has held, in the order they were recorded. Pass sortDirection DESC to get the newest, normally the active lock, first. Empty when the loan was never locked. |
Arguments
|
|
rateLockTerm - NonNegativeInt
|
Number of days borrower wants to lock the rate for |
realtorsTaskStatus - TaskCompletionStatus!
|
Status of the step where the borrower gives realtor information. |
redisclosureFeeChanges - [RedisclosureFeeChange!]!
|
Every fee that changed since the loan was last disclosed, each of which a redisclosure can give its own changed-circumstance reason. Restricted to internal Pylon operators, like redisclose. |
redisclosurePipelineRun - RedisclosurePipelineRun
|
A redisclosure pipeline run on this loan, for following it to the send. With id, that run, or null if it is not this loan's. Without id, the loan's in-flight run, else its most recent run, else null. |
Arguments
|
|
refinanceCashOutProceeds - NonNegativeInt
|
Refinance cash out proceeds not used towards paying off existing liens. |
requirementConversationSessions - RequirementConversationSessionConnection!
|
The requirement conversations on this loan the caller may read: a loan officer's own conversations, or every conversation for underwriting staff. |
sellerCredit - NonNegativeInt
|
The total seller credit to be applied towards closing costs |
servicers - [Contact!]!
|
The loan's servicer contacts, synced from the loan origination system. Empty until the loan's next origination-system update. |
stages - [LoanStage!]
|
The chronological sequence of stages a loan has progressed through, listed from earliest to most recent. |
subjectProperty - SubjectProperty
|
The subject property associated with the loan |
subjectPropertyFoundTaskStatus - TaskCompletionStatus!
|
Status of identifying the subject property for the loan. |
subjectPropertyIntent - SubjectPropertyIntent
|
The subject property intent associated with the loan |
systemOfRecordDti - NonNegativeFloat
|
The system of record's debt-to-income ratio, expressed as a 0-1 fraction: its own figure only, never a pricing-time value. Null when the system of record hasn't supplied one. |
title - Title
|
Title information for the loan. |
titleCompanyAttached - Boolean!
|
Whether a title company is attached to the loan as a party (file contact). A rate cannot be locked until a title company is attached. |
totalAssetsAvailable - NonNegativeInt
|
The total amount of assets on this loan. |
tridTriggeredDate - Date
|
The date the TRID clock was triggered: the application became complete enough that the initial Loan Estimate deadline started counting. Unset until the system of record computes it. |
underwritingSubmissionGate - UnderwritingSubmissionGate
|
Whether the loan can be submitted for underwriting right now, and the tasks that must be completed first if not. |
useOwnTitleCompany - Boolean
|
Whether the borrower wants to use their own title company. |
Example
{
"allowedStates": ["AK"],
"appraisal": Appraisal,
"appraisalOrders": [AppraisalOrder],
"archiveDate": "2007-12-03T10:15:30Z",
"assignedLoanOfficer": LoanOfficer,
"availableGlobalLoanOfficers": [GlobalLoanOfficer],
"availableLoanAssignments": [LoanAssignmentUser],
"borrowerPreferences": BorrowerPreferences,
"borrowers": BorrowerConnection,
"bulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"cashOutType": "CASH_OUT",
"changeEventWordings": [LoanChangeEventWording],
"changeRequests": [LoanChangeRequest],
"closingDate": "2007-12-03",
"concessions": [ConcessionLog],
"contacts": [Contact],
"currentStage": "xyz789",
"customerPointAdjustments": CustomerPointAdjustment,
"dealId": "abc123",
"disclosureDrift": DisclosureDriftAssessed,
"disclosureSendAttention": DisclosureSendAttention,
"documents": [Document],
"dti": 123.45,
"duplicateLiabilitySuggestions": [
DuplicateLiabilitySuggestion
],
"earnestMoneyDeposit": 123.45,
"effectiveAppraisalWaiver": "AUTOMATED_COLLATERAL_EVALUATION",
"employmentsMissingStartDateCount": 123,
"estimatedRatios": EstimatedLoanRatios,
"fees": [Fee],
"friendlyId": "xyz789",
"fundedDate": "2007-12-03",
"fundingSettlement": FundingSettlement,
"getAutoConditionalApprovalStatus": GetAutoConditionalApprovalStatusResponse,
"homeBuyingProcess": "ACTIVELY_LOOKING",
"icdFieldHistory": IcdFieldHistory,
"icdReadiness": IcdReadiness,
"id": "4",
"intentToProceedDate": "2007-12-03",
"interestedPartyContributions": InterestedPartyContributions,
"isClosed": false,
"isFirstTimeHomebuyer": true,
"isFloated": true,
"isFrozen": true,
"lastPreApprovalRunAt": "2007-12-03T10:15:30Z",
"latestBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"latestPreApprovalRunTime": "2007-12-03T10:15:30Z",
"latestSuccessfulBulkLoanDocumentsExportJob": BulkLoanDocumentsExportJob,
"legacyLoanStage": "xyz789",
"liabilities": [Liability],
"loanAssignments": [LoanAssignment],
"loanChannel": "Broker",
"loanContact": LoanContact,
"loanDocuments": [LoanDocument],
"loanNumber": "xyz789",
"loanOfficerDocumentTasks": [LoanOfficerDocumentTask],
"loanProcess": LoanProcess,
"loanPurpose": "PURCHASE",
"loanStatus": "xyz789",
"loanTermYears": 123.45,
"lockReplacementChangeRequest": LockReplacementChangeRequest,
"lockReplacementChangedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"lockedSummary": LockedLoanSummary,
"ltv": 123.45,
"maxLoanAmount": 123.45,
"maxPurchasePrice": 987.65,
"mismoImport": MismoImport,
"nonBorrowingOwners": [NonBorrowingOwner],
"nonBorrowingOwnersTaskStatus": "COMPLETED",
"noteRatePercent": 123.45,
"orderOuts": [Appraisal],
"organization": Organization,
"outOfPocketMax": 123,
"ownedProperties": [OwnedProperty],
"pointOfContact": Borrower,
"preapprovalProduct": Product,
"pricingChangeFindings": [PricingChangeFinding],
"pricingFreshness": LoanPricingFreshness,
"productPricingRate": ProductPricingRate,
"productStructure": ProductPricingRate,
"productStructureDegraded": DegradedProductStructure,
"purchasePrice": 123,
"pylonApproved": true,
"rateLock": RateLockDetails,
"rateLockExtensionTerms": RateLockExtensionTerms,
"rateLockHistory": RateLockHistoryConnection,
"rateLockTerm": 123,
"realtorsTaskStatus": "COMPLETED",
"redisclosureFeeChanges": [RedisclosureFeeChange],
"redisclosurePipelineRun": RedisclosurePipelineRun,
"refinanceCashOutProceeds": 123,
"requirementConversationSessions": RequirementConversationSessionConnection,
"sellerCredit": 123,
"servicers": [Contact],
"stages": [LoanStage],
"subjectProperty": SubjectProperty,
"subjectPropertyFoundTaskStatus": "COMPLETED",
"subjectPropertyIntent": SubjectPropertyIntent,
"systemOfRecordDti": 123.45,
"title": Title,
"titleCompanyAttached": true,
"totalAssetsAvailable": 123,
"tridTriggeredDate": "2007-12-03",
"underwritingSubmissionGate": UnderwritingSubmissionGate,
"useOwnTitleCompany": false
}
LoanAmountExceedsPurchasePriceError
Description
User error indicating that the requested loan amount exceeds the requested purchase price.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["xyz789"],
"message": "abc123"
}
LoanAmountInsufficientViolation
Description
The requested loan amount is too low to cover payoff and costs, and the loan structure (rolled-in closing costs) leaves no room to apply the borrower's cash to close.
Fields
| Field Name | Description |
|---|---|
additionalLoanAmountNeeded - Float!
|
Dollar shortfall between the requested loan amount and what the current structure requires; raise the loan amount by this much or stop rolling in closing costs. |
Example
{"additionalLoanAmountNeeded": 123.45}
LoanApplication
Description
Loan application object
Fields
| Field Name | Description |
|---|---|
archiveDate - Date
|
|
creationDate - DateTime!
|
|
friendlyId - String!
|
|
id - ID!
|
Loan application ID |
lastPreApprovalRunAt - DateTime
|
Time of the latest pre-approval run for this loan application, approved or declined; null if pre-approval has never been run |
requirementConversationSessions - RequirementConversationSessionConnection!
|
The requirement conversations on this loan the caller may read: a loan officer's own conversations, or every conversation for underwriting staff. |
submitted - Boolean!
|
Loan Application has been submitted |
Example
{
"archiveDate": "2007-12-03",
"creationDate": "2007-12-03T10:15:30Z",
"friendlyId": "abc123",
"id": 4,
"lastPreApprovalRunAt": "2007-12-03T10:15:30Z",
"requirementConversationSessions": RequirementConversationSessionConnection,
"submitted": true
}
LoanApplicationAnalyticsConnection
Fields
| Field Name | Description |
|---|---|
edges - [LoanApplicationAnalyticsEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - NonNegativeInt!
|
The total number of loans that meet the filter criteria. |
Example
{
"edges": [LoanApplicationAnalyticsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
LoanApplicationAnalyticsDimension
Description
A column of the loan-application analytics row that an aggregation can group by.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARCHIVE_DATE"
LoanApplicationAnalyticsDimensionValue
Description
One dimension value of a group, positionally parallel to the requested groupBy.
Fields
| Field Name | Description |
|---|---|
bucketStart - DateTime
|
The start of the bucket, for a date dimension only. Always UTC, and always the first instant of the period. |
dimension - LoanApplicationAnalyticsDimension!
|
|
value - String
|
The dimension's value for this group, as text. Null is a real group — the loans with no value for that column — rather than an absence. |
Example
{
"bucketStart": "2007-12-03T10:15:30Z",
"dimension": "ARCHIVE_DATE",
"value": "abc123"
}
LoanApplicationAnalyticsEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - LoanApplicationAnalyticsRoot!
|
Example
{
"cursor": "4",
"node": LoanApplicationAnalyticsRoot
}
LoanApplicationAnalyticsFilters
Fields
| Input Field | Description |
|---|---|
addressLineText - TextComparator
|
The property's street address. |
addressUnitIdentifier - TextComparator
|
The property's unit. |
and - [LoanApplicationAnalyticsFilters!]
|
Every member must match. Only needed for shapes the implicit AND between sibling fields cannot express, such as (A and B) or C. |
archiveDate - DateTimeComparator
|
|
assignedTo - LoanAssignmentScope
|
|
cashOutType - CashOutTypeComparator
|
The kind of cash-out on a refinance. |
cityName - TextComparator
|
The property's city. |
closingDate - DayComparator
|
Filters on the closing date by calendar day, in UTC. Bounds are days rather than instants, so a date read off a row can be handed straight back: lte covers everything that closed during that day, eq matches the day itself, and gt starts after it. Bounds intersect, so supplying several narrows the window. |
concessions - NumberComparator
|
The concession priced into the loan, in dollars — "loans that conceded more than $5,000". |
contactPointEmailValue - TextComparator
|
The primary contact's email. |
contactPointFullName - TextComparator
|
|
countyName - TextComparator
|
The property's county. |
creationDate - DateTimeComparator
|
|
debtToIncome - NumberComparator
|
The debt-to-income ratio. |
disbursementDate - DateTimeComparator
|
|
disclosureSendNeedsAction - Boolean
|
Filter by whether the latest disclosure send requires attention. |
downPaymentAmount - NumberComparator
|
The down payment on the property. |
estimatedClosingCostsAmount - NumberComparator
|
Estimated closing costs. |
friendlyId - TextComparator
|
The loan's human-readable id. |
fundedDate - DateTimeComparator
|
|
globalSearch - String
|
|
hasSubjectProperty - BooleanComparator
|
Whether a subject property is attached. |
hmdaDisposition - HmdaDispositionComparator
|
|
icdSignedDate - DateTimeComparator
|
Filters on when the initial Closing Disclosure was fully signed. |
intentToProceedDate - DayComparator
|
Filters on the intent-to-proceed date by calendar day, in UTC — the date a row reports can be handed straight back as a bound. |
loanAmount - NumberComparator
|
The approved loan amount. |
loanNumber - TextComparator
|
The servicing loan number. |
loanOfficerEmail - TextComparator
|
|
loanPurpose - LoanPurposeComparator
|
Purchase or refinance. |
loanStage - TextComparator
|
|
noteRatePercent - NumberComparator
|
The note rate. |
or - [LoanApplicationAnalyticsFilters!]
|
At least one member must match. Fields outside the group are still ANDed with it. |
organizationAccountStatus - CustomerAccountStatusComparator
|
Which organizations' loans to read, by account status. Only the cross-customer omniLoanApplications and omniLoanApplicationsSummary queries accept it: there it defaults to ACTIVE organizations, and a single-customer read rejects it, since a customer's own loans all share one status. |
organizationId - CustomerIdComparator
|
Which organizations' loans to read, by organization id. Only the cross-customer omniLoanApplications and omniLoanApplicationsSummary queries accept it (the Command Center's Customers filter); a single-customer read rejects it, since its organization is fixed by the session. |
postalCode - TextComparator
|
The property's ZIP. |
preapproved - NumberComparator
|
|
rateLockStatus - RateLockStatusComparator
|
Whether and how the rate is locked. |
salesContractAmount - NumberComparator
|
The purchase price. |
stateCode - StateCodeComparator
|
The property's state, two letters. |
tridTriggeredDate - DayComparator
|
Filters on the TRID trigger date by calendar day, in UTC — the date a row reports can be handed straight back as a bound. |
Example
{
"addressLineText": TextComparator,
"addressUnitIdentifier": TextComparator,
"and": [LoanApplicationAnalyticsFilters],
"archiveDate": DateTimeComparator,
"assignedTo": "CURRENT_USER",
"cashOutType": CashOutTypeComparator,
"cityName": TextComparator,
"closingDate": DayComparator,
"concessions": NumberComparator,
"contactPointEmailValue": TextComparator,
"contactPointFullName": TextComparator,
"countyName": TextComparator,
"creationDate": DateTimeComparator,
"debtToIncome": NumberComparator,
"disbursementDate": DateTimeComparator,
"disclosureSendNeedsAction": false,
"downPaymentAmount": NumberComparator,
"estimatedClosingCostsAmount": NumberComparator,
"friendlyId": TextComparator,
"fundedDate": DateTimeComparator,
"globalSearch": "abc123",
"hasSubjectProperty": BooleanComparator,
"hmdaDisposition": HmdaDispositionComparator,
"icdSignedDate": DateTimeComparator,
"intentToProceedDate": DayComparator,
"loanAmount": NumberComparator,
"loanNumber": TextComparator,
"loanOfficerEmail": TextComparator,
"loanPurpose": LoanPurposeComparator,
"loanStage": TextComparator,
"noteRatePercent": NumberComparator,
"or": [LoanApplicationAnalyticsFilters],
"organizationAccountStatus": CustomerAccountStatusComparator,
"organizationId": CustomerIdComparator,
"postalCode": TextComparator,
"preapproved": NumberComparator,
"rateLockStatus": RateLockStatusComparator,
"salesContractAmount": NumberComparator,
"stateCode": StateCodeComparator,
"tridTriggeredDate": DayComparator
}
LoanApplicationAnalyticsGroup
Description
One row of an aggregation: a combination of dimension values and the statistics under it.
Fields
| Field Name | Description |
|---|---|
count - Int!
|
Loans in this group. |
key - [LoanApplicationAnalyticsDimensionValue!]!
|
The dimension values, in the order they were requested. Empty when the request did not group. |
measures - [LoanApplicationAnalyticsMeasureStatistics!]!
|
One entry per requested measure, in the order requested. |
Example
{
"count": 123,
"key": [LoanApplicationAnalyticsDimensionValue],
"measures": [LoanApplicationAnalyticsMeasureStatistics]
}
LoanApplicationAnalyticsGroupBy
Description
One dimension of a grouping. A date dimension must say which calendar period to bucket into; any other dimension must not.
Fields
| Input Field | Description |
|---|---|
bucket - AnalyticsDateBucket
|
Required for a date dimension, rejected for any other. Buckets are calendar periods in UTC. |
dimension - LoanApplicationAnalyticsDimension!
|
Example
{"bucket": "DAY", "dimension": "ARCHIVE_DATE"}
LoanApplicationAnalyticsMeasure
Description
A numeric column of the loan-application analytics row that an aggregation can total, average, or take the extremes of.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONCESSIONS"
LoanApplicationAnalyticsMeasureStatistics
Description
The statistics of one measured column within one group. Every statistic but count is null when no row in the group has a value for the column — the sum of nothing is unknown, not zero.
Fields
| Field Name | Description |
|---|---|
avg - Float
|
|
count - Int!
|
Rows in this group where the column has a value. Deliberately not the group's row count: an average over a column that is half null is an average over the other half. |
max - Float
|
|
measure - LoanApplicationAnalyticsMeasure!
|
|
min - Float
|
|
sum - Float
|
Example
{
"avg": 987.65,
"count": 987,
"max": 987.65,
"measure": "CONCESSIONS",
"min": 987.65,
"sum": 987.65
}
LoanApplicationAnalyticsMetrics
Description
Aggregated statistics over the loans a filter matched. Scoped exactly as the list is: an aggregate can never total a loan its requester could not have read.
Fields
| Field Name | Description |
|---|---|
groups - [LoanApplicationAnalyticsGroup!]!
|
One group per distinct combination of the requested dimensions, ordered by those dimensions. A request that did not group gets exactly one group covering everything the filter matched — including when it matched nothing, which is a group with a count of zero. |
totalCount - Int!
|
Loans the filter matched, before grouping. The same number the list's totalCount reports for the same filter. |
truncated - Boolean!
|
True when the aggregation produced more than 1000 groups and groups is only the first of them. Narrow the filter or group by something coarser; the numbers present are correct, but they do not cover the whole filtered set. |
Example
{
"groups": [LoanApplicationAnalyticsGroup],
"totalCount": 987,
"truncated": false
}
LoanApplicationAnalyticsMetricsInput
Fields
| Input Field | Description |
|---|---|
filters - LoanApplicationAnalyticsFilters
|
The same filter input the list takes. Omitted means the caller's whole visible book. |
groupBy - [LoanApplicationAnalyticsGroupBy!]
|
Up to 2 dimensions to group by. Omitted returns one group covering the whole filtered set. Each added dimension multiplies the number of groups rather than adding to it, which is why the limit is low. |
measures - [LoanApplicationAnalyticsMeasure!]
|
The columns to compute statistics for. Each may appear at most once — a repeated measure returns the same numbers and costs another set of aggregates. Omitted or empty returns counts only, which is a histogram over the dimensions. |
Example
{
"filters": LoanApplicationAnalyticsFilters,
"groupBy": [LoanApplicationAnalyticsGroupBy],
"measures": ["CONCESSIONS"]
}
LoanApplicationAnalyticsRoot
Fields
| Field Name | Description |
|---|---|
addressLineText - String
|
The street address of the property. |
addressUnitIdentifier - String
|
The unit identifier of the property. |
archiveDate - DateTime
|
Set to the date a loan application is archived; has no value if the loan application is not yet archived. |
cashOutType - RefinanceCashOutType
|
The type of cashout on the loan. |
cityName - String
|
The name of the city where the property is located. |
closingDate - Date
|
The date that the purchase is set to close. |
concessions - NonNegativeInt
|
The concession priced into the loan's selected product structure, in dollars, or null if the loan has no priced structure. This is what the loan was priced with, not the concession-request approval log; the structure reports the same figure in points, which is this over the principal. |
contactPointEmailValue - String
|
The email address for the primary contract on the loan. |
contactPointFullName - String
|
The full name of the primary contact on the loan. |
contactPointTelephoneValues - [String!]
|
The phone number (or numbers) of the primary contact on the loan. |
countyName - String
|
The name of the county where the property is located. |
creationDate - DateTime
|
The date the loan application was first started by the user. |
creditScoreAggregate - MatrixAggregate!
|
|
dealId - String!
|
The unique ID of the deal associated with this loan. |
debtToIncome - Float
|
Debt to income |
disbursementDate - DateTime
|
The date the loan proceeds are scheduled to disburse. Distinct from the closing date: on a refinance the rescission period sits between the two. Has no value until a disbursement is scheduled. |
disclosureSendAttention - DisclosureSendAttention
|
|
downPaymentAmount - NonNegativeInt
|
The down payment on the property. |
estimatedClosingCostsAmount - NonNegativeInt
|
The dollar amount of the estimated loan fees, title fees, appraisal fees and other closing costs associated with the subject transaction excluding discount points. |
friendlyId - String!
|
An alternative ID that might be more aesthetically pleasing. May be shared by multiple objects representing the same loan. |
fundedDate - DateTime
|
The date the loan was funded (disbursed). |
hasSubjectProperty - Boolean!
|
Whether or not a subject property is associated with this application |
hmdaDisposition - HmdaDispositionCode
|
The HMDA action taken on the application: originated, denied, withdrawn, closed for incompleteness, and so on. Null until the loan reaches an outcome, which is itself the answer for a loan still in flight. |
icdSignedDate - DateTime
|
When the loan's INITIAL Closing Disclosure package (the earliest-sent one) was fully signed: every recipient required to sign has signed, and this is the latest signature-completion time among them. Unset while no initial CD has been sent, or it is not yet fully signed. |
id - ID!
|
|
intentToProceedDate - Date
|
The date the borrowers expressed intent to proceed after receiving initial disclosures. Unset until intent to proceed is received. |
loanAmount - NonNegativeInt
|
If the loan is approved, this is the total amount of the loan. |
loanNumber - String
|
The current loan number for internal Pylon use. |
loanPurpose - LoanPurposeType
|
The type of loan, purchase or refinance. |
loanStage - String
|
A human readable description of the current loan stage in the legacy origination system. |
noteRatePercent - Float
|
The rate at which the interest on the mortgage is amortized. |
organizationAccountStatus - CustomerAccountStatus
|
Where the loan's organization is in its life with Pylon, answered only by the cross-customer omniLoanApplications query so a UI merging rows from several organizations can badge the ones that are not ACTIVE. Selecting it through the single-customer loanApplications query is rejected. |
organizationId - String
|
The organization ID associated with the loan application. |
organizationName - String
|
The organization's display name, populated only by the cross-customer omniLoanApplications query. Selecting this field through the ordinary single-customer loanApplications query is rejected rather than silently answering null, so a null here always means the organization has no resolvable name. |
postalCode - String
|
The ZIP code where the property is located. |
preapprovedLoanAmount - NonNegativeInt
|
The preapproved amount of the loan |
rateLockStatus - RateLockStatus
|
Is the rate locked |
salesContractAmount - NonNegativeInt
|
The total amount of money property is being purchased for. |
stateCode - String
|
The two-letter abbreviation of the state where the property is located. |
tridTriggeredDate - Date
|
The date the TRID clock was triggered: the application became complete enough that the initial Loan Estimate deadline started counting. Unset until the system of record computes it. |
Example
{
"addressLineText": "abc123",
"addressUnitIdentifier": "abc123",
"archiveDate": "2007-12-03T10:15:30Z",
"cashOutType": "CASH_OUT",
"cityName": "abc123",
"closingDate": "2007-12-03",
"concessions": 123,
"contactPointEmailValue": "xyz789",
"contactPointFullName": "abc123",
"contactPointTelephoneValues": ["abc123"],
"countyName": "xyz789",
"creationDate": "2007-12-03T10:15:30Z",
"creditScoreAggregate": MatrixAggregate,
"dealId": "xyz789",
"debtToIncome": 987.65,
"disbursementDate": "2007-12-03T10:15:30Z",
"disclosureSendAttention": DisclosureSendAttention,
"downPaymentAmount": 123,
"estimatedClosingCostsAmount": 123,
"friendlyId": "xyz789",
"fundedDate": "2007-12-03T10:15:30Z",
"hasSubjectProperty": true,
"hmdaDisposition": "APPLICATION_APPROVED_BUT_NOT_ACCEPTED",
"icdSignedDate": "2007-12-03T10:15:30Z",
"id": 4,
"intentToProceedDate": "2007-12-03",
"loanAmount": 123,
"loanNumber": "xyz789",
"loanPurpose": "PURCHASE",
"loanStage": "xyz789",
"noteRatePercent": 987.65,
"organizationAccountStatus": "ACTIVE",
"organizationId": "abc123",
"organizationName": "abc123",
"postalCode": "xyz789",
"preapprovedLoanAmount": 123,
"rateLockStatus": "CANCELLED",
"salesContractAmount": 123,
"stateCode": "xyz789",
"tridTriggeredDate": "2007-12-03"
}
LoanAssignee
Fields
| Field Name | Description |
|---|---|
fullName - String
|
|
primaryRoleNames - [String!]!
|
The roles this user is the loan's primary assignee for. |
roles - [String!]!
|
The user's roles when the snapshot was recorded. |
userReference - String!
|
The loan system's identifier for this user. |
userStatus - String
|
The user's status when the snapshot was recorded (Active, Deactivated, ...); null when the loan system omitted it. |
Example
{
"fullName": "xyz789",
"primaryRoleNames": ["abc123"],
"roles": ["xyz789"],
"userReference": "abc123",
"userStatus": "xyz789"
}
LoanAssigneeSnapshot
Fields
| Field Name | Description |
|---|---|
assignees - [LoanAssignee!]!
|
|
changedByReference - String
|
The loan system's identifier for the user who made the change, when it said. |
occurredAt - DateTimeISO!
|
When the loan system says the change happened. Not the moment assignees describes: a change delivered late keeps its own time but holds the team as of its delivery. |
recordedAt - DateTimeISO!
|
When the team was recorded, and the moment assignees describes. For seed rows this is when braid began recording history for that loan, not an older loan-system event timestamp. Snapshots are ordered by this, oldest first. |
source - LoanAssigneeSnapshotSource!
|
Example
{
"assignees": [LoanAssignee],
"changedByReference": "abc123",
"occurredAt": "2007-12-03T10:15:30Z",
"recordedAt": "2007-12-03T10:15:30Z",
"source": "SEED"
}
LoanAssigneeSnapshotSource
Description
How a snapshot of a loan's assigned team came to be recorded.
Values
| Enum Value | Description |
|---|---|
|
|
The team when recording began for the loan. |
|
|
Recorded from a change the loan system announced. |
Example
"SEED"
LoanAssignment
Description
A loan team assignment
Fields
| Field Name | Description |
|---|---|
createdAt - DateTimeISO!
|
|
id - ID!
|
|
role - LoanAssignmentRoleType!
|
Role type of the assignment |
user - LoanAssignmentUser!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"role": "LOAN_OFFICER_ASSISTANT",
"user": LoanAssignmentUser
}
LoanAssignmentRoleType
Description
Assignable loan team role types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LOAN_OFFICER_ASSISTANT"
LoanAssignmentScope
Description
Restricts analytics loan results to a viewer-relative assignment scope.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CURRENT_USER"
LoanAssignmentUser
Description
A user available for loan team assignment
Fields
| Field Name | Description |
|---|---|
email - String
|
|
firstName - String
|
|
id - ID!
|
|
lastName - String
|
|
role - LoanAssignmentRoleType!
|
The user's assignable loan team role at this customer — the role they would take on if assigned. |
Example
{
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastName": "xyz789",
"role": "LOAN_OFFICER_ASSISTANT"
}
LoanChangeEvent
Description
A concrete change-of-circumstance event. The change request records the TRID changed-circumstance category the event falls under. Every event but OTHER has standard borrower wording (Loan.changeEventWordings) that the requester completes as the request's description.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADD_OR_REMOVE_BORROWER"
LoanChangeEventWording
Description
A change event's standard borrower wording for one loan, to be completed as a change request's description.
Fields
| Field Name | Description |
|---|---|
changeEvent - LoanChangeEvent!
|
|
changedCircumstanceReason - ChangeOfCircumstanceReason!
|
The changed-circumstance reason a request or redisclosure naming this event is recorded under. |
wording - String!
|
The reference guide's wording, with the placeholders braid can already fill from the loan replaced by its values. Any remaining bracketed placeholder, such as [date], must be filled in before the request is opened. |
Example
{
"changeEvent": "ADD_OR_REMOVE_BORROWER",
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"wording": "xyz789"
}
LoanChangeRequest
Description
A request to make changes to a loan
Fields
| Field Name | Description |
|---|---|
changedCircumstanceReason - ChangeOfCircumstanceReason
|
Why this change is a changed circumstance under §1026.19(e)(3)(iv), as stated when the request was opened. Null when none was stated, which is every request raised before the field existed. |
id - ID!
|
The ID of the loan change request |
status - LoanChangeRequestStatus!
|
Current status of this change request |
Example
{
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"id": 4,
"status": "APPROVED"
}
LoanChangeRequestStatus
Description
Status of a loan change request
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVED"
LoanChangeStage
Description
How far a loan change has gone.
Values
| Enum Value | Description |
|---|---|
|
|
The loan already carries the change, as when a redisclosure is sent for it. |
|
|
The loan does not carry the change yet, as when a change request is opened. |
Example
"APPLIED"
LoanChannel
Description
Origination channel of a loan or a customer's default.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Broker"
LoanClosedError
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
LoanContact
Description
LoanContact
Example
{
"email": "xyz789",
"firstName": "abc123",
"id": "4",
"lastName": "abc123",
"middleName": "xyz789",
"nmlsId": "xyz789",
"phoneNumber": "xyz789",
"title": "abc123"
}
LoanDocument
Description
A document uploaded against a loan application.
Fields
| Field Name | Description |
|---|---|
citations - CitationConnection!
|
Typed citation rows anchored into this document (supersedes the JSON-encoded evidence fieldMetadata). Paginated from day one: the facts-decomposition pass writes an observation citation per extracted fact, so overlays should fetch only the visible page / focused field keys via filterBy. |
Arguments
|
|
evidence - [LoanDocumentEvidence!]!
|
Evidence records extracted from this document. |
fileName - String!
|
The original file name. |
id - ID!
|
The unique identifier of the document. |
loan - Loan
|
The loan this document belongs to. Null, with an error, when the user cannot access it. |
loanApplicationId - ID!
|
The loan application this document belongs to. Use loan { id }.
|
mimeType - String!
|
The MIME type of the document. |
review - DocumentReview
|
The reviewer's read of this document — its status and, when ready, a plain-English summary. Null when there is no review to show. |
Arguments
|
|
s3Id - String!
|
The S3 storage identifier. |
underwritingEvidence - [UnderwritingEvidenceEdge!]!
|
Underwriting evidence edges naming this document — where the upload landed (rejected, satisfied, or matched nothing). Empty for a document with no edges at all. |
underwritingIntakeOutcomes - [UnderwritingIntakeOutcome!]!
|
Always empty: the underwriting service no longer records intake outcomes. The underwriting service no longer records intake outcomes; this field always returns an empty list and will be removed. |
uploadedAt - DateTime!
|
When the document was uploaded. |
uploadedBy - AnyContributor!
|
The contributor who uploaded this document. |
Example
{
"citations": CitationConnection,
"evidence": [LoanDocumentEvidence],
"fileName": "abc123",
"id": "4",
"loan": Loan,
"loanApplicationId": "4",
"mimeType": "abc123",
"review": DocumentReview,
"s3Id": "abc123",
"underwritingEvidence": [UnderwritingEvidenceEdge],
"underwritingIntakeOutcomes": [
UnderwritingIntakeOutcome
],
"uploadedAt": "2007-12-03T10:15:30Z",
"uploadedBy": AnyContributor
}
LoanDocumentEvidence
Description
An evidence record extracted from a document.
Fields
| Field Name | Description |
|---|---|
content - String!
|
JSON-encoded extracted content for this evidence. |
createdAt - DateTimeISO!
|
When this evidence was created. |
fieldMetadata - String
|
JSON-encoded per-field metadata including bounding boxes. Superseded by typed LoanDocument.citations rows; emits null as of P4 teardown and will be removed in the next release.
|
id - ID!
|
The unique identifier of the evidence. |
kind - String!
|
The kind of evidence (e.g. W2, PAYSTUB). |
params - String!
|
JSON-encoded parameters for this evidence. |
source - String!
|
JSON-encoded typed source object (who produced this evidence). |
Example
{
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"fieldMetadata": "abc123",
"id": 4,
"kind": "xyz789",
"params": "abc123",
"source": "xyz789"
}
LoanDocumentQueries
Description
Root type for document evidence queries.
Fields
| Field Name | Description |
|---|---|
documentById - LoanDocument!
|
Fetch a single document by its ID. |
Arguments
|
|
Example
{"documentById": LoanDocument}
LoanDocumentsFilter
Description
Filters for the list of documents associated with a loan. Defaults to active non-disclosure loan documents.
Fields
| Input Field | Description |
|---|---|
kind - LoanDocumentsKindFilter
|
Which document kinds to include. Defaults to non-disclosure loan documents. |
status - LoanDocumentsStatusFilter
|
Which document statuses to include. Defaults to active documents. |
Example
{"kind": "ALL", "status": "ACTIVE"}
LoanDocumentsKindFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
LoanDocumentsStatusFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
LoanEvent
Description
A durable, actor-attributed loan-lifecycle event. Append-only: events are recorded once and never mutated. A loan-activity webhook names one as its entity; node(id) resolves it for a caller who can read its loan.
Fields
| Field Name | Description |
|---|---|
actorId - String
|
Namespaced actor key (kind:id), where kind is the lowercased actorKind enum name (e.g. system:…, not any internal storage value); null when the event has no attributable actor. |
actorKind - LoanEventActorKind
|
The namespace of the actor who caused the event; null for system-initiated events with no attributable actor. |
actorName - String
|
Server-resolved display name of the actor — the name and nothing else, so cross-organization actors (Pylon internal admins) resolve without exposing any other field. Null whenever no name exists to give: system-initiated events, machine API credentials, and actors known only to the legacy origination system with no mirrored name. Clients render their own neutral copy for null. |
eventType - LoanEventType!
|
What happened |
id - ID!
|
The event's id |
loan - Loan
|
The loan the event belongs to. Null, with an error, when the user cannot access it. |
loanId - ID!
|
The loan the event belongs to Use loan { id }.
|
metadata - JSONObject!
|
Event-type-specific payload, validated server-side against the event type's closed schema at write time. |
occurredAt - DateTimeISO!
|
When the event happened in the domain (may predate its recording, e.g. for replayed webhooks). |
Example
{
"actorId": "xyz789",
"actorKind": "API",
"actorName": "xyz789",
"eventType": "ASYNC_JOB_COMPLETED",
"id": "4",
"loan": Loan,
"loanId": 4,
"metadata": {},
"occurredAt": "2007-12-03T10:15:30Z"
}
LoanEventActorKind
Description
The namespace of the actor attributed to a loan event. Request-context actors mirror the authenticated principal kinds; SYSTEM marks actors known only from the loan origination system's webhooks.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"API"
LoanEventType
Description
The kind of loan-lifecycle event. The full vocabulary is declared up front; emit sites land incrementally, so not every type is produced yet.
Values
| Enum Value | Description |
|---|---|
|
|
An asynchronous job the loan asked for reached a terminal state. Metadata: { jobType, outcome, ...ids }, where the ids name the job and outcome is what that job type can reach (spelled as the JobStatus members they correspond to): AVM carries subjectPropertyId, SUCCEEDED or FAILED, and is never sent for a property with no usable address yet; FEE_SHEET carries feeSheetRequestId, SUCCEEDED or FAILED; VOIE carries borrowerId (the report itself is read from the borrower's VOIE record): SUCCEEDED once the report's incomes are ingested and qualified, FAILED when the report carried no employment or income, so the borrower still owes paystubs. |
|
|
An automated-underwriting run changed state. Recorded once per status the run reaches (COMPLETED and DOWNGRADED are two readings of one status), in the API and in the worker alike; a write the event store refuses is retried by the worker, and on the API path only by the loan system's redelivery, so an event there can be missing. Metadata: { ausRunId, system, initiatedBy, transition } (initiatedBy is PYLON or LOAN_SYSTEM) plus, for every transition but STARTED, result (the engine's finding, or null), and for DOWNGRADED rateLockId. transition is STARTED (the run was submitted), COMPLETED (the engine answered), FAILED (the run ended with no finding) or DOWNGRADED (the engine answered while the loan holds a live rate lock that an earlier run allowed and this finding would not have; a lock no run allowed, taken under an override, is not downgraded by a repeat of its finding). The actor is the person who started the run, on every transition of that run; a run the loan system or a workflow started has none. |
|
|
A borrower-merge audit record, not an underwriting decision. The surviving borrower's ownership percentage was kept and the merged borrower's percentage was discarded. Metadata: { companyId, survivingBorrowerId, mergedBorrowerId, keptPercent, discardedPercent }. Published as LoanApplication.borrowerMergeOwnershipConflict. |
|
|
An underwriter reviewed a satisfied condition and cleared it. This is the sign-off that follows the TASK_COMPLETED of the same task (the submission). Metadata: { taskId, taskName }. |
|
|
An underwriter recorded a decision. Metadata: { decision }, one of CONDITIONALLY_APPROVED, SUSPEND, CLEAR_TO_CLOSE or DENY. |
|
|
A disclosure package was issued. Metadata: { disclosuresRunId, stage }. |
|
|
An underwriter archived a document or set its review status. Staff only: never returned to a customer credential, by loanEvents, orgEvents or node. Recorded when the write changes the document, not on a repeat of it. Metadata: { documentId, status, archiveReasonCategory } — documentId is an internal id for the loan-system document, which no public operation accepts (it is not Document.documentLink.id); status is the status the underwriter set, and archiveReasonCategory the reason when it is archived (null otherwise). The actor is the underwriter. |
|
|
A document was received on the loan. Metadata: { documentId, documentType } — documentId is Document.documentLink.id (the id rejectDocument accepts), documentType the type it was filed under. |
|
|
A user added a fee to the loan. Metadata: { closingCostId, after } — closingCostId is the Fee.id, after the fee's { description, totalFeeAmount, percentOfLoanAmount, borrowerPaidAtClose, sellerPaidAtClose, lenderPaidAtClose }. |
|
|
A user removed a fee from the loan. Metadata: { closingCostId, before }, shaped as in FEE_CREATED. |
|
|
A user edited a fee on the loan. Metadata: { closingCostId, before, after }, each side shaped as in FEE_CREATED. |
|
|
The loan was created. Metadata: { dealId }. |
|
|
The loan's live rate lock changed rate or product in place, keeping its lock date, expiry and extensions. Metadata: { rateLockId, kind, feeCharged, before, after } — kind is SAME_INVESTOR or INVESTOR_CHANGE, feeCharged the worst-case fee points the change charged, and before/after the lock's committed terms on each side. |
|
|
A requirement on the loan was satisfied: evidence was accepted, a deterministic credit check passed, a grouped requirement was met, a letter of explanation was accepted, or an underwriter asserted it. Fires once per requirement, the first time it is met; one that reopens and is met again does not fire again, but one whose parameters change is a new requirement and fires afresh. A waived requirement is not met and records no event while the waiver stands; if the waiver is later challenged and the requirement is then satisfied, it fires. Only requirements first met after this shipped record an event; earlier ones are not backfilled and their current state is available by query. An event is skipped, and not emitted again later, if its metadata are invalid or its loan is missing when the requirement is first met. Has no actor (actorKind is null). The metadata are { requirementId }, the requirement's id. |
|
|
The loan moved between stages. Recorded on every transition, so a loan that returns to a stage it already visited gets a new event. Metadata: { from, to } (from is null for the first stage). |
|
|
An underwriting condition (task) was withdrawn. Metadata: { taskId, taskName }. |
|
|
An underwriting condition (task) was satisfied. Metadata: { taskId, taskName }. |
|
|
An underwriting condition (task) was issued. Metadata: { taskId, taskName, taskType, requiresBorrowerAction } — taskId is BorrowerTask.id, taskType a TaskType value. |
|
|
A satisfied or withdrawn underwriting condition (task) was sent back for more work. Metadata: { taskId, taskName }. |
|
|
The loan's title agents changed: one was added, removed or replaced. The event is a signal only, with empty metadata {}; re-read Loan.title.agents for the current list. A change made through Pylon is normally not signalled, but its echo from the loan system can be, so treat every event as a hint to re-read. |
Example
"ASYNC_JOB_COMPLETED"
LoanEventsResponse
Fields
| Field Name | Description |
|---|---|
events - [LoanEvent!]!
|
Events in append order, oldest first. |
next - String!
|
Cursor for the next page. Always returned: when the page is empty the cursor is unchanged, so it can be replayed to poll for new events. |
Example
{
"events": [LoanEvent],
"next": "abc123"
}
LoanMutations
Fields
| Field Name | Description |
|---|---|
addRequirementConversationMessage - AddRequirementConversationMessageResponse
|
Add a message to a conversation. |
Arguments |
|
approveChangeRequest - ApproveLoanChangeRequestResponse
|
Approve a change request |
Arguments
|
|
archive - ArchiveLoanResponse
|
Archive a loan |
Arguments
|
|
assignLoanOfficer - AssignLoanOfficerResponse
|
Assign aloan officer to a loan |
Arguments
|
|
attachContact - AttachLoanContactResponse
|
Associate a contact with a loan |
Arguments
|
|
attachLoanNote - AttachLoanNoteResponse
|
Attach a note to the loan without submitting for underwriting |
Arguments
|
|
attachProductPricingRate - AttachProductPricingRateResponse
|
Assign a product pricing rate to a loan |
Arguments
|
|
attachSubjectProperty - AttachSubjectPropertyResponse
|
Attach a subject property to a loan |
Arguments
|
|
attachTitleCompany - AttachTitleCompanyResponse
|
Attach a title company to a loan |
Arguments
|
|
closeRequirementConversationSession - CloseRequirementConversationSessionResponse
|
Close a conversation. Underwriters only. |
Arguments |
|
confirmRateLock - ConfirmRateLockResponse
|
Confirm a rate lock for a loan |
Arguments
|
|
create - CreateLoanResponse
|
Create a loan |
Arguments
|
|
createApplication - CreateApplicationResponse
|
Open an application: a new deal and loan with a borrower per contact, the first contact as point of contact. Retrying with the same idempotency key, contacts, source and loan-officer slug returns the same loan and creates nothing once creation effects finish. While the first request is still finishing, a retry returns LOAN_APPLICATION_CREATION_IN_PROGRESS (retryable, HTTP 503); retry with the same key until the loan is returned. Reusing the key with different input returns IDEMPOTENCY_KEY_REUSED in userErrors and no loan. |
Arguments
|
|
createLoanAssignment - CreateLoanAssignmentResponse
|
Assign a user to a loan team |
Arguments
|
|
createRequirementConversationSession - CreateRequirementConversationSessionResponse
|
Start a conversation about a requirement or evidence item. A loan officer starts one with underwriting; an underwriter may start one with one of the loan's loan officers. |
Arguments |
|
denyRateLock - DenyRateLockResponse
|
Deny a rate lock for a loan Functionality has been absorbed into confirmRateLock |
Arguments
|
|
detachContact - DetachLoanContactResponse
|
Remove a contact's association from a loan |
Arguments
|
|
export - ExportLoanResponse
|
Export this loan as an XML file |
Arguments
|
|
extendRateLock - ExtendRateLockResponse
|
Extend the loan's active rate lock to one of its currently offered expiration dates. A rejected request is reported through userErrors and writes nothing. |
Arguments
|
|
floatStructure - FloatStructureResponse
|
Float a product structure for a loan by dispatching initial disclosures without locking the rate |
Arguments
|
|
forceGenerateDisclosurePackage - ForceGenerateDisclosurePackageResponse
|
Queue the loan's initial Loan Estimate for sending, outside the rate lock and float flows. Admin-only, for a loan whose initial disclosures did not go out. The package is sent in the background: read disclosuresRunStatus with the returned run ID for the outcome. The send is still withheld, and the run fails with the reason, when an initial package went out after this request, or when an earlier initial send has no confirmed delivery; record how that send ended with resolveUncertainDisclosureSend first. |
Arguments |
|
forceIcdSend - ForceIcdSendResponse
|
Force the loan's initial Closing Disclosure past its readiness gates, for a loan that is ready in a way readiness cannot yet see. This is the only override for those gates, and it is unrelated to forceGenerateDisclosurePackage, which re-sends only the initial Loan Estimate. Restricted to internal Pylon operators. Records the reason and every bypassed item, and leaves the evaluations as they were. While the forced send awaits its hand-off, a retry hands it off again: on the same evaluations it returns that forced send, with its reason; on newer ones it is refused. Once it is REJECTED_STALE or FAILED the loan can be forced again; in any other status a new forced send is refused. |
Arguments
|
|
freeze - FreezeLoanResponse
|
Freeze a loan, only available to Pylon employees. |
Arguments
|
|
generateClosingDisclosurePreview - GenerateClosingDisclosurePreviewResponse
|
Generate a closing disclosure preview for a loan. |
Arguments |
|
generateLoanEstimatePreview - GenerateLoanEstimatePreviewResponse
|
Generate a loan estimate preview for a loan. |
Arguments |
|
generateLockReplacementRedisclosurePreview - GenerateLockReplacementRedisclosurePreviewResponse
|
Preview the revised Loan Estimate that replacing this loan's committed lock would send its borrower, generated with the reasons the send would carry. Nothing is recorded or sent. Generation is asynchronous: poll disclosuresRun until it succeeds, then open its documentLinks. A loan whose standing change request names no changed circumstance, or whose send would be refused, is refused through userErrors. A loan with no committed lock the caller may replace is rejected as confirmRateLock rejects its replacement, and the call is forbidden for a customer whose lock replacements send no revised disclosure automatically. |
Arguments |
|
generateRedisclosurePreview - GenerateRedisclosurePreviewResponse
|
Preview the redisclosure redisclose would send this loan's borrower under these reasons. Nothing is recorded or sent. Restricted to internal Pylon operators. Generation is asynchronous: poll disclosuresRun until it succeeds, then open its documentLinks. The send refreshes mortgage insurance and AUS first, so the package it sends can differ from this preview. A loan whose send would be refused, such as one that owes nothing or is inside the closing window, is refused through userErrors. |
Arguments |
|
openChangeRequest - OpenLoanChangeRequestResponse
|
Open a new change request for a loan |
Arguments
|
|
reassignLoanOfficerTasks - ReassignLoanOfficerTasksResponse
|
Reassign all of the loan officer's tasks on the loan to the borrower in one go |
Arguments
|
|
reassignTask - ReassignTaskResponse
|
Flip a task's responsibility to a new assignee |
Arguments
|
|
recordLoanView - RecordLoanViewResponse
|
Record that the current user viewed a loan, for recency-sorted loan lists. Idempotent per (user, organization, loan): a repeat view bumps the last-viewed timestamp. |
Arguments
|
|
redisclose - RediscloseResponse
|
Start the redisclosure the loan owes its borrower, recording the changed circumstance that permits it. Restricted to internal Pylon operators. Resolves once the pipeline is started, not once the package is sent: the pipeline pulls mortgage insurance, runs AUS and requires it to allow the structure, and only then sends. Follow it through Loan.redisclosurePipelineRun, and the package through its disclosuresRun. The form the baseline owes is chosen by the send rather than asked for: a Loan Estimate baseline owes a revised LE, a Closing Disclosure a corrected CD. A pipeline already in flight for the loan, or a per-fee reason named twice, is refused through userErrors and starts nothing. A loan that owes nothing, has never been disclosed to, or is inside the four-business-day window in which §1026.19(e)(4)(ii) bars a revised Loan Estimate fails the pipeline, with the reason in the run's userErrors, before anything is sent. Scheduled for removal: do not build new integrations on redisclose.
|
Arguments
|
|
removeLoanAssignment - RemoveLoanAssignmentResponse
|
Remove a user from a loan team |
Arguments
|
|
reopenRequirementConversationSession - ReopenRequirementConversationSessionResponse
|
Reopen a closed conversation. Underwriters only. |
Arguments |
|
resolveUncertainDisclosureSend - ResolveUncertainDisclosureSendResponse
|
Record what the loan system shows about a disclosure package that was handed to it with no confirmed delivery: the send timed out, failed after the loan system accepted it, or its attempt stopped mid-send. While an initial send has no confirmed delivery, no other initial Loan Estimate is sent for the loan; the package's webhook records a delivery it can match to the run, and this records the rest. DELIVERED records the earliest package of the run's type that went out since the send began and that no other run records, and moves the loan's disclosures date up to it; NOT_DELIVERED is accepted only when there is no such package (a Failed package never went out), and lets the package be sent again. The run keeps the outcome, the user who recorded it and when. Refused within an hour of the send beginning, while its attempt may still report the outcome, and NOT_DELIVERED within two hours, while a late package may still arrive. Restricted to internal Pylon operators. |
Arguments |
|
setUseOwnTitleCompany - SetUseOwnTitleCompanyResponse
|
Set whether the borrower wants to use their own title company |
Arguments
|
|
startBulkLoanDocumentsExport - StartBulkLoanDocumentsExportResponse
|
Start a bulk loan documents export job. |
Arguments |
|
submitUnderwritingNotes - SubmitUnderwritingNotesResponse
|
Start an underwriting run with optional notes |
Arguments
|
|
thaw - ThawLoanResponse
|
Thaw a loan, only available to Pylon employees. |
Arguments
|
|
update - UpdateLoanResponse
|
Update top-level Loan fields. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateBorrowerPreferences - UpdateBorrowerPreferencesResponse
|
Update borrower preferences for a loan. |
Arguments
|
|
updateCompanyName - UpdateCompanyNameResponse
|
Update a processor's payee company name at the customer level and propagate to all assigned loans |
Arguments
|
|
updateProcessorFee - UpdateProcessorFeeResponse
|
Update a processor's fee at the customer level and propagate to all assigned loans |
Arguments
|
|
updateTaskName - UpdateTaskNameResponse
|
Updates the task name |
Arguments
|
|
withdraw - WithdrawLoanResponse
|
Withdraw a loan |
Arguments
|
|
Example
{
"addRequirementConversationMessage": AddRequirementConversationMessageResponse,
"approveChangeRequest": ApproveLoanChangeRequestResponse,
"archive": ArchiveLoanSuccess,
"assignLoanOfficer": AssignLoanOfficerResponse,
"attachContact": AttachLoanContactResponse,
"attachLoanNote": AttachLoanNoteResponse,
"attachProductPricingRate": AttachProductPricingRateResponse,
"attachSubjectProperty": AttachSubjectPropertyResponse,
"attachTitleCompany": AttachTitleCompanyResponse,
"closeRequirementConversationSession": CloseRequirementConversationSessionResponse,
"confirmRateLock": ConfirmRateLockResponse,
"create": CreateLoanResponse,
"createApplication": CreateApplicationResponse,
"createLoanAssignment": CreateLoanAssignmentResponse,
"createRequirementConversationSession": CreateRequirementConversationSessionResponse,
"denyRateLock": DenyRateLockResponse,
"detachContact": DetachLoanContactResponse,
"export": ExportLoanResponse,
"extendRateLock": ExtendRateLockResponse,
"floatStructure": FloatStructureResponse,
"forceGenerateDisclosurePackage": ForceGenerateDisclosurePackageResponse,
"forceIcdSend": ForceIcdSendResponse,
"freeze": FreezeLoanResponse,
"generateClosingDisclosurePreview": GenerateClosingDisclosurePreviewResponse,
"generateLoanEstimatePreview": GenerateLoanEstimatePreviewResponse,
"generateLockReplacementRedisclosurePreview": GenerateLockReplacementRedisclosurePreviewResponse,
"generateRedisclosurePreview": GenerateRedisclosurePreviewResponse,
"openChangeRequest": OpenLoanChangeRequestResponse,
"reassignLoanOfficerTasks": ReassignLoanOfficerTasksResponse,
"reassignTask": ReassignTaskResponse,
"recordLoanView": RecordLoanViewResponse,
"redisclose": RediscloseResponse,
"removeLoanAssignment": RemoveLoanAssignmentResponse,
"reopenRequirementConversationSession": ReopenRequirementConversationSessionResponse,
"resolveUncertainDisclosureSend": ResolveUncertainDisclosureSendResponse,
"setUseOwnTitleCompany": SetUseOwnTitleCompanyResponse,
"startBulkLoanDocumentsExport": StartBulkLoanDocumentsExportResponse,
"submitUnderwritingNotes": SubmitUnderwritingNotesResponse,
"thaw": ThawLoanResponse,
"update": UpdateLoanResponse,
"updateBorrowerPreferences": UpdateBorrowerPreferencesResponse,
"updateCompanyName": UpdateCompanyNameResponse,
"updateProcessorFee": UpdateProcessorFeeResponse,
"updateTaskName": UpdateTaskNameResponse,
"withdraw": LoanClosedError
}
LoanNotPreApprovedError
Description
User error indicating that the operation failed because the loan is not preapproved.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["abc123"],
"message": "xyz789"
}
LoanOfficer
Description
Loan-specific loan officer
Fields
| Field Name | Description |
|---|---|
email - String
|
Email address |
firstName - String
|
First name |
globalLoanOfficer - GlobalLoanOfficer
|
The loan officer's identity across loans: the global loan officer this assignment is for. Null when the assignment has no global loan officer record. |
id - ID!
|
The ID of the loan mortgage broker |
lastName - String
|
Last name |
licensedStates - [StateAbbreviated!]
|
The states the loan officer's broker is licensed in. Empty when the officer has no broker record. |
phoneNumber - String
|
Phone number |
Example
{
"email": "abc123",
"firstName": "xyz789",
"globalLoanOfficer": GlobalLoanOfficer,
"id": 4,
"lastName": "xyz789",
"licensedStates": ["AK"],
"phoneNumber": "xyz789"
}
LoanOfficerActiveInAnotherInstanceError
Description
The loan officer was not activated because they are active in another of the organizations that share this organization's loan officers. Make them inactive there first.
Fields
| Field Name | Description |
|---|---|
activeIn - LoanOfficerOrganization!
|
The organization the loan officer is active in. |
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"activeIn": LoanOfficerOrganization,
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
LoanOfficerChangeRequester
Description
Whom Pylon staff changed a loan officer's status for, when they acted on someone's request.
Values
| Enum Value | Description |
|---|---|
|
|
The organization the loan officer belongs to asked for it. |
Example
"CUSTOMER"
LoanOfficerDocumentTask
Description
A borrower's task that is only available to the loan officer
Fields
| Field Name | Description |
|---|---|
accessToken - String
|
Access token for SSO PDF viewer or any third-party access, if applicable. |
assigneeBorrower - Borrower
|
The borrower currently assigned to this task, if any. |
assigneeBorrowerId - ID
|
The borrower currently assigned to this task, if any. Use assigneeBorrower { id }.
|
clearedAt - DateTimeISO
|
When an underwriter (or the requirement's own rules) last cleared this task's condition. Requires read:loan-events; borrowers are refused. Null unless the task is completed. Null after a person or an integration reopened the task or withdrew its condition, until it is cleared again. Reopens the loan system makes on its own are not recorded, so a task completed again after one keeps its earlier clearance. Also null for a task cleared before late September 2026, when clearances were first recorded. |
completedAt - DateTime
|
|
createdOn - DateTime
|
|
description - String
|
|
details - TaskEntityDetails
|
Details about the entity this task is associated with Use relatedEntity instead, which resolves the associated entity as a Node whose own fields can be queried directly.
|
disclosureRecipient - DisclosureRecipient
|
|
documentLinks - [DocumentLink!]!
|
|
documentUploadPath - String
|
|
dueDate - DateTime
|
|
fields - [String!]
|
|
id - ID!
|
|
note - String
|
|
priority - Float
|
|
relatedEntity - Node
|
The entity this task is about (e.g. the Asset for a bank-statement upload task, or the AssetTransaction for a large-deposit task), resolvable as a Node. Prefer this over the deprecated details field. |
relatedEntityId - String
|
Related entity ID: the global id of the entity this task is about, resolvable via relatedEntity or the node(id) query. Use relatedEntity { id } instead — relatedEntity resolves the entity itself (its id plus all its other fields) in one query.
|
reopenedAt - DateTime
|
When the task was most recently reopened after having been completed or cancelled. Null if the task has never been reopened. |
requiredFor1003Form - Boolean
|
|
status - String!
|
|
title - String
|
|
type - String!
|
Example
{
"accessToken": "xyz789",
"assigneeBorrower": Borrower,
"assigneeBorrowerId": 4,
"clearedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"details": TaskEntityDetails,
"disclosureRecipient": DisclosureRecipient,
"documentLinks": [DocumentLink],
"documentUploadPath": "xyz789",
"dueDate": "2007-12-03T10:15:30Z",
"fields": ["xyz789"],
"id": 4,
"note": "abc123",
"priority": 123.45,
"relatedEntity": Node,
"relatedEntityId": "abc123",
"reopenedAt": "2007-12-03T10:15:30Z",
"requiredFor1003Form": false,
"status": "xyz789",
"title": "xyz789",
"type": "xyz789"
}
LoanOfficerMatchKey
Description
How loan officer records in different organizations were found to be the same person. EMAIL: the same email, ignoring case. SHARED_CONTACT: the same shared loan system contact.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
LoanOfficerMoveResult
Description
What moving one loan officer of a list did.
Values
| Enum Value | Description |
|---|---|
|
|
They were already active here and nowhere else, so nothing changed. |
|
|
They were made active here, and inactive wherever else they were active. |
|
|
Nothing changed; userErrors says why. |
Example
"ALREADY_HERE"
LoanOfficerMoveRow
Description
The result of moving one loan officer of a list.
Fields
| Field Name | Description |
|---|---|
globalLoanOfficer - GlobalLoanOfficer
|
The GlobalLoanOfficer after the move. Null when the organization has no such loan officer. |
movedFrom - [LoanOfficerOrganization!]!
|
Every other organization the loan officer was active in, where this move made them inactive, the one they were last active in first. Empty unless the result is MOVED. |
result - LoanOfficerMoveResult!
|
|
userErrors - [UserError!]!
|
Why the move was refused. Empty unless the result is REFUSED. |
Example
{
"globalLoanOfficer": GlobalLoanOfficer,
"movedFrom": [LoanOfficerOrganization],
"result": "ALREADY_HERE",
"userErrors": [UserError]
}
LoanOfficerMutations
Description
Loan officer mutations
Fields
| Field Name | Description |
|---|---|
activateLoanOfficerHere - ActivateLoanOfficerHereResponse
|
Make a GlobalLoanOfficer active in the current organization and, in the same change, inactive in every other organization that shares loan officers with it where they were active, so they are never active in both or in neither. A move between organizations happens only in the window at the start of each quarter; one outside it is refused in userErrors. When they are already active here, it only makes them inactive in those other organizations, at any time, and otherwise changes nothing. When their records disagree about who they are, it is refused in userErrors, also when they are already active here. While the organization's dual comp setting is off, it is refused in userErrors (MULTI_INSTANCE_LOAN_OFFICERS_OFF) and nothing changes. Works for loan officers with no user login. |
Arguments
|
|
moveLoanOfficersHere - MoveLoanOfficersHereResponse
|
Make each of a list of GlobalLoanOfficers active in the current organization, as activateLoanOfficerHere does, in one change. Each id gets a row with its result; a refused row changes nothing and leaves the others to go ahead. Calling it again reports the loan officers already moved as ALREADY_HERE. Refused as a whole in userErrors, changing nothing, while the organization's dual comp setting is off (MULTI_INSTANCE_LOAN_OFFICERS_OFF), when a caller other than Pylon staff names a requester, or when it waits too long for a lock held by another change in the organization, such as another list being moved in (LOAN_OFFICER_MOVE_RETRYABLE: send it again). A list of more than 25 ids fails with an error (LOAN_OFFICER_MOVE_BATCH_TOO_LARGE), not in userErrors, and changes nothing. |
Arguments
|
|
removeLoanOfficer - RemoveLoanOfficerResponse
|
Remove a GlobalLoanOfficer from the current organization: they become inactive here, and their login, if they have one, is removed from the organization unless another active loan officer record of theirs there shares its email. Their loans keep them, and their state licenses, which the loan officer's other organizations share, are never changed. Works for loan officers with no user login. |
Arguments
|
|
setLoanOfficerSlug - SetLoanOfficerSlugResponse
|
Set the URL slug for a GlobalLoanOfficer in the current organization. Callers without update:organization may only set their own slug. |
Arguments
|
|
setLoanOfficerStatus - SetLoanOfficerStatusResponse
|
Activate or deactivate a GlobalLoanOfficer in the current organization. An inactive loan officer is not listed among a loan's available loan officers and cannot be assigned to loans; loans already assigned keep the loan officer. Works for loan officers with no user login. Where organizations share loan officers, a loan officer is active in at most one of them, and moves to another one only in the window at the start of each quarter; an activation that breaks either rule is refused in userErrors. While the organization's dual comp setting is off, a caller other than Pylon staff is refused in userErrors (MULTI_INSTANCE_LOAN_OFFICERS_OFF) and nothing changes. |
Arguments
|
|
Example
{
"activateLoanOfficerHere": ActivateLoanOfficerHereResponse,
"moveLoanOfficersHere": MoveLoanOfficersHereResponse,
"removeLoanOfficer": RemoveLoanOfficerResponse,
"setLoanOfficerSlug": SetLoanOfficerSlugResponse,
"setLoanOfficerStatus": SetLoanOfficerStatusResponse
}
LoanOfficerOrganization
LoanOfficerStatus
Description
Whether a loan officer can be assigned new loans in this organization.
Values
| Enum Value | Description |
|---|---|
|
|
Listed among a loan's available loan officers and can be assigned to loans. |
|
|
Not listed among a loan's available loan officers and cannot be assigned to loans. Loans already assigned keep the loan officer. |
Example
"ACTIVE"
LoanOfficerStatusActor
Description
Who changed a loan officer's status.
Fields
| Field Name | Description |
|---|---|
apiClientId - OpaqueToken
|
The id of the API client that made it. Null unless an API client made it, and once the client is deleted. |
kind - LoanOfficerStatusActorKind!
|
Who it was. |
user - LoanOfficerStatusActorUser
|
The user who made it. Null for Pylon support, for an API client, and once the user is deleted. |
Example
{
"apiClientId": OpaqueToken,
"kind": "API_CLIENT",
"user": LoanOfficerStatusActorUser
}
LoanOfficerStatusActorKind
Description
Who changed a loan officer's status.
Values
| Enum Value | Description |
|---|---|
|
|
One of the organization's API clients. |
|
|
Pylon support. |
|
|
A user of the organization. |
Example
"API_CLIENT"
LoanOfficerStatusActorUser
Description
A user who changed a loan officer's status.
Fields
| Field Name | Description |
|---|---|
email - String
|
The user's email. |
Example
{"email": "abc123"}
LoanOfficerStatusChange
Description
One change to a loan officer's status in one organization.
Fields
| Field Name | Description |
|---|---|
cause - LoanOfficerStatusChangeCause!
|
What changed it. |
changedAt - DateTime!
|
When it changed. |
changedBy - LoanOfficerStatusActor!
|
Who changed it. |
from - LoanOfficerStatus!
|
The status before. |
organization - LoanOfficerOrganization!
|
The organization the status changed in. |
requestedBy - LoanOfficerChangeRequester
|
Whom Pylon staff made the change for. Null when it was made on no one's request. |
to - LoanOfficerStatus!
|
The status after. |
Example
{
"cause": "ACTIVATED_ELSEWHERE",
"changedAt": "2007-12-03T10:15:30Z",
"changedBy": LoanOfficerStatusActor,
"from": "ACTIVE",
"organization": LoanOfficerOrganization,
"requestedBy": "CUSTOMER",
"to": "ACTIVE"
}
LoanOfficerStatusChangeCause
Description
What changed a loan officer's status in an organization.
Values
| Enum Value | Description |
|---|---|
|
|
The loan officer was made active in another organization, which made them inactive here. |
|
|
The loan officer was made active in this organization, which made them inactive in their other organizations. |
|
|
The loan officer was removed from the organization. |
|
|
The status was set directly. |
Example
"ACTIVATED_ELSEWHERE"
LoanOfficerStatusChangeConnection
Description
A page of loan officer status changes.
Fields
| Field Name | Description |
|---|---|
edges - [LoanOfficerStatusChangeEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [LoanOfficerStatusChangeEdge],
"pageInfo": PageInfo
}
LoanOfficerStatusChangeEdge
Fields
| Field Name | Description |
|---|---|
cursor - OpaqueToken!
|
|
node - LoanOfficerStatusChange!
|
Example
{
"cursor": OpaqueToken,
"node": LoanOfficerStatusChange
}
LoanOfficerSwitchOutsideWindowError
Description
The loan officer was not moved to this organization because moves between the organizations that share loan officers happen only in a window at the start of each quarter.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
nextAllowedAt - DateTime!
|
When the next window opens. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123",
"nextAllowedAt": "2007-12-03T10:15:30Z"
}
LoanPreApprovedForLowerAmountError
Description
User error indicating that the operation failed because the loan was preapproved for a lower amount than what was requested.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["abc123"],
"message": "abc123"
}
LoanPricingFreshness
Description
Whether the loan's attached product structure is priced against the rate sheet that is current for it: the product's newest sheet, or, while a rate lock is in force on a customer with automatic redisclosure enabled, the sheet the lock was taken on. Float and rate lock are refused (LOAN_STRUCTURE_OUTDATED) while pricingStale is true; re-run pricing and re-select a rate to clear it.
Fields
| Field Name | Description |
|---|---|
currentRatesAsOf - DateTime
|
When the sheet the verdict compares against was received: the product's newest sheet, or the lock's sheet while a rate lock is in force on a customer with automatic redisclosure enabled. Null when no sheet could be resolved for the product. |
pricedAsOf - DateTime!
|
When the rate sheet the attached structure was priced against was received. |
pricingStale - Boolean!
|
Whether the attached structure is pinned to an older rate sheet than the one current for the loan. Matches the gate float, rate lock, and relock enforce. For a customer with automatic redisclosure enabled, a locked loan is judged against the sheet its lock was taken on, so a re-shop priced on the lock's sheet reads fresh. Re-running pricing alone does not clear this; a rate must be re-selected. |
Example
{
"currentRatesAsOf": "2007-12-03T10:15:30Z",
"pricedAsOf": "2007-12-03T10:15:30Z",
"pricingStale": true
}
LoanProcess
Description
Process-level information for a loan.
Fields
| Field Name | Description |
|---|---|
assignedRequirements - [AssignedRequirement!]
|
The published requirements on this loan assigned by party, not by individual: every borrower on the loan sees every BORROWER-assigned requirement. A borrower reads BORROWER; a loan officer reads either party. Null, with an error, when the read is refused. |
Arguments
|
|
legacyBorrowerTasks - [BorrowerTask!]!
|
Legacy borrower tasks for a specific borrower on this loan |
Arguments
|
|
legacyLoanOfficerTasks - [LoanOfficerDocumentTask!]!
|
Legacy loan officer tasks for this loan |
readyToUnderwrite - ReadyToUnderwrite
|
Readiness for the PROCESSING → UNDERWRITING transition. What's needed before submitting for underwriting? |
Arguments
|
|
Example
{
"assignedRequirements": [AssignedRequirement],
"legacyBorrowerTasks": [BorrowerTask],
"legacyLoanOfficerTasks": [LoanOfficerDocumentTask],
"readyToUnderwrite": ReadyToUnderwrite
}
LoanProductAvailability
Description
Whether a loan product can be enabled.
Fields
| Field Name | Description |
|---|---|
product - Product!
|
The loan product. |
unavailableReason - LoanProductUnavailableReason
|
Why the product can't be enabled yet. Null means it can be enabled. |
Example
{
"product": Product,
"unavailableReason": "NOT_YET_AVAILABLE"
}
LoanProductChangedReason
Description
§1026.19(f)(2)(ii)(B); product as §1026.37(a)(10) defines it.
Fields
| Field Name | Description |
|---|---|
changedComponents - [LoanProductComponent!]!
|
The parts that moved, so a narrative can name them. |
currentProduct - DisclosedLoanProduct!
|
|
disclosedProduct - DisclosedLoanProduct!
|
|
kind - DisclosureDriftReasonKind!
|
Example
{
"changedComponents": ["AMORTIZATION_TYPE"],
"currentProduct": DisclosedLoanProduct,
"disclosedProduct": DisclosedLoanProduct,
"kind": "APR_INACCURATE"
}
LoanProductComponent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMORTIZATION_TYPE"
LoanProductNoLongerAvailableError
Description
The loan product can no longer be enabled.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789"
}
LoanProductNotYetAvailableError
Description
The loan product can't be enabled for this organization yet.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
LoanPurposeChangedReason
Description
§1026.37(a)(9): the loan's purpose is no longer the one disclosed. No tolerance governs it, but a purchase and a refinance print different disclosures.
Fields
| Field Name | Description |
|---|---|
currentLoanPurpose - LoanPurposeType!
|
|
disclosedLoanPurpose - LoanPurposeType!
|
|
kind - DisclosureDriftReasonKind!
|
Example
{
"currentLoanPurpose": "PURCHASE",
"disclosedLoanPurpose": "PURCHASE",
"kind": "APR_INACCURATE"
}
LoanPurposeComparator
Description
Comparisons available on the loan purpose.
Fields
| Input Field | Description |
|---|---|
eq - LoanPurposeType
|
|
in - [LoanPurposeType!]
|
|
isNull - Boolean
|
|
neq - LoanPurposeType
|
|
nin - [LoanPurposeType!]
|
|
null - Boolean
|
Example
{
"eq": "PURCHASE",
"in": ["PURCHASE"],
"isNull": true,
"neq": "PURCHASE",
"nin": ["PURCHASE"],
"null": false
}
LoanPurposeType
Description
The purpose for which the loan proceeds will be used.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PURCHASE"
LoanScript
Description
A stored loan script: an ordered list of replayable API operations plus acceptance criteria (assertions and/or an expected preapproval outcome). This surface serves only active (runnable) scripts.
Fields
| Field Name | Description |
|---|---|
description - String!
|
What the script builds and verifies. |
scenarioId - String!
|
Stable, human-readable identifier for the script. |
spec - JSONObject!
|
The script payload: steps, and assertions and/or expected. |
Example
{
"description": "xyz789",
"scenarioId": "abc123",
"spec": {}
}
LoanScriptAssertionResult
Description
The outcome of a single loan-script assertion.
Fields
| Field Name | Description |
|---|---|
actualJson - String
|
JSON-serialized value the assertion's path resolved to. Null when the path (or its source) did not resolve. |
label - String!
|
The assertion's display label. |
message - String
|
Failure explanation. Null when the assertion passed. |
passed - Boolean!
|
Whether the assertion passed. |
Example
{
"actualJson": "xyz789",
"label": "xyz789",
"message": "xyz789",
"passed": true
}
LoanScriptMutations
Description
Root object for loan-script mutations (internal use only).
Fields
| Field Name | Description |
|---|---|
createLoanScript - CreateLoanScriptResponse
|
Create an active loan script. The spec is validated against the strict loan-script schema. |
Arguments
|
|
deleteLoanScript - DeleteLoanScriptResponse
|
Soft-delete an active loan script. |
Arguments
|
|
runLoanScript - RunLoanScriptResponse
|
Replay a stored loan-script scenario in-process, creating the loan by issuing its GraphQL operations as a real client would, then evaluate the script's assertions. Internal use only. |
Arguments
|
|
updateLoanScript - UpdateLoanScriptResponse
|
Update an active loan script's description and/or spec. |
Arguments
|
|
Example
{
"createLoanScript": CreateLoanScriptResponse,
"deleteLoanScript": DeleteLoanScriptResponse,
"runLoanScript": RunLoanScriptResponse,
"updateLoanScript": UpdateLoanScriptResponse
}
LoanScriptOperationVariable
LoanScriptQueries
Description
Root object for loan-script queries (internal use only).
Fields
| Field Name | Description |
|---|---|
all - [LoanScript!]!
|
List all active loan scripts. |
byScenarioId - LoanScript!
|
Fetch one active loan script by its scenario id. |
Arguments
|
|
stepCatalog - [LoanScriptStepCatalogEntry!]!
|
Every step type a loan script may use, derived from the runtime operation registry and step schemas (it cannot drift from what the executor accepts). |
Example
{
"all": [LoanScript],
"byScenarioId": LoanScript,
"stepCatalog": [LoanScriptStepCatalogEntry]
}
LoanScriptStepCatalogEntry
Description
One step type available to loan scripts: a replayable GraphQL operation, or a direct-DB step kind with its field names.
Fields
| Field Name | Description |
|---|---|
fields - [String!]
|
Top-level field names of the step shape (only for direct-DB steps). |
kind - String!
|
graphql, or a direct-DB step kind such as mockCredit.
|
operation - String
|
The operation key (only for graphql entries). |
variables - [LoanScriptOperationVariable!]
|
The operation document's variables (only for graphql entries). |
Example
{
"fields": ["abc123"],
"kind": "abc123",
"operation": "abc123",
"variables": [LoanScriptOperationVariable]
}
LoanScriptStepResult
Description
The result of a single replayed scenario step.
Fields
| Field Name | Description |
|---|---|
data - JSONObject
|
The raw GraphQL data the step produced. Null for non-GraphQL steps such as credit seeding. |
label - String!
|
The step's label. |
Example
{"data": {}, "label": "abc123"}
LoanStage
Description
Represents a stage in the loan process.
Fields
| Field Name | Description |
|---|---|
hmdaDisposition - HmdaDispositionCode
|
The HMDA disposition this stage records; null for a workflow stage. |
name - String!
|
The name of the loan stage. |
timestamp - DateTime!
|
The timestamp when this loan stage was reached. |
Example
{
"hmdaDisposition": "APPLICATION_APPROVED_BUT_NOT_ACCEPTED",
"name": "xyz789",
"timestamp": "2007-12-03T10:15:30Z"
}
LoanTermChangedReason
Description
A term the disclosure printed no longer matches the loan. Raised for the interest rate against a Loan Estimate (§1026.19(e)(3)(iv)(D)), and for any printed term against a Closing Disclosure (§1026.19(f)(2)(i)).
Fields
| Field Name | Description |
|---|---|
change - DisclosedFigureChange!
|
|
kind - DisclosureDriftReasonKind!
|
Example
{
"change": DisclosedAmountChange,
"kind": "APR_INACCURATE"
}
LoanToValueViolation
Description
Optimizer could not find a solution without exceeding the LTV limit.
Example
{"loanAmountExceeded": 123.45, "ltv": 987.65, "ltvLimit": 123.45}
LockReplacementChangeRequest
Description
The standing change request a replacement of the loan's committed lock would cite, as opened.
Fields
| Field Name | Description |
|---|---|
changedCircumstanceReason - ChangeOfCircumstanceReason!
|
|
description - String!
|
The request's description. For a request opened with descriptionDeferred, the template whose placeholders confirmRateLock's changeRequestDescription completes. |
Example
{
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"description": "xyz789"
}
LockedLoanSummary
Description
Authoritative loan summary values for a rate-locked loan, sourced from the system of record. Present only when the rate is locked. Each field falls back to the most recent internally-computed value when the system of record has not yet supplied one.
Fields
| Field Name | Description |
|---|---|
closingDate - Date
|
The estimated closing date. |
dti - NonNegativeFloat
|
The debt-to-income ratio, expressed as a 0-1 fraction. |
loanAmount - NonNegativeInt
|
The loan amount (in dollars). |
ltv - NonNegativeFloat
|
The loan-to-value ratio, expressed as a 0-1 fraction. |
noteRatePercent - NonNegativeFloat
|
Note rate. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
purchasePrice - NonNegativeInt
|
The purchase price (in dollars). |
rateLockExpiration - DateTime
|
The rate lock expiration time. |
Example
{
"closingDate": "2007-12-03",
"dti": 123.45,
"loanAmount": 123,
"ltv": 123.45,
"noteRatePercent": 123.45,
"purchasePrice": 123,
"rateLockExpiration": "2007-12-03T10:15:30Z"
}
LpaKnownRulesBackfillMutations
Description
Internal operations for the AUS known-rules catalogs.
Fields
| Field Name | Description |
|---|---|
start - StartLpaKnownRulesBackfillResponse
|
Start a bounded backfill of historical AUS runs. |
Arguments
|
|
status - StatusLpaKnownRulesBackfillResponse
|
Read a backfill execution and its continuation cursor when complete. |
Arguments |
|
Example
{
"start": StartLpaKnownRulesBackfillResponse,
"status": StatusLpaKnownRulesBackfillResponse
}
ManualBlockingLine
Values
| Enum Value | Description |
|---|---|
|
|
The loan's disbursement amount was missing or invalid. |
|
|
The loan's effective date was missing or invalid. |
Example
"DISBURSEMENT_AMOUNT"
ManualFigureLineInput
Description
One itemized line of a hand-entered wire-out figure.
Fields
| Input Field | Description |
|---|---|
amount - MonetaryAmount!
|
The signed amount, as the issued figure's lines carry it: positive for a credit to the wire, negative for a deduction. A zero line is dropped. |
code - FundingFigureLineCode!
|
A line code supported for wire-out figures. Each code appears at most once. |
Example
{"amount": MonetaryAmount, "code": "BORROWER_POINTS"}
ManualProvenance
Description
Provenance from a human reviewer. The requirement exists because an underwriter or processor added it manually.
Fields
| Field Name | Description |
|---|---|
citations - [Citation!]!
|
The citations the minting underwriter drew as grounds for the requirement, in minting order. Unresolvable references are skipped (and logged server-side), never surfaced as errors; requirements minted before citations existed read as []. |
description - String!
|
Human-readable explanation. |
evidence - [GuidelineReference!]!
|
Supporting evidence. |
Example
{
"citations": [Citation],
"description": "abc123",
"evidence": [GuidelineReference]
}
ManualRequirementAddOutcome
Description
What addManualRequirement did with the slug.
Values
| Enum Value | Description |
|---|---|
|
|
The slug's requirement is live; nothing changed. |
|
|
No requirement had this slug: a new one was minted (a retry of that same add also answers MINTED). |
|
|
The slug's requirement was removed and stays removed; restoreRequirement brings it back. |
|
|
The slug's removed requirement was restored by the add. Returned only until the add stops restoring (CUP-2686 step 2), and never after. |
Example
"ALREADY_ON_LOAN"
MarginSplit
Description
How a margin window splits the company's margin between its loan officers and the company. The company margin is the loan officer margin plus the holdback.
Fields
| Field Name | Description |
|---|---|
activeAt - DateTime!
|
The instant this margin segment became active (inclusive). |
companyMargin - NonNegativeFloat!
|
The company's whole margin, in points (1.5 = 1.5%): the loan officer margin plus the holdback. |
endsAt - DateTime
|
The instant this margin segment stops being active (exclusive). Null for the segment active right now. |
houseHoldback - NonNegativeFloat!
|
The part of the company margin the company holds back from its loan officers, in points (1.5 = 1.5%). 0 when none is held back. |
loanOfficerMargin - NonNegativeFloat!
|
The part of the company margin the company's loan officers receive, in points (1.5 = 1.5%). |
Example
{
"activeAt": "2007-12-03T10:15:30Z",
"companyMargin": 123.45,
"endsAt": "2007-12-03T10:15:30Z",
"houseHoldback": 123.45,
"loanOfficerMargin": 123.45
}
MaritalStatusType
Description
An individual's marital status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIVORCED"
MarketingRates
Description
Marketing rates
Fields
| Field Name | Description |
|---|---|
conforming - [ConformingMarketingRate]!
|
|
Arguments
|
|
custom - [CustomMarketingRate]!
|
|
Arguments
|
|
fha - [FhaMarketingRate]!
|
|
Arguments
|
|
jumbo - [JumboMarketingRate]!
|
|
Arguments
|
|
warehousingCosts - WarehousingCosts
|
Warehousing costs for all products. Always 0 points: Pylon no longer rolls warehousing costs into rate points. Warehousing costs are never applied; every product reports 0 points. This field will be removed. |
Example
{
"conforming": [ConformingMarketingRate],
"custom": [CustomMarketingRate],
"fha": [FhaMarketingRate],
"jumbo": [JumboMarketingRate],
"warehousingCosts": WarehousingCosts
}
MatrixAggregate
Fields
| Field Name | Description |
|---|---|
minimumMedian - Float
|
The minimum of all median values |
Example
{"minimumMedian": 123.45}
MergeSeededBorrowerInput
Description
Fold a co-borrower that document seeding minted into another borrower on the same loan.
Fields
| Input Field | Description |
|---|---|
keepName - DocumentSeedingNameChoice!
|
APPLICATION keeps the surviving borrower's name unchanged. DOCUMENT gives it the merged co-borrower's name as read from the documents, recorded under the caller. |
sourceBorrowerId - ID!
|
The co-borrower to fold in and remove. One that document seeding did not create on this loan is refused as SEED_DECISION_MERGE_SOURCE_NOT_SEEDED. |
targetBorrowerId - ID!
|
The borrower that survives, on the same loan as the source. Borrowers on different loans are a thrown denial. |
Example
{"keepName": "APPLICATION", "sourceBorrowerId": 4, "targetBorrowerId": 4}
MergeSeededBorrowerResponse
Description
The outcome of a merge. A refusal changes nothing and explains itself in userErrors.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
The surviving borrower; null on a refusal. |
userErrors - [DocumentSeedingDecisionUserError!]!
|
Empty when the merge was recorded. |
Example
{
"borrower": Borrower,
"userErrors": [DocumentSeedingDecisionUserError]
}
MilitaryBasePayIncome
Description
Military base pay income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
MilitaryClothesAllowanceIncome
Description
Military clothes allowance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryCombatPayIncome
Description
Military combat pay income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
MilitaryFlightPayIncome
Description
Military flight pay income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryHazardPayIncome
Description
Military hazard pay income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryOverseasPayIncome
Description
Military overseas pay income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryPropPayIncome
Description
Military prop pay income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryQuartersAllowanceIncome
Description
Military quarters allowance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryRationsAllowanceIncome
Description
Military rations allowance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MilitaryService
Description
Borrower has indicated active or prior military service.
Fields
| Field Name | Description |
|---|---|
militaryServiceExpectedCompletionDate - Date
|
|
militaryStatusType - MilitaryStatusType!
|
|
survivingSpouseIndicator - Boolean
|
Example
{
"militaryServiceExpectedCompletionDate": "2007-12-03",
"militaryStatusType": "ACTIVE_DUTY",
"survivingSpouseIndicator": false
}
MilitaryServiceDeclaration
Types
| Union Types |
|---|
Example
MilitaryService
MilitaryStatusType
Description
An individual's military status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE_DUTY"
MilitaryVariableHousingAllowanceIncome
Description
Military variable housing allowance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
MiscellaneousIncome
Description
Miscellaneous income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MismoFieldNonAdoption
Description
Data the importer could not import: one or more columns on a record it created, or an entity it did not create at all.
Fields
| Field Name | Description |
|---|---|
entity - IntakeEntity!
|
The kind of record this non-adoption concerns, stated even when none was created — which is how a client knows whose create mutation would close it. |
fields - [IntakeField!]!
|
The columns that went unfilled — at most one today, and empty when the non-adoption is that the record itself was never created. A list because the shared intake contract allows a run to report several columns against one non-adoption; this importer records one non-adoption per column, so it never sends more than one, and a client that handles the list handles whatever a later intake path sends. |
id - ID!
|
|
reason - IntakeNonAdoptionReason!
|
|
record - Node
|
The record the columns belong to. Null exactly when the importer created none — an asset no borrower owns, a party in a role we do not carry, a borrower who stated no income at all — and the client then reaches for that entity's ordinary create mutation rather than an editor. Never null merely because the identity was omitted: the importer binds each record at the moment it creates it. |
severity - IntakeNonAdoptionSeverity!
|
|
source - MismoSource!
|
Example
{
"entity": "ASSET",
"fields": [IntakeField],
"id": 4,
"reason": "ABSENT",
"record": Node,
"severity": "CRITICAL",
"source": MismoSource
}
MismoImport
Description
One MISMO file's import: the loan it created, and every non-adoption the importer could not act on itself. Read-only, and deliberately short-lived — an hourly sweep drops an import 24 hours after it ran, because the report describes one parse of one file at one moment rather than anything about the loan.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Stable id. The same value the upload returns as import_id. |
importedAt - DateTime!
|
When the import ran. |
loan - Loan!
|
The loan this import created. Always present: an import that created no loan is a rejected upload, and a rejected upload writes no report. |
nonAdoptions - [MismoNonAdoption!]!
|
Every non-adoption, in the order the importer met it in the file. Unpaginated: a report covers one file, and the whole of one is smaller than a cursor contract would be worth. |
Example
{
"id": "4",
"importedAt": "2007-12-03T10:15:30Z",
"loan": Loan,
"nonAdoptions": [MismoNonAdoption]
}
MismoNonAdoption
Description
One non-adoption from a MISMO import. Switch on __typename for the kind: MismoFieldNonAdoption names a column of ours, MismoUnrepresentableElement names a word of the file's that is not one.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Stable for the life of the import: two reads of one import return the same id for the same non-adoption. |
reason - IntakeNonAdoptionReason!
|
Why the importer could not do this itself. Keys a copy catalog on the client; never displayed raw. |
severity - IntakeNonAdoptionSeverity!
|
How much this non-adoption matters to the loan. |
source - MismoSource!
|
Where in the file the non-adoption arose, and what the file said. |
Possible Types
| MismoNonAdoption Types |
|---|
Example
{
"id": "4",
"reason": "ABSENT",
"severity": "CRITICAL",
"source": MismoSource
}
MismoSource
Description
Where in the uploaded file a non-adoption arose, and what the file said there. A statement about the FILE, never an identity: two imports of the same file produce the same source, and the record a non-adoption concerns is record's to name.
Fields
| Field Name | Description |
|---|---|
entity - IntakeEntity!
|
The entity the position indexes, which may differ from the non-adoption's own entity. MISMO states income inside the borrower who earns it, so an income non-adoption points at that borrower. |
label - String
|
The file's own label for the element, when a converter trusted one. Always null for interested parties: MISMO labels those on the ROLE as free text the file chose, not a closed vocabulary, so a party's non-adoptions are positioned instead (see position) rather than risk echoing a real name. |
position - Int
|
Zero-based position within the file's list of that entity. Null when the entity admits only one instance, when the file supplied a label instead, or when the non-adoption arose while reading the file and points at no instance at all. |
rawValue - String
|
The file's text for the value, verbatim, when it stated one we could not use. Null when the non-adoption is that the file said nothing. |
Example
{
"entity": "ASSET",
"label": "xyz789",
"position": 123,
"rawValue": "xyz789"
}
MismoUnrepresentableElement
Description
A word in the uploaded file that corresponds to no column of ours — an element MISMO 3.6 defines and 3.4, the model the importer reads, has no equivalent for, so it was dropped while normalizing the file. Nothing on the loan resolves it; it is reported so the loss is visible rather than silent.
Fields
| Field Name | Description |
|---|---|
element - String!
|
The file's own name for the element, as MISMO spells it. Not a column of ours, and deliberately not dressed up as one. |
id - ID!
|
|
reason - IntakeNonAdoptionReason!
|
|
record - Node
|
The record the element would have belonged to, when the importer can name one. Often null, and for a reason this kind does not share with MismoFieldNonAdoption: the loss is found while normalizing the file, before any record exists, and the file position it carries names a kind of record rather than one instance of it. |
severity - IntakeNonAdoptionSeverity!
|
|
source - MismoSource!
|
Example
{
"element": "xyz789",
"id": "4",
"reason": "ABSENT",
"record": Node,
"severity": "CRITICAL",
"source": MismoSource
}
MissingAttachmentTypeError
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
MissingCreditPullError
Description
User error indicating that there is no credit-pull associated with a borrower, blocking pricing and preapproval
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["xyz789"],
"message": "xyz789"
}
MissingDataError
Description
User error indicating the loan is missing information required in order to successfully preapprove or price it
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
missingData - String!
|
Example
{
"code": "abc123",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789",
"missingData": "xyz789"
}
MissingEmploymentStartDateError
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789"
}
MissingFieldsForCreditPullInput
Description
Input for checking missing fields required for credit pull
Example
{"borrowerIds": [4], "loanId": 4}
MonetaryAmount
Description
An exact USD amount serialized as a canonical signed decimal string with exactly two fractional digits.
Example
MonetaryAmount
MoneyMarketFundAsset
Description
Money market fund asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "xyz789",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
MortgageCreditCertificateIncome
Description
Mortgage credit certificate income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
percentageOfInterest - NonNegativeFloat
|
The percentage of interest that the mortgage credit certificate will cover. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"percentageOfInterest": 123.45,
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MortgageDifferentialIncome
Description
Mortgage differential income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
MoveLoanOfficersHereInput
Description
Input to the moveLoanOfficersHere mutation
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
The GlobalLoanOfficers to make active in the current organization, at most 25. |
requestedBy - LoanOfficerChangeRequester
|
Whom the moves are made for, recorded with each status change they make. Null when they are made on no one's request. Only Pylon staff may set it. |
Example
{"ids": [4], "requestedBy": "CUSTOMER"}
MoveLoanOfficersHereResponse
Description
Response of the moveLoanOfficersHere mutation
Fields
| Field Name | Description |
|---|---|
organization - Organization!
|
The organization the loan officers were moved into: the current organization. |
rows - [LoanOfficerMoveRow!]!
|
One row per id given, in the same order. |
userErrors - [UserError!]!
|
Why the whole list was refused, changing nothing. Empty when rows were judged. |
Example
{
"organization": Organization,
"rows": [LoanOfficerMoveRow],
"userErrors": [UserError]
}
MultiInstanceLoanOfficerConflict
Description
A person active in more than one of the organizations of this organization's legal entity.
Fields
| Field Name | Description |
|---|---|
activeIn - [String!]!
|
Slugs of the organizations the person is active in. |
emails - [String!]!
|
The emails on the matched loan officer records. |
matchedBy - LoanOfficerMatchKey!
|
Example
{
"activeIn": ["abc123"],
"emails": ["xyz789"],
"matchedBy": "EMAIL"
}
MultiInstanceLoanOfficers
Description
Whether an organization's loan officers work across the other organizations of its legal entity, each active in exactly one. Turning it ON is refused while any loan officer is active in more than one of those organizations. Adding or changing a loan officer does not depend on it yet. OFF is the default.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OFF"
MultiInstanceLoanOfficersGroupMember
Description
Another organization in the same legal entity, which shares loan officer contacts with this one.
Fields
| Field Name | Description |
|---|---|
companyName - String!
|
|
multiInstanceLoanOfficers - MultiInstanceLoanOfficers!
|
|
slug - String!
|
Example
{
"companyName": "xyz789",
"multiInstanceLoanOfficers": "OFF",
"slug": "xyz789"
}
MutualFundAsset
Description
Mutual fund asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "xyz789",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
NeighborhoodHousingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONDOMINIUM"
NetRentalIncome
Description
Net rental income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
NoAusForProduct
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["abc123"],
"message": "abc123"
}
NoLoanOfficerAssignedError
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
NoMilitaryService
Description
Borrower has indicated they have no military service.
Fields
| Field Name | Description |
|---|---|
survivingSpouseIndicator - Boolean
|
Example
{"survivingSpouseIndicator": true}
NoProductPricingError
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
NoStructurePresentBlocker
Description
No product structure is present on the loan
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
Node
Description
An entity uniquely identified by its id field
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Node ID |
Possible Types
| Node Types |
|---|
Example
{"id": 4}
NodeChangedEvent
NodeChangedEventBatch
Fields
| Field Name | Description |
|---|---|
changed - [NodeChangedEvent!]!
|
Array of changed entities (up to 20 items) |
Example
{"changed": [NodeChangedEvent]}
NodeType
Description
The base types of all Node
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Asset"
NonBorrowerContributionIncome
Description
Non-borrower contribution income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
NonBorrowerHouseholdIncome
Description
Non-borrower household income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
NonBorrowingOwner
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
personalInformation - PersonalInformation!
|
Example
{
"id": "4",
"personalInformation": PersonalInformation
}
NonBorrowingOwnerMutations
Fields
| Field Name | Description |
|---|---|
create - CreateNonBorrowingOwnerResponse
|
Create a new non-borrowing owner |
Arguments
|
|
delete - DeleteNonBorrowingOwnerResponse
|
Delete a non-borrowing owner |
Arguments
|
|
update - UpdateNonBorrowingOwnerResponse
|
Update a NonBorrowingOwner. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
Example
{
"create": CreateNonBorrowingOwnerResponse,
"delete": DeleteNonBorrowingOwnerResponse,
"update": UpdateNonBorrowingOwnerResponse
}
NonNegativeFloat
Description
Floats that will have a value of 0 or more.
Example
123.45
NonNegativeInt
Description
Integers that will have a value of 0 or more.
Example
123
NotesReceivableInstallmentIncome
Description
Notes receivable installment income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
NumberComparator
Description
Comparisons available on a numeric field.
Example
{
"eq": 123.45,
"gt": 987.65,
"gte": 987.65,
"in": [987.65],
"isNull": false,
"lt": 987.65,
"lte": 987.65,
"neq": 123.45,
"nin": [987.65],
"null": false
}
OauthClientScopeBundle
Description
Scope bundles a machine-to-machine API client can be granted. MTM_READ_WRITE is the full grant; MTM_LOAN_FILE_READ is read-only access to loan-file data; MTM_RATES_READ is read-only access to rates.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MTM_LOAN_FILE_READ"
OfferedDocument
Description
A document offered against a requirement: the underwriting service recorded a SUBMISSION citing it. It is listed even when it ends up satisfying nothing.
Fields
| Field Name | Description |
|---|---|
document - Document!
|
The offered document, as Loan.documents serves it. |
parsedDocumentId - OpaqueToken
|
The parsed-documents id braid registered the document under. Null until braid has registered it. |
Example
{
"document": Document,
"parsedDocumentId": OpaqueToken
}
OfferedFile
Description
A file offered against a requirement via upload (a SUBMISSION evidence edge). Upload intent is recorded even when the file ends up satisfying nothing, and split children inherit the offer from their parent packet.
Fields
| Field Name | Description |
|---|---|
extractionState - OfferedFileExtractionState!
|
|
file - LoanDocument!
|
The offered file. |
Example
{"extractionState": "EXTRACTED", "file": LoanDocument}
OfferedFileExtractionState
Description
Extraction progress of a file offered against a requirement: PENDING (uploaded, not yet extracted) or EXTRACTED (evidence exists).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EXTRACTED"
OpaqueToken
Description
An opaque string. Pass it back verbatim; do not parse it or infer meaning from its contents.
Example
OpaqueToken
OpenIntakeDraftResponse
Description
An operator's document-intake draft, or a retryable refusal to open one.
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime
|
When the draft expires. Reopening an unexpired draft preserves this time. Null when userErrors is non-empty. |
loan - Loan
|
The draft loan to upload documents to. Null when userErrors is non-empty. |
userErrors - [UserError!]!
|
Empty when a draft was opened. DOCUMENT_INTAKE_DRAFT_CLEANUP_PENDING means the expired draft is still being removed; try again. |
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"loan": Loan,
"userErrors": [UserError]
}
OpenLoanChangeRequestInput
Description
Input to the loan.openChangeRequest mutation.
Fields
| Input Field | Description |
|---|---|
attachmentDocumentIds - [ID!]
|
Loan documents to attach to the change-of-circumstance support ticket: ids returned by requestSupportDocumentUpload's file POST, or document ids from this loan's documents. Forwarded to Plain as-is and not recorded on the change request itself; ignored when change-request ticket filing is not enabled for the customer. At most 20. |
changeEvent - LoanChangeEvent
|
The change-of-circumstance event behind this request, recorded as the changed-circumstance reason the event falls under. Mutually exclusive with changedCircumstanceReason. |
changedCircumstanceReason - ChangeOfCircumstanceReason
|
Why this change is a changed circumstance under §1026.19(e)(3)(iv) — the judgement that permits a redisclosure to reset a fee's tolerance baseline. Recorded on the request; a later rate lock rediscloses under it rather than asking again. Omit when no judgement has been made: an unstated reason is not the same as OTHER. Omit also when changeEvent is given, which determines the reason. |
description - String!
|
Detailed description about the change request. With a changeEvent, it must be non-blank; for any event but OTHER it is the event's wording from Loan.changeEventWordings, completed with no bracketed placeholder such as [date] left in it. |
descriptionDeferred - Boolean
|
True when description is a template whose bracketed placeholders are completed later, at the confirmation of the rate lock this request precedes (ConfirmRateLockInput.changeRequestDescription). Skips the placeholder check here; the description must still be non-blank. |
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{
"attachmentDocumentIds": ["4"],
"changeEvent": "ADD_OR_REMOVE_BORROWER",
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"description": "xyz789",
"descriptionDeferred": false,
"loanId": "4"
}
OpenLoanChangeRequestResponse
Description
Response of the loan.openChangeRequest mutation.
Fields
| Field Name | Description |
|---|---|
changedCircumstanceReason - ChangeOfCircumstanceReason
|
Why this change is a changed circumstance under §1026.19(e)(3)(iv), as stated when the request was opened. Null when none was stated, which is every request raised before the field existed. |
id - ID!
|
The ID of the loan change request |
plainTicketId - ID
|
Id of the change-of-circumstance support ticket filed in Plain for this request, when ticket filing is enabled for the customer; null otherwise. |
status - LoanChangeRequestStatus!
|
Current status of this change request |
Example
{
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"id": "4",
"plainTicketId": "4",
"status": "APPROVED"
}
OpenPricingChangeFinding
Description
An open pricing change finding on a loan, in the queue.
Fields
| Field Name | Description |
|---|---|
deadline - PricingChangeDeadline!
|
|
id - ID!
|
|
ineligibilityReasons - [String!]!
|
For a finding that holds INELIGIBLE, the reasons, such as debt_to_income. |
kinds - [PricingChangeKind!]!
|
Every kind the finding holds. |
loan - Loan
|
The loan the finding is on. Null, with an error, when the viewer cannot access it. |
openedAt - DateTimeISO
|
Null when the finding's opening time was not recorded. |
Example
{
"deadline": PricingChangeDeadline,
"id": 4,
"ineligibilityReasons": ["abc123"],
"kinds": ["APR_MOVED_BEYOND_TOLERANCE"],
"loan": Loan,
"openedAt": "2007-12-03T10:15:30Z"
}
OpenRequirement
Description
A requirement that has not yet been fulfilled. Carries status, assignee, and fulfillment paths. Composite requirements list their children (each with its own phase) inside fulfillmentOptions.
Fields
| Field Name | Description |
|---|---|
agentEvaluation - AusConditionAgentEvaluation
|
The evaluation agent's latest assessment of this requirement (verdict, confidence, reasoning, cited passages). Only populated for automated-underwriting conditions the agent has evaluated; null otherwise. |
assignee - RequirementAssigneeRole!
|
The role responsible for fulfilling this requirement. |
blockedBy - [Requirement!]!
|
The open gate requirements this requirement waits on, per the readiness projection. Empty when nothing blocks it — including requirements written before the projection existed. |
borrowerIds - [ID!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. |
children - [Requirement!]!
|
Child requirements of a composite, each with its own phase, recursing through nested composites so a deep tree renders as a tree. Empty for leaf requirements. Unlike fulfillmentOptions, present in every phase — a satisfied or waived composite still lists its children here. |
description - String!
|
Human-readable label for this requirement, e.g. "W2 for Acme Corp (2025)". |
evidence - [Evidence!]!
|
The requirement's ordered evidence log — assertions and dispute acts interleaved in creation order (offered → asserted → challenged → endorsed → waived). |
fulfillmentOptions - [FulfillmentOption!]!
|
Paths to satisfying this requirement. For composites, contains the child requirements. |
id - ID!
|
Node ID |
offeredDocuments - [OfferedDocument!]
|
Documents offered against this requirement: those the underwriting service's SUBMISSIONs cite, minus any a live INVALIDATION on the same requirement withdrew (an INVALIDATION that is itself withdrawn no longer counts), and minus archived or deleted documents. A document appears here even when it ends up satisfying nothing. Null when the requirement was not read from the underwriting service (readyToUnderwrite(reconcile: false), or node(id)). |
offeredFiles - [OfferedFile!]!
|
Files offered against this requirement via upload (SUBMISSION evidence edges), including split children of offered packets. A file appears here even when it ends up satisfying nothing. |
openedAt - DateTimeISO!
|
When this requirement (re)entered its current OPEN period. A removed and later restored requirement carries the restore time, not its original creation time. |
phase - RequirementPhase!
|
Current resolution phase. Redundant with __typename but useful for client-side filtering without fragment matching. |
provenance - [ProvenanceSource!]!
|
Why this requirement exists — rule evaluation, manual condition, or data dependency. |
recommendedAction - RequirementRecommendedAction!
|
The next action recommended for this requirement. Clients must use this field, never the human-readable description, to decide whether to offer a specialized action. |
relatedEntities - [Node!]!
|
Entities this requirement's params point at (borrower, employment, asset, asset transaction, property), resolvable as Nodes. Entities the caller cannot read, that no longer exist, or that belong to another loan are omitted. |
status - RequirementStatus!
|
Current status of this requirement. |
verdict - AssertionVerdict
|
The folded evaluation outcome from the requirement's evidence log: UNFULFILLED or NEEDS_HUMAN (a FULFILLED fold satisfies the requirement, which then leaves the OPEN phase). Null means the requirement has never been evaluated. |
Example
{
"agentEvaluation": AusConditionAgentEvaluation,
"assignee": "ACCOUNT_MANAGER",
"blockedBy": [Requirement],
"borrowerIds": [4],
"borrowers": [Borrower],
"children": [Requirement],
"description": "xyz789",
"evidence": [Evidence],
"fulfillmentOptions": [FulfillmentOption],
"id": "4",
"offeredDocuments": [OfferedDocument],
"offeredFiles": [OfferedFile],
"openedAt": "2007-12-03T10:15:30Z",
"phase": "OPEN",
"provenance": [ProvenanceSource],
"recommendedAction": "ATTACH_LOAN_STRUCTURE",
"relatedEntities": [Node],
"status": "COMPLETED",
"verdict": "FULFILLED"
}
OptForDefaultTitleVendorInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
Example
{"loanId": 4}
OptForDefaultTitleVendorResponse
OptimalStructure
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Job ID |
productBreakdown - [StructuringResult!]!
|
|
result - EligibleProductStructure
|
|
status - JobStatus!
|
Job status |
Example
{
"id": "4",
"productBreakdown": [EligibleProductStructure],
"result": EligibleProductStructure,
"status": "FAILED"
}
OptimizerUnsatisfied
Description
Represents a failed optimizer solve.
Fields
| Field Name | Description |
|---|---|
_ - Boolean!
|
A no-op field that should not be requested. It will always throw an error if requested. It only exists to allow empty objects and may be removed in the future. This field should not be requested. It only exists to allow empty objects and may be removed in the future if more fields are added to this type. |
Example
{"_": false}
OrderAppraisalInput
Description
Input for ordering an appraisal.
Example
{"amcId": 987, "appraisalTypeId": 123, "loanId": 4}
OrderAppraisalResponse
Description
Response from ordering an appraisal.
Fields
| Field Name | Description |
|---|---|
appraisal - Appraisal!
|
The placed order's appraisal, as returned by Loan.appraisal(id) and listed by Loan.orderOuts. |
appraisalOrder - AppraisalOrder!
|
The created appraisal order. Use appraisal { id }.
|
Example
{
"appraisal": Appraisal,
"appraisalOrder": AppraisalOrder
}
OrderFloodInput
Description
Input for ordering a flood determination.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
ID of the loan application to order the flood determination for. |
productType - FloodProductType
|
Type of flood product to order. Defaults to Life of Loan when omitted. |
Example
{"loanId": "4", "productType": "Basic"}
OrderFloodResponse
Description
Response from ordering a flood determination.
Fields
| Field Name | Description |
|---|---|
floodOrder - FloodOrder!
|
The created flood order. |
Example
{"floodOrder": FloodOrder}
OrderOut
Organization
Description
Organization
Fields
| Field Name | Description |
|---|---|
accountStatus - CustomerAccountStatus!
|
Where the organization is in its life with Pylon: onboarding, live, a test workspace, or inactive. Only available to internal Pylon administrators |
accountStatusChange - OrganizationAccountStatusChange
|
Who last set the organization's account status and when; null while it is still the status it was created or backfilled with. Only available to internal Pylon administrators |
apiAccessStatus - CustomerApiAccessStatus!
|
Whether this organization's API access is active, paused, or inactive. |
availableCustomers - [CustomerMembership!]!
|
Organizations the requesting user has access to via a role relation, sorted alphabetically by companyName. Empty for non-org users; length 1 for single-customer users. Used by the org switcher. |
borrowerPortalUrl - String
|
Public origin of the organization's borrower intake portal, e.g. https://apply.example.com. Null when the organization has not configured one. |
branding - OrganizationBranding!
|
The organization's uploaded branding assets, as short-lived URLs for rendering. Always present; individual assets are null until uploaded. |
companyAddress - Address
|
The organization's company address. |
companyLegalName - String
|
|
companyName - String!
|
|
companySupportEmail - String
|
|
concessionLimitPerLoan - Float
|
|
contacts - [Contact!]
|
Contacts used or saved for this organization |
costAbsorption - [CostAbsorption!]
|
|
customerShare - NonNegativeFloat!
|
The share of the margin that the customer receives from the loan. Only available to internal Pylon administrators |
customerSlug - String
|
|
defaultLoanChannel - LoanChannel
|
The origination channel this customer's loans default to. Only available to internal Pylon administrators. |
defaultPrimaryLoanContact - LoanContact
|
The organization's default primary loan contact — the loan officer rendered on preapproval letters. Null when the organization has never set one; letters then fall back to the placeholder contact (see defaultPrimaryLoanContactFallbackEmail). Only available to internal Pylon administrators. |
defaultPrimaryLoanContactFallbackEmail - String!
|
Support mailbox standing in for the organization's default primary loan contact email while none has been set. Only available to internal Pylon administrators. |
effectiveMargin - OrganizationMargin!
|
The effective-dated margin breakdown (global, customer, Pylon take, and share) for the customer. Omit asOf for today's window; pass asOf for the window in effect on that date. Only available to internal Pylon administrators |
Arguments
|
|
electronicCommunicationsConsentUrl - String
|
|
emailDomains - [String!]
|
|
enableSso - Boolean!
|
Indicates whether this customer's users will use SSO-based login in the command center |
enabledLoanProducts - [PreapprovalProduct!]
|
|
enabledPlaidProducts - [EnabledPlaidProduct!]
|
|
feeHistory - [OrganizationFeeSchedule!]!
|
Every version of this organization's pay schedule with the fees in force under it, newest first. The version active right now reports endsAt: null. Only available to internal Pylon administrators |
fees - [OrganizationFee!]!
|
Fees on this organization's currently active pay schedule. Only available to internal Pylon administrators |
id - ID!
|
|
legalEntityGroup - String
|
The legal entity Pylon staff put the organization in, shared by every organization of that entity; null when it is in none. Organizations share loan officer contacts only within one legal entity. Only available to internal Pylon administrators |
loanOfficers - GlobalLoanOfficerConnection
|
The organization's loan officers, active and inactive, newest first unless sortDirection says otherwise. Includes loan officers with no user login. Null, with an error, for an organization other than the caller's. |
Arguments
|
|
loanProductAvailability - [LoanProductAvailability!]!
|
For every loan product, whether braid currently allows enabling it. The answer is the same for every organization. Only available to internal Pylon administrators |
margin - Float
|
|
Arguments
|
|
marginBreakdown - MarginSplit
|
How the organization's margin is split between its loan officers and the organization, in force now. It is the split a loan on the organization's default channel carries. Null when the margin breakdown is not available to the caller for this organization. |
marginHistory - [OrganizationMargin!]!
|
Every effective-dated (global margin, share) segment for the customer, newest-first. Type A windows are crossed with pay-schedule history so a share change mid-margin produces a distinct entry; Type B windows emit one entry per margin window. The segment active right now reports endsAt: null; closed segments report their real endsAt. Only available to internal Pylon administrators |
masqueradableCustomers - [CustomerMembership!]!
|
Every customer workspace in the environment being served — the set of valid masquerade targets — with real company names, sorted alphabetically by companyName. Only available to internal Pylon administrators; the org switcher renders it so admins see friendly customer names instead of slug-derived labels. |
mersOrgId - Int
|
The customer's MERS Organization ID (a 7-digit integer). Only available to internal Pylon administrators. |
multiInstanceLoanOfficers - MultiInstanceLoanOfficers!
|
Whether the organization's loan officers work across the other organizations of its legal entity. Available for the caller's own organization, and to internal Pylon administrators for any organization |
multiInstanceLoanOfficersChange - OrganizationSettingChange
|
Who last set multiInstanceLoanOfficers and when; null while it has never been set. Only available to internal Pylon administrators |
multiInstanceLoanOfficersGroup - [MultiInstanceLoanOfficersGroupMember!]!
|
The other organizations in the same legal entity, each with its own setting; empty when there are none. Only available to internal Pylon administrators |
nmlsId - String
|
|
privacyPolicyUrl - String
|
|
share - Float
|
This field is not populated and will be removed. |
telephonicCommunicationsConsentEnabled - Boolean!
|
Whether the borrower-facing consent screens link to a Telephonic Communications Consent document. |
telephonicCommunicationsConsentUrl - String
|
|
termsOfServiceUrl - String
|
|
underwritingCostRecovery - UnderwritingCostRecovery
|
|
underwritingGateThresholds - UnderwritingGateThresholds!
|
The organization's underwriting submission gate thresholds: the share of document tasks a loan needs complete before a first submission and before a resubmission, each the organization's own value or Pylon's default. Only available to internal Pylon administrators |
Example
{
"accountStatus": "ACTIVE",
"accountStatusChange": OrganizationAccountStatusChange,
"apiAccessStatus": "ACTIVE",
"availableCustomers": [CustomerMembership],
"borrowerPortalUrl": "abc123",
"branding": OrganizationBranding,
"companyAddress": Address,
"companyLegalName": "abc123",
"companyName": "abc123",
"companySupportEmail": "abc123",
"concessionLimitPerLoan": 123.45,
"contacts": [Contact],
"costAbsorption": [CostAbsorption],
"customerShare": 123.45,
"customerSlug": "abc123",
"defaultLoanChannel": "Broker",
"defaultPrimaryLoanContact": LoanContact,
"defaultPrimaryLoanContactFallbackEmail": "xyz789",
"effectiveMargin": OrganizationMargin,
"electronicCommunicationsConsentUrl": "xyz789",
"emailDomains": ["abc123"],
"enableSso": true,
"enabledLoanProducts": ["BayviewBayviewJumboAus"],
"enabledPlaidProducts": ["ASSETS"],
"feeHistory": [OrganizationFeeSchedule],
"fees": [OrganizationFee],
"id": "4",
"legalEntityGroup": "xyz789",
"loanOfficers": GlobalLoanOfficerConnection,
"loanProductAvailability": [LoanProductAvailability],
"margin": 987.65,
"marginBreakdown": MarginSplit,
"marginHistory": [OrganizationMargin],
"masqueradableCustomers": [CustomerMembership],
"mersOrgId": 123,
"multiInstanceLoanOfficers": "OFF",
"multiInstanceLoanOfficersChange": OrganizationSettingChange,
"multiInstanceLoanOfficersGroup": [
MultiInstanceLoanOfficersGroupMember
],
"nmlsId": "xyz789",
"privacyPolicyUrl": "xyz789",
"share": 123.45,
"telephonicCommunicationsConsentEnabled": false,
"telephonicCommunicationsConsentUrl": "xyz789",
"termsOfServiceUrl": "abc123",
"underwritingCostRecovery": UnderwritingCostRecovery,
"underwritingGateThresholds": UnderwritingGateThresholds
}
OrganizationAccountStatusChange
Description
Who last set the organization's account status, and when. Absent while the status is still the one it was created or backfilled with.
Example
{
"changedAt": "2007-12-03T10:15:30Z",
"changedBy": "abc123"
}
OrganizationBranding
Description
An organization's uploaded branding assets.
Fields
| Field Name | Description |
|---|---|
logoPngUrl - String
|
Short-lived URL for rendering the uploaded PNG logo, or null when none has been uploaded. Mint a fresh one per page load rather than storing it. |
logoSvgUrl - String
|
Short-lived URL for rendering the uploaded SVG logo, or null when none has been uploaded. Mint a fresh one per page load rather than storing it. |
Example
{
"logoPngUrl": "abc123",
"logoSvgUrl": "xyz789"
}
OrganizationContactRole
Description
Role of the contact in the context of an organization.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ATTORNEY"
OrganizationFee
Description
A fee an organization collects on its loans in addition to its margin share. Fees belong to the pay schedule that was active when they were opened and are never edited in place.
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeFloat
|
Dollar amount of the fee, e.g. 545. |
id - ID!
|
|
isAprFeeIndicator - Boolean
|
Whether the fee counts toward the APR. |
label - String
|
|
payType - CustomerFeePayType
|
Example
{
"amount": 123.45,
"id": "4",
"isAprFeeIndicator": true,
"label": "abc123",
"payType": "BORROWER_TO_BROKER"
}
OrganizationFeeInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeFloat!
|
Dollar amount of the fee, e.g. 545. |
isAprFeeIndicator - Boolean!
|
Whether the fee counts toward the APR. Default = false |
label - String!
|
|
payType - CustomerFeePayType!
|
Example
{
"amount": 123.45,
"isAprFeeIndicator": false,
"label": "xyz789",
"payType": "BORROWER_TO_BROKER"
}
OrganizationFeeSchedule
Description
One version of an organization's pay schedule and the fees that were in force under it. Fee changes open a new version rather than editing fee rows, so the versions are the audit trail. A version runs from activeAt (inclusive) until endsAt (exclusive); the version active right now reports endsAt: null.
Fields
| Field Name | Description |
|---|---|
activeAt - DateTime!
|
The instant this version became active (inclusive). |
endsAt - DateTime
|
The instant this version stopped applying (exclusive), or null for the version active right now. |
fees - [OrganizationFee!]!
|
The fees in force under this version. |
id - ID!
|
Example
{
"activeAt": "2007-12-03T10:15:30Z",
"endsAt": "2007-12-03T10:15:30Z",
"fees": [OrganizationFee],
"id": "4"
}
OrganizationLicensing
Fields
| Field Name | Description |
|---|---|
states - [OrganizationStateWithLicenses!]!
|
Example
{"states": [OrganizationStateWithLicenses]}
OrganizationMargin
Description
An effective-dated view of an organization's margin. All point values are expressed in points, where 1.5 means 1.5%. A segment is active from its activeAt (inclusive) until its endsAt (exclusive); the segment active right now reports endsAt: null.
Fields
| Field Name | Description |
|---|---|
activeAt - DateTime!
|
The instant this margin segment became active (inclusive). |
customerMargin - NonNegativeFloat!
|
The portion of the global margin the customer receives, in points (1.5 = 1.5%). |
endsAt - DateTime
|
The instant this margin segment stops being active (exclusive). Null for the segment active right now. |
globalMargin - NonNegativeFloat!
|
The full margin priced into the loan, in points (1.5 = 1.5%). Split between the customer and Pylon. |
houseHoldback - NonNegativeFloat!
|
The part of the customer margin held back from the organization's loan officers, in points (1.5 = 1.5%). 0 when none is held back. |
loanOfficerMargin - NonNegativeFloat!
|
The part of the customer margin the organization's loan officers receive, in points (1.5 = 1.5%): the customer margin less the holdback. |
pylonTake - NonNegativeFloat!
|
The portion of the global margin Pylon takes, in points (1.5 = 1.5%). |
share - NonNegativeFloat
|
The fraction of the global margin the customer receives (0-1), when the margin is share-based. Null when the split is not share- based (the customer margin and Pylon take are set directly). |
Example
{
"activeAt": "2007-12-03T10:15:30Z",
"customerMargin": 123.45,
"endsAt": "2007-12-03T10:15:30Z",
"globalMargin": 123.45,
"houseHoldback": 123.45,
"loanOfficerMargin": 123.45,
"pylonTake": 123.45,
"share": 123.45
}
OrganizationMutations
Description
Organization mutations
Fields
| Field Name | Description |
|---|---|
addEmailDomains - AddEmailDomainsResponse
|
Add email domains to the current organization. Domains are normalized to lowercase. Fails if any domain is already assigned to a different organization. Only available to internal Pylon administrators. |
Arguments
|
|
addOrganizationFee - AddOrganizationFeeResponse
|
Add a fee to the current organization. Opens a new pay schedule carrying the existing fees plus this one; loans pinned to an earlier date keep their fees. Refused with organization: null and a userErrors entry coded CUSTOMER_FEE_DUAL_COMPENSATION when a wholesale or broker-channel customer asks for a BORROWER_TO_BROKER fee, since its brokers are already paid by the lender (Reg Z §1026.36(d)(2)(i)), or coded CUSTOMER_FEE_CONFLICTS_WITH_RATE_COST when a borrower-paid underwriting fee is requested while the organization recovers that cost through its rate price. Only available to internal Pylon administrators |
Arguments
|
|
createContact - CreateContactResponse
|
Create and add a new contact to the current organization. |
Arguments
|
|
createOrganizationRole - CreateOrganizationRoleResponse
|
|
Arguments
|
|
createOrganizationUser - CreateOrganizationUserResponse
|
|
Arguments
|
|
createWebhookSigningKey - CreateWebhookSigningKeyResponse
|
Mints a new signing key for one of the organization's webhook subscriptions. The key starts PENDING and signs nothing until it has been tested and promoted. The signing secret is returned once, in this response only. A pending key that is not promoted expires after 72 hours, and minting another key for the same subscription replaces a pending one. |
Arguments
|
|
createWebhookSubscription - CreateWebhookSubscriptionResponse
|
Registers a webhook endpoint for the organization and mints its first signing key, whose secret is returned once, in this response only. The endpoint starts REGISTERED and its first key PENDING: no deliveries begin until that key has been tested and promoted. An organization can register up to 10 endpoints, each with its own callback URL, event types and signing keys; registering one never replaces another, and one past the limit is refused with WebhookSubscriptionLimitReachedError. Needs the webhook endpoint management feature, which is off unless enabled for the organization. |
Arguments
|
|
deleteOrganizationRole - DeleteOrganizationRoleResponse
|
|
Arguments
|
|
deleteOrganizationStateLicenses - DeleteOrganizationStateLicensesResponse
|
Delete the current organization's state licenses |
Arguments |
|
deleteOrganizationUser - DeleteOrganizationUserResponse
|
|
Arguments
|
|
deleteWebhookSubscription - DeleteWebhookSubscriptionResponse
|
Deletes a webhook endpoint and its signing keys, and returns it as it was. Deliveries to it stop and any still waiting are dropped. Needs the webhook endpoint management feature. |
Arguments
|
|
emergencyRevokeWebhookSigningKey - EmergencyRevokeWebhookSigningKeyResponse
|
Revokes a signing key immediately, bypassing the overlap window. Revoking the active key disables the subscription: deliveries stop, and are not replayed, until a new key is minted, tested and promoted. |
Arguments |
|
promoteWebhookSigningKey - PromoteWebhookSigningKeyResponse
|
Promotes a pending signing key to active; the previous active key becomes retiring in the same step, so there is never a moment with no active key or two. The key must have had a successful test delivery to the callback URL events are delivered to, and must not have expired. Your receiver must accept both keys until the retiring key is revoked, 7 days later. While a retiring key's overlap is open, promoting another key is refused with a WebhookRotationInProgressError naming the retiring key and when its overlap ends; revoke that key with emergencyRevokeWebhookSigningKey to end the overlap early. |
Arguments
|
|
redeliverWebhookEvent - RedeliverWebhookEventResponse
|
Sends one event to one of your organization's webhook endpoints again, as a new delivery with the event's own id, sequence and idempotency key: your receiver de-duplicates it like any repeat. It is signed with the endpoint's current key, sent to its current URL, and retried like any delivery; follow it in the endpoint's deliveries. The endpoint must receive the event's type now, and this key must be able to read the event's record. Limited per organization, and recorded with who asked while the delivery history is kept. Needs the webhook delivery history and webhook endpoint management features. |
Arguments
|
|
removeEmailDomains - RemoveEmailDomainsResponse
|
Remove email domains from the current organization. Only available to internal Pylon administrators. |
Arguments
|
|
replaceOrganizationFee - ReplaceOrganizationFeeResponse
|
Replace a fee on the current organization (e.g. change who pays it) with a new fee row on a new pay schedule; the original row is left untouched for loans pinned to an earlier date. Refused with organization: null and a userErrors entry coded CUSTOMER_FEE_NOT_ACTIVE when customerFeeId is not on the active schedule, so a repeated submission cannot open a second replacement, or coded CUSTOMER_FEE_DUAL_COMPENSATION when a wholesale or broker-channel customer asks for a BORROWER_TO_BROKER replacement, since its brokers are already paid by the lender (Reg Z §1026.36(d)(2)(i)), or coded CUSTOMER_FEE_CONFLICTS_WITH_RATE_COST when a borrower-paid underwriting replacement is requested while the organization recovers that cost through its rate price. Only available to internal Pylon administrators |
Arguments
|
|
requestBrandingLogoUpload - RequestBrandingLogoUploadResponse
|
Register a branding-logo upload for a customer and get the URL to POST the file to. The uploaded bytes replace the customer's logo of the declared file type. Only available to internal Pylon administrators. |
Arguments
|
|
resetOrganizationUserMfa - ResetOrganizationUserMfaResponse
|
Reset a user's multi-factor authentication: their MFA enrollments are removed and their MFA-trusted browsers forgotten, so they set up MFA again at their next login. |
Arguments
|
|
retireOrganizationFee - RetireOrganizationFeeResponse
|
Retire a fee from the current organization. Opens a new pay schedule without it; the fee stays on the closed schedule for loans pinned to an earlier date. Refused with organization: null and a userErrors entry coded CUSTOMER_FEE_NOT_ACTIVE when the fee is not on the active schedule, e.g. a repeated submission. Only available to internal Pylon administrators |
Arguments
|
|
sendOrganizationUserInvitationEmail - SendOrganizationUserInvitationEmailResponse
|
|
Arguments |
|
sendWebhookTestDelivery - SendWebhookTestDeliveryResponse
|
Sends a signed webhook.test event for a pending signing key, or for the active key (to verify a changed callback URL, or re-check the current one), to the pending callback URL if there is one and otherwise to the URL events are delivered to, and waits for the answer. A 2xx answering the event's challenge with the HMAC-SHA256 of challenge. + the token under the key records the key as tested against that URL, which is required before a pending key can be promoted, and verifies the endpoint there, which is required before anything is delivered to it; a pending callback URL becomes the callback URL in the same step when the key tested is the active key, or when nothing else signs deliveries yet (no active key and no shared secret from onboarding); a pending key tested while another key or the shared secret still signs deliveries moves the URL when it is promoted. Nothing is retried: a failure is reported here. |
Arguments
|
|
setDefaultPrimaryLoanContact - SetDefaultPrimaryLoanContactResponse
|
Set the current organization's default primary loan contact — the loan officer rendered on preapproval letters. Selects an existing loan contact by id, or creates a new one from the supplied fields, then repoints the organization at it. Only available to internal Pylon administrators. |
Arguments |
|
setOrganizationAccountStatus - SetOrganizationAccountStatusResponse
|
Set the current organization's account status. ACTIVE organizations are the only ones the cross-organization pipeline shows by default; ONBOARDING, TEST and INACTIVE organizations are left out of it until the caller widens the read, and badged in the workspace switcher. Does not affect login or API access. Only available to internal Pylon administrators |
Arguments |
|
setOrganizationApiAccessStatus - SetOrganizationApiAccessStatusResponse
|
Set the current organization's API access status. Only available to internal Pylon administrators. |
Arguments |
|
setOrganizationLegalEntityGroup - SetOrganizationLegalEntityGroupResponse
|
Put the current organization in a legal entity, or in none with null. Organizations share loan officer contacts, and a licence update may change a shared contact, only within one legal entity. Refused, with a userErrors entry coded LEGAL_ENTITY_GROUP_LOCKED_BY_SHARED_LOAN_OFFICERS, while the organization's multi-instance loan officers setting is ON. Only available to internal Pylon administrators |
Arguments |
|
setOrganizationMultiInstanceLoanOfficers - SetOrganizationMultiInstanceLoanOfficersResponse
|
Set whether the current organization's loan officers work across the other organizations of its legal entity. OFF is always allowed and changes nothing already shared or set. ON is refused, with a userErrors entry coded MULTI_INSTANCE_LOAN_OFFICERS_ACTIVE_IN_SEVERAL_INSTANCES and the people in conflicts, while anyone is active in more than one of those organizations. Only available to internal Pylon administrators |
Arguments |
|
setUnderwritingCostRecovery - SetUnderwritingCostRecoveryResponse
|
Choose how the current organization recovers its fixed underwriting cost: FEE charges dollars as the borrower-paid underwriting fee and sets the rate cost to $0; RATE adds dollars to the cost of every rate and sets the fee to $0. Both sides change in one transaction at the same instant, so the organization never charges both or neither. Fee and rate-cost history are preserved. Only available to internal Pylon administrators |
Arguments |
|
setUnderwritingGateThresholds - SetUnderwritingGateThresholdsResponse
|
Set the current organization's underwriting submission gate thresholds: the whole percentage (1 to 100) of a loan's borrower and loan-officer document tasks that must be complete before a first submission, and before a resubmission. A null side returns that round to Pylon's default (80 and 100). Takes effect on the next readiness read and submit for every loan of the organization. Only available to internal Pylon administrators |
Arguments |
|
toggleEnabledLoanProduct - ToggleEnabledLoanProductResponse
|
Enable or disable a loan product for the current customer. Only available to internal Pylon administrators |
Arguments
|
|
togglePlaidProduct - TogglePlaidProductResponse
|
Enable a Plaid product for the current customer. Only available to internal Pylon administrators |
Arguments
|
|
updateContact - UpdateContactResponse
|
Update an existing contact and returns the result. |
Arguments
|
|
updateCostAbsorption - UpdateCostAbsorptionResponse
|
Set the cost absorption points for a loan product on the current customer. Only available to internal Pylon administrators |
Arguments
|
|
updateCustomerShare - UpdateCustomerShareResponse
|
Updates the share of the margin that the current organization takes. Only available to internal Pylon administrators |
Arguments
|
|
updateOrganization - UpdateOrganizationResponse
|
Update the current organization |
Arguments
|
|
updateOrganizationCustomerMargin - UpdateOrganizationCustomerMarginResponse
|
Sets the customer margin (and optionally Pylon's take), in points, for an existing fixed-take agreement. Omitted Pylon take keeps its stored value. Share-based agreements must use total-margin and share updates instead. Only available to internal Pylon administrators |
Arguments |
|
updateOrganizationHouseHoldback - UpdateOrganizationHouseHoldbackResponse
|
Sets the part of the current organization's customer margin that is held back from its loan officers, in points. It opens a new margin window that keeps the current contract. A holdback above 0 is refused unless the organization is eligible for one. 0 is always allowed. Only available to internal Pylon administrators |
Arguments |
|
updateOrganizationLicensing - UpdateOrganizationLicensingResponse
|
Update the current organization's state licensing |
Arguments |
|
updateOrganizationMargin - UpdateOrganizationMarginResponse
|
Updates the current organization's total margin, in points, preserving its contract type. Only available to internal Pylon administrators |
Arguments
|
|
updateOrganizationOrigination - UpdateOrganizationOriginationResponse
|
Updates the current organization's origination configuration (MERS Org ID and default loan channel). Only available to internal Pylon administrators |
Arguments |
|
updateOrganizationRolePermissions - UpdateOrganizationRolePermissionsResponse
|
|
Arguments |
|
updateOrganizationUserDetails - UpdateOrganizationUserDetailsResponse
|
Update an organization user's names, phone number, or individual NMLS id. Omitted fields are unchanged; a null phone number or NMLS id clears the value. Email and licenses are not editable here. |
Arguments |
|
updateOrganizationUserLicenses - UpdateOrganizationUserLicensesResponse
|
Add or replace an organization user's individual state licenses. Each supplied state replaces the user's license in that state; states not supplied are kept, as the user may hold them through another organization. |
Arguments |
|
updateOrganizationUserRoles - UpdateOrganizationUserRolesResponse
|
|
Arguments |
|
updateWebhookSubscription - UpdateWebhookSubscriptionResponse
|
Changes a webhook endpoint's URL, its event types, its topics, or any of them; an omitted field keeps its value. A URL change is staged: deliveries keep going to the verified callbackUrl while the new URL waits in pendingCallbackUrl, and it becomes the delivery URL once a key that signs deliveries has passed a test delivery there: at once when the active key is tested (so no rotation is needed), or when a tested pending key is promoted. Naming the current URL again withdraws the pending change. Needs the webhook endpoint management feature. |
Arguments
|
|
Example
{
"addEmailDomains": AddEmailDomainsResponse,
"addOrganizationFee": AddOrganizationFeeResponse,
"createContact": CreateContactResponse,
"createOrganizationRole": CreateOrganizationRoleResponse,
"createOrganizationUser": CreateOrganizationUserResponse,
"createWebhookSigningKey": CreateWebhookSigningKeyResponse,
"createWebhookSubscription": CreateWebhookSubscriptionResponse,
"deleteOrganizationRole": DeleteOrganizationRoleResponse,
"deleteOrganizationStateLicenses": DeleteOrganizationStateLicensesResponse,
"deleteOrganizationUser": DeleteOrganizationUserResponse,
"deleteWebhookSubscription": DeleteWebhookSubscriptionResponse,
"emergencyRevokeWebhookSigningKey": EmergencyRevokeWebhookSigningKeyResponse,
"promoteWebhookSigningKey": PromoteWebhookSigningKeyResponse,
"redeliverWebhookEvent": RedeliverWebhookEventResponse,
"removeEmailDomains": RemoveEmailDomainsResponse,
"replaceOrganizationFee": ReplaceOrganizationFeeResponse,
"requestBrandingLogoUpload": RequestBrandingLogoUploadResponse,
"resetOrganizationUserMfa": ResetOrganizationUserMfaResponse,
"retireOrganizationFee": RetireOrganizationFeeResponse,
"sendOrganizationUserInvitationEmail": SendOrganizationUserInvitationEmailResponse,
"sendWebhookTestDelivery": SendWebhookTestDeliveryResponse,
"setDefaultPrimaryLoanContact": SetDefaultPrimaryLoanContactResponse,
"setOrganizationAccountStatus": SetOrganizationAccountStatusResponse,
"setOrganizationApiAccessStatus": SetOrganizationApiAccessStatusResponse,
"setOrganizationLegalEntityGroup": SetOrganizationLegalEntityGroupResponse,
"setOrganizationMultiInstanceLoanOfficers": SetOrganizationMultiInstanceLoanOfficersResponse,
"setUnderwritingCostRecovery": SetUnderwritingCostRecoveryResponse,
"setUnderwritingGateThresholds": SetUnderwritingGateThresholdsResponse,
"toggleEnabledLoanProduct": ToggleEnabledLoanProductResponse,
"togglePlaidProduct": TogglePlaidProductResponse,
"updateContact": UpdateContactResponse,
"updateCostAbsorption": UpdateCostAbsorptionResponse,
"updateCustomerShare": UpdateCustomerShareResponse,
"updateOrganization": UpdateOrganizationResponse,
"updateOrganizationCustomerMargin": UpdateOrganizationCustomerMarginResponse,
"updateOrganizationHouseHoldback": UpdateOrganizationHouseHoldbackResponse,
"updateOrganizationLicensing": UpdateOrganizationLicensingResponse,
"updateOrganizationMargin": UpdateOrganizationMarginResponse,
"updateOrganizationOrigination": UpdateOrganizationOriginationResponse,
"updateOrganizationRolePermissions": UpdateOrganizationRolePermissionsResponse,
"updateOrganizationUserDetails": UpdateOrganizationUserDetailsResponse,
"updateOrganizationUserLicenses": UpdateOrganizationUserLicensesResponse,
"updateOrganizationUserRoles": UpdateOrganizationUserRolesResponse,
"updateWebhookSubscription": UpdateWebhookSubscriptionResponse
}
OrganizationRole
OrganizationRoleConnection
Fields
| Field Name | Description |
|---|---|
edges - [OrganizationRoleEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [OrganizationRoleEdge],
"pageInfo": PageInfo
}
OrganizationRoleEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - OrganizationRoleNode!
|
Example
{"cursor": 4, "node": OrganizationRoleNode}
OrganizationRoleNode
OrganizationSettingChange
OrganizationStateWithLicenses
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
|
licenses - [StateLicense!]!
|
|
state - StateAbbreviated!
|
Example
{
"active": true,
"licenses": [StateLicense],
"state": "AK"
}
OrganizationStateWithLicensesInput
Fields
| Input Field | Description |
|---|---|
active - Boolean!
|
|
licenses - [StateLicenseInput!]
|
|
state - StateAbbreviated!
|
Example
{
"active": true,
"licenses": [StateLicenseInput],
"state": "AK"
}
OrganizationUser
Description
Organization user object
Fields
| Field Name | Description |
|---|---|
companyName - String
|
Payee company name for processor-type roles. Synced to the closing cost as the fee-paid-to name. |
email - String!
|
|
firstName - String!
|
|
id - ID!
|
|
individualNmlsId - String
|
The user's individual NMLS identifier. |
lastName - String!
|
|
licenses - [OrganizationUserLicense!]
|
Individual state licenses read back from the user's licensed-user broker record (loan officers and admins). Null when the user has no such record. License expiration is not stored locally, so it is not returned here. |
organizationRoles - [OrganizationRole!]
|
|
phoneNumber - String
|
The user's phone number. |
processorFeeAmount - Float
|
Current processing fee in dollars, if the user has a processor-type role |
Example
{
"companyName": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"id": 4,
"individualNmlsId": "abc123",
"lastName": "xyz789",
"licenses": [OrganizationUserLicense],
"organizationRoles": [OrganizationRole],
"phoneNumber": "xyz789",
"processorFeeAmount": 987.65
}
OrganizationUserAccessType
Description
Whether a new organization user is provisioned with Command Center access (login + internal) or as an internal-only record.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CommandCenterAccess"
OrganizationUserAddedBy
Description
Who added a user to the organization.
Fields
| Field Name | Description |
|---|---|
apiClientId - OpaqueToken
|
The id of the API client that added them. Null unless an API client did, and once the client is deleted. |
kind - LoanOfficerStatusActorKind!
|
Who it was. |
user - OrganizationUserAddedByUser
|
The user who added them, Pylon staff included. Null for an API client, for Pylon support acting with no user of its own, and once the user is deleted. |
Example
{
"apiClientId": OpaqueToken,
"kind": "API_CLIENT",
"user": OrganizationUserAddedByUser
}
OrganizationUserAddedByUser
OrganizationUserConnection
Fields
| Field Name | Description |
|---|---|
edges - [OrganizationUserEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - NonNegativeInt!
|
The total number of users in the organization. |
Example
{
"edges": [OrganizationUserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
OrganizationUserEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - OrganizationUserNode!
|
Example
{"cursor": 4, "node": OrganizationUserNode}
OrganizationUserExport
Description
An organization's users as a CSV file, one row per user, with each user's roles and account creation time.
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"filename": "xyz789",
"url": "xyz789"
}
OrganizationUserLicense
Description
A state license held by an organization user, read back from the licensed-user broker record created alongside the user.
Fields
| Field Name | Description |
|---|---|
licenseNumber - String
|
The state-issued license number. |
state - StateAbbreviated!
|
The US state the license is held in. |
Example
{"licenseNumber": "xyz789", "state": "AK"}
OrganizationUserLicenseInput
Description
A state license held by an organization user. The expiration year defaults to December 31st of that year.
Fields
| Input Field | Description |
|---|---|
expirationYear - PositiveInt!
|
The year the license expires. The expiration date is set to December 31st of this year. |
licenseNumber - String!
|
The state-issued license number. |
state - StateAbbreviated!
|
The US state the license is held in. |
Example
{
"expirationYear": 123,
"licenseNumber": "xyz789",
"state": "AK"
}
OrganizationUserNode
Fields
| Field Name | Description |
|---|---|
addedBy - OrganizationUserAddedBy
|
Who added the user to the organization. Null when that was not recorded. Pylon internal admins only. |
createdAt - DateTime
|
When the user's account was created. Pylon internal admins only. |
email - String!
|
|
firstName - String!
|
|
id - ID!
|
|
lastName - String!
|
|
organizationRoles - [OrganizationRole!]!
|
The user's roles in this organization. |
Example
{
"addedBy": OrganizationUserAddedBy,
"createdAt": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "xyz789",
"id": "4",
"lastName": "xyz789",
"organizationRoles": [OrganizationRole]
}
OtherAsset
Description
Asset of miscellaneous or unspecified type
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
description - String
|
Description of the asset |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
isLiquid - Boolean
|
Indicates whether or not the asset is liquid |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"description": "abc123",
"id": "4",
"institutionLogoUrl": "abc123",
"institutionName": "xyz789",
"isLiquid": true,
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
OtherIncome
Description
Income that does not fall into any of the predefined types
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
description - String
|
Information about the income type |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"description": "xyz789",
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
OutOfPocketExceedsAssetsViolation
Description
The requested loan amount forces more cash to close than the borrower's available assets can cover.
Fields
| Field Name | Description |
|---|---|
additionalAssetsNeeded - Float!
|
Additional dollars of available assets the borrower needs to cover the required cash to close. |
Example
{"additionalAssetsNeeded": 987.65}
OvertimeIncome
Description
Overtime income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment
|
The employment this income is associated with |
employmentId - ID
|
The employment this income is associated with Use employment { id }.
|
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": Employment,
"employmentId": 4,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
OwnedProperty
Description
Owned property
Fields
| Field Name | Description |
|---|---|
address - Address
|
US Address |
createdOn - DateTime!
|
When the owned property was created. |
currentUsageType - PropertyUsageType
|
How the owner is using this property. |
homeInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly home insurance premium. |
id - ID!
|
Owned property ID |
intendedDisposition - PropertyDisposition
|
The intended disposition of the property. Indicates whether the borrowers will be retaining or selling (or sold) the property. |
intendedUsageType - PropertyUsageType
|
How the owner intends to use this property. |
liabilities - [Liability!]
|
Liabilities associated with an owned property, including stored self-reported mortgages. |
monthlyAssociationDues - NonNegativeInt
|
Monthly association dues (in dollars) |
mortgageInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly mortgage insurance monthly premium. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing (e.g. single or multi-family) |
nonBorrowingOwners - [NonBorrowingOwner!]!
|
|
pendingNetSaleProceedsAsset - Asset
|
If the property is pending sale, the associated asset that represents the expected net proceeds from the sale. |
propertyTaxMonthlyPayment - NonNegativeInt
|
The dollar amount of property taxes due per month. |
propertyValue - NonNegativeInt
|
The estimated value of the owned property, in whole dollars |
purchaseDate - Date
|
The date when the property was originally purchased |
rentalIncome - Income
|
If the property is a rental property, the associated rental income entity. |
sellDate - Date
|
The date when the property was sold (or null if the borrower(s) still own the property). |
Example
{
"address": Address,
"createdOn": "2007-12-03T10:15:30Z",
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"id": "4",
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"liabilities": [Liability],
"monthlyAssociationDues": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"nonBorrowingOwners": [NonBorrowingOwner],
"pendingNetSaleProceedsAsset": Asset,
"propertyTaxMonthlyPayment": 123,
"propertyValue": 123,
"purchaseDate": "2007-12-03",
"rentalIncome": Income,
"sellDate": "2007-12-03"
}
OwnedPropertyConnection
Fields
| Field Name | Description |
|---|---|
edges - [OwnedPropertyEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [OwnedPropertyEdge],
"pageInfo": PageInfo
}
OwnedPropertyEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - OwnedProperty!
|
Example
{
"cursor": "4",
"node": OwnedProperty
}
OwnedPropertyMutations
Description
Owned property mutations
Fields
| Field Name | Description |
|---|---|
attachLiabilities - AttachOwnedPropertyLiabilitiesResponse
|
Attach liabilities to owned property. |
Arguments |
|
attachNonBorrowingOwner - AttachOwnedPropertyNonBorrowingOwnerResponse
|
Attach non-borrowing owner to owned property. |
Arguments |
|
create - CreateOwnedPropertyResponse
|
Create an OwnedProperty |
Arguments
|
|
delete - DeleteOwnedPropertyResponse
|
Delete an owned property |
Arguments
|
|
detachLiabilities - DetachOwnedPropertyLiabilitiesResponse
|
Detach the address from an owned property. |
Arguments |
|
update - UpdateOwnedPropertyResponse
|
Update an OwnedProperty. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
Example
{
"attachLiabilities": AttachOwnedPropertyLiabilitiesResponse,
"attachNonBorrowingOwner": AttachOwnedPropertyNonBorrowingOwnerResponse,
"create": CreateOwnedPropertyResponse,
"delete": DeleteOwnedPropertyResponse,
"detachLiabilities": DetachOwnedPropertyLiabilitiesResponse,
"update": UpdateOwnedPropertyResponse
}
PacificIslanderRace
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GUAMANIAN_OR_CHAMORRO"
PageInfo
PagePoint
PagePointInput
PageRange
Fields
| Field Name | Description |
|---|---|
from - PositiveInt!
|
|
to - PositiveInt!
|
Example
{"from": 123, "to": 123}
PaidTo
Fields
| Field Name | Description |
|---|---|
legalEntity - LegalEntity
|
Example
{"legalEntity": LegalEntity}
Party
Fields
| Field Name | Description |
|---|---|
address - Address
|
|
id - ID!
|
The unique ID of the Party. |
individual - PartyIndividual
|
Details about the party, if the party is an individual (rather than a company) |
legalEntity - PartyLegalEntity
|
Details about the party, if the party is a legal entity |
role - PartyRole
|
Indicates the type of relationship between the party and the loan. |
Example
{
"address": Address,
"id": 4,
"individual": PartyIndividual,
"legalEntity": PartyLegalEntity,
"role": "APPRAISER"
}
PartyIndividual
Example
{
"email": "abc123",
"name": PartyName,
"telephoneNumber": "xyz789"
}
PartyIndividualInput
Fields
| Input Field | Description |
|---|---|
email - String
|
The e-mail address of the individual associated with the loan. |
name - PartyNameInput
|
The name of the individual associated with the loan. |
telephoneNumber - String
|
The phone number of the individual associated with the loan. |
Example
{
"email": "abc123",
"name": PartyNameInput,
"telephoneNumber": "abc123"
}
PartyLegalEntity
Fields
| Field Name | Description |
|---|---|
legalEntityDetail - PartyLegalEntityDetail
|
Details about the legal entity associated with the loan. |
Example
{"legalEntityDetail": PartyLegalEntityDetail}
PartyLegalEntityDetail
PartyLegalEntityDetailInput
PartyLegalEntityInput
Fields
| Input Field | Description |
|---|---|
legalEntityDetail - PartyLegalEntityDetailInput
|
Details about the legal entity associated with the loan. |
Example
{"legalEntityDetail": PartyLegalEntityDetailInput}
PartyMutations
Fields
| Field Name | Description |
|---|---|
create - CreatePartyResponse
|
|
Arguments
|
|
delete - DeletePartyResponse
|
|
Arguments
|
|
optForDefaultTitleVendor - OptForDefaultTitleVendorResponse
|
|
Arguments
|
|
update - UpdatePartyResponse
|
|
Arguments
|
|
Example
{
"create": CreatePartyResponse,
"delete": DeletePartyResponse,
"optForDefaultTitleVendor": OptForDefaultTitleVendorResponse,
"update": UpdatePartyResponse
}
PartyName
PartyNameInput
PartyRole
Description
A designation for what type of Party is being represented.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPRAISER"
PayPeriodFrequency
Description
The frequency at which income is paid
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANNUALLY"
PendingNetSaleProceedsFromRealEstateAsset
Description
Pending net sale proceeds from a real estate asset. The amount is the expected proceeds and should be less than or equal to the salePrice.
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
ownedProperty - OwnedProperty
|
The property being sold |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
salePrice - NonNegativeInt
|
Sale price of the property in dollars |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "abc123",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"ownedProperty": OwnedProperty,
"qualifiedAmount": 123,
"salePrice": 123,
"verifiedAmount": 123
}
PensionIncome
Description
Pension income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
PersonalInformation
PersonalInformationInput
PhoneNumberType
Description
Phone number type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CELL"
PickLoanId
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Node ID |
Example
{"id": "4"}
PickSubjectPropertyId
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Node ID |
Example
{"id": "4"}
PipelineSummaryCounter
Fields
| Input Field | Description |
|---|---|
filters - LoanApplicationAnalyticsFilters!
|
|
label - String!
|
Example
{
"filters": LoanApplicationAnalyticsFilters,
"label": "xyz789"
}
PipelineSummaryItem
PipelineSummaryResponse
Fields
| Field Name | Description |
|---|---|
counts - [PipelineSummaryItem!]!
|
|
totalCount - Float!
|
Example
{"counts": [PipelineSummaryItem], "totalCount": 123.45}
Pitia
Fields
| Field Name | Description |
|---|---|
floodInsurance - NonNegativeFloat
|
|
hoaDues - NonNegativeFloat
|
|
homeownersInsurance - NonNegativeFloat
|
|
mortgageInsurance - NonNegativeFloat
|
|
principalAndInterest - NonNegativeFloat
|
|
qualifyingPrincipalAndInterest - NonNegativeFloat
|
|
taxes - NonNegativeFloat
|
Example
{
"floodInsurance": 123.45,
"hoaDues": 123.45,
"homeownersInsurance": 123.45,
"mortgageInsurance": 123.45,
"principalAndInterest": 123.45,
"qualifyingPrincipalAndInterest": 123.45,
"taxes": 123.45
}
PlaceAddressComponent
Fields
| Field Name | Description |
|---|---|
longText - String
|
Full text of the component, e.g. "California" |
shortText - String
|
Abbreviated text of the component, e.g. "CA" |
types - [String!]!
|
Component types, e.g. "street_number", "route", "locality", "postal_code" |
Example
{
"longText": "xyz789",
"shortText": "xyz789",
"types": ["abc123"]
}
PlaceAutocompleteSuggestion
Fields
| Field Name | Description |
|---|---|
mainText - String!
|
Primary text of the suggestion, usually the street address |
placeId - ID!
|
Opaque place identifier; pass to the place field to fetch address components |
secondaryText - String!
|
Secondary text of the suggestion, usually city/state/country; "" when there is none |
Example
{
"mainText": "xyz789",
"placeId": "4",
"secondaryText": "abc123"
}
PlaceDetails
Fields
| Field Name | Description |
|---|---|
addressComponents - [PlaceAddressComponent!]!
|
Structured address components of the place |
Example
{"addressComponents": [PlaceAddressComponent]}
PlaidAssetReportStatus
Description
The state of a borrower's Plaid asset report
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELED"
PlaidExchangeMetadata
Description
Metadata from Plaid Link onSuccess callback
Example
{
"institutionId": "abc123",
"institutionName": "xyz789",
"linkSessionId": "xyz789"
}
PlaidIncomeReportStatus
Description
The state of a borrower's Plaid income report
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELED"
PlaidItemAccess
PlaidLayerItem
PlaidLinkToken
Description
Plaid link token for initializing widget
Fields
| Field Name | Description |
|---|---|
linkToken - String!
|
Link token for Plaid Link widget |
Example
{"linkToken": "abc123"}
PositiveFloat
Description
Floats that will have a value greater than 0.
Example
123.45
PositiveInt
Description
Integers that will have a value greater than 0.
Example
123
PreApproval
Description
A pre-approval issued on a loan
Fields
| Field Name | Description |
|---|---|
baseLoanAmount - MonetaryAmount!
|
The pre-approved base loan amount (MISMO BaseLoanAmount) |
createdAt - DateTime!
|
When the pre-approval was issued |
id - ID!
|
Pre-approval ID |
salesContractAmount - MonetaryAmount!
|
The pre-approved purchase price (MISMO SalesContractAmount) |
updatedAt - DateTime!
|
When the pre-approval was last changed |
Example
{
"baseLoanAmount": MonetaryAmount,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"salesContractAmount": MonetaryAmount,
"updatedAt": "2007-12-03T10:15:30Z"
}
PreApprovalLetterStylesInput
Description
Styles for a pre-approval letter. An omitted, null or empty style uses the letter's default.
Fields
| Input Field | Description |
|---|---|
boldFontUrl - String
|
URL of the font for bold text. Only an https URL on fonts.gstatic.com that serves a TrueType, OpenType or WOFF file is used; for any other font, the letter uses its default font. |
normalFontUrl - String
|
URL of the font for regular text. Only an https URL on fonts.gstatic.com that serves a TrueType, OpenType or WOFF file is used; for any other font, the letter uses its default font. |
primaryColor - String
|
CSS color for the letter's accents. |
Example
{
"boldFontUrl": "abc123",
"normalFontUrl": "xyz789",
"primaryColor": "abc123"
}
PreApprovalMutations
Description
Pre-approval mutations
Fields
| Field Name | Description |
|---|---|
createLoanPreApprovalLetter - CreateLoanPreApprovalLetterResponse
|
Create a pre-approval letter for a loan that has already been pre-approved. |
Arguments |
|
createMaxLoanPreApprovalLetter - CreateMaxLoanPreApprovalLetterResponse
|
Create a pre-approval letter with the maximum pre-approved loan amount and purchase price for a loan that has already been pre-approved. |
Arguments |
|
runLoanPreApproval - RunLoanPreApprovalResponse
|
Create a pre-approval for a loan |
Arguments
|
|
Example
{
"createLoanPreApprovalLetter": CreateLoanPreApprovalLetterResponse,
"createMaxLoanPreApprovalLetter": CreateMaxLoanPreApprovalLetterResponse,
"runLoanPreApproval": RunLoanPreApprovalResponse
}
PreApprovalRun
Description
A pre-approval run
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Possible Types
| PreApprovalRun Types |
|---|
Example
{"id": 4}
PreApprovalRunPurpose
Description
Why a pre-approval run happens.
Values
| Enum Value | Description |
|---|---|
|
|
The run that submits the borrower's application. A declined run moves a loan with no stage, or at Account Created, to Manual Review, as the REST publish call does. |
|
|
Any other run. A declined run leaves the stage unchanged. |
Example
"APPLICATION_SUBMISSION"
PreQualification
Fields
| Field Name | Description |
|---|---|
conventional - ConventionalPreQualification
|
|
Arguments
|
|
debug - [PreQualificationProductResult!]!
|
|
Arguments |
|
Example
{
"conventional": ConventionalPreQualification,
"debug": [PreQualificationProductResult]
}
PreQualificationBestEligibleResult
Fields
| Field Name | Description |
|---|---|
apr - Float!
|
|
discountPointsTotal - Float!
|
|
discountPointsTotalAmount - Int!
|
|
loanAmount - NonNegativeInt!
|
|
ltv - Float!
|
|
product - Product!
|
The loan product with the optimal prequalification result. |
rate - Float!
|
|
salesContractAmount - NonNegativeInt!
|
Example
{
"apr": 987.65,
"discountPointsTotal": 123.45,
"discountPointsTotalAmount": 123,
"loanAmount": 123,
"ltv": 123.45,
"product": Product,
"rate": 987.65,
"salesContractAmount": 123
}
PreQualificationMutations
Description
Pre-qualification mutations
Fields
| Field Name | Description |
|---|---|
conventional - ConventionalResponse
|
Create a conventional pre-qualification |
Arguments |
|
Example
{"conventional": ConventionalResponse}
PreQualificationProductResult
Fields
| Field Name | Description |
|---|---|
product - Product!
|
|
result - ConventionalPreQualificationResult!
|
Example
{
"product": Product,
"result": EligiblePreQualification
}
PreapprovalProduct
Description
Loan products that can be enabled for a customer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Renamed to PylonDirectFannieMaeConforming. |
|
|
Renamed to PylonDirectFannieMaeHomeReady. |
|
|
Renamed to PylonDirectFreddieMacConforming. |
|
|
Renamed to PylonDirectFreddieMacHomePossible. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BayviewBayviewJumboAus"
PreciseDecimal
Description
A decimal string with an optional minus sign, without exponent notation or a plus sign. A multi-digit integer part cannot have leading zeros, and a decimal point requires digits on both sides. Every supplied digit is preserved; the scalar never rounds. Zero is written without a sign.
Example
PreciseDecimal
PrepaidItemType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOROUGH_PROPERTY_TAX"
PrepaymentPenaltyAddedReason
Description
§1026.19(f)(2)(ii)(C).
Fields
| Field Name | Description |
|---|---|
kind - DisclosureDriftReasonKind!
|
Example
{"kind": "APR_INACCURATE"}
Pricing
Fields
| Field Name | Description |
|---|---|
dumpParameters - ProductPricingParameterDump
|
|
Arguments
|
|
fixedLoanAmountProductPricing - ProductPricingQuery
|
Unlike productPricing, which calculates an optimal structure for a given scenario, fixedLoanAmountProductPricing pins the solver to a specific loan amount rather than deriving it from the loan's LTV and subject property value. Use this endpoint when the desired loan amount is known upfront (e.g. the borrower has requested a specific payoff amount on a refinance) but prefer productPricing for all other values |
Arguments
|
|
optimalStructure - OptimalStructure
|
|
Arguments
|
|
productPricing - ProductPricingQuery
|
|
Arguments
|
|
Example
{
"dumpParameters": ProductPricingParameterDump,
"fixedLoanAmountProductPricing": ProductPricingQuery,
"optimalStructure": OptimalStructure,
"productPricing": ProductPricingQuery
}
PricingAmortizationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADJUSTABLE_RATE"
PricingBatch
Description
A customer's file of loans, priced together on the rate sheets in effect when the batch starts.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
PricingBatchesMutations
Description
Asynchronous pricing batch mutations.
Fields
| Field Name | Description |
|---|---|
createPricingBatchUpload - CreatePricingBatchUploadResponse
|
Creates a pricing batch waiting for its input file, and returns a URL to PUT the file to. Start the batch once the file is uploaded. Needs the pricing batch feature, which is off unless enabled for your organization. |
Example
{
"createPricingBatchUpload": CreatePricingBatchUploadResponse
}
PricingChangeAttribution
Description
Whether a changed input caused the finding.
Values
| Enum Value | Description |
|---|---|
|
|
This change alone caused at least one kind. |
|
|
This change was not checked on its own. |
|
|
Not checked: the change did not hurt the borrower. |
|
|
This change alone caused no kind. |
|
|
A row the loan no longer has. |
Example
"CAUSE"
PricingChangeDeadline
Description
When a redisclosure for a finding is due.
Fields
| Field Name | Description |
|---|---|
kind - PricingChangeDeadlineKind!
|
|
lastDay - Date
|
The last day to redisclose. Set exactly when kind is DUE. |
Example
{"kind": "DUE", "lastDay": "2007-12-03"}
PricingChangeDeadlineKind
Values
| Enum Value | Description |
|---|---|
|
|
Due by lastDay. |
|
|
No deadline: a correction due by consummation. |
|
|
The holiday calendar cannot count the deadline, so the redisclosure may already be due. |
Example
"DUE"
PricingChangeDismissal
PricingChangeFinding
Description
A pricing change since the loan's last disclosure that needs a redisclosure, or did.
Fields
| Field Name | Description |
|---|---|
changedFields - [PricingChangedField!]!
|
The changed inputs, shorter paths first. A field the latest check no longer saw changed may be back at its disclosed value. |
closedAt - DateTimeISO
|
When the finding closed; null while it is open. |
deadline - PricingChangeDeadline!
|
|
dismissal - PricingChangeDismissal
|
Set exactly when status is DISMISSED. |
id - ID!
|
|
ineligibilityReasons - [String!]!
|
For a finding that holds INELIGIBLE, the reasons, such as debt_to_income. |
kinds - [PricingChangeKind!]!
|
Every kind the finding holds. |
openedAt - DateTimeISO
|
Null when the finding's opening time was not recorded. |
status - PricingChangeFindingStatus!
|
Example
{
"changedFields": [PricingChangedField],
"closedAt": "2007-12-03T10:15:30Z",
"deadline": PricingChangeDeadline,
"dismissal": PricingChangeDismissal,
"id": "4",
"ineligibilityReasons": ["abc123"],
"kinds": ["APR_MOVED_BEYOND_TOLERANCE"],
"openedAt": "2007-12-03T10:15:30Z",
"status": "DISMISSED"
}
PricingChangeFindingStatus
Values
| Enum Value | Description |
|---|---|
|
|
Dismissed by Pylon staff. |
|
|
Awaiting a redisclosure or a dismissal. |
|
|
Resolved by a change of circumstance. |
|
|
Resolved by a newer disclosure to the borrower. |
|
|
Closed because the loan's pricing is no longer watched, such as after it funded or was withdrawn. |
Example
"DISMISSED"
PricingChangeKind
Description
How a pricing change since the loan's last disclosure affects the borrower.
Values
| Enum Value | Description |
|---|---|
|
|
The APR moved by more than its disclosure tolerance. |
|
|
A change to correct on the disclosures by consummation, with no deadline of its own. |
|
|
The loan no longer qualifies as disclosed. |
|
|
The lender credit the borrower receives went down. |
|
|
The points the borrower pays went up. |
Example
"APR_MOVED_BEYOND_TOLERANCE"
PricingChangeQueue
Description
Open pricing change findings that need a redisclosure, soonest deadline first.
Fields
| Field Name | Description |
|---|---|
findings - [OpenPricingChangeFinding!]!
|
|
unlisted - Int!
|
Open findings left out because the list is at its limit of 5,000. |
Example
{"findings": [OpenPricingChangeFinding], "unlisted": 987}
PricingChangedField
Description
One pricing input of the loan that differs from what was last disclosed.
Fields
| Field Name | Description |
|---|---|
attribution - PricingChangeAttribution
|
Null for an attribution this API does not name. |
currentValue - String!
|
The latest value. |
disclosedValue - String!
|
The value as last disclosed. |
firstObservedAt - DateTimeISO
|
The earliest evidence of the change. |
path - String!
|
The input's path, each list element named by its key, such as borrower_params.liabilities[liab_1].balance. |
Example
{
"attribution": "CAUSE",
"currentValue": "xyz789",
"disclosedValue": "xyz789",
"firstObservedAt": "2007-12-03T10:15:30Z",
"path": "xyz789"
}
PricingChangesMutations
Description
Changes to pricing change findings.
Fields
| Field Name | Description |
|---|---|
dismissPricingChangeFinding - DismissPricingChangeFindingResponse
|
Dismisses an open pricing change finding on a loan as the person signed in, recording why, so it needs no redisclosure. A dismissal is final. Dismissing it again as the same person with the same reason changes nothing; a finding already closed any other way is refused. |
Arguments |
|
Example
{
"dismissPricingChangeFinding": DismissPricingChangeFindingResponse
}
PricingConstraints
Fields
| Input Field | Description |
|---|---|
applyOutOfPocketToLoan - Boolean
|
Represents if Out Of Pocket cash will be applied to reduce loan cost |
closingCosts - NonNegativeFloat
|
The maximum allowable closing costs. |
downPaymentAmount - NonNegativeFloat
|
The down payment amount. |
maxDiscountPoints - Float
|
Limit number of rate point buys to not exceed this value. |
maxLtv - NonNegativeFloat
|
Max loan-to-value ratio allowed. Will not override takeout requirements. |
maxOutOfPocket - NonNegativeFloat
|
Out of pocket maximum in dollars. |
monthlyPayment - NonNegativeFloat
|
The maximum allowable monthly payment. |
monthlyPaymentAsPercentageOfIncome - Boolean!
|
Interpret monthly payment field as a percentage instead of dollar amount. Default = false |
mortgageInsurance - Boolean
|
Indicates whether mortgage insurance is required. |
principal - NonNegativeFloat
|
The maximum allowable principal amount. |
rate - NonNegativeFloat
|
The preferred interest rate as a percentage (e.g., 5.0 for 5%). |
rollInClosingCosts - Boolean
|
Represents if closing costs will be rolled into loan amount on a ReFi |
totalCost - Float
|
The cost of points for the loan. |
totalPoints - NonNegativeFloat
|
The number of points required for the loan. |
Example
{
"applyOutOfPocketToLoan": false,
"closingCosts": 123.45,
"downPaymentAmount": 123.45,
"maxDiscountPoints": 987.65,
"maxLtv": 123.45,
"maxOutOfPocket": 123.45,
"monthlyPayment": 123.45,
"monthlyPaymentAsPercentageOfIncome": true,
"mortgageInsurance": true,
"principal": 123.45,
"rate": 123.45,
"rollInClosingCosts": true,
"totalCost": 123.45,
"totalPoints": 123.45
}
PricingMutations
Fields
| Field Name | Description |
|---|---|
calculateOptimalStructure - CalculateOptimalStructureResponse
|
|
Arguments
|
|
Example
{
"calculateOptimalStructure": CalculateOptimalStructureResponse
}
PricingObjectiveIntent
Description
Configure the objective that the optimizer uses. E.g. minimize monthly cost or out of pocket.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MIN_DOWN_PAYMENT"
PrimaryIncomeHourlyPayError
Description
User error indicating that a preapproval was run with a borrower who is paid hourly, which is currently unsupported
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789"
}
PriorPropertyTitleType
Description
Specifies the ownership title type of the prior property.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"JOINT_WITH_OTHER_THAN_SPOUSE"
PriorPropertyUsageType
Description
Defines how the borrower's prior property was used.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FHA_SECONDARY_RESIDENCE"
ProceedsFromSaleOfNonRealEstateAsset
Description
Proceeds from sale of non-real estate asset
Fields
| Field Name | Description |
|---|---|
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"nonBorrowerOwnerNames": ["abc123"],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
ProceedsFromSecuredLoanAsset
Description
Proceeds from secured loan asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "abc123",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
ProceedsFromUnsecuredLoanAsset
Description
Proceeds from unsecured loan asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "xyz789",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
ProcessDocumentQueries
Description
Root type for process-document queries.
Fields
| Field Name | Description |
|---|---|
status - ProcessDocumentStatusResponse!
|
Status of a process-document (split) workflow, with the sections it produced once complete. |
Arguments
|
|
Example
{"status": ProcessDocumentStatusResponse}
ProcessDocumentSection
Description
One section detected and classified within an uploaded document packet.
Fields
| Field Name | Description |
|---|---|
document - LoanDocument
|
The document for this section. A single-section packet references the uploaded document itself. Null, with an error, when the document is not on the workflow's loan. |
documentId - ID!
|
The document ID for this section. Query loanDocument(id) to read its extracted evidence. A single-section packet references the uploaded document itself. Use document { id }.
|
extractionWorkflowId - ID
|
The workflow ID for this section's extraction, or null when no extractor exists for this section. Poll the extraction workflow with this ID to track extraction progress. |
kind - DocumentKind
|
The extractable document kind this section routes to, or null when no extractor exists for its classification yet (recorded as OTHER_DOCUMENT for review). |
observation - String!
|
The splitter's explanation of why it classified the section. |
Example
{
"document": LoanDocument,
"documentId": 4,
"extractionWorkflowId": 4,
"kind": "BANK_STATEMENT",
"observation": "abc123"
}
ProcessDocumentStatusInput
Description
Input for querying the status of a process-document (split) workflow.
Fields
| Input Field | Description |
|---|---|
workflowId - ID!
|
The workflow ID returned when the document packet was submitted. |
Example
{"workflowId": 4}
ProcessDocumentStatusResponse
Description
Status of a process-document (split) workflow, plus the sections it produced once complete.
Fields
| Field Name | Description |
|---|---|
sections - [ProcessDocumentSection!]!
|
Sections the packet was split into. Empty until the workflow succeeds. |
status - JobStatus!
|
Current status of the split workflow. |
Example
{"sections": [ProcessDocumentSection], "status": "FAILED"}
Product
Fields
| Field Name | Description |
|---|---|
description - String!
|
A human-readable description of a loan product. |
id - ID!
|
An opaque ID identifiying a loan product. |
rateLockExtensionPolicy - ProductRateLockExtensionPolicy
|
This product's own rate lock extension policy, or null when it has none and uses the default. Pylon super-admins only. |
type - String!
|
One of Conforming, Jumbo, FHA, VA, Other |
Example
{
"description": "xyz789",
"id": "4",
"rateLockExtensionPolicy": ProductRateLockExtensionPolicy,
"type": "abc123"
}
ProductDeliveryCommitment
Description
A product's delivery commitment now, and every period it has had.
Fields
| Field Name | Description |
|---|---|
current - DeliveryCommitmentStatus!
|
The delivery commitment in force now. |
loanProduct - Product!
|
The same product as product, as the loan Product other fields hang off. |
periods - [ProductDeliveryCommitmentPeriod!]!
|
Every period, newest first (by effectiveFrom, then the open or later-ending period first). Empty for a product never classified. |
product - PreapprovalProduct!
|
Example
{
"current": "BEST_EFFORTS",
"loanProduct": Product,
"periods": [ProductDeliveryCommitmentPeriod],
"product": "BayviewBayviewJumboAus"
}
ProductDeliveryCommitmentPeriod
Description
One period of a product's delivery commitment, in force over [effectiveFrom, effectiveTo). Periods are never edited except to close them, and never deleted.
Fields
| Field Name | Description |
|---|---|
contributor - AnyContributor!
|
Who recorded this period. |
createdAt - DateTimeISO!
|
When the period was recorded. |
deliveryCommitmentType - DeliveryCommitmentType!
|
|
effectiveFrom - DateTimeISO!
|
|
effectiveTo - DateTimeISO
|
When the next period replaced this one. Null for the period in force now. Equal to effectiveFrom for a period that was replaced at the instant it began, which was never in force. |
id - ID!
|
Example
{
"contributor": AnyContributor,
"createdAt": "2007-12-03T10:15:30Z",
"deliveryCommitmentType": "BEST_EFFORTS",
"effectiveFrom": "2007-12-03T10:15:30Z",
"effectiveTo": "2007-12-03T10:15:30Z",
"id": "4"
}
ProductDeliveryCommitmentsMutations
Description
Product delivery commitment mutations, for Pylon super-admins.
Fields
| Field Name | Description |
|---|---|
set - SetProductDeliveryCommitmentsResponse
|
Set a product's delivery commitment, attributed to the caller. Setting the type it already has changes nothing. A change closes the period in force and opens the new one now; only a first classification can be backdated. |
Arguments |
|
Example
{"set": SetProductDeliveryCommitmentsResponse}
ProductDeliveryCommitmentsQueries
Description
Product delivery commitment queries, for Pylon super-admins.
Fields
| Field Name | Description |
|---|---|
products - [ProductDeliveryCommitment!]!
|
Every product that can be classified, in product order, including products never classified (current UNKNOWN, no periods). |
Example
{"products": [ProductDeliveryCommitment]}
ProductPricing
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate |
id - ID
|
The unique ID of this product pricing result. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
term - PositiveInt!
|
The term of the loan being considered in years. |
Possible Types
| ProductPricing Types |
|---|
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"id": "4",
"lock": 123,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"term": 123
}
ProductPricingAdjustableRateDetail
Fields
| Field Name | Description |
|---|---|
initialFixedPeriodEffectiveMonthsCount - NonNegativeInt!
|
The number of months in the initial fixed period of a loan with an adjustable rate or payment |
marginRatePercent - NonNegativeFloat!
|
The number of percentage points to be added to the index to arrive at the new interest rate. |
maximumIncreaseRatePercent - NonNegativeFloat!
|
The maximum number of percentage points by which the interest rate can increase from the original interest rate over the life of the loan. |
paymentsBetweenBaseRatesCount - NonNegativeInt!
|
The number of payments between rate changes. |
perChangeMaximumIncreaseRatePercent - NonNegativeFloat!
|
The maximum number of percentage points by which the rate can increase from the previous interest rate. |
periodicMaximumIncreaseRatePercent - NonNegativeFloat!
|
The maximum number of percentage points by which the interest rate can increase from the Periodic Base Rate until the next base rate selection date. |
Example
{
"initialFixedPeriodEffectiveMonthsCount": 123,
"marginRatePercent": 123.45,
"maximumIncreaseRatePercent": 123.45,
"paymentsBetweenBaseRatesCount": 123,
"perChangeMaximumIncreaseRatePercent": 123.45,
"periodicMaximumIncreaseRatePercent": 123.45
}
ProductPricingAdjustment
ProductPricingApor
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of the APOR. |
rate - PositiveFloat!
|
The average prime offer rate at the time of this pricing run for a comparible loan with the same term and amortization type. |
Example
{"id": "4", "rate": 123.45}
ProductPricingCharge
Description
A lock fee on a structure, priced inside the rate's points.
Fields
| Field Name | Description |
|---|---|
description - String!
|
A human-readable label. |
kind - ProductPricingChargeKind!
|
|
specifiedFixedAmount - NonNegativeInt
|
Null; a lock fee is a percentage of the loan amount. |
totalPercent - NonNegativeFloat!
|
The fee as a percentage of the loan amount, the same unit as points. Already included in totalPoints and shown as its own row in the points breakdown; never a separate closing cost. |
Example
{
"description": "abc123",
"kind": "RATE_LOCK_EXTENSION",
"specifiedFixedAmount": 123,
"totalPercent": 123.45
}
ProductPricingChargeKind
Description
A kind of lock fee priced inside a structure's points.
Values
| Enum Value | Description |
|---|---|
|
|
The fee for one extension of the rate lock. |
|
|
The relock fee from the relock fee policy in force (50 bps at launch), charged at most once per lock: on a relock, or on a live investor change. |
Example
"RATE_LOCK_EXTENSION"
ProductPricingErrorUnsetClosingDate
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789"
}
ProductPricingErrorUnsetEitherDownPaymentOrMaxAssetsToUse
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["xyz789"],
"message": "abc123"
}
ProductPricingErrorUnsetPurchasePrice
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
ProductPricingOverrides
Fields
| Input Field | Description |
|---|---|
maximumAssetsToUse - NonNegativeInt
|
Override the maximum asset amount to use toward upfront costs of the loan. |
purchasePrice - PositiveInt
|
Override the purchase price of the subject property. |
Example
{"maximumAssetsToUse": 123, "purchasePrice": 123}
ProductPricingParameterDump
Fields
| Field Name | Description |
|---|---|
serializedParameters - String
|
|
userErrors - [UserError!]!
|
Example
{
"serializedParameters": "xyz789",
"userErrors": [UserError]
}
ProductPricingQuery
Fields
| Field Name | Description |
|---|---|
products - [ProductPricing!]
|
|
userErrors - [UserError!]!
|
Example
{
"products": [ProductPricing],
"userErrors": [UserError]
}
ProductPricingRate
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this structure is an adjustable-rate mortgage. Braid prices a product once per adjustable term, so structures on the same product id are told apart by this detail. |
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
appliedMargin - AppliedMargin
|
The margin applied when this rate or structure was priced, derived on read from the effective-dated margin window in force at the loan's lock (its original lock for a company that reads margin at the original lock, its current lock otherwise), or now for an unlocked loan. Identical for a loan's current product structure and for the candidates of a pricing run on the same loan. Every caller reads loanOfficerMargin; split is null unless the caller may read the margin breakdown. Null for results priced outside a loan context (e.g. scenarios). |
apr - Float!
|
The APR with this rate applied as a percentage. |
breakEvenMonths - NonNegativeInt!
|
The number of months before the interest savings surpases the points cost of this rate. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
increasedClosingCosts - NonNegativeFloat!
|
The increased closing costs compared to the baseline preapproval rate. |
ineligibilityDetails - [ProductStructureIneligibilityDetails!]
|
Why this structure violates the product's guidelines, or null when the structure is eligible. A structure can be attached to a loan while ineligible, but not locked until every reason is resolved or overridden. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
lockCharges - [ProductPricingCharge!]
|
The rate lock fees priced inside this structure's points: the lock's relock fee, charged on a relock or a live investor change, and each extension's fee. Already included in totalPoints, each shown as its own row in the points breakdown; never a separate closing cost. Empty when there are none. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
monthlySavings - NonNegativeFloat!
|
The increased savings month over month between this rate and the baseline preapproval rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
repricing - StructureRepricing
|
How this structure was priced against the loan's expired rate lock: the worse of the lock-day and today's rate sheets inside the relock window, or today's rate sheet after it. Null when no repricing outcome is recorded for this structure. |
term - PositiveInt!
|
The term of the loan being considered in years. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"appliedMargin": AppliedMargin,
"apr": 123.45,
"breakEvenMonths": 123,
"cashFromToBorrower": 987.65,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 987.65,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": 4,
"increasedClosingCosts": 123.45,
"ineligibilityDetails": [
CashToCloseExceedsOwnFundsViolation
],
"interest": 123,
"lock": 123,
"lockCharges": [ProductPricingCharge],
"ltv": 987.65,
"monthlyPayment": 123.45,
"monthlySavings": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"rate": 987.65,
"rateId": "4",
"ratePoints": 123.45,
"repricing": StructureRepricing,
"term": 123,
"totalCost": 123.45,
"totalPoints": 987.65
}
ProductRateLockExtensionPolicy
Description
One saved version of a Best efforts product's own extension policy. It applies while the product is Best efforts.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When this version was saved. |
createdBy - OrganizationUser
|
Who saved this version, including a user who has since been removed. Null when no user was recorded. |
history - ProductRateLockExtensionPolicyConnection!
|
A page of this product's policy versions, newest first unless sortDirection says otherwise. |
Arguments
|
|
id - ID!
|
|
maxCumulativeDays - Int
|
The most days, in total, a lock can be extended past its original expiry. Null means no cap. |
maxExtensions - Int
|
The most extensions one lock can take. Null means no cap. |
prices - [RateLockExtensionPolicyPrice!]!
|
The extension lengths offered, shortest first. A length with no price isn't offered. |
pricingKind - RateLockExtensionPolicyPricingKind!
|
How the prices were entered. For PER_DAY, the 1-day price is the per-day rate and each length costs that many days of it. |
product - Product!
|
|
retiredAt - DateTime
|
When a later save replaced this version. Null while it is in effect. |
version - Int!
|
1 for the policy's first save, then one higher per save. The version with no retiredAt is in effect. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": OrganizationUser,
"history": ProductRateLockExtensionPolicyConnection,
"id": "4",
"maxCumulativeDays": 123,
"maxExtensions": 987,
"prices": [RateLockExtensionPolicyPrice],
"pricingKind": "LOOKUP_TABLE",
"product": Product,
"retiredAt": "2007-12-03T10:15:30Z",
"version": 123
}
ProductRateLockExtensionPolicyConnection
Description
A page of one product policy's saved versions.
Fields
| Field Name | Description |
|---|---|
edges - [ProductRateLockExtensionPolicyEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ProductRateLockExtensionPolicyEdge],
"pageInfo": PageInfo
}
ProductRateLockExtensionPolicyEdge
Fields
| Field Name | Description |
|---|---|
cursor - OpaqueToken!
|
|
node - ProductRateLockExtensionPolicy!
|
Example
{
"cursor": OpaqueToken,
"node": ProductRateLockExtensionPolicy
}
ProductRelockPoliciesMutations
Description
Relock pricing configuration mutations, for Pylon super-admins.
Fields
| Field Name | Description |
|---|---|
set - SetProductRelockPoliciesResponse
|
Set or clear a product's net price cap, effective now and attributed to the caller. Setting the cap it already has, or omitting the cap, changes nothing. A change closes the period in force and opens the new one. |
Arguments
|
|
setRelockFeePolicy - SetRelockFeePolicyResponse
|
Set the relock fee policy shared by every product, effective now and attributed to the caller. Every save closes the policy in force and opens a new one. It prices every relock and live investor change priced after the save, including on locks that ended before it; a fee already recorded on a lock never changes. |
Arguments
|
|
Example
{
"set": SetProductRelockPoliciesResponse,
"setRelockFeePolicy": SetRelockFeePolicyResponse
}
ProductRelockPoliciesQueries
Description
Relock pricing configuration queries, for Pylon super-admins.
Fields
| Field Name | Description |
|---|---|
products - [ProductRelockPolicy!]!
|
Every product that can hold a policy, in product order, including products never given one (no cap, no periods). |
relockFeePolicyHistory - [RelockFeePolicy!]!
|
Every relock fee policy ever recorded, newest first (by effectiveFrom, then the open or later-ending policy first). |
relockFeePolicyInForce - RelockFeePolicy
|
The relock fee policy in force now, shared by every product. Null when none is in force. |
Example
{
"products": [ProductRelockPolicy],
"relockFeePolicyHistory": [RelockFeePolicy],
"relockFeePolicyInForce": RelockFeePolicy
}
ProductRelockPolicy
Description
A product's relock policy now, and every period it has had.
Fields
| Field Name | Description |
|---|---|
netPriceCap - Float
|
The net price cap in force now, as a price. Null when the product has no cap. |
periods - [ProductRelockPolicyPeriod!]!
|
Every period, newest first (by effectiveFrom, then the open or later-ending period first). Empty for a product never given a policy. |
product - Product!
|
Example
{
"netPriceCap": 987.65,
"periods": [ProductRelockPolicyPeriod],
"product": Product
}
ProductRelockPolicyPeriod
Description
One period of a product's relock policy, in force over [effectiveFrom, effectiveTo). Periods are never edited except to close them, and never deleted.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTimeISO!
|
When the period was recorded. |
createdBy - OrganizationUser
|
Who recorded this, including a user who has since been removed. Null when no user was recorded. |
effectiveFrom - DateTimeISO!
|
|
effectiveTo - DateTimeISO
|
When the next period replaced this one. Null for the period in force now. Equal to effectiveFrom for a period replaced at the instant it began, which was never in force. |
id - ID!
|
|
netPriceCap - Float
|
The highest net price a worst-case relock could reach in this period, as a price (100 is par; 102.000 allows at most 2 points of lender credit). Null when the period had no cap. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": OrganizationUser,
"effectiveFrom": "2007-12-03T10:15:30Z",
"effectiveTo": "2007-12-03T10:15:30Z",
"id": "4",
"netPriceCap": 987.65
}
ProductStructure
Fields
| Field Name | Description |
|---|---|
adjustableRateDetail - ProductPricingAdjustableRateDetail
|
If non-null, this product represents an adjustable rate mortgage |
adjustments - [ProductPricingAdjustment!]!
|
All adjustments that apply to this product, rate, and deal. |
apor - ProductPricingApor!
|
The published APOR for a comparible mortgage at the time of this pricing run. |
appliedMargin - AppliedMargin
|
The margin applied when this rate or structure was priced, derived on read from the effective-dated margin window in force at the loan's lock (its original lock for a company that reads margin at the original lock, its current lock otherwise), or now for an unlocked loan. Identical for a loan's current product structure and for the candidates of a pricing run on the same loan. Every caller reads loanOfficerMargin; split is null unless the caller may read the margin breakdown. Null for results priced outside a loan context (e.g. scenarios). |
apr - Float!
|
The APR with this rate applied as a percentage. |
cashFromToBorrower - Float!
|
The net change in cash from/to the borrower at closing. |
cashOutAmount - NonNegativeFloat!
|
The cash out amount. |
cashOutType - RefinanceCashOutType!
|
The cash out type. |
closingCosts - Float!
|
The closing costs for this rate. Currently, this is only an estimate-- things like title fees are difficult to correctly compute, but this should be a good approximation. |
concessionPoints - NonNegativeFloat!
|
The concessions being applied to the rate cost in this scenario, in points. |
downPaymentAmount - NonNegativeFloat!
|
The down payment on a property. |
dti - NonNegativeFloat!
|
The debt-to-income ratio of the borrowers with the PITIA for this rate taken into account. |
floodInsurance - NonNegativeFloat!
|
The cost of flood insurance. |
id - ID
|
The unique ID of this product pricing result. |
interest - PositiveInt!
|
The total interest over the life of the loan, in dollars, with this rate applied. |
llpasWaived - Boolean!
|
Whether LLPAs were waived for this rate due to low-income borrower eligibility |
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
lockCharges - [ProductPricingCharge!]
|
The rate lock fees priced inside this structure's points: the lock's relock fee, charged on a relock or a live investor change, and each extension's fee. Already included in totalPoints, each shown as its own row in the points breakdown; never a separate closing cost. Empty when there are none. |
ltv - Float!
|
The ratio of the loan amount to the total value of the property, expressed as a percentage |
monthlyPayment - NonNegativeFloat!
|
The monthly mortgage payment (PITIA) of a loan at this rate. |
mortgageInsurance - NonNegativeFloat!
|
The cost of mandatory mortgage insurance each month. |
pitia - Pitia!
|
Breakdown of the monthly payment for this rate. |
pointsCost - NonNegativeFloat!
|
The cost, in dollars, to buy enough points in order to qualify for a better rate. |
pointsNeeded - NonNegativeFloat!
|
The number of additional points that must be purchased in order to qualify for this rate. |
prepaidInterestDailyAmount - NonNegativeFloat!
|
The amount of prepaid interest paid per day before closing, |
prepaidInterestDaysPaid - NonNegativeFloat!
|
The number of days' worth of prepaid interest to be paid at closing, |
prepaidInterestTotalAmount - NonNegativeFloat!
|
The total dollar amount of prepaid interest due at closing, |
principal - PositiveFloat!
|
The total principal, in dollars, of the loan with this rate applied. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
ratePoints - Float!
|
The cost, in points, of this rate. |
repricing - StructureRepricing
|
How this structure was priced against the loan's expired rate lock: the worse of the lock-day and today's rate sheets inside the relock window, or today's rate sheet after it. Null when no repricing outcome is recorded for this structure. |
totalCost - Float!
|
The total cost after adjustments for this rate. Can be negative if the rate is below par. |
totalPoints - Float!
|
The total number of points after adjustments for this rate. |
Possible Types
| ProductStructure Types |
|---|
Example
{
"adjustableRateDetail": ProductPricingAdjustableRateDetail,
"adjustments": [ProductPricingAdjustment],
"apor": ProductPricingApor,
"appliedMargin": AppliedMargin,
"apr": 123.45,
"cashFromToBorrower": 987.65,
"cashOutAmount": 123.45,
"cashOutType": "CASH_OUT",
"closingCosts": 123.45,
"concessionPoints": 123.45,
"downPaymentAmount": 123.45,
"dti": 123.45,
"floodInsurance": 123.45,
"id": 4,
"interest": 123,
"llpasWaived": false,
"loanTermYears": 123,
"lock": 123,
"lockCharges": [ProductPricingCharge],
"ltv": 987.65,
"monthlyPayment": 123.45,
"mortgageInsurance": 123.45,
"pitia": Pitia,
"pointsCost": 123.45,
"pointsNeeded": 123.45,
"prepaidInterestDailyAmount": 123.45,
"prepaidInterestDaysPaid": 123.45,
"prepaidInterestTotalAmount": 123.45,
"principal": 123.45,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"rate": 123.45,
"rateId": 4,
"ratePoints": 123.45,
"repricing": StructureRepricing,
"totalCost": 987.65,
"totalPoints": 123.45
}
ProductStructureIneligibilityDetails
Example
CashToCloseExceedsOwnFundsViolation
ProductStructureUnsatisfiabilityDetails
Types
| Union Types |
|---|
Example
GuidelineViolation
ProductStructureUnsatisfiabilityDetailsType
PromoteWebhookSigningKeyInput
Description
Promotes a tested pending signing key to active. The previous active key becomes retiring in the same step.
Fields
| Input Field | Description |
|---|---|
signingKeyId - ID!
|
The pending signing key to promote. |
Example
{"signingKeyId": 4}
PromoteWebhookSigningKeyResponse
Description
The result of promoting a webhook signing key.
Fields
| Field Name | Description |
|---|---|
subscription - WebhookSubscription
|
The subscription after the promotion. Null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused, if it was. Empty on success. Codes: WEBHOOK_KEY_NOT_PENDING, WEBHOOK_KEY_EXPIRED, WEBHOOK_KEY_NOT_TESTED, WEBHOOK_ROTATION_IN_PROGRESS. |
Example
{
"subscription": WebhookSubscription,
"userErrors": [UserError]
}
PropertyDisposition
Description
Disposition of a property
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING_SALE"
PropertyUsageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INVESTMENT"
PropertyValuationMethodType
Description
The method used to determine the property's value.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTOMATED_VALUATION_MODEL"
ProposedGrossRentForSubjectPropertyIncome
Description
Proposed gross rent for subject property income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
ProvenanceSource
Description
A source explaining why a requirement exists — rule evaluation, manual condition, or data dependency.
Fields
| Field Name | Description |
|---|---|
description - String!
|
Human-readable explanation, e.g. "W2 required for employment income verification". |
evidence - [GuidelineReference!]!
|
Supporting evidence — guideline citations, document references, etc. |
Possible Types
| ProvenanceSource Types |
|---|
Example
{
"description": "abc123",
"evidence": [GuidelineReference]
}
ProvisionCustomerInput
Description
Input for provisioning a new customer.
Fields
| Input Field | Description |
|---|---|
companyLegalName - String!
|
Customer legal name. |
companyName - String
|
Customer display name. Defaults to the legal name when omitted. |
customerSlug - String!
|
Customer slug. Must be a known Pylon customer slug (registered in CustomerSlugs). |
customerWebsite - String!
|
Customer website URL. |
emailDomains - [String!]!
|
Allowed email domains for the customer. |
friendlyCustomerId - String
|
Optional friendly id prefix (1-4 uppercase letters) used for deal ids. Derived from the company name when omitted. |
scopeBundles - [OauthClientScopeBundle!]
|
Scope bundles granted to the machine-to-machine API client. The bundles are stored on the oauth_client row and the matching scopes are granted to the Auth0 application. Defaults to [MTM_READ_WRITE] when omitted. |
Example
{
"companyLegalName": "abc123",
"companyName": "abc123",
"customerSlug": "abc123",
"customerWebsite": "abc123",
"emailDomains": ["xyz789"],
"friendlyCustomerId": "abc123",
"scopeBundles": ["MTM_LOAN_FILE_READ"]
}
ProvisionCustomerResponse
Description
Result of provisioning a new customer.
Fields
| Field Name | Description |
|---|---|
customerId - ID
|
The id of the created customer, when provisioning succeeded. |
oauthClientId - String
|
The Auth0 OAuth client id created for direct API access, when provisioning succeeded. |
userErrors - [GenericUserError!]!
|
User errors that prevented provisioning (e.g. the slug is unknown or already taken). Empty when provisioning succeeded. |
Example
{
"customerId": "4",
"oauthClientId": "abc123",
"userErrors": [GenericUserError]
}
PublicAssistanceIncome
Description
Public assistance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
PurchaseConsolidatedDebtNotAllowedError
Description
Not raised. Kept in the CreateLoanPreApprovalLetterError union so existing client fragments still validate.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
liabilityCount - Int!
|
|
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["abc123"],
"liabilityCount": 123,
"message": "abc123"
}
PurchasePricingInput
Fields
| Input Field | Description |
|---|---|
amortizationTypes - [PricingAmortizationType!]
|
The amortization types to price. Defaults to fixed-only; request ADJUSTABLE_RATE (typically in a separate sequential call) to price ARM products, so one request never solves both halves of the sheet at once. Default = [FIXED] |
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt
|
Monthly homeowners association dues in dollars. When omitted, pricing behaves as if the property has no HOA dues. |
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean!
|
|
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
numberOfUnits - NonNegativeInt
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
outOfPocketMax - Float!
|
|
pricingConstraints - PricingConstraints
|
|
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Whether property taxes and insurance are included in the monthly payment (impounded). Defaults to impounded when omitted. |
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
|
salesContractAmount - NonNegativeInt!
|
The amount of money that the property will be purchased for. Also called the purchase price. |
Example
{
"amortizationTypes": ["ADJUSTABLE_RATE"],
"concessions": 123,
"fipsCountyCode": "abc123",
"hoaDues": 123,
"isBorrowerSelfEmployed": false,
"isFirstTimeHomeBuyer": false,
"loanTermYears": 123.45,
"monthlyDebt": 987.65,
"monthlyIncome": 987.65,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"objectiveIntent": "MIN_DOWN_PAYMENT",
"outOfPocketMax": 987.65,
"pricingConstraints": PricingConstraints,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 987,
"rateLockDays": 123.45,
"salesContractAmount": 123
}
PurchasePricingNoRestructureInput
Fields
| Input Field | Description |
|---|---|
amortizationTypes - [PricingAmortizationType!]
|
The amortization types to price. Defaults to fixed-only; request ADJUSTABLE_RATE (typically in a separate sequential call) to price ARM products, so one request never solves both halves of the sheet at once. Default = [FIXED] |
concessions - NonNegativeInt!
|
|
downPayment - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
hoaDues - NonNegativeInt
|
Monthly homeowners association dues in dollars. When omitted, pricing behaves as if the property has no HOA dues. |
isBorrowerSelfEmployed - Boolean!
|
|
isFirstTimeHomeBuyer - Boolean!
|
|
loanAmount - NonNegativeInt!
|
|
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
numberOfUnits - NonNegativeInt
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
pricingConstraints - PricingConstraints
|
|
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Whether property taxes and insurance are included in the monthly payment (impounded). Defaults to impounded when omitted. |
propertyUsageType - PropertyUsageType!
|
|
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
Example
{
"amortizationTypes": ["ADJUSTABLE_RATE"],
"concessions": 123,
"downPayment": 123,
"fipsCountyCode": "xyz789",
"hoaDues": 123,
"isBorrowerSelfEmployed": false,
"isFirstTimeHomeBuyer": false,
"loanAmount": 123,
"loanTermYears": 987.65,
"monthlyDebt": 123.45,
"monthlyIncome": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"objectiveIntent": "MIN_DOWN_PAYMENT",
"pricingConstraints": PricingConstraints,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"propertyUsageType": "INVESTMENT",
"qualifyingFicoScore": 123,
"rateLockDays": 123.45
}
PylonEvent
Description
One entry of the durable event log: something that happened to one of your records, in the same shape a webhook delivers it (type, id, occurredAt, sequence, data), so one parser serves a push and a replay. Delivery is at-least-once, so the same event can appear more than once; id is stable and is the key to de-duplicate on.
Fields
| Field Name | Description |
|---|---|
data - PylonEventData!
|
The event's data: its version, when it was recorded, its record and its loans. |
id - ID!
|
The event's id. Stable across redelivery. Pass the id of the last event you processed as eventLog.page(after:) to read on after it. |
occurredAt - DateTimeISO!
|
When the event happened in the domain. May be earlier than data.recordedAt for replayed sources. |
sequence - PositiveInt!
|
The event's number among the events recorded for you: 1, 2, 3 and so on, with no gaps across every event type, and the number its webhook carried. Event types outside the webhook vocabulary are numbered but never pushed, so even a receiver subscribed to every webhook type can see permanent gaps between webhook deliveries. A gap is therefore not always a missed delivery; page from the last id you processed to see what is between them. |
type - String!
|
What happened, as <Kind>.<verb>, for example Borrower.changed. .changed events are coalesced: a burst of writes to one record can produce one event, so treat it as "fetch the current state". The set of types grows over time; ignore types you do not know. |
Example
{
"data": PylonEventData,
"id": "4",
"occurredAt": "2007-12-03T10:15:30Z",
"sequence": 123,
"type": "xyz789"
}
PylonEventData
Description
What happened, as the event type's contract describes it. schemaVersion versions this data.
Fields
| Field Name | Description |
|---|---|
entity - PylonEventEntity
|
The record the event is about. Null only for an event about the organization as a whole. |
loans - [PylonEventLoan!]!
|
Every loan the event's record belonged to when the event was recorded. Empty when it belonged to none. |
recordedAt - DateTimeISO!
|
When the event was appended to the log. eventLog.cursorAt(since:) is keyed on this time. |
schemaVersion - Int!
|
Version of this event type's shape. Raised only when the shape changes incompatibly. |
Example
{
"entity": PylonEventEntity,
"loans": [PylonEventLoan],
"recordedAt": "2007-12-03T10:15:30Z",
"schemaVersion": 123
}
PylonEventEntity
Description
What an event is about. Carries only its id today; the type can grow fields without renaming anything.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the record the event is about: for a .changed event the record that changed; for a loan-activity event the LoanEvent that happened, which node(id) resolves to its eventType and metadata. |
Example
{"id": "4"}
PylonEventLoan
Description
A loan an event belongs to. Carries only its id today; the type can grow fields without renaming anything.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The loan's id. |
Example
{"id": 4}
PylonEventPage
Description
A page of the event log, oldest event first. Pass the id of the last event as after to read on.
Fields
| Field Name | Description |
|---|---|
events - [PylonEvent!]!
|
The events, oldest first. |
hasMore - Boolean!
|
True when more events are available right now after the last event on this page. |
Example
{"events": [PylonEvent], "hasMore": false}
PylonTeam
Description
The loan's Pylon team as assigned in the loan system.
Fields
| Field Name | Description |
|---|---|
accountManager - PylonTeamMember
|
The primary account manager: the primary-role designation when the loan system provides one, else the sole member holding the Account Management role, else null (never guessed among several). |
closer - PylonTeamMember
|
The loan's primary closer from the loan system's Primary Closer designation; null when none is designated or the designee is not a Pylon closer (outsourced closing partners are never returned); carries name, email, and the loan system phone number. Its schedulingUrl is always null and deprecated for closers; never guessed from roles. |
members - [PylonTeamMember!]!
|
Every assigned team member (account managers, processor, closer, ...). Underwriters are withheld — see underwriter. Other roles flow through; empty until the loan's assignments have synced. |
underwriter - UnderwriterScheduling
|
Anonymous scheduling handle for the loan's underwriter: the primary-role designation when the loan system provides one, else the sole member holding the Underwriter role, else null (never guessed among several). The underwriter is never named. |
Example
{
"accountManager": PylonTeamMember,
"closer": PylonTeamMember,
"members": [PylonTeamMember],
"underwriter": UnderwriterScheduling
}
PylonTeamMember
Description
A member of the loan's Pylon team.
Fields
| Field Name | Description |
|---|---|
email - String
|
Email address. |
name - String
|
Full name. |
nmlsId - String
|
NMLS identifier, when the member is licensed. |
phoneNumber - String
|
Phone number from the loan system. Only set on closer; null on every other member. |
roles - [String!]!
|
Role names as configured in the loan system (e.g. "Account Management", "Underwriter"). |
schedulingUrl - String
|
Booking link (e.g. Calendly) for this person, when one is on file. |
Example
{
"email": "xyz789",
"name": "abc123",
"nmlsId": "xyz789",
"phoneNumber": "abc123",
"roles": ["xyz789"],
"schedulingUrl": "xyz789"
}
QmFeeCapViolation
Description
Loan post-structuring violates QM fee cap.
Example
{"borrowerPaidFees": 987.65, "loanAmount": 123.45, "parRate": 123.45}
Race
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AM_INDIAN_ALASKAN"
RateLockDetails
Description
Rate lock related fields
Fields
| Field Name | Description |
|---|---|
comments - String
|
Rate lock comments |
expirationTime - DateTime
|
The expiration time of the lock |
lockedTime - DateTime
|
The time when the rate was locked |
period - NonNegativeInt
|
The rate lock period in days |
relockWindow - RelockWindow
|
The relock window, once the loan's rate lock has ended. Null while the lock is in force, and for a loan never locked. |
requestedTime - DateTime
|
The time when the rate lock was requested |
status - RateLockStatus
|
Rate lock status |
Example
{
"comments": "abc123",
"expirationTime": "2007-12-03T10:15:30Z",
"lockedTime": "2007-12-03T10:15:30Z",
"period": 123,
"relockWindow": RelockWindow,
"requestedTime": "2007-12-03T10:15:30Z",
"status": "CANCELLED"
}
RateLockExtensionFeePayer
Description
Who pays a rate lock period's fee.
Values
| Enum Value | Description |
|---|---|
|
|
The borrower: the fee is priced into the loan and redisclosed. |
|
|
The broker: a broker concession of the fee's amount pays it, so the borrower's price is unchanged; the new expiry is redisclosed. |
|
|
Pylon: the loan's pricing and disclosures are left unchanged. |
Example
"BORROWER"
RateLockExtensionOption
Description
One extension a rate lock can take now.
Fields
| Field Name | Description |
|---|---|
days - Int!
|
Calendar days this extension adds. |
expiresOn - Date!
|
The lock's new expiration date. |
priceBps - Float!
|
The extension's price, in basis points. Positive is a cost to the borrower. |
token - OpaqueToken!
|
Opaque. Send it unchanged as extendRateLock's token when extending to this option, so the extension is refused if its price or the rules behind it changed since. |
Example
{
"days": 987,
"expiresOn": "2007-12-03",
"priceBps": 123.45,
"token": OpaqueToken
}
RateLockExtensionPoliciesMutations
Description
Rate lock extension policy mutations, for Pylon super-admins.
Fields
| Field Name | Description |
|---|---|
update - UpdateRateLockExtensionPoliciesResponse
|
Save a policy's next version, or version 1 on its first save. Earlier versions keep their caps and prices. |
Arguments |
|
updateProduct - UpdateProductRateLockExtensionPoliciesResponse
|
Save the next version of a Best efforts product's own policy, or version 1 on its first save. Earlier versions keep their caps and prices. |
Arguments |
|
Example
{
"update": UpdateRateLockExtensionPoliciesResponse,
"updateProduct": UpdateProductRateLockExtensionPoliciesResponse
}
RateLockExtensionPolicy
Description
One saved version of a rate lock extension policy. A version's caps and prices never change; each save retires the current version and adds the next one.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When this version was saved. |
createdBy - OrganizationUser
|
Who saved this version, including a user who has since been removed. Null when no user was recorded. |
id - ID!
|
|
maxCumulativeDays - Int
|
The most days, in total, a lock can be extended past its original expiry. Null means no cap. |
maxExtensions - Int
|
The most extensions one lock can take. Null means no cap. |
policyKey - RateLockExtensionPolicyKey!
|
|
prices - [RateLockExtensionPolicyPrice!]!
|
The extension lengths offered, shortest first. A length with no price isn't offered. |
pricingKind - RateLockExtensionPolicyPricingKind!
|
How the prices were entered. For PER_DAY, the 1-day price is the per-day rate and each length costs that many days of it. |
retiredAt - DateTime
|
When a later save replaced this version. Null while it is in effect. |
version - Int!
|
1 for the policy's first save, then one higher per save. The version with no retiredAt is in effect. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": OrganizationUser,
"id": "4",
"maxCumulativeDays": 123,
"maxExtensions": 123,
"policyKey": "MANDATORY",
"prices": [RateLockExtensionPolicyPrice],
"pricingKind": "LOOKUP_TABLE",
"retiredAt": "2007-12-03T10:15:30Z",
"version": 123
}
RateLockExtensionPolicyConnection
Description
A page of one policy's saved versions.
Fields
| Field Name | Description |
|---|---|
edges - [RateLockExtensionPolicyEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [RateLockExtensionPolicyEdge],
"pageInfo": PageInfo
}
RateLockExtensionPolicyEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - RateLockExtensionPolicy!
|
Example
{"cursor": 4, "node": RateLockExtensionPolicy}
RateLockExtensionPolicyKey
Description
A rate lock extension policy that Pylon configures.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Policies are set per product; this key is ignored. |
|
|
Policies are set per product; this key is ignored. |
Example
"MANDATORY"
RateLockExtensionPolicyPrice
RateLockExtensionPolicyPriceInput
RateLockExtensionPolicyPricingKind
Description
How a policy's extension prices are entered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LOOKUP_TABLE"
RateLockExtensionPolicyQueries
Description
Rate lock extension policy queries, for Pylon super-admins.
Fields
| Field Name | Description |
|---|---|
current - [RateLockExtensionPolicy!]!
|
The current version of every saved policy, at most one per RateLockExtensionPolicyKey. A policy that was never saved, or was retired, is absent. |
history - RateLockExtensionPolicyConnection!
|
A page of one policy's saved versions, newest first unless sortDirection says otherwise. |
Arguments
|
|
productPolicies - [ProductRateLockExtensionPolicy!]!
|
The current version of each Best efforts product's own policy, one per product. A product that was never given a policy is absent. |
Example
{
"current": [RateLockExtensionPolicy],
"history": RateLockExtensionPolicyConnection,
"productPolicies": [ProductRateLockExtensionPolicy]
}
RateLockExtensionPolicyVersion
Description
One saved version of a rate lock extension policy. A version's caps and prices never change; each save retires the current version and adds the next one.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When this version was saved. |
createdBy - OrganizationUser
|
Who saved this version, including a user who has since been removed. Null when no user was recorded. |
id - ID!
|
|
maxCumulativeDays - Int
|
The most days, in total, a lock can be extended past its original expiry. Null means no cap. |
maxExtensions - Int
|
The most extensions one lock can take. Null means no cap. |
prices - [RateLockExtensionPolicyPrice!]!
|
The extension lengths offered, shortest first. A length with no price isn't offered. |
pricingKind - RateLockExtensionPolicyPricingKind!
|
How the prices were entered. For PER_DAY, the 1-day price is the per-day rate and each length costs that many days of it. |
retiredAt - DateTime
|
When a later save replaced this version. Null while it is in effect. |
version - Int!
|
1 for the policy's first save, then one higher per save. The version with no retiredAt is in effect. |
Possible Types
| RateLockExtensionPolicyVersion Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": OrganizationUser,
"id": "4",
"maxCumulativeDays": 987,
"maxExtensions": 123,
"prices": [RateLockExtensionPolicyPrice],
"pricingKind": "LOOKUP_TABLE",
"retiredAt": "2007-12-03T10:15:30Z",
"version": 123
}
RateLockExtensionRejection
Description
Why a rate lock can't be extended.
Values
| Enum Value | Description |
|---|---|
|
|
The broker concession that would pay the fee would leave the broker's compensation below the underwriting fee; nothing was written. Only extending with a feePayer of BROKER returns this. |
|
|
The broker concession that would pay the fee would bring the loan's concessions to its per-loan limit, past which a concession waits for review; nothing was written. Only extending with a feePayer of BROKER returns this. |
|
|
The loan can't take an extension paid by its broker; nothing was written. Only extending with a feePayer of BROKER returns this. |
|
|
Pylon can't yet tell which extension terms apply to this loan. Never returned. Read RATE_LOCK_EXTENSION_PRODUCT_UNKNOWN, RATE_LOCK_EXTENSION_PRODUCT_NOT_SUPPORTED or RATE_LOCK_EXTENSION_PRODUCT_UNCLASSIFIED instead. |
|
|
Another extension of this lock was saved first, or the lock was replaced; nothing was written. Only extending returns this. |
|
|
The lock has used every extension it is allowed. |
|
|
Every length that fits would end on a weekend or a federal holiday. |
|
|
No offered extension ends on the requested date. Extending no longer returns this: a date the terms do not offer is RATE_LOCK_EXTENSION_TERMS_CHANGED. |
|
|
The lock has no extension days left, or no offered length fits in the days left. |
|
|
Extensions aren't offered for this loan. |
|
|
The loan has no active rate lock: it was never locked, or its lock has expired. |
|
|
A disclosure was sent, but Pylon has no record of its terms yet, so it can't check the loan for changes that must be disclosed. A loan never disclosed returns RATE_LOCK_EXTENSION_UNDISCLOSED_CHANGES instead. Only extending returns this. |
|
|
Extension terms aren't set up for the locked product. |
|
|
The locked product has no extension terms set up yet. |
|
|
The locked product can't be identified, so Pylon can't tell which extension terms apply. |
|
|
The request's token no longer matches the option's current price and rules, or no option offers the requested date any more, so the options and prices may differ from what was read; nothing was written. Only extending returns this. |
|
|
The loan has changes that must be disclosed to the borrower before its lock can be extended. Only extending returns this. |
Example
"RATE_LOCK_EXTENSION_BROKER_COMPENSATION_EXCEEDED"
RateLockExtensionTerms
Description
Whether the loan's rate lock can be extended now, and within what limits.
Fields
| Field Name | Description |
|---|---|
currentExpiresOn - Date
|
The active lock's expiration, even if it has passed. Null when the loan has no active lock. |
eligible - Boolean!
|
|
extensionDaysLeft - Int
|
Days the lock can still be extended by, in total, never below 0. Null when there is no limit, or no extension terms apply to the loan. |
extensionDaysUsed - Int!
|
Days the active lock has been extended past its original expiration. |
extensionsLeft - Int
|
Extensions the lock can still have, never below 0. Null when there is no limit, or no extension terms apply to the loan. |
extensionsUsed - Int!
|
Extensions the active lock has had. 0 with no active lock. |
options - [RateLockExtensionOption!]
|
The extensions the lock can take now, fewest days first: each fits in the days left and ends on a business day. Set exactly when eligible. A calendar should enable only these expiresOn dates. |
reason - RateLockExtensionRejection
|
Why the lock can't be extended. Null when eligible. |
Example
{
"currentExpiresOn": "2007-12-03",
"eligible": true,
"extensionDaysLeft": 123,
"extensionDaysUsed": 987,
"extensionsLeft": 123,
"extensionsUsed": 123,
"options": [RateLockExtensionOption],
"reason": "RATE_LOCK_EXTENSION_BROKER_COMPENSATION_EXCEEDED"
}
RateLockHistoryConnection
Description
A page of rate locks the loan has held.
Fields
| Field Name | Description |
|---|---|
edges - [RateLockHistoryEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [RateLockHistoryEdge],
"pageInfo": PageInfo
}
RateLockHistoryEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - RateLockHistoryEntry!
|
Example
{
"cursor": "4",
"node": RateLockHistoryEntry
}
RateLockHistoryEntry
Description
One rate lock the loan has held.
Fields
| Field Name | Description |
|---|---|
abandonedAt - DateTimeISO
|
When a new lock replaced this one. Null for the loan's active lock, including one that has expired. |
expiresOn - Date!
|
The lock's expiration: the last period's expiresOn. |
lockedAt - DateTimeISO!
|
When the rate was locked. |
periods - [RateLockPeriodEntry!]!
|
The initial term, then each extension, by sequence. A list, not a connection: a lock's periods are its term and its extensions, a short chain the page loads in one query. |
Example
{
"abandonedAt": "2007-12-03T10:15:30Z",
"expiresOn": "2007-12-03",
"lockedAt": "2007-12-03T10:15:30Z",
"periods": [RateLockPeriodEntry]
}
RateLockPeriodEntry
Description
One period of a rate lock: its initial term, or one extension of it.
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
The broker concession that pays the fee when feePayer is BROKER. Null for every other period. |
days - Int
|
Calendar days this extension added. Null for the initial term. |
expiresOn - Date!
|
The lock's expiration at the end of this period. |
feeBps - Float
|
The extension's fee, in basis points. Null for the initial term and for periods recorded from the loan system. |
feePayer - RateLockExtensionFeePayer!
|
Who pays feeBps. BORROWER for the initial term and for periods recorded from the loan system. |
id - ID!
|
The period's id. |
kind - RateLockPeriodKind!
|
|
previousExpiresOn - Date
|
The lock's expiration before this period. Null for the initial term. |
requestedAt - DateTimeISO!
|
When Pylon recorded this period. |
requestedBy - String
|
The name of the Command Center user who requested the extension. Null for the initial term, for periods recorded from the loan system, and for extensions requested with an API key. |
sequence - Int!
|
0 for the initial term, then 1, 2, … |
Example
{
"concession": Concession,
"days": 987,
"expiresOn": "2007-12-03",
"feeBps": 987.65,
"feePayer": "BORROWER",
"id": "4",
"kind": "EXTENSION",
"previousExpiresOn": "2007-12-03",
"requestedAt": "2007-12-03T10:15:30Z",
"requestedBy": "abc123",
"sequence": 123
}
RateLockPeriodKind
Values
| Enum Value | Description |
|---|---|
|
|
An extension of the period before it. |
|
|
The term the lock was taken for. |
Example
"EXTENSION"
RateLockStatus
Description
Rate lock status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
RateLockStatusComparator
Description
Comparisons available on the rate-lock status.
Fields
| Input Field | Description |
|---|---|
eq - RateLockStatus
|
|
in - [RateLockStatus!]
|
|
isNull - Boolean
|
|
neq - RateLockStatus
|
|
nin - [RateLockStatus!]
|
|
null - Boolean
|
Example
{
"eq": "CANCELLED",
"in": ["CANCELLED"],
"isNull": false,
"neq": "CANCELLED",
"nin": ["CANCELLED"],
"null": true
}
Rates
Fields
| Field Name | Description |
|---|---|
apor - Apor
|
|
Arguments
|
|
Example
{"apor": Apor}
ReadyToUnderwrite
Description
Readiness for the PROCESSING → UNDERWRITING transition. What's needed before submitting for underwriting?
Fields
| Field Name | Description |
|---|---|
_ - Boolean!
|
A no-op field that should not be requested. It will always throw an error if requested. It only exists to allow empty objects and may be removed in the future. This field should not be requested. It only exists to allow empty objects and may be removed in the future if more fields are added to this type. |
allRequirements - [Requirement!]!
|
Every requirement for this transition at any depth, flattened, optionally filtered by phase and by folded evaluation verdict. Use requirements for the tree: it returns roots and filters roots, so a phase or verdict that only ever lands on a leaf is invisible there. Use this to ask for the matching requirements themselves — verdict: [NEEDS_HUMAN] is every requirement on the loan waiting on a human. A verdict exists only on an OPEN requirement, so filtering by verdict never returns a satisfied or waived one; null verdict means never evaluated and matches no filter. Each match still renders its own subtree under children. |
Arguments
|
|
requirements - [Requirement!]!
|
All requirements for this transition, optionally filtered by phase. Omit the argument to get all requirements regardless of phase. |
Arguments
|
|
Example
{
"_": false,
"allRequirements": [Requirement],
"requirements": [Requirement]
}
RealEstateOwnedGrossRentalIncome
Description
Real estate owned gross rental income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
propertyId - ID!
|
The owned real estate associated with the income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"propertyId": 4,
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
ReappLoanInput
ReappLoanResponse
Description
The result of a reapp dry run or execution.
Fields
| Field Name | Description |
|---|---|
friendlyLoanId - String
|
The created loan's friendly id. Null on a dry run. |
loan - Loan
|
The created loan. Null on a dry run, or, with an error, when the user cannot access it. |
loanId - ID
|
The id of the created loan. Null on a dry run. Use loan { id }.
|
steps - [ReappStepResult!]!
|
The plan's steps, in execution order. |
warnings - [String!]!
|
Source data the plan does not recreate — review before executing. |
Example
{
"friendlyLoanId": "abc123",
"loan": Loan,
"loanId": 4,
"steps": [ReappStepResult],
"warnings": ["abc123"]
}
ReappMutations
Description
Root object for reapp mutations (internal use only).
Fields
| Field Name | Description |
|---|---|
reappLoan - ReappLoanResponse
|
Duplicate a loan by replaying its data through the API as a new application. Pass dryRun to review the plan first. Internal use only. |
Arguments
|
|
Example
{"reappLoan": ReappLoanResponse}
ReappStepResult
ReassignLoanOfficerTasksInput
Description
Input to the reassignLoanOfficerTasks mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": "4"}
ReassignLoanOfficerTasksResponse
Description
Response of the reassignLoanOfficerTasks mutation.
Fields
| Field Name | Description |
|---|---|
reassignedCount - NonNegativeInt!
|
How many loan officer tasks were reassigned to the borrower |
Example
{"reassignedCount": 123}
ReassignTaskInput
Description
Input to the reassignTask mutation.
Example
{
"assigneeBorrowerId": "4",
"loanId": 4,
"newAssignee": "abc123",
"taskId": 4
}
ReassignTaskResponse
Description
Response of the reassignTask mutation.
Example
{
"assignedTo": "xyz789",
"assigneeBorrower": Borrower,
"assigneeBorrowerId": "4"
}
RecentlyViewedLoan
Description
A loan the current user recently viewed within their active organization, with thin display fields for list rows.
Fields
| Field Name | Description |
|---|---|
contactPointFullName - String
|
The full name of the primary contact on the loan |
currentStage - String
|
The current stage that the loan is in. Returned raw so clients can apply their own stage-visibility policy. |
friendlyLoanId - String!
|
The human-friendly ID of the loan |
loan - Loan
|
The loan the user viewed. Null, with an error, when the user can no longer access it. |
loanId - ID!
|
The ID of the loan Use loan { id }.
|
loanNumber - String
|
The loan number in the origination system |
viewedAt - DateTimeISO!
|
When the current user last viewed this loan |
Example
{
"contactPointFullName": "xyz789",
"currentStage": "xyz789",
"friendlyLoanId": "xyz789",
"loan": Loan,
"loanId": 4,
"loanNumber": "xyz789",
"viewedAt": "2007-12-03T10:15:30Z"
}
RecomputeIncomeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the income to recompute |
Example
{"id": 4}
RecomputeIncomeResponse
Fields
| Field Name | Description |
|---|---|
qualifiedAmount - NonNegativeFloat
|
The recomputed qualified (and verified) monthly amount, present when recomputed is true. |
recomputed - Boolean!
|
False when the income has no paystub data to recompute from (e.g. a manual/stated income); no change was made. |
Example
{"qualifiedAmount": 123.45, "recomputed": true}
RecordLoanViewInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
Example
{"loanId": "4"}
RecordLoanViewResponse
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
True when the view was recorded. False when the caller has no org-user identity to record against (e.g. machine tokens); such calls are a silent no-op rather than an error. |
userErrors - [UserError!]!
|
Example
{"success": false, "userErrors": [UserError]}
RecordManualWireOutFigureInput
Description
Hand-enters an itemized wire-out figure for a wire-out figure the calculation blocked.
Fields
| Input Field | Description |
|---|---|
acknowledgedRemittanceIds - [ID!]
|
The remittances the caller saw recorded against the figure it replaces. Replacing a figure that has remittances is refused unless this lists exactly those. Omit for none. |
blockedFigureId - ID!
|
The blocked wire-out figure this entry resolves. |
effectiveDate - Date!
|
The date the figure takes effect. |
idempotencyKey - String!
|
A retry key unique to this loan's hand-entered figures. Entering the same figure again under the same key returns the stored one. |
lines - [ManualFigureLineInput!]!
|
The itemized lines, which must sum to the net amount. |
loanId - ID!
|
The loan whose wire-out figure is blocked. |
netAmount - MonetaryAmount!
|
The net amount to wire. It must equal the sum of the lines to the cent, and it must equal the loan's disbursement amount when the loan has a valid one. |
recipientName - String!
|
The recipient the wire is addressed to. |
replacesFigureId - ID
|
The hand-entered figure in force that this entry replaces. Omit or null for a first entry. An id that is not the figure in force is refused, so an entry prepared from a stale view cannot overwrite a newer one. |
Example
{
"acknowledgedRemittanceIds": [4],
"blockedFigureId": "4",
"effectiveDate": "2007-12-03",
"idempotencyKey": "xyz789",
"lines": [ManualFigureLineInput],
"loanId": "4",
"netAmount": MonetaryAmount,
"recipientName": "abc123",
"replacesFigureId": 4
}
RecordManualWireOutFigureResponse
Fields
| Field Name | Description |
|---|---|
blockingLines - [ManualBlockingLine!]!
|
The lines that blocked the figure this entry resolves. |
figure - FundingFigure!
|
The hand-entered figure, or for a retry the figure stored under its key. |
outcome - FundingManualFigureOutcome!
|
Example
{
"blockingLines": ["DISBURSEMENT_AMOUNT"],
"figure": FundingFigure,
"outcome": "CREATED"
}
RecordWireInAdjustmentInput
Fields
| Input Field | Description |
|---|---|
amount - MonetaryAmount!
|
The signed amount, up to $1,000,000 in either direction. A positive amount increases the wire balance and a negative amount reduces it. Zero is rejected. |
category - FundingAdjustmentCategory!
|
What the adjustment is for. |
effectiveDate - Date!
|
The accounting date the adjustment belongs to, from 2000-01-01 through 2100-12-31. It may precede the completion. |
idempotencyKey - String!
|
A retry key unique to this loan's adjustments. |
loanId - ID!
|
The loan whose completed purchase is adjusted. |
passThrough - Boolean
|
Required to be false for FEES and ESCROW. Pass-through changes must use a corrected figure and are refused here. |
Example
{
"amount": MonetaryAmount,
"category": "ESCROW",
"effectiveDate": "2007-12-03",
"idempotencyKey": "abc123",
"loanId": 4,
"passThrough": true
}
RecordWireInAdjustmentResponse
Fields
| Field Name | Description |
|---|---|
adjustment - FundingAdjustment!
|
|
fundingSettlement - FundingSettlement!
|
Example
{
"adjustment": FundingAdjustment,
"fundingSettlement": FundingSettlement
}
RecordWireInInputsInput
Fields
| Input Field | Description |
|---|---|
applyCredits - Boolean!
|
|
concessionAmount - MonetaryAmount
|
Concession amount used by the approved purchase advice. Omit to retain the latest recorded amount, or use the selected loan terms on the first record. Provide null to resume the loan value. |
escrowAtClosing - MonetaryAmount
|
Escrow held at closing used by the approved purchase advice. Omit to retain the latest recorded amount, or use the loan value on the first record. Provide null to resume the loan value. |
globalMarginPercent - NonNegativeFloat
|
Global margin in percentage points: 2.75 means 2.75%, not 0.0275. Provide together with sellerMarginShare. Omit both to retain the latest recorded pair, or use the rate-lock margin on the first record. Provide null for both to resume the rate-lock margin. |
loanId - ID!
|
|
monthlyEscrow - MonetaryAmount
|
Monthly escrow used for a stripped payment. Omit to retain the latest recorded amount, or sum the loan components on the first record. Provide null to resume the loan components. |
passthroughFees - MonetaryAmount
|
Total pass-through fees used by the approved purchase advice. Omit to retain the latest recorded amount, or sum eligible loan fees on the first record. Provide null to resume the loan fees. |
paymentsReceivedBeforePurchase - WireInPaymentsReceivedBeforePurchase
|
Payments the seller received before the purchase date. It sets the purchased principal balance, the escrow transferred and the interest days. Pylon applies it only while the loan keeps the first payment date it was stated for, and refuses it while the loan has no scheduled first payment date. Omit to retain the latest recorded value while the purchase date and first payment date it was stated for are unchanged; once either changed an omitted value is refused with FUNDING_PAYMENTS_RECEIVED_REQUIRED, recording nothing, until the count is stated again or null is sent. Provide null to use the payment schedule: the first payment counts as received when the purchase falls after the 15th of the month before it is due. |
purchaseDate - Date!
|
|
sellerMarginShare - NonNegativeFloat
|
Seller's fraction of the global margin, from 0 to 1: 0.8182 means 81.82%. Provide together with globalMarginPercent. Omit both to retain the latest recorded pair. |
supersededReason - FundingFigureSupersededReason
|
Why this input replaces the prior issued figure. Used only when a prior figure exists. |
totalToleranceCures - MonetaryAmount
|
Tolerance cures used by the approved purchase advice. Omit to retain the latest recorded amount, or use the loan value on the first record. Provide null to resume the loan value. |
Example
{
"applyCredits": true,
"concessionAmount": MonetaryAmount,
"escrowAtClosing": MonetaryAmount,
"globalMarginPercent": 123.45,
"loanId": 4,
"monthlyEscrow": MonetaryAmount,
"passthroughFees": MonetaryAmount,
"paymentsReceivedBeforePurchase": "FIRST_PAYMENT",
"purchaseDate": "2007-12-03",
"sellerMarginShare": 123.45,
"supersededReason": "CALCULATION_REVISION",
"totalToleranceCures": MonetaryAmount
}
RecordWireInInputsResponse
Fields
| Field Name | Description |
|---|---|
inputVersion - FundingWireInInputVersion!
|
Example
{"inputVersion": FundingWireInInputVersion}
RecordWireInRemittanceInput
Fields
| Input Field | Description |
|---|---|
amount - MonetaryAmount!
|
The positive amount Pylon sent through the bank. |
figureId - ID!
|
The issued wire-in figure used for the bank transfer. |
fundsOrderedAt - DateTime!
|
The time when Pylon placed the bank transfer. |
idempotencyKey - String!
|
A retry key unique to this loan's wire-in records. |
kind - FundingRemittanceKind
|
REMITTANCE (the default when omitted) records money sent through the bank. RETURN_RECEIVED records money that came back when the wire exceeded the figure. Only a Pylon operator may record a return; send the positive amount returned. |
loanId - ID!
|
The loan Pylon sent funds for. |
Example
{
"amount": MonetaryAmount,
"figureId": "4",
"fundsOrderedAt": "2007-12-03T10:15:30Z",
"idempotencyKey": "xyz789",
"kind": "REMITTANCE",
"loanId": "4"
}
RecordWireInRemittanceResponse
Fields
| Field Name | Description |
|---|---|
fundingSettlement - FundingSettlement!
|
|
purchaseAdviceRefusalReason - FundingPurchaseAdviceRefusalReason
|
Why generation was refused. BINDING_CHANGED needs a retry; MISSING_PAYMENTS needs effective wire-in and wire-out remittances. NON_RECONCILING_LINES uses the figures bound to those remittances: only a calculation fix, or correcting and re-recording the remittance, changes the outcome; reissuing a figure alone does not. Once the underlying issue is resolved, repeat recordWireInRemittance with the same idempotency key to retry generation. |
purchaseAdviceStatus - FundingPurchaseAdviceStatus
|
Generation outcome for this recorded remittance. Null for RETURN_RECEIVED: returned funds do not generate Purchase Advice. Inspect the status and refusal reason for recovery guidance; the remittance remains recorded even when generation is not STORED. |
remittance - FundingRemittance!
|
Example
{
"fundingSettlement": FundingSettlement,
"purchaseAdviceRefusalReason": "BINDING_CHANGED",
"purchaseAdviceStatus": "FAILED",
"remittance": FundingRemittance
}
RecordWireOutRemittanceInput
Fields
| Input Field | Description |
|---|---|
amount - MonetaryAmount!
|
The positive amount ordered through the bank. |
figureId - ID!
|
The issued wire-out figure used for the bank order. |
fundsOrderedAt - DateTime!
|
The time when the reporting system placed the bank order. |
idempotencyKey - String!
|
A retry key unique to this loan's wire-out records. |
kind - FundingRemittanceKind
|
REMITTANCE (the default when omitted) records money sent through the bank. RETURN_RECEIVED records money that came back when the wire exceeded the figure. Only a Pylon operator may record a return; send the positive amount returned. |
loanId - ID!
|
The loan whose wire was ordered. |
Example
{
"amount": MonetaryAmount,
"figureId": 4,
"fundsOrderedAt": "2007-12-03T10:15:30Z",
"idempotencyKey": "xyz789",
"kind": "REMITTANCE",
"loanId": 4
}
RecordWireOutRemittanceResponse
Fields
| Field Name | Description |
|---|---|
fundingSettlement - FundingSettlement!
|
|
remittance - FundingRemittance!
|
Example
{
"fundingSettlement": FundingSettlement,
"remittance": FundingRemittance
}
RedeliverWebhookEventInput
Description
Sends one event to one of your organization's webhook endpoints again.
Example
{"eventId": 4, "subscriptionId": 4}
RedeliverWebhookEventResponse
Description
The result of asking for a redelivery.
Fields
| Field Name | Description |
|---|---|
delivery - WebhookDelivery
|
The new delivery. A successful request queues the event; it does not mean your endpoint has acknowledged it. Read the endpoint's deliveries to see its outcome. Null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused, if it was. Empty on success. Codes: WEBHOOK_REDELIVERY_NOT_SUBSCRIBED, WEBHOOK_REDELIVERY_ENDPOINT_INACTIVE, WEBHOOK_TOPIC_SCOPE_MISSING. An unknown or another organization's endpoint or event is a not-found GraphQL error instead. |
Example
{
"delivery": WebhookDelivery,
"userErrors": [UserError]
}
RediscloseInput
Description
Input to the loan.redisclose mutation.
Fields
| Input Field | Description |
|---|---|
changeDescription - String!
|
The Change of Circumstances Request Form's "Change Requested" cell — what changed, in the requester's own words ('Flipping to Fannie'). Not derivable from the drift report: that is what Pylon detected, this is what a person intended. |
changeEvent - LoanChangeEvent
|
The change-of-circumstance event behind this redisclosure, sent under the reason the event falls under. For any event but OTHER, changeDescription is the event's wording from Loan.changeEventWordings, completed with no bracketed placeholder such as [date] left in it. Mutually exclusive with changedCircumstanceReason. |
changedCircumstanceReason - ChangeOfCircumstanceReason
|
Why this is a changed circumstance under §1026.19(e)(3)(iv): the judgement that permits a revised Loan Estimate to reset a fee's tolerance baseline. Exactly one of this and changeEvent is required; a send with neither is refused. |
feeChangedCircumstanceReasons - [RedisclosureFeeReasonInput!]
|
The reason chosen for each changed fee in Loan.redisclosureFeeChanges. Omitted discloses every fee under changedCircumstanceReason. A changed fee left out of a supplied list is treated as not a valid change. Naming a fee twice refuses the send. |
loanId - ID!
|
The ID or friendly ID of the loan. |
supportingDocumentIds - [ID!]
|
Documents on this loan that evidence the changed circumstance, printed under the form's supporting-documentation rows. Every id must belong to loanId; one that does not refuses the send. Omitted leaves the rows blank for a human to complete, which is the paper form. |
Example
{
"changeDescription": "abc123",
"changeEvent": "ADD_OR_REMOVE_BORROWER",
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"feeChangedCircumstanceReasons": [
RedisclosureFeeReasonInput
],
"loanId": "4",
"supportingDocumentIds": [4]
}
RediscloseResponse
Description
Response of the loan.redisclose mutation.
Fields
| Field Name | Description |
|---|---|
assessedReasonKinds - [DisclosureDriftReasonKind!]!
|
What the drift report said at the moment of sending. Always empty: the send happens after this call resolves. Resolved asynchronously by the redisclosure pipeline: follow redisclosurePipelineRun instead.
|
changeOfCircumstanceForm - ChangeOfCircumstanceForm
|
Always null: the form is filed when the pipeline sends. Resolved asynchronously by the redisclosure pipeline: follow redisclosurePipelineRun instead.
|
changeOfCircumstanceRequest - ChangeOfCircumstanceRequest
|
Always null: the change of circumstance is recorded when the pipeline sends. Resolved asynchronously by the redisclosure pipeline: follow redisclosurePipelineRun instead.
|
disclosuresRun - DisclosuresRunStatus
|
Always null: the run is booked when the pipeline sends. Resolved asynchronously by the redisclosure pipeline: follow redisclosurePipelineRun instead.
|
redisclosurePipelineRun - RedisclosurePipelineRun
|
The pipeline carrying out this redisclosure. Read it again, through Loan.redisclosurePipelineRun, to follow it: it resolves as soon as it is started, and the send happens later. Null exactly when userErrors is non-empty. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the loan.redisclose mutation. |
Example
{
"assessedReasonKinds": ["APR_INACCURATE"],
"changeOfCircumstanceForm": ChangeOfCircumstanceForm,
"changeOfCircumstanceRequest": ChangeOfCircumstanceRequest,
"disclosuresRun": DisclosuresRunStatus,
"redisclosurePipelineRun": RedisclosurePipelineRun,
"userErrors": [UserError]
}
RedisclosureFeeChange
Description
A fee that changed since the loan was last disclosed, which a redisclosure can give its own changed-circumstance reason.
Fields
| Field Name | Description |
|---|---|
currentAmount - MonetaryAmount
|
|
description - String
|
|
disclosedAmount - MonetaryAmount
|
The amount the last disclosure printed. |
id - ID!
|
The key to choose this fee's reason under in RediscloseInput.feeChangedCircumstanceReasons. |
isTotalLenderCredit - Boolean!
|
Whether this is the loan's total lender credit rather than a single fee. |
Example
{
"currentAmount": MonetaryAmount,
"description": "abc123",
"disclosedAmount": MonetaryAmount,
"id": 4,
"isTotalLenderCredit": true
}
RedisclosureFeeReasonInput
Description
The changed-circumstance reason chosen for one changed fee.
Fields
| Input Field | Description |
|---|---|
changedCircumstanceReason - ChangeOfCircumstanceReason
|
Null marks the change as not a valid changed circumstance, so the fee is not disclosed under one. |
feeChangeId - ID!
|
A RedisclosureFeeChange.id. |
Example
{
"changedCircumstanceReason": "CHANGED_CIRCUMSTANCE_AFFECTING_ELIGIBILITY",
"feeChangeId": "4"
}
RedisclosurePipelineRun
Description
A redisclosure being carried out: mortgage insurance is pulled, AUS is run and must pass, and only then is the package sent. A pipeline that stops short has sent nothing and recorded no change of circumstance.
Fields
| Field Name | Description |
|---|---|
ausRun - AusRunJob
|
The AUS run the pipeline started, which says why AUS did not allow the loan when userErrors points at it. Null until the pipeline has started one, and for a product that needs no AUS. |
disclosuresRun - DisclosuresRunStatus
|
The disclosures run the send booked: a revised Loan Estimate or a corrected Closing Disclosure, whichever the baseline owes. Null until the send has booked it. Generation is asynchronous, so a resolved run means the package was booked, not that the borrower has it; read its status for that. |
id - ID!
|
|
status - RedisclosurePipelineStatus!
|
|
userErrors - [UserError!]!
|
Why the pipeline stopped without sending. Empty unless status is FAILED or FAILED_TO_START. When AUS is the reason, ausRun carries its own explanation. |
Example
{
"ausRun": AusRunJob,
"disclosuresRun": DisclosuresRunStatus,
"id": 4,
"status": "FAILED",
"userErrors": [UserError]
}
RedisclosurePipelineStatus
Description
Where a redisclosure is in the pipeline that refreshes mortgage insurance and AUS before sending. SUCCEEDED means the package was booked, not delivered: follow disclosuresRun for that. FAILED and FAILED_TO_START sent nothing.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FAILED"
RefinanceCashOutType
Description
Refinance cash out type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CASH_OUT"
RefinancePricingInput
Fields
| Input Field | Description |
|---|---|
amortizationTypes - [PricingAmortizationType!]
|
The amortization types to price. Defaults to fixed-only; request ADJUSTABLE_RATE (typically in a separate sequential call) to price ARM products, so one request never solves both halves of the sheet at once. Default = [FIXED] |
cashOut - NonNegativeInt
|
The amount of cash to be returned to the borrower from the equity. Default = 0 |
concessions - NonNegativeInt!
|
|
fipsCountyCode - String!
|
|
firstLienAmount - NonNegativeInt!
|
The remaining balance on the first lien of the property |
hoaDues - NonNegativeInt
|
Monthly homeowners association dues in dollars. When omitted, pricing behaves as if the property has no HOA dues. |
isBorrowerSelfEmployed - Boolean!
|
|
loanAmount - NonNegativeInt
|
The desired loan amount in dollars. When provided, pins the solver to this exact loan amount and the out-of-pocket cost is derived from it. When omitted, the solver determines the optimal loan amount. |
loanTermYears - Float!
|
|
monthlyDebt - Float!
|
|
monthlyIncome - Float!
|
|
neighborhoodHousingType - NeighborhoodHousingType!
|
|
numberOfUnits - NonNegativeInt
|
|
objectiveIntent - PricingObjectiveIntent
|
Configure the objective function to optimize against. Default = MIN_PITIA |
pricingConstraints - PricingConstraints
|
|
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Whether property taxes and insurance are included in the monthly payment (impounded). Defaults to impounded when omitted. |
propertyUsageType - PropertyUsageType!
|
|
propertyValue - NonNegativeInt!
|
The value of the property being refinanced in dollars. |
qualifyingFicoScore - Int
|
|
rateLockDays - Float!
|
Example
{
"amortizationTypes": ["ADJUSTABLE_RATE"],
"cashOut": 123,
"concessions": 123,
"fipsCountyCode": "xyz789",
"firstLienAmount": 123,
"hoaDues": 123,
"isBorrowerSelfEmployed": true,
"loanAmount": 123,
"loanTermYears": 123.45,
"monthlyDebt": 123.45,
"monthlyIncome": 987.65,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"objectiveIntent": "MIN_DOWN_PAYMENT",
"pricingConstraints": PricingConstraints,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"propertyUsageType": "INVESTMENT",
"propertyValue": 123,
"qualifyingFicoScore": 987,
"rateLockDays": 123.45
}
RefreshCreditReportInput
Description
Input to refresh an existing credit report
Fields
| Input Field | Description |
|---|---|
creditPullId - ID!
|
The ID of the completed credit pull to refresh |
Example
{"creditPullId": 4}
RefreshCreditReportResponse
Description
Response from refreshing a credit report
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job for the refresh |
userErrors - [String!]
|
User errors preventing refresh |
Example
{
"job": CreditPullJob,
"userErrors": ["abc123"]
}
RefreshLinkInput
RefreshLinkResponse
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime!
|
|
hostedUrl - String
|
The borrower-facing hosted link, null unless the link is pending and unexpired. |
linkId - String!
|
|
status - AssetVerificationLinkStatus!
|
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"hostedUrl": "xyz789",
"linkId": "xyz789",
"status": "COMPLETED"
}
RejectDocumentInput
RejectDocumentResponse
Description
Response of the rejected document mutation.
Fields
| Field Name | Description |
|---|---|
taskId - ID!
|
Success of the rejected task |
Example
{"taskId": "4"}
RelativeDateTime
Description
An instant, given either absolutely as an RFC 3339 date-time ("2026-07-18T00:00:00Z") or relatively as an ISO 8601 duration from now ("P2W" is two weeks ahead, "-P30D" is thirty days ago). Durations are resolved on the server against a single reading of the clock, so a window built from two of them cannot straddle a tick.
Example
RelativeDateTime
RelockCommittedStructure
Description
The product structure committed by an ended lock.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RelockFeePolicy
Description
One relock fee policy, shared by every product, in force over [effectiveFrom, effectiveTo). It prices both the relock fee of a lock relocked inside the window and the fee of an investor change on a live lock. Policies are never edited except to close them, and never deleted.
Fields
| Field Name | Description |
|---|---|
capture - Float!
|
Share of a market improvement the borrower keeps on a relock: 0 applies the whole worst-case difference, 1 applies none of it. |
createdAt - DateTimeISO!
|
When the policy was recorded. |
createdBy - OrganizationUser
|
Who recorded this, including a user who has since been removed. Null when no user was recorded. |
effectiveFrom - DateTimeISO!
|
|
effectiveTo - DateTimeISO
|
When the next policy replaced this one. Null for the policy in force now. Equal to effectiveFrom for a policy replaced at the instant it began, which was never in force. |
feePoints - Float!
|
The relock fee, in points of the loan amount. Use feeTotalPercent. |
feeTotalPercent - NonNegativeFloat!
|
The relock fee as a percentage of the loan amount (the same unit as points), as a closing cost's feeTotalPercent. A relocked structure's totalPoints includes it. |
id - ID!
|
|
relockWindowDays - Int!
|
Calendar days after a lock ends during which a new lock is priced at worst case. |
Example
{
"capture": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": OrganizationUser,
"effectiveFrom": "2007-12-03T10:15:30Z",
"effectiveTo": "2007-12-03T10:15:30Z",
"feePoints": 123.45,
"feeTotalPercent": 123.45,
"id": 4,
"relockWindowDays": 123
}
RelockWindow
Description
The relock window of a rate lock that has ended: how long a relock is priced at worst case instead of at today's market.
Fields
| Field Name | Description |
|---|---|
inWindow - Boolean!
|
Whether today is inside the window. |
lockExpiredOn - Date!
|
The day the lock ended: its last period's expiration, or its cancellation when earlier. |
lockedStructure - RelockCommittedStructure!
|
The product structure committed by the ended lock. |
lockedStructureId - ID!
|
The product structure the ended lock committed; compare with Loan.productStructure.id to tell it from a relock candidate. Use lockedStructure { id }.
|
windowEndsOn - Date!
|
The last day a relock is priced at worst case. |
Example
{
"inWindow": true,
"lockExpiredOn": "2007-12-03",
"lockedStructure": RelockCommittedStructure,
"lockedStructureId": 4,
"windowEndsOn": "2007-12-03"
}
RemoveEmailDomainsInput
Fields
| Input Field | Description |
|---|---|
domains - [String!]!
|
Email domains to remove from the organization. |
Example
{"domains": ["xyz789"]}
RemoveEmailDomainsResponse
Fields
| Field Name | Description |
|---|---|
emailDomains - [String!]!
|
Example
{"emailDomains": ["xyz789"]}
RemoveLoanAssignmentInput
Fields
| Input Field | Description |
|---|---|
loanAssignmentId - ID!
|
Example
{"loanAssignmentId": "4"}
RemoveLoanAssignmentResponse
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
|
userErrors - [UserError!]!
|
Example
{"success": true, "userErrors": [UserError]}
RemoveLoanOfficerInput
Description
Input to the removeLoanOfficer mutation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the GlobalLoanOfficer to remove |
Example
{"id": "4"}
RemoveLoanOfficerResponse
Description
Response of the removeLoanOfficer mutation
Fields
| Field Name | Description |
|---|---|
globalLoanOfficer - GlobalLoanOfficer
|
The GlobalLoanOfficer after the removal, now inactive. Null exactly when userErrors is not empty. |
userErrors - [UserError!]!
|
Why the removal was not made, when the caller can act on it. Empty when it was made. A loan officer not in the organization is reported as an error, not here. |
Example
{
"globalLoanOfficer": GlobalLoanOfficer,
"userErrors": [UserError]
}
RemoveManualRequirementInput
Fields
| Input Field | Description |
|---|---|
requirementId - ID!
|
The manual requirement to remove (a req_… id). |
Example
{"requirementId": "4"}
RemoveManualRequirementResponse
Description
Result of removing a manual requirement.
Fields
| Field Name | Description |
|---|---|
evictedRequirementIds - [ID!]!
|
The requirement ids this write evicted — normalized-cache eviction hints for the caller. |
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"evictedRequirementIds": [4],
"requirement": Requirement,
"warnings": ["TARGET_SUPERSEDED"]
}
RentalIncome
Description
Rental income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
id - ID!
|
Node ID |
ownedProperty - OwnedProperty!
|
The associated owned property entity |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"id": "4",
"ownedProperty": OwnedProperty,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
RentalStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LEASED"
ReopenAssessmentInput
ReopenAssessmentResponse
Description
Result of reopening an assessment.
Fields
| Field Name | Description |
|---|---|
evidence - Evidence!
|
The INVALIDATION act the reopen wrote. |
evidenceId - ID!
|
The INVALIDATION act's content-addressed edge id. Use evidence { id }.
|
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"evidence": Evidence,
"evidenceId": 4,
"requirement": Requirement,
"warnings": ["TARGET_SUPERSEDED"]
}
ReopenRequirementConversationSessionInput
ReopenRequirementConversationSessionResponse
Fields
| Field Name | Description |
|---|---|
session - RequirementConversationSession
|
The conversation, or null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused: REQUIREMENT_CONVERSATION_STATE_CONFLICT (the conversation can't take this step now) or REQUIREMENT_CONVERSATION_REQUEST_ID_REUSED (the request id was used for a different request). Empty on success. |
Example
{
"session": RequirementConversationSession,
"userErrors": [UserError]
}
ReplaceOrganizationFeeInput
Fields
| Input Field | Description |
|---|---|
customerFeeId - ID!
|
The fee being replaced. Must be on the organization's currently active pay schedule, so a repeated submission is rejected once the first one has retired it. |
fee - OrganizationFeeInput!
|
Example
{"customerFeeId": 4, "fee": OrganizationFeeInput}
ReplaceOrganizationFeeResponse
Fields
| Field Name | Description |
|---|---|
organization - Organization
|
The organization after the change (select fees / feeHistory for the new schedule); null when the change was refused (see userErrors). |
userErrors - [GenericUserError!]!
|
Why the change was refused: CUSTOMER_FEE_DUAL_COMPENSATION or CUSTOMER_FEE_CONFLICTS_WITH_RATE_COST on an add or replace (see those mutations for when), CUSTOMER_FEE_NOT_ACTIVE when the fee was already replaced or retired, or MARGIN_WINDOW_START_BEFORE_CURRENT when a newer schedule already exists (retry). Empty when it was applied. |
Example
{
"organization": Organization,
"userErrors": [GenericUserError]
}
ReportType
Description
Whether the liability was sourced from a credit report or self-reported
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREDIT_REPORT"
RepricingSheetPrice
Description
The price of this rate on one rate sheet of a comparison.
Example
{
"points": 987.65,
"sheetReceivedAt": "2007-12-03T10:15:30Z"
}
RequestBrandingLogoUploadInput
Description
Input for requesting a branding-logo upload URL.
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
The customer to set the logo for (internal administrators are cross-customer, so the target is named explicitly). |
extension - BrandingLogoExtension!
|
Declared file type of the logo that will be uploaded. The received bytes must match it. |
Example
{"customerId": 4, "extension": "PNG"}
RequestBrandingLogoUploadResponse
Description
Response from requesting a branding-logo upload.
Fields
| Field Name | Description |
|---|---|
upload - BrandingLogoUpload!
|
The upload target. |
Example
{"upload": BrandingLogoUpload}
RequestConcessionInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
|
loanId - ID
|
|
reason - String
|
Example
{
"amount": 123,
"loanId": "4",
"reason": "xyz789"
}
RequestConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
RequestLinkInput
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
Example
{"borrowerId": "4"}
RequestLinkResponse
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime!
|
|
hostedUrl - String
|
The borrower-facing hosted link, null unless the link is pending and unexpired. |
linkId - String!
|
|
status - AssetVerificationLinkStatus!
|
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"hostedUrl": "abc123",
"linkId": "xyz789",
"status": "COMPLETED"
}
RequestOrderInput
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
Example
{"borrowerId": 4}
RequestOrderResponse
Fields
| Field Name | Description |
|---|---|
existingOrderReused - Boolean!
|
|
expiresAt - DateTime!
|
|
orderId - String!
|
|
shareUrl - String
|
The borrower-facing verification link, null when the order has no usable link. |
status - IncomeVerificationOrderStatus!
|
Example
{
"existingOrderReused": false,
"expiresAt": "2007-12-03T10:15:30Z",
"orderId": "abc123",
"shareUrl": "xyz789",
"status": "CANCELED"
}
RequestReconsiderationInput
Fields
| Input Field | Description |
|---|---|
requirementId - ID!
|
The requirement whose assessment the agent should revisit. |
Example
{"requirementId": "4"}
RequestReconsiderationResponse
Description
Result of requesting agent reconsideration. The agent's answer arrives asynchronously as an AGENT assertion with outcome CONCUR or DEFER; it can never displace an active human assertion (author precedence is structural).
Fields
| Field Name | Description |
|---|---|
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"requirement": Requirement,
"warnings": ["TARGET_SUPERSEDED"]
}
RequestSupportDocumentUploadInput
Description
Input for requesting a support-document upload URL.
Example
{"fileName": "xyz789", "loanId": 4}
RequestSupportDocumentUploadResponse
Description
Response from requesting a document upload.
Fields
| Field Name | Description |
|---|---|
upload - SupportDocumentUpload!
|
The upload target. |
Example
{"upload": SupportDocumentUpload}
Requirement
Description
A requirement that must be satisfied before the loan can progress.
Fields
| Field Name | Description |
|---|---|
borrowerIds - [ID!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. |
children - [Requirement!]!
|
Child requirements of a composite, each with its own phase, recursing through nested composites so a deep tree renders as a tree. Empty for leaf requirements. Unlike fulfillmentOptions, present in every phase — a satisfied or waived composite still lists its children here. |
description - String!
|
Human-readable label for this requirement, e.g. "W2 for Acme Corp (2025)". |
id - ID!
|
Stable identifier for this requirement, resolvable via the root node(id) query. |
openedAt - DateTimeISO!
|
When this requirement (re)entered its current OPEN period. A removed and later restored requirement carries the restore time, not its original creation time. |
phase - RequirementPhase!
|
Current resolution phase. Redundant with __typename but useful for client-side filtering without fragment matching. |
provenance - [ProvenanceSource!]!
|
Why this requirement exists — rule evaluation, manual condition, or data dependency. |
recommendedAction - RequirementRecommendedAction!
|
The next action recommended for this requirement. Clients must use this field, never the human-readable description, to decide whether to offer a specialized action. |
relatedEntities - [Node!]!
|
Entities this requirement's params point at (borrower, employment, asset, asset transaction, property), resolvable as Nodes. Entities the caller cannot read, that no longer exist, or that belong to another loan are omitted. |
Possible Types
| Requirement Types |
|---|
Example
{
"borrowerIds": [4],
"borrowers": [Borrower],
"children": [Requirement],
"description": "abc123",
"id": "4",
"openedAt": "2007-12-03T10:15:30Z",
"phase": "OPEN",
"provenance": [ProvenanceSource],
"recommendedAction": "ATTACH_LOAN_STRUCTURE",
"relatedEntities": [Node]
}
RequirementAssigneeRole
Description
The role responsible for fulfilling a requirement. MULTIPLE indicates a composite with mixed ownership. SYSTEM indicates a prerequisite resolved automatically. MANUAL_REVIEW indicates the requirement is pending a human reviewer's judgment rather than borrower action. THIRD_PARTY indicates an external party must provide the requirement input. ACCOUNT_MANAGER and CLOSER indicate an internal Pylon account manager or closer must act. UNASSIGNED indicates no honest assignee role is available for the current requirement state.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT_MANAGER"
RequirementCategory
Description
A category a requirement belongs to. Title-related requirements are SUBJECT_PROPERTY.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSETS"
RequirementConversationMessage
Fields
| Field Name | Description |
|---|---|
authorParty - ConversationAuthorParty!
|
|
body - String!
|
|
createdAt - DateTime!
|
|
id - ID!
|
|
kind - ConversationMessageKind!
|
|
replyTo - RequirementConversationMessage
|
The earlier message in the same conversation that this one replies to. |
session - RequirementConversationSession!
|
The conversation the message belongs to. |
visibility - ConversationVisibility!
|
Example
{
"authorParty": "AGENT",
"body": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"kind": "CONTEST_OUTCOME",
"replyTo": RequirementConversationMessage,
"session": RequirementConversationSession,
"visibility": "LO_VISIBLE"
}
RequirementConversationMessageConnection
Fields
| Field Name | Description |
|---|---|
nodes - [RequirementConversationMessage!]!
|
|
pageInfo - RequirementConversationPageInfo!
|
Example
{
"nodes": [RequirementConversationMessage],
"pageInfo": RequirementConversationPageInfo
}
RequirementConversationPageInfo
RequirementConversationSession
Description
A conversation between one loan officer and underwriting about one requirement or evidence item on a loan.
Fields
| Field Name | Description |
|---|---|
closedAt - DateTime
|
When an underwriter last closed the conversation; null while it is open. |
createdAt - DateTime!
|
|
evidence - UnderwritingEvidenceEdge
|
The evidence item the conversation is about, when targetKind is EVIDENCE, as the requirements service holds it. Shown to underwriting staff only; null for a loan officer. |
id - ID!
|
|
loan - Loan!
|
The loan the conversation is on. |
loanOfficer - GlobalLoanOfficer!
|
The loan officer in the conversation: the loan's assigned loan officer when it started. |
messages - RequirementConversationMessageConnection!
|
The messages the caller may read, oldest first. A loan officer never receives staff-only messages. |
requirement - Requirement
|
The requirement the conversation is about, when targetKind is REQUIREMENT. Null for a loan officer when the requirement is not shown to loan officers. |
state - ConversationSessionState!
|
|
targetKind - ConversationTargetKind!
|
Whether the conversation is about a requirement or an evidence item. |
Example
{
"closedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"evidence": UnderwritingEvidenceEdge,
"id": "4",
"loan": Loan,
"loanOfficer": GlobalLoanOfficer,
"messages": RequirementConversationMessageConnection,
"requirement": Requirement,
"state": "CLOSED",
"targetKind": "EVIDENCE"
}
RequirementConversationSessionConnection
Fields
| Field Name | Description |
|---|---|
nodes - [RequirementConversationSession!]!
|
|
pageInfo - RequirementConversationPageInfo!
|
Example
{
"nodes": [RequirementConversationSession],
"pageInfo": RequirementConversationPageInfo
}
RequirementPhase
Description
The resolution phase of a requirement: OPEN (not yet fulfilled), SATISFIED (evidence or judgment demonstrates it's met), WAIVED (authorized actor explicitly waived it).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
RequirementRecommendedAction
Description
The next action recommended for this requirement. Clients must use this field, never the human-readable description, to decide whether to offer a credit pull or attach a loan structure. NONE means no specialized action is recommended.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ATTACH_LOAN_STRUCTURE"
RequirementRestoreOutcome
Description
What restoreRequirement did with the requirement.
Values
| Enum Value | Description |
|---|---|
|
|
It was already live; nothing changed. |
|
|
It was removed and is live again (unpublished). |
Example
"ALREADY_LIVE"
RequirementStatus
Description
Status of a requirement: PENDING (not started), PROCESSING (in progress), REJECTED (needs re-attempt), COMPLETED (satisfied).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
ReservesNotMetViolation
Description
Optimizer could not find a solution with sufficient reserves.
Fields
| Field Name | Description |
|---|---|
additionalReserveRequirements - Float!
|
Minimum additional dollars needed to meet the reserve requirements. |
availableReserves - Float
|
Dollars of reserves the borrower has after cash to close: assets that count toward reserves less cash to close. Negative when cash to close alone exceeds those assets. Absent on pricing recorded before this field existed. |
requiredReserveMonths - Int
|
The reserve requirement as whole months of the qualifying housing payment, when it is one: 0 when no months-of-reserves rule applies. Null when the requirement is not a whole number of months, when a cash-out solve's floor could be either a months rule or one net of the proceeds, or on pricing recorded before this field existed. |
requiredReserves - Float
|
Dollars of reserves the product requires after cash to close. Zero when no months-of-reserves rule applies and the shortfall is cash to close exceeding the assets that count toward reserves. Absent on pricing recorded before this field existed. |
Example
{
"additionalReserveRequirements": 987.65,
"availableReserves": 123.45,
"requiredReserveMonths": 987,
"requiredReserves": 123.45
}
ResetOrganizationUserMfaInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
ResetOrganizationUserMfaResponse
Fields
| Field Name | Description |
|---|---|
userErrors - [GenericUserError!]!
|
Example
{"userErrors": [GenericUserError]}
ResolveFieldProvenanceInput
Description
Resolve one contested borrower field from one evidence row the current provenance response exposed.
Fields
| Input Field | Description |
|---|---|
candidateCitationId - ID!
|
The selected candidate's immutable citation identity, copied from FieldProvenance.candidates. |
candidateDocumentId - ID!
|
The selected candidate citation's document identity, copied from FieldProvenance.candidates. Both identities must still agree on the server. |
expectedCandidateSetVersion - String!
|
The FieldProvenance.candidateSetVersion the human reviewed. A mismatch returns STALE_CANDIDATE_SET and writes nothing. |
field - String!
|
The FieldProvenance.field value being resolved. This operation accepts only fields with a reviewed candidate-to-borrower write mapping. |
targetBorrowerId - ID!
|
The borrower the contested field belongs to. The loan is derived server-side from this borrower's own loan, never taken as a second, independent client claim (PAPI-322) — a borrower's loan is a real 1:1 relationship, so naming the borrower is naming the loan. |
Example
{
"candidateCitationId": 4,
"candidateDocumentId": "4",
"expectedCandidateSetVersion": "abc123",
"field": "abc123",
"targetBorrowerId": 4
}
ResolveFieldProvenanceResponse
Description
Result of resolving a contested field from its current evidence set. The returned candidate-set version is current at the transaction's decision point; STALE_CANDIDATE_SET is a conflict outcome, not a partial success.
Fields
| Field Name | Description |
|---|---|
candidateSetVersion - String!
|
The candidate-set version that was current when the server decided this request. Re-fetch provenance before retrying after STALE_CANDIDATE_SET. |
status - FieldProvenanceResolutionStatus!
|
Example
{
"candidateSetVersion": "abc123",
"status": "BORROWER_LOAN_MISMATCH"
}
ResolveSeedPersonDecisionInput
Description
Resolve one PERSON_CONTESTED decision of a seed-from-documents run.
Fields
| Input Field | Description |
|---|---|
decisionId - ID!
|
The decision to resolve. |
expectedVersion - OpaqueToken!
|
The version observed while OPEN. An identical recorded resolution replays regardless of this token; an OPEN mismatch is SEED_DECISION_STALE. |
resolution - SeedPersonResolutionInput!
|
Example
{
"decisionId": "4",
"expectedVersion": OpaqueToken,
"resolution": SeedPersonResolutionInput
}
ResolveSeedPersonDecisionResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
|
decision - DocumentSeedingDecision!
|
The decision as it stands now: RESOLVED on success, unchanged on a refusal. |
seeding - DocumentSeeding!
|
The run the decision belongs to, as it stands now. |
userErrors - [DocumentSeedingDecisionUserError!]!
|
Empty when the resolution was recorded. |
Example
{
"borrower": Borrower,
"decision": DocumentSeedingDecision,
"seeding": DocumentSeeding,
"userErrors": [DocumentSeedingDecisionUserError]
}
ResolveSeedValueDecisionInput
Description
Resolve one document-seeding value decision.
Fields
| Input Field | Description |
|---|---|
decisionId - ID!
|
|
expectedVersion - OpaqueToken!
|
|
resolution - SeedValueResolutionInput!
|
Example
{
"decisionId": "4",
"expectedVersion": OpaqueToken,
"resolution": SeedValueResolutionInput
}
ResolveSeedValueDecisionResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
|
decision - DocumentSeedingDecision!
|
The decision as it stands now: RESOLVED on success, unchanged on a refusal. |
seeding - DocumentSeeding!
|
The run the decision belongs to, as it stands now. |
userErrors - [DocumentSeedingDecisionUserError!]!
|
Empty when the resolution was recorded. |
Example
{
"borrower": Borrower,
"decision": DocumentSeedingDecision,
"seeding": DocumentSeeding,
"userErrors": [DocumentSeedingDecisionUserError]
}
ResolveUncertainDisclosureSendInput
Description
Input to the resolveUncertainDisclosureSend mutation.
Fields
| Input Field | Description |
|---|---|
disclosuresRunId - ID!
|
The disclosures run whose package was handed to the loan system with no confirmed delivery. |
outcome - UncertainDisclosureSendOutcome!
|
What the loan system shows about the run's package. |
Example
{
"disclosuresRunId": "4",
"outcome": "DELIVERED"
}
ResolveUncertainDisclosureSendResponse
Description
Response of the resolveUncertainDisclosureSend mutation.
Fields
| Field Name | Description |
|---|---|
disclosuresRun - DisclosuresRunStatus
|
The run once the outcome is recorded; null when it was refused. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the resolveUncertainDisclosureSend mutation. |
Example
{
"disclosuresRun": DisclosuresRunStatus,
"userErrors": [UserError]
}
RestoreRequirementInput
RestoreRequirementResponse
Description
Shares BaseUnderwritingReviewResponse (requirement subtree, warnings).
Fields
| Field Name | Description |
|---|---|
outcome - RequirementRestoreOutcome!
|
What the restore did with the requirement. |
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
restoredRequirements - [Requirement!]!
|
Every requirement this restore brought back: the target plus children removed with it. |
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"outcome": "ALREADY_LIVE",
"requirement": Requirement,
"restoredRequirements": [Requirement],
"warnings": ["TARGET_SUPERSEDED"]
}
RetireOrganizationFeeInput
Fields
| Input Field | Description |
|---|---|
customerFeeId - ID!
|
The fee to retire. Must be on the organization's currently active pay schedule. |
Example
{"customerFeeId": 4}
RetireOrganizationFeeResponse
Fields
| Field Name | Description |
|---|---|
organization - Organization
|
The organization after the change (select fees / feeHistory for the new schedule); null when the change was refused (see userErrors). |
userErrors - [GenericUserError!]!
|
Why the change was refused: CUSTOMER_FEE_DUAL_COMPENSATION or CUSTOMER_FEE_CONFLICTS_WITH_RATE_COST on an add or replace (see those mutations for when), CUSTOMER_FEE_NOT_ACTIVE when the fee was already replaced or retired, or MARGIN_WINDOW_START_BEFORE_CURRENT when a newer schedule already exists (retry). Empty when it was applied. |
Example
{
"organization": Organization,
"userErrors": [GenericUserError]
}
RetirementFundAsset
Description
Retirement fund asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "abc123",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
RetirementIncome
Description
Retirement income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
RetryDocumentIntakeInput
Description
Ask for one uploaded file to be read again.
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
The uploaded file to re-read. |
Example
{"documentId": 4}
RetryDocumentIntakeResponse
Description
The outcome of asking for a re-read. Resolves once the request is accepted, NOT once the file has been re-read — poll the status for that.
Example
{"accepted": false, "attempt": 123}
RevokeConcessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
revocationReason - ConcessionRevocationReason
|
Example
{
"id": "4",
"revocationReason": "BETTER_LOAN_STRUCTURE"
}
RevokeConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
RoyaltiesIncome
Description
Royalties income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
RuleProvenance
Description
Provenance from an SGR-evaluated rule. The requirement exists because a computed rule determined it was needed.
Fields
| Field Name | Description |
|---|---|
description - String!
|
Human-readable explanation of the rule. |
evidence - [GuidelineReference!]!
|
Supporting evidence. |
ruleId - String!
|
Machine-readable identifier of the SGR rule that produced this requirement. |
Example
{
"description": "xyz789",
"evidence": [GuidelineReference],
"ruleId": "abc123"
}
RunLoanPreApprovalInput
Description
Input to the runLoanPreApproval mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
purpose - PreApprovalRunPurpose
|
Why this run happens. Omitted or null: RECALCULATION. |
Example
{"loanId": 4, "purpose": "APPLICATION_SUBMISSION"}
RunLoanPreApprovalResponse
Description
Response of the runLoanPreApproval mutation.
Fields
| Field Name | Description |
|---|---|
preApprovalRun - PreApprovalRun
|
|
userErrors - [UserError!]!
|
Example
{
"preApprovalRun": PreApprovalRun,
"userErrors": [UserError]
}
RunLoanScriptInput
Description
Input for replaying a stored loan-script scenario.
Fields
| Input Field | Description |
|---|---|
scenarioId - String!
|
The scenario_id of the stored loan-script spec to replay. |
Example
{"scenarioId": "xyz789"}
RunLoanScriptResponse
Description
The result of replaying a loan-script scenario.
Fields
| Field Name | Description |
|---|---|
assertions - [LoanScriptAssertionResult!]!
|
Outcomes of the script's assertions, evaluated after the last step. Empty when the script declares none. |
loan - Loan
|
The loan created by the scenario, if any. Null, with an error, when the caller cannot access it. |
loanId - ID
|
The id of the loan created by the scenario, if any. Use loan { id }.
|
steps - [LoanScriptStepResult!]!
|
The per-step results, in execution order. |
Example
{
"assertions": [LoanScriptAssertionResult],
"loan": Loan,
"loanId": 4,
"steps": [LoanScriptStepResult]
}
SatisfiedRequirement
Description
A requirement that has been satisfied by evidence or judgment.
Fields
| Field Name | Description |
|---|---|
borrowerIds - [ID!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. |
children - [Requirement!]!
|
Child requirements of a composite, each with its own phase, recursing through nested composites so a deep tree renders as a tree. Empty for leaf requirements. Unlike fulfillmentOptions, present in every phase — a satisfied or waived composite still lists its children here. |
description - String!
|
Human-readable label for this requirement, e.g. "W2 for Acme Corp (2025)". |
id - ID!
|
Node ID |
openedAt - DateTimeISO!
|
When this requirement (re)entered its current OPEN period. A removed and later restored requirement carries the restore time, not its original creation time. |
phase - RequirementPhase!
|
Current resolution phase. Redundant with __typename but useful for client-side filtering without fragment matching. |
provenance - [ProvenanceSource!]!
|
Why this requirement exists — rule evaluation, manual condition, or data dependency. |
recommendedAction - RequirementRecommendedAction!
|
The next action recommended for this requirement. Clients must use this field, never the human-readable description, to decide whether to offer a specialized action. |
relatedEntities - [Node!]!
|
Entities this requirement's params point at (borrower, employment, asset, asset transaction, property), resolvable as Nodes. Entities the caller cannot read, that no longer exist, or that belong to another loan are omitted. |
resolution - FulfillmentResolution!
|
How this requirement was resolved, with pinned evidence hydrated on demand. |
resolvedAt - DateTimeISO!
|
When this requirement was satisfied. |
stopgapCompletedSubrequirements - [Requirement!]!
|
Children of a satisfied composite requirement, each with its own phase and resolution. Empty for non-composite (leaf) requirements. Superseded by the recursive children field on every requirement. Retained temporarily for already-shipped clients and removed after one release.
|
Example
{
"borrowerIds": [4],
"borrowers": [Borrower],
"children": [Requirement],
"description": "xyz789",
"id": 4,
"openedAt": "2007-12-03T10:15:30Z",
"phase": "OPEN",
"provenance": [ProvenanceSource],
"recommendedAction": "ATTACH_LOAN_STRUCTURE",
"relatedEntities": [Node],
"resolution": FulfillmentResolution,
"resolvedAt": "2007-12-03T10:15:30Z",
"stopgapCompletedSubrequirements": [Requirement]
}
SavingsAccountAsset
Description
Savings account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "abc123",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
Scenario
Fields
| Field Name | Description |
|---|---|
fixedLoanAmountPurchasePricing - ProductPricingQuery!
|
|
Arguments
|
|
pricing - ProductPricingQuery!
|
|
Arguments
|
|
purchasePricing - ProductPricingQuery!
|
|
Arguments
|
|
purchasePricingNoRestructure - ProductPricingQuery!
|
|
Arguments |
|
refinancePricing - ProductPricingQuery!
|
|
Arguments
|
|
Example
{
"fixedLoanAmountPurchasePricing": ProductPricingQuery,
"pricing": ProductPricingQuery,
"purchasePricing": ProductPricingQuery,
"purchasePricingNoRestructure": ProductPricingQuery,
"refinancePricing": ProductPricingQuery
}
SeedAusRunInput
SeedAusRunResponse
SeedCancelledKind
Description
Which of the three genuinely distinct ways an operator's cancel request stopped a seed run: SETTLING (nothing had been written or resolved), RESOLVING (clustering/matching finished — a co-borrower may already be minted — but no field was written) or READING (some resolved people's documents were already read and applied before the stop).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"READING"
SeedCoBorrowerCreationInput
Description
Create a new co-borrower on the loan for the decision's document and assign the document to them.
Fields
| Input Field | Description |
|---|---|
name - DocumentSeedingCoBorrowerNameInput
|
The co-borrower's name. Omitted: the name read from the document is used, and the request is refused when the document yielded no usable name. |
Example
{"name": DocumentSeedingCoBorrowerNameInput}
SeedFromDocumentsInput
Description
Ask for a fresh application to be seeded from its uploads.
Fields
| Input Field | Description |
|---|---|
loanApplicationId - ID!
|
The loan whose uploaded documents to seed from. Must be effectively unfilled: nobody beyond the point-of-contact stub, and no prior seed. |
Example
{"loanApplicationId": 4}
SeedFromDocumentsResponse
Description
The outcome of asking for a seed. Resolves once the seed has been STARTED, not once it has finished — poll seedOutcome for that. A loan that is not seed-eligible is refused through userErrors, never by silently accepting.
Fields
| Field Name | Description |
|---|---|
userErrors - [GenericUserError!]!
|
What made the loan ineligible to seed (already filled, already seeded, nothing uploaded). Empty when the seed started. |
workflowId - String
|
The started seed run's id. Null exactly when userErrors is non-empty. |
Example
{
"userErrors": [GenericUserError],
"workflowId": "xyz789"
}
SeedLoanFromDocumentsInput
Description
Ask for a loan to be seeded from an explicit set of its uploaded documents.
Fields
| Input Field | Description |
|---|---|
documentIds - [ID!]!
|
The uploaded documents to read — root files only, never discovered server-side. A call arriving while a prior seeding is still running on this loan cancels it (ending it CANCELLED) and starts fresh; there is no once-per-loan limit and no 'already filled' refusal — a value already on the application is held rather than overwritten, on every field, every run. |
loanId - ID
|
The ID or friendly ID of the loan. Provide this or the deprecated loanApplicationId, not both. The loan to seed. |
Example
{"documentIds": [4], "loanId": "4"}
SeedLoanFromDocumentsResponse
Description
The outcome of asking for a seeding. Resolves once the run has STARTED, not once it has finished — poll documentIntake.seeding for that.
Fields
| Field Name | Description |
|---|---|
seeding - DocumentSeeding
|
The started run, PENDING. Null exactly when userErrors is non-empty. |
userErrors - [GenericUserError!]!
|
Empty when the run started. Populated in exactly two cases, each before any run or row exists: SEED_NO_DOCUMENTS when none of the given documentIds resolve to this loan's own uploads; SEED_PACKET_NOT_ON_SEED_LANE when none of those that do was read in a form this import can use. |
Example
{
"seeding": DocumentSeeding,
"userErrors": [GenericUserError]
}
SeedOutcomeInput
Description
Scope for a seed outcome read.
Fields
| Input Field | Description |
|---|---|
loanApplicationId - ID!
|
The loan whose seed outcome to report. |
Example
{"loanApplicationId": 4}
SeedOutcomeResponse
Description
What one loan's seed did — counts of field KEYS and a typed refusal, NEVER field values. This surface is deliberately narrow and must not grow into an audit trail: what landed where, with which citations, is the write-receipt record's to answer, not a polling endpoint's.
Fields
| Field Name | Description |
|---|---|
appliedCount - Int!
|
Fields written onto the application, counted across every seeded borrower. Zero until the seed settles. |
coBorrowerCreated - Boolean!
|
Whether the seed minted at least one co-borrower for a second person the documents named. |
contestedCount - Int!
|
Distinct fields the documents contradicted each other about, left for a person to settle. |
contestedPersonCount - Int!
|
People the packet named who read too much like an existing borrower to mint and not enough to match — left for a person to settle. Their documents are attached but joined to nobody. |
heldCount - Int!
|
Fields held by a loan freeze, counted across borrowers. |
preexistingCount - Int!
|
Fields already holding somebody's typed value, held rather than overwritten — typed values always win. |
refusal - String
|
The typed refusal code (e.g. SEED_NO_NAMED_DOCUMENTS). Null unless status is REFUSED. |
status - SeedOutcomeStatus!
|
Where the seed has got to. |
unattributedDocumentCount - Int!
|
Documents naming nobody the run could compare — a nameless paystub, a name outside the comparable alphabet. Attached to the loan, joined to no borrower; somebody should file them by hand. |
withheldCount - Int!
|
Distinct fields read and deliberately not written — income, today. |
Example
{
"appliedCount": 987,
"coBorrowerCreated": true,
"contestedCount": 987,
"contestedPersonCount": 123,
"heldCount": 123,
"preexistingCount": 123,
"refusal": "xyz789",
"status": "FAILED",
"unattributedDocumentCount": 987,
"withheldCount": 123
}
SeedOutcomeStatus
Description
Where one loan's seed-from-documents run has got to. Unknown members should be read as PROCESSING.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FAILED"
SeedPersonAssignmentInput
Description
Assign the decision's document to a borrower already on the loan.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
A borrower on the decision's own loan. A borrower on any other loan is refused as SEED_DECISION_INPUT_INVALID. |
keepName - DocumentSeedingNameChoice!
|
Example
{"borrowerId": 4, "keepName": "APPLICATION"}
SeedPersonIgnoreAction
Description
Leave the decision's document unassigned. It is not read into any borrower.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"IGNORE"
SeedPersonResolutionInput
Description
Exactly one way to settle a person decision: assign its document to an existing borrower, create a co-borrower for it, or ignore it.
Fields
| Input Field | Description |
|---|---|
assign - SeedPersonAssignmentInput
|
|
createCoBorrower - SeedCoBorrowerCreationInput
|
|
ignore - SeedPersonIgnoreAction
|
Example
{
"assign": SeedPersonAssignmentInput,
"createCoBorrower": SeedCoBorrowerCreationInput,
"ignore": "IGNORE"
}
SeedProcessingPhase
Description
Where a RUNNING seed run has got to: SETTLING (waiting on extraction), RESOLVING (clustering people), READING (writing field values) or PERSISTING (landing the outcome record).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PERSISTING"
SeedProcessingProgress
Description
Live progress for a seed run still RUNNING. A field reading null simply has not happened yet in this run.
Fields
| Field Name | Description |
|---|---|
borrowersCreated - Int
|
Co-borrowers minted so far this run. Null while phase is SETTLING or RESOLVING, for the same reason as resolvedPersonCount. |
lastCheckedAt - DateTime
|
When the run last checked on its uploads. A run whose lastCheckedAt stops advancing has stopped polling; a slow one keeps checking. |
lastProgressAt - DateTime
|
When one of the uploads last moved through the pipeline (its intake record last changed). Null until an upload has an intake record. |
phase - SeedProcessingPhase!
|
Where this run has got to. |
resolvedPersonCount - Int
|
People the packet has been resolved into so far. Null while phase is SETTLING or RESOLVING — resolution has not finished, so there is nothing yet to report. |
settleStage - SeedSettleStage
|
Where the uploads are in the pipeline, as of lastCheckedAt. Null until the run's first settlement check has reported. |
settledDocumentCount - Int!
|
Uploaded documents whose extraction has settled so far. |
totalDocumentCount - Int!
|
Uploaded documents this run is waiting on in total. |
Example
{
"borrowersCreated": 987,
"lastCheckedAt": "2007-12-03T10:15:30Z",
"lastProgressAt": "2007-12-03T10:15:30Z",
"phase": "PERSISTING",
"resolvedPersonCount": 123,
"settleStage": "READING",
"settledDocumentCount": 123,
"totalDocumentCount": 987
}
SeedSettleStage
Description
Where the uploads of a SETTLING run are: WAITING_FOR_SLOT (queued behind other packets, nothing read yet), READING (being parsed, classified and extracted) or SETTLED (every upload's extraction is over).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"READING"
SeedTypingDecision
Description
Seed-from-documents read this document as a kind but left its loan-system document type (the type the loan's document list shows, such as YTD Paystubs) as it found it. The kind it read is suggestedKind; for an unsplit file that is normally the same value as documentKind, since both come from the classifier. A suggestion for a reviewer: confirming it means giving the document the loan-system type for that kind (where the loan system has none, reason NO_TYPE_FOR_KIND, there is none to give). It stands only while the document keeps the loan-system type the seed found: once the document is given another type or deleted by any path, or a person re-types the seed's reading of it, the suggestion is gone and no later seed pass brings it back; an untyped document echoed back by the loan system as Uncategorized keeps it.
Fields
| Field Name | Description |
|---|---|
decidedAt - DateTime!
|
The seed worker's clock: when the seed first made this decision. |
id - ID!
|
The decision's id, which is the id of the filed document it is about (one decision per document): the packet itself, or the section of a split packet the seed read. A confirmation gives this document its loan-system type. |
reason - SeedTypingDeclinedReason!
|
Why the seed left the type alone; a closed set to branch on. |
suggestedKind - DocumentKind!
|
The kind the seed read the document as, in documentKind's vocabulary, and for an unsplit file normally documentKind's own value. Not a loan-system document type: confirming it means giving the document the loan-system type this kind maps to. |
Example
{
"decidedAt": "2007-12-03T10:15:30Z",
"id": 4,
"reason": "CARRIES_OTHER_ENTITIES",
"suggestedKind": "BANK_STATEMENT"
}
SeedTypingDeclinedReason
Description
Why seed-from-documents left a filed document as it found it instead of giving it the type it read. TYPED_BY_A_PERSON: the document already carries a type the seed did not set, and a person's choice stands. CARRIES_OTHER_ENTITIES: the document is linked to entities beyond its task's own, which retyping it would orphan. LOAN_SYSTEM_CANNOT_RETYPE_IN_PLACE: a document review owns the document's type, and the loan system can only fork a reviewed document into a second one rather than retype it. REVIEW_STATE_UNREADABLE: whether a review owns the document could not be read, so the seed left it to be safe. NO_BORROWER_TO_OWN_IT: the seed could not attribute the document to a borrower on the loan, and a typed document is filed under its owner, so a person has to type it. NO_TYPE_FOR_KIND: the loan system has no document type for the kind the seed read, so the document was filed without one.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARRIES_OTHER_ENTITIES"
SeedValueDiscardAction
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DISCARD"
SeedValueKeepCurrentAction
Values
| Enum Value | Description |
|---|---|
|
|
Example
"KEEP_CURRENT"
SeedValueResolutionInput
Description
Use the decision's document value, keep the current value, or discard the decision.
Fields
| Input Field | Description |
|---|---|
discard - SeedValueDiscardAction
|
|
keepCurrent - SeedValueKeepCurrentAction
|
|
useDocumentValue - SeedValueUseDocumentValueAction
|
Example
{
"discard": "DISCARD",
"keepCurrent": "KEEP_CURRENT",
"useDocumentValue": "USE_DOCUMENT_VALUE"
}
SeedValueUseDocumentValueAction
Values
| Enum Value | Description |
|---|---|
|
|
Example
"USE_DOCUMENT_VALUE"
SeedWireOutWorksheetCaseInput
SeedWireOutWorksheetCaseResponse
Description
The result of seeding a synthetic wire-out worksheet case.
Fields
| Field Name | Description |
|---|---|
expectedWireOutAmount - MonetaryAmount!
|
The authoritative wire-out amount expected from the API. |
loan - Loan!
|
The populated development loan. |
loanId - ID!
|
The populated development loan. Use loan { id }.
|
sourceRow - Int!
|
The reproduced worksheet row. |
Example
{
"expectedWireOutAmount": MonetaryAmount,
"loan": Loan,
"loanId": 4,
"sourceRow": 987
}
SelfEmployment
Description
Self employment
Fields
| Field Name | Description |
|---|---|
business - BorrowerBusiness
|
The associated business |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. Will be null if the employment is current. |
id - ID!
|
Employment ID |
isCurrentEmployment - Boolean!
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
Example
{
"business": BorrowerBusiness,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": "4",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"position": "abc123",
"startDate": "2007-12-03"
}
SelfEmploymentBusinessInput
Description
Self employment business input
Fields
| Input Field | Description |
|---|---|
address - AddressInput!
|
Address |
name - String!
|
Name |
percentOwnership - NonNegativeFloat!
|
Percent of the business that the borrower owns. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"address": AddressInput,
"name": "xyz789",
"percentOwnership": 123.45
}
SelfEmploymentIncome
Description
Self-employment income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - SelfEmployment!
|
The associated employment |
externalId - OpaqueToken
|
The employment identifier assigned by the income verification provider. |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": SelfEmployment,
"externalId": OpaqueToken,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
SelfEmploymentLossIncome
Description
Self employment loss. Amounts are the magnitude of the loss and reduce qualifying income.
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment
|
The self-employment this loss is associated with |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": Employment,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
SendBorrowerEmailVerificationCodeInput
SendBorrowerEmailVerificationCodeResponse
Description
Response of the sendEmailVerificationCode mutation.
Fields
| Field Name | Description |
|---|---|
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the sendEmailVerificationCode mutation. |
Example
{"userErrors": [UserError]}
SendBorrowerPortalInviteInput
SendBorrowerPortalInviteResponse
Description
Response of the send borrower portal invite mutation.
Fields
| Field Name | Description |
|---|---|
expiresAt - String!
|
ISO-8601 instant after which the invite's claim link can no longer be redeemed |
Example
{"expiresAt": "abc123"}
SendMessageInput
SendMessageResponse
Fields
| Field Name | Description |
|---|---|
advisorCompletionJob - AdvisorCompletionJob!
|
Example
{"advisorCompletionJob": AdvisorCompletionJob}
SendOrganizationUserInvitationEmailInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "xyz789"}
SendOrganizationUserInvitationEmailResponse
Fields
| Field Name | Description |
|---|---|
userErrors - [GenericUserError!]!
|
Example
{"userErrors": [GenericUserError]}
SendWebhookTestDeliveryInput
Description
Sends a signed test event to the callback URL events are delivered to, or to the pending callback URL when one is set, using a pending signing key or the active key. Its body is the envelope every delivery uses, and its data.challenge is a one-time token (64 lowercase hex characters); the endpoint must answer 2xx within 10 seconds with a JSON body { "challenge": "<hex HMAC-SHA256 of "challenge." + the token under the key's secret>" }. The challenge. prefix keeps the answer from ever being a delivery signature; answer only a token of that shape. Echoing the token proves nothing.
Fields
| Input Field | Description |
|---|---|
signingKeyId - ID!
|
The signing key to test: a pending key, to earn its promotion, or the active key, to verify a changed callback URL or re-check the current one. |
Example
{"signingKeyId": 4}
SendWebhookTestDeliveryResponse
Description
The result of a webhook test delivery.
Fields
| Field Name | Description |
|---|---|
httpStatus - Int
|
The HTTP status your endpoint answered with, when it did. |
outcome - WebhookTestOutcome!
|
How the test ended. Only DELIVERED records the key as tested. |
signingKey - WebhookSigningKey
|
The signing key after the test; testedAt is set when the test succeeded. Null when the request was refused. |
userErrors - [UserError!]!
|
Why the test did not succeed, if it did not. Empty on success. Codes: WEBHOOK_KEY_NOT_PENDING, WEBHOOK_KEY_EXPIRED, WEBHOOK_TEST_DELIVERY_FAILED, WEBHOOK_TEST_DELIVERY_INCOMPLETE. |
Example
{
"httpStatus": 123,
"outcome": "CHALLENGE_NOT_ANSWERED",
"signingKey": WebhookSigningKey,
"userErrors": [UserError]
}
SeparateMaintenanceIncome
Description
Separate maintenance income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
SetBorrowerEmailVerifiedInput
Fields
| Input Field | Description |
|---|---|
emailVerified - Boolean!
|
Email verified. Default = true |
id - ID!
|
ID of the borrower to update |
verificationCode - String
|
A code from the verification email. When given, the email address is marked verified only if the code matches, and emailVerified must be true. A borrower or contributor session must give it. |
Example
{
"emailVerified": false,
"id": "4",
"verificationCode": "xyz789"
}
SetBorrowerEmailVerifiedResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the borrower that was updated |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the setEmailVerified mutation. |
Example
{"id": 4, "userErrors": [UserError]}
SetDefaultPrimaryLoanContactInput
Description
Sets the organization's default primary loan contact — the loan officer rendered on preapproval letters. Either select an existing loan contact by loanContactId, or omit it to create a new contact from the detail fields (firstName and lastName are then required).
Fields
| Input Field | Description |
|---|---|
email - String
|
E-mail address. |
firstName - String
|
First name of the new contact. Required when creating. |
lastName - String
|
Last name of the new contact. Required when creating. |
loanContactId - ID
|
Select an existing loan contact to make the default primary contact. When set, the detail fields below are ignored. When omitted, a new loan contact is created from those fields. |
middleName - String
|
Middle name. |
nmlsId - String
|
NMLS ID. |
phoneNumber - String
|
Phone number. |
title - String
|
Title or position shown on the preapproval letter. |
Example
{
"email": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"loanContactId": 4,
"middleName": "xyz789",
"nmlsId": "xyz789",
"phoneNumber": "abc123",
"title": "abc123"
}
SetDefaultPrimaryLoanContactResponse
Fields
| Field Name | Description |
|---|---|
defaultPrimaryLoanContact - LoanContact!
|
The organization's default primary loan contact after the update. |
Example
{"defaultPrimaryLoanContact": LoanContact}
SetExclusionReasonInput
Description
Update a Liability. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
exclusionReason - LiabilityExclusionReason
|
The reason why the liability is excluded |
id - ID!
|
Liability ID |
Example
{
"exclusionReason": "ASSIGNED_TO_ANOTHER_PARTY",
"id": "4"
}
SetExclusionReasonResponse
Description
Response of the setExclusionReason mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
SetIntentInput
Description
Update a Liability. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Liability ID |
intent - LiabilityIntent
|
The intent regarding liability |
Example
{"id": 4, "intent": "DO_NOTHING"}
SetIntentResponse
Description
Response of the setIntent mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability!
|
The updated Liability |
Example
{"liability": Liability}
SetLoanOfficerSlugInput
SetLoanOfficerSlugResponse
Description
Response of the setLoanOfficerSlug mutation
Fields
| Field Name | Description |
|---|---|
globalLoanOfficer - GlobalLoanOfficer!
|
The updated GlobalLoanOfficer. |
Example
{"globalLoanOfficer": GlobalLoanOfficer}
SetLoanOfficerStatusInput
Description
Input to the setLoanOfficerStatus mutation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the GlobalLoanOfficer to update |
status - LoanOfficerStatus!
|
The status to set. Setting the status the loan officer already has changes nothing. |
Example
{"id": 4, "status": "ACTIVE"}
SetLoanOfficerStatusResponse
Description
Response of the setLoanOfficerStatus mutation
Fields
| Field Name | Description |
|---|---|
globalLoanOfficer - GlobalLoanOfficer
|
The GlobalLoanOfficer after the change. Null exactly when userErrors is not empty. |
userErrors - [UserError!]!
|
Why the change was not made, when the caller can act on it. Empty when it was made. A loan officer not in the organization is reported as an error, not here. |
Example
{
"globalLoanOfficer": GlobalLoanOfficer,
"userErrors": [UserError]
}
SetOrganizationAccountStatusInput
Fields
| Input Field | Description |
|---|---|
status - CustomerAccountStatus!
|
The account status to set for the current organization. |
Example
{"status": "ACTIVE"}
SetOrganizationAccountStatusResponse
Fields
| Field Name | Description |
|---|---|
accountStatus - CustomerAccountStatus!
|
The organization's account status after the change. |
accountStatusChange - OrganizationAccountStatusChange!
|
Example
{
"accountStatus": "ACTIVE",
"accountStatusChange": OrganizationAccountStatusChange
}
SetOrganizationApiAccessStatusInput
Fields
| Input Field | Description |
|---|---|
status - CustomerApiAccessStatus!
|
The API access status to set for the current organization. |
Example
{"status": "ACTIVE"}
SetOrganizationApiAccessStatusResponse
Fields
| Field Name | Description |
|---|---|
apiAccessStatus - CustomerApiAccessStatus!
|
The organization's API access status after the change. |
Example
{"apiAccessStatus": "ACTIVE"}
SetOrganizationLegalEntityGroupInput
Fields
| Input Field | Description |
|---|---|
legalEntityGroup - String
|
The legal entity to put the current organization in, shared by every organization of that entity; null puts it in none. |
Example
{"legalEntityGroup": "xyz789"}
SetOrganizationLegalEntityGroupResponse
Fields
| Field Name | Description |
|---|---|
legalEntityGroup - String
|
The organization's legal entity after the request. |
userErrors - [UserError!]!
|
Example
{
"legalEntityGroup": "xyz789",
"userErrors": [UserError]
}
SetOrganizationMultiInstanceLoanOfficersInput
Fields
| Input Field | Description |
|---|---|
setting - MultiInstanceLoanOfficers!
|
The multi-instance loan officers setting for the current organization. |
Example
{"setting": "OFF"}
SetOrganizationMultiInstanceLoanOfficersResponse
Fields
| Field Name | Description |
|---|---|
conflicts - [MultiInstanceLoanOfficerConflict!]!
|
Who blocked turning the setting ON; empty otherwise. |
multiInstanceLoanOfficers - MultiInstanceLoanOfficers!
|
The organization's setting after the request. |
multiInstanceLoanOfficersChange - OrganizationSettingChange
|
|
userErrors - [UserError!]!
|
Example
{
"conflicts": [MultiInstanceLoanOfficerConflict],
"multiInstanceLoanOfficers": "OFF",
"multiInstanceLoanOfficersChange": OrganizationSettingChange,
"userErrors": [UserError]
}
SetProductDeliveryCommitmentsInput
Fields
| Input Field | Description |
|---|---|
deliveryCommitmentType - DeliveryCommitmentType!
|
|
effectiveFrom - DateTime
|
Backdates a product's first classification so locks taken before today resolve under it. Must not be in the future. Refused once the product has any period, except a repeat of the first classification's own type and date, which changes nothing; later changes take effect now. Omit for now. |
product - PreapprovalProduct!
|
Example
{
"deliveryCommitmentType": "BEST_EFFORTS",
"effectiveFrom": "2007-12-03T10:15:30Z",
"product": "BayviewBayviewJumboAus"
}
SetProductDeliveryCommitmentsResponse
Fields
| Field Name | Description |
|---|---|
changed - Boolean!
|
False when the product already had this delivery commitment, or the change was refused; nothing was written. |
productDeliveryCommitment - ProductDeliveryCommitment
|
The product after the change. Null when the change was refused. |
userErrors - [UserError!]!
|
Example
{
"changed": false,
"productDeliveryCommitment": ProductDeliveryCommitment,
"userErrors": [UserError]
}
SetProductRelockPoliciesInput
Example
{"netPriceCap": 123.45, "productId": "4"}
SetProductRelockPoliciesResponse
Fields
| Field Name | Description |
|---|---|
changed - Boolean!
|
False when the product already had this cap, or the change was refused; nothing was written. |
productRelockPolicy - ProductRelockPolicy
|
The product after the change. Null when it was refused. |
userErrors - [UserError!]!
|
Example
{
"changed": true,
"productRelockPolicy": ProductRelockPolicy,
"userErrors": [UserError]
}
SetRelockFeePolicyInput
Fields
| Input Field | Description |
|---|---|
capture - Float!
|
Share of a market improvement the borrower keeps on a relock, from 0 (the whole worst-case difference applies) to 1 (none of it applies). |
feeTotalPercent - NonNegativeFloat!
|
The relock fee as a percentage of the loan amount (the same unit as points), as a closing cost's feeTotalPercent; 0 or more. A relocked structure's totalPoints includes it. The same fee applies to an investor change on a live lock. |
relockWindowDays - Int!
|
Calendar days after a lock ends during which a new lock is priced at worst case; 1 or more. |
Example
{"capture": 123.45, "feeTotalPercent": 123.45, "relockWindowDays": 123}
SetRelockFeePolicyResponse
Fields
| Field Name | Description |
|---|---|
relockFeePolicy - RelockFeePolicy
|
The policy this save opened, in force now. Null when the save was refused; nothing was written. |
userErrors - [UserError!]!
|
Example
{
"relockFeePolicy": RelockFeePolicy,
"userErrors": [UserError]
}
SetSubjectPropertyFirstLienInput
SetSubjectPropertyFirstLienResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
Updated subject property |
Example
{"subjectProperty": SubjectProperty}
SetUnderwritingCostRecoveryInput
Fields
| Input Field | Description |
|---|---|
dollars - PositiveInt!
|
Whole-dollar amount to recover through mode, e.g. 1250. The other mechanism is set to $0 at the same instant. |
mode - UnderwritingCostRecoveryMode!
|
Example
{"dollars": 123, "mode": "FEE"}
SetUnderwritingCostRecoveryResponse
Fields
| Field Name | Description |
|---|---|
underwritingCostRecovery - UnderwritingCostRecovery!
|
Example
{"underwritingCostRecovery": UnderwritingCostRecovery}
SetUnderwritingGateThresholdsInput
Fields
| Input Field | Description |
|---|---|
initialSubmissionPercent - PositiveInt
|
Whole percentage of applicable tasks, 1 to 100, required for a first submission. Null returns the organization to Pylon's default. |
resubmissionPercent - PositiveInt
|
Whole percentage of applicable tasks, 1 to 100, required for a resubmission. Null returns the organization to Pylon's default. |
thresholdState - UnderwritingGateThresholdState
|
Whether the thresholds apply. OFF turns them off for the organization; null reads as ENFORCED. |
Example
{
"initialSubmissionPercent": 123,
"resubmissionPercent": 123,
"thresholdState": "ENFORCED"
}
SetUnderwritingGateThresholdsResponse
Fields
| Field Name | Description |
|---|---|
underwritingGateThresholds - UnderwritingGateThresholds!
|
Example
{"underwritingGateThresholds": UnderwritingGateThresholds}
SetUseOwnTitleCompanyInput
SetUseOwnTitleCompanyResponse
Description
Response of the setUseOwnTitleCompany mutation.
Example
{
"loan": Loan,
"loanId": "4",
"useOwnTitleCompany": true
}
Sex
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FEMALE"
SocialSecurityIncome
Description
Social Security income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
SortDirection
Description
The direction in which to sort a collection of items (ascending or descending).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
StandardEmployment
Description
Standard employment
Fields
| Field Name | Description |
|---|---|
borrowerHasSpecialRelationshipWithEmployer - Boolean!
|
When true, indicates that the borrower has a special relationship with the employer, such as familial ties |
employer - Employer!
|
The borrower's employer |
employerRelationship - EmployerRelationship
|
The borrower's stated relationship with the employer; null when unanswered. |
employmentClassification - EmploymentClassificationType!
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. Will be null if the employment is current. |
id - ID!
|
Node ID |
incomePayType - IncomePayType
|
The type of pay (hourly or salaried) |
isCurrentEmployment - Boolean!
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
position - String
|
A name or description of the employment position or job title |
reportedEmployer - Employer
|
The recorded employer, or null when no employer record is available |
startDate - Date
|
Start date |
Example
{
"borrowerHasSpecialRelationshipWithEmployer": false,
"employer": Employer,
"employerRelationship": "NO_SPECIAL_RELATIONSHIP",
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"id": 4,
"incomePayType": "HOURLY",
"isCurrentEmployment": true,
"numberOfMonthsInLineOfWork": 123,
"position": "xyz789",
"reportedEmployer": Employer,
"startDate": "2007-12-03"
}
StandardEmploymentIncome
Description
Standard employment income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - StandardEmployment!
|
The associated employment |
externalId - OpaqueToken
|
The employment identifier assigned by the income verification provider. |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": StandardEmployment,
"externalId": OpaqueToken,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
StartAnalyticsExportJobInput
Fields
| Input Field | Description |
|---|---|
format - AnalyticsExportFormat!
|
|
root - AnalyticsExportRoot!
|
Example
{"format": "CSV", "root": "LOAN_APPLICATIONS"}
StartAnalyticsExportJobResponse
Fields
| Field Name | Description |
|---|---|
job - AnalyticsExportJob!
|
Example
{"job": AnalyticsExportJob}
StartBulkLoanDocumentsExportInput
Description
Input to the startBulkLoanDocumentsExport mutation.
Example
{"documentIds": [4], "includeDisclosurePackages": false, "loanId": 4}
StartBulkLoanDocumentsExportResponse
Description
Response of the startBulkLoanDocumentsExport mutation.
Fields
| Field Name | Description |
|---|---|
job - BulkLoanDocumentsExportJob!
|
The created bulk loan documents export job. |
Example
{"job": BulkLoanDocumentsExportJob}
StartIndividualCreditPullJobInput
Description
Input to start a hard credit pull job for an individual
Fields
| Input Field | Description |
|---|---|
borrower - CreditPullBorrowerInput!
|
Credit pull borrower |
creditReportId - String
|
Vendor case number of an existing credit report to import. When set, the job retrieves that report instead of placing a new credit order. |
pullType - CreditPullType
|
Type of credit to pull (soft or hard) |
Example
{
"borrower": CreditPullBorrowerInput,
"creditReportId": "xyz789",
"pullType": "HARD"
}
StartIndividualCreditPullJobResponse
Description
Response of the startIndividualHardCreditPullJob mutation
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job |
userErrors - [String!]
|
User errors preventing credit pull |
Example
{
"job": CreditPullJob,
"userErrors": ["xyz789"]
}
StartJointCreditPullJobInput
Description
Input to start a joint hard credit pull job for two co-borrowers on the same loan application
Fields
| Input Field | Description |
|---|---|
borrower1 - CreditPullBorrowerInput!
|
The first of two borrowers to be included in the joint credit report. Must be on the same loan application as borrower2. |
borrower2 - CreditPullBorrowerInput!
|
The second of two borrowers to be included in the joint credit report. Must be on the same loan application as borrower1. |
creditReportId - String
|
Vendor case number of an existing credit report to import. When set, the job retrieves that report instead of placing a new credit order. |
pullType - CreditPullType
|
Type of credit to pull (soft or hard) |
Example
{
"borrower1": CreditPullBorrowerInput,
"borrower2": CreditPullBorrowerInput,
"creditReportId": "abc123",
"pullType": "HARD"
}
StartJointCreditPullJobResponse
Description
Response of the startJointHardCreditPullJob mutation
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job |
userErrors - [String!]
|
User errors preventing credit pull |
Example
{
"job": CreditPullJob,
"userErrors": ["xyz789"]
}
StartLpaKnownRulesBackfillInput
Fields
| Input Field | Description |
|---|---|
afterAusRunId - ID
|
Cursor returned by the previous backfill execution. |
latestPerLoanSince - DateTime
|
When set, backfill only each loan's latest successful run, among runs created at or after this time. |
maxRuns - PositiveInt!
|
Maximum number of historical AUS runs to process. |
runsPerHour - PositiveInt
|
Ceiling on the average number of AUS runs cataloged per hour, from 100 to 3600. Unset uses the workflow's default pace. A running backfill keeps the pace it started with; starting it again with a different pace is refused. |
system - AusSystem
|
The AUS engine whose runs are backfilled. Unset means LPA. |
Example
{
"afterAusRunId": "4",
"latestPerLoanSince": "2007-12-03T10:15:30Z",
"maxRuns": 123,
"runsPerHour": 123,
"system": "DESKTOP_ORIGINATOR"
}
StartLpaKnownRulesBackfillResponse
Fields
| Field Name | Description |
|---|---|
workflowId - String!
|
Example
{"workflowId": "abc123"}
StateAbbreviated
Description
US state in two-letter abbreviated format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AK"
StateCodeComparator
StateLicense
StateLicenseInput
StatusLpaKnownRulesBackfillInput
Fields
| Input Field | Description |
|---|---|
workflowId - ID!
|
Example
{"workflowId": 4}
StatusLpaKnownRulesBackfillResponse
Fields
| Field Name | Description |
|---|---|
hasMore - Boolean
|
|
nextCursor - ID
|
|
status - String!
|
|
totalCataloged - NonNegativeInt
|
|
totalErrors - NonNegativeInt
|
|
totalProcessed - NonNegativeInt
|
|
totalSkipped - NonNegativeInt
|
|
workflowId - ID!
|
Example
{
"hasMore": false,
"nextCursor": "4",
"status": "xyz789",
"totalCataloged": 123,
"totalErrors": 123,
"totalProcessed": 123,
"totalSkipped": 123,
"workflowId": "4"
}
StockAsset
Description
Stock asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": 4,
"borrowerIds": [4],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "xyz789",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
StockOptionsAsset
Description
Stock options asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": 4,
"institutionLogoUrl": "abc123",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"verifiedAmount": 123
}
StrawBuyerFraudConditionBlocker
Description
Straw buyer fraud condition detected
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "xyz789"}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StructureRepricing
Description
How a structure of a locked loan was priced. Switch on __typename for the rate sheets that priced it.
Fields
| Field Name | Description |
|---|---|
worstCaseAdjustmentPoints - Float!
|
The points that worst-case pricing adds to this rate's price; 0 when none. Already included in totalPoints and ratePoints. |
Possible Types
| StructureRepricing Types |
|---|
Example
{"worstCaseAdjustmentPoints": 987.65}
StructuringError
Fields
| Field Name | Description |
|---|---|
loanTermYears - PositiveInt!
|
The term length of the loan, in years |
lock - PositiveInt!
|
The number of days this rate can be locked for. |
product - Product!
|
The product to which these calculations apply. |
publishedAt - DateTimeISO!
|
The date and time that rates for this product were published. |
publishedOn - Date!
|
The date that rates for this product were published. Use publishedAt for full timestamp precision. |
rate - Float!
|
The interest rate as a percentage. |
rateId - ID!
|
The ID of the rate. |
unsatisfiabilityDetails - [ProductStructureUnsatisfiabilityDetails!]!
|
Example
{
"loanTermYears": 123,
"lock": 123,
"product": Product,
"publishedAt": "2007-12-03T10:15:30Z",
"publishedOn": "2007-12-03",
"rate": 987.65,
"rateId": 4,
"unsatisfiabilityDetails": [GuidelineViolation]
}
StructuringResult
Types
| Union Types |
|---|
Example
EligibleProductStructure
SubjectProperty
Fields
| Field Name | Description |
|---|---|
address - Address
|
US Address |
attachmentType - AttachmentEnum
|
Whether the property is physically attached to neighboring units |
avmEstimatedValue - NonNegativeInt
|
The model estimated value of the property |
avmProvider - String
|
The model that provided estimated value of the property |
borrowerSpecifiedMonthlyPropertyTaxes - NonNegativeInt
|
The borrower-specified monthly property taxes |
firstLienAmount - NonNegativeInt
|
The remaining balance on the first lien of the property |
firstLienLiability - Liability
|
The first lien on the property |
firstLienLiabilityId - ID
|
The ID of the first lien on the property Use firstLienLiability { id }.
|
hoaDues - NonNegativeInt
|
The monthly HOA dues of the property |
homeInsuranceMonthlyAmount - NonNegativeInt
|
The monthly home insurance premium associated with this property |
homeInsuranceMonthlyAmountEstimate - PositiveFloat
|
Pylon's own estimate of the monthly home insurance premium, derived from the purchase price on a purchase and the estimated value on a refinance. This is what Pylon prices and discloses against when homeInsuranceMonthlyAmount is null. Null when there is no value to derive it from. |
id - ID!
|
Node ID |
isManufacturedHome - Boolean
|
Marks a subject property as a manufactured home |
isMixedUse - Boolean
|
Marks a subject property as having a mixed-use character |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
liabilities - [Liability!]!
|
The liabilities associated with the subject property |
manuallyEstimatedValue - NonNegativeInt
|
The manually estimated value of the property |
monthlyPropertyTaxesEstimate - Float
|
Pylon's own estimate of the monthly property taxes: the estimate service's figure for the property when it has one, else a default rate on the purchase price (purchase) or estimated value (refinance). This is what Pylon prices and discloses against when borrowerSpecifiedMonthlyPropertyTaxes is null. Null when there is neither a figure nor a value to derive it from. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of property |
numberOfUnits - NonNegativeInt
|
The number of dwelling units on the property |
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Is Property taxes and insurance included in payment |
rentalEstimatedGrossMonthlyRentAmount - NonNegativeInt
|
The estimated gross monthly rent amount (for investment properties) |
rentalIncomeAmounts - IncomeAmounts
|
The property's recorded rental income amounts, retaining cents and negative values. |
rentalStatus - RentalStatus
|
Whether the property is leased, rented short term, or vacant |
subjectPropertyIntent - SubjectPropertyIntent!
|
Example
{
"address": Address,
"attachmentType": "ATTACHED",
"avmEstimatedValue": 123,
"avmProvider": "abc123",
"borrowerSpecifiedMonthlyPropertyTaxes": 123,
"firstLienAmount": 123,
"firstLienLiability": Liability,
"firstLienLiabilityId": 4,
"hoaDues": 123,
"homeInsuranceMonthlyAmount": 123,
"homeInsuranceMonthlyAmountEstimate": 123.45,
"id": 4,
"isManufacturedHome": false,
"isMixedUse": true,
"isPlannedUnitDevelopment": true,
"liabilities": [Liability],
"manuallyEstimatedValue": 123,
"monthlyPropertyTaxesEstimate": 123.45,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"propertyTaxesAndInsuranceIncludedInPayment": false,
"rentalEstimatedGrossMonthlyRentAmount": 123,
"rentalIncomeAmounts": IncomeAmounts,
"rentalStatus": "LEASED",
"subjectPropertyIntent": SubjectPropertyIntent
}
SubjectPropertyIntent
Description
SubjectPropertyIntent
Fields
| Field Name | Description |
|---|---|
county - County
|
The county in which the borrower(s) intend to purchase |
id - ID!
|
The ID of the SubjectPropertyIntent |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development Use SubjectProperty to read and update this field |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing |
propertyUsageType - PropertyUsageType
|
How the borrower(s) intend to use the property |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
Example
{
"county": County,
"id": 4,
"isPlannedUnitDevelopment": true,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"state": "AK"
}
SubjectPropertyMutations
Fields
| Field Name | Description |
|---|---|
addSubjectPropertyIntent - AddSubjectPropertyIntentResponse
|
Update a SubjectPropertyIntent. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
attachAddress - AttachSubjectPropertyAddressResponse
|
Attaches street-level address to a subject property. |
Arguments |
|
attachLiabilities - AttachSubjectPropertyLiabilitiesResponse
|
Attach liabilities to the subject property. |
Arguments |
|
create - CreateSubjectPropertyResponse
|
Create a new subject property |
Arguments
|
|
detachAddress - DetachSubjectPropertyAddressResponse
|
Detach the address from a subject property. |
Arguments |
|
detachLiabilities - DetachSubjectPropertyLiabilitiesResponse
|
Detach liabilities from the subject property. |
Arguments |
|
setFirstLien - SetSubjectPropertyFirstLienResponse
|
Add first lien to a subject property. |
Arguments |
|
unsetFirstLien - UnsetSubjectPropertyFirstLienResponse
|
Remove first lien from a subject property. |
Arguments |
|
update - UpdateSubjectPropertyResponse
|
Update a SubjectProperty. Fields with non-null values will be updated, the rest will be ignored. |
Arguments
|
|
updateSubjectPropertyIntent - UpdateSubjectPropertyIntentResponse
|
Update a SubjectPropertyIntent. Fields with non-null values will be updated, the rest will be ignored. |
Arguments |
|
Example
{
"addSubjectPropertyIntent": AddSubjectPropertyIntentResponse,
"attachAddress": AttachSubjectPropertyAddressResponse,
"attachLiabilities": AttachSubjectPropertyLiabilitiesResponse,
"create": CreateSubjectPropertyResponse,
"detachAddress": DetachSubjectPropertyAddressResponse,
"detachLiabilities": DetachSubjectPropertyLiabilitiesResponse,
"setFirstLien": SetSubjectPropertyFirstLienResponse,
"unsetFirstLien": UnsetSubjectPropertyFirstLienResponse,
"update": UpdateSubjectPropertyResponse,
"updateSubjectPropertyIntent": UpdateSubjectPropertyIntentResponse
}
SubjectPropertyNetCashFlowIncome
Description
Subject property net cash flow income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
SubmitCounterAssessmentInput
Fields
| Input Field | Description |
|---|---|
assertionId - String!
|
Client-supplied per-act draft id (the draft-once model): held in client state while the underwriter drafts, sent unchanged on every retry of the same Save. Citation ids and the assertion's content-addressed edge id derive from it, so a double-click or network retry is a structural no-op; a revised payload under a new draft id is a new assertion. |
citations - [CounterAssessmentCitationInput!]!
|
Citations grounding the assessment. Required toward FULFILLED for kinds that argue from documents (gates and computed kinds are exempt). |
reasoning - String!
|
The underwriter's reasoning. |
requirementId - ID!
|
The requirement being assessed. |
verdict - UnderwriterVerdict!
|
The underwriter's verdict on the requirement. |
Example
{
"assertionId": "abc123",
"citations": [CounterAssessmentCitationInput],
"reasoning": "abc123",
"requirementId": 4,
"verdict": "FULFILLED"
}
SubmitCounterAssessmentResponse
Description
Result of submitting a counter-assessment.
Fields
| Field Name | Description |
|---|---|
citationIds - [ID!]!
|
The persisted citation ids, in input order — deterministic per (assertionId, ordinal), so a retry returns the identical ids. Use citations { id }.
|
citations - [Citation!]!
|
The persisted citations, in input order. |
evidence - Evidence!
|
The underwriter assertion the counter-assessment wrote. |
evidenceId - ID!
|
The underwriter assertion's content-addressed edge id. Use evidence { id }.
|
requirement - Requirement
|
The affected requirement's post-reconcile subtree (adversarial-review ruling 2): every review mutation reconciles inline, so the caller can render the new phase without a refetch. Null when the requirement row no longer exists (evicted or not yet minted). |
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write. Empty on a clean write. |
Example
{
"citationIds": [4],
"citations": [Citation],
"evidence": Evidence,
"evidenceId": 4,
"requirement": Requirement,
"warnings": ["TARGET_SUPERSEDED"]
}
SubmitUnderwritingNotesInput
Description
Input to the submitUnderwritingNotes mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
notes - String
|
Notes submitted with the underwriting run (max 10000 characters, measured as UTF-8 bytes so accented characters and emoji count extra) |
routeToUnderwriting - Boolean
|
When true, routes the loan into Underwriting from any stage, including a later one. When unset or false, moves only a loan that is not yet in Underwriting; for a loan at or past it, only the notes are added. A call that submits the loan is refused with LOAN_UNDERWRITING_TASKS_INCOMPLETE while the task-completion gate is not met. |
taskGateOverride - UnderwritingTaskGateOverrideInput
|
Submit despite an unmet task-completion gate. Refused with LOAN_UNDERWRITING_GATE_OVERRIDE_INVALID on a call that only adds notes, and with LOAN_UNAUTHORIZED_ACCESS for callers without the internal administrator scope. |
Example
{
"loanId": 4,
"notes": "abc123",
"routeToUnderwriting": false,
"taskGateOverride": UnderwritingTaskGateOverrideInput
}
SubmitUnderwritingNotesResponse
Description
Response of the submitUnderwritingNotes mutation.
Example
{"jobId": 4, "notes": "abc123"}
SupportAdminIssueType
Description
An issue type as administrators see it: includes retired entries and the Plain link state hidden from customer-facing discovery.
Example
{
"displayName": "xyz789",
"isActive": false,
"key": "4",
"vendorId": "4"
}
SupportAdminMutations
Description
Root type for Pylon-internal support administration.
Fields
| Field Name | Description |
|---|---|
addIssueType - AddIssueTypeResponse
|
Register a new issue type (or reactivate a previously deleted one). The backing Plain label is linked lazily on first use. |
Arguments
|
|
deleteIssueType - DeleteIssueTypeResponse
|
Retire an issue type: it leaves discovery and filing rejects its key. Idempotent for an already-retired one; labels applied to existing threads are unaffected. |
Arguments
|
|
importIssueType - ImportIssueTypeResponse
|
Register an issue type from an existing Plain label type, linked immediately (no lazy sync). |
Arguments
|
|
Example
{
"addIssueType": AddIssueTypeResponse,
"deleteIssueType": DeleteIssueTypeResponse,
"importIssueType": ImportIssueTypeResponse
}
SupportAdminQueries
Description
Root type for Pylon-internal support administration queries.
Fields
| Field Name | Description |
|---|---|
issueTypes - [SupportAdminIssueType!]!
|
Every issue type, retired ones included, with its escalation and link state. |
Example
{"issueTypes": [SupportAdminIssueType]}
SupportAttachmentDownloadUrl
Description
A short-lived link to download one attachment. Fetch a fresh one when needed rather than storing it.
Example
{
"expiresAt": "xyz789",
"url": "abc123"
}
SupportDocumentUpload
Description
A target for uploading a support document.
Fields
| Field Name | Description |
|---|---|
expiresAt - String!
|
When the upload slot expires if no file is posted (ISO-8601). |
uploadUrl - String!
|
URL to POST the file to as multipart/form-data (a single "files" field), authenticated the same way as this request. The response contains the stored document's id, which can then be attached to tickets and messages any number of times. |
Example
{
"expiresAt": "abc123",
"uploadUrl": "abc123"
}
SupportIssueType
SupportMessageAuthor
Description
Who posted a support-ticket message: a requester on the filing customer's side, or the support team.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"REQUESTER"
SupportMutations
Description
Root type for support mutations.
Fields
| Field Name | Description |
|---|---|
addSupportMessage - AddSupportMessageResponse
|
Add a message to an existing ticket's thread. |
Arguments
|
|
createSupportTicket - CreateSupportTicketResponse
|
File a loan-specific support ticket. Creates a Plain thread with the given label, requester identity, and question body. An API credential names the user or contributor in its organization it acts for by sending their id in the x-pylon-on-behalf-of header. |
Arguments
|
|
requestSupportDocumentUpload - RequestSupportDocumentUploadResponse
|
Register a support-attachment upload and get the URL to POST the file to. Reference the returned uploadId in createSupportTicket.attachmentUploadIds once the file is uploaded. |
Arguments |
|
Example
{
"addSupportMessage": AddSupportMessageResponse,
"createSupportTicket": CreateSupportTicketResponse,
"requestSupportDocumentUpload": RequestSupportDocumentUploadResponse
}
SupportQueries
Description
Root type for support queries.
Fields
| Field Name | Description |
|---|---|
issueTypes - [SupportIssueType!]!
|
The set of issue types available when filing a ticket. |
pylonTeam - PylonTeam!
|
The loan's Pylon team as assigned in the loan system. |
Arguments
|
|
supportTicket - SupportTicket!
|
Read a single ticket (with its current Plain status) by id. A caller may open a ticket of their organization on a loan they may read (read:loan, as loan(id:) decides it); any other id is not found. |
Arguments
|
|
supportTicketMessages - [SupportTicketMessage!]!
|
A ticket's conversation, oldest first: the messages filed through this API and the support team's replies. |
Arguments
|
|
supportTickets - SupportTicketConnection!
|
A page of the calling customer's tickets on the loans the caller may read (read:loan, the loans their loan list covers), ordered by creation time (newest first unless sortDirection says otherwise). |
Arguments
|
|
supportTicketsForLoan - [SupportTicket!]!
|
The tickets associated with a given loan, newest first unless orderBy says otherwise, narrowed by filter when one is given. |
Arguments
|
|
Example
{
"issueTypes": [SupportIssueType],
"pylonTeam": PylonTeam,
"supportTicket": SupportTicket,
"supportTicketMessages": [SupportTicketMessage],
"supportTickets": SupportTicketConnection,
"supportTicketsForLoan": [SupportTicket]
}
SupportRecipient
SupportRecipientInput
SupportTicket
Description
A support ticket. Backed by a Plain thread, which is the system of record.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime
|
When the ticket was opened. |
id - ID!
|
Unique identifier of the ticket (the Plain thread id). |
issueType - SupportIssueType
|
The issue type the ticket carries at the support desk: the one it was filed under, unless the desk re-labelled it since. Null when the ticket carries no type we know, and also when the type could not be read this time; the ticket is still served. |
lastMessageAt - DateTime
|
When the last message was sent in either direction, the requester's or the support team's; for a ticket nobody has answered yet, its opening message. Internal activity on the ticket does not move it. May be null when the ticket's emails could not be read. |
lastSupportReplyAt - DateTime
|
When the support team last sent a reply. Null while none has, and also when the requester has sent 10 or more emails since that reply. May also be null when the ticket's emails could not be read. |
loan - Loan
|
The loan this ticket is about, if any. Null, with an error, when the user cannot access it. |
loanApplicationId - ID
|
The loan application this ticket is about, if any. Use loan { id }.
|
lockedAt - DateTime
|
When the support desk locked the ticket; null while it accepts replies. A lock is permanent and a locked ticket rejects addSupportMessage; open a new ticket instead. |
reference - String
|
Human-readable ticket reference (e.g. T-1234). |
resolvedAt - DateTime
|
When the ticket was resolved; null while it is not. |
state - SupportTicketState!
|
Where the ticket stands for the requester, derived from lockedAt, status and Plain's status detail: a locked ticket is CLOSED whatever its status. |
status - String!
|
Ticket status, passed through from Plain as-is. Use state. Its values differ: DONE is RESOLVED, or CLOSED when the ticket is locked.
|
title - String!
|
Ticket title. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"issueType": SupportIssueType,
"lastMessageAt": "2007-12-03T10:15:30Z",
"lastSupportReplyAt": "2007-12-03T10:15:30Z",
"loan": Loan,
"loanApplicationId": 4,
"lockedAt": "2007-12-03T10:15:30Z",
"reference": "abc123",
"resolvedAt": "2007-12-03T10:15:30Z",
"state": "CLOSED",
"status": "abc123",
"title": "xyz789"
}
SupportTicketAttachment
Description
A file attached to a message on a support ticket.
Fields
| Field Name | Description |
|---|---|
downloadUrl - SupportAttachmentDownloadUrl
|
A short-lived link to download the file. Ask for it only when the file is about to be opened; it is not meant to be stored. Null while the file is being scanned, when it failed or was not scanned, or when the support desk has no link for it. |
fileExtension - String
|
The file extension without the dot, when known. |
fileName - String!
|
The file's name, with its extension. |
id - ID!
|
Unique identifier of the attachment. |
mimeType - String!
|
The file's MIME type. |
sizeBytes - Int!
|
The file's size in bytes. |
Example
{
"downloadUrl": SupportAttachmentDownloadUrl,
"fileExtension": "abc123",
"fileName": "xyz789",
"id": 4,
"mimeType": "abc123",
"sizeBytes": 123
}
SupportTicketConnection
Description
A page of the calling customer's support tickets.
Fields
| Field Name | Description |
|---|---|
edges - [SupportTicketEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Total tickets matching the query, across all pages. Unaffected by first/last/after/before. |
Example
{
"edges": [SupportTicketEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SupportTicketEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID!
|
|
node - SupportTicket!
|
Example
{
"cursor": "4",
"node": SupportTicket
}
SupportTicketFilter
Description
Narrows a list of support tickets. Every field is optional; a ticket must match each one that is given.
Fields
| Input Field | Description |
|---|---|
issueTypes - [ID!]
|
Only tickets filed under one of these issue types, given by id (e.g. PRE_LOCK, the ids the issueTypes query returns). |
search - String
|
Only tickets whose reference or title contains this text, ignoring case. |
states - [SupportTicketState!]
|
Only tickets in one of these states. |
Example
{
"issueTypes": ["4"],
"search": "abc123",
"states": ["CLOSED"]
}
SupportTicketMessage
Description
A message on a support ticket's thread.
Fields
| Field Name | Description |
|---|---|
additionalRecipients - [SupportRecipient!]!
|
Extra addresses copied on the message, beyond the support desk and the requester. |
attachments - [SupportTicketAttachment!]!
|
The files attached to the message; empty when it has none. |
author - SupportMessageAuthor!
|
Which side of the conversation posted the message. |
authorEmail - String
|
Email address the message was sent from, when known. |
authorName - String
|
Display name of the sender, when known. |
fullText - String
|
The whole email as plain text, with every earlier message quoted below the new one. Null when it adds nothing to text. Ask for it only to show the quoted history. |
id - ID!
|
Unique identifier of the message. |
sentAt - String!
|
When the message was posted (ISO-8601). |
text - String!
|
The message as plain text (empty for attachment-only messages): the new message alone, without the earlier messages an email quotes below it, which fullText then carries. When the support desk cannot serve the new message alone in full, this is the whole email, quoted messages included. |
to - SupportRecipient
|
The email's main recipient. No write sets it: a message always goes to the ticket's own participants, and anyone copied through additionalRecipients appears there. |
Example
{
"additionalRecipients": [SupportRecipient],
"attachments": [SupportTicketAttachment],
"author": "REQUESTER",
"authorEmail": "xyz789",
"authorName": "xyz789",
"fullText": "xyz789",
"id": "4",
"sentAt": "abc123",
"text": "xyz789",
"to": SupportRecipient
}
SupportTicketOrder
Description
How a list of support tickets is ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Tickets waiting on the requester first, then those with the support team, on hold, resolved, and closed; newest first within each. |
|
|
Most recently opened first. |
|
|
Most recent message first, in either direction. |
Example
"NEEDS_REPLY_FIRST"
SupportTicketState
Description
Where a support ticket stands for the requester: with the support team, waiting on the requester's reply, on hold, resolved, or closed.
Values
| Enum Value | Description |
|---|---|
|
|
Closed for good (see lockedAt): it takes no more messages, and a follow-up needs a new ticket. |
|
|
Paused by the support team until something changes. |
|
|
The support team marked it done. It reopens on new activity. |
|
|
The support team replied and is waiting to hear back. |
|
|
The support team has it and owes the next response. |
Example
"CLOSED"
SystemResolution
Description
Resolved by the system — stage gate completed, waiting period elapsed, or precondition met.
Fields
| Field Name | Description |
|---|---|
assertions - [Assertion!]!
|
The satisfying assertion(s) pinned at resolution time. |
description - String!
|
Human-readable summary. |
method - String!
|
Resolution method identifier. Superseded by assertions. Retained temporarily for already-shipped clients and removed after one release.
|
Example
{
"assertions": [Assertion],
"description": "abc123",
"method": "abc123"
}
TaskAssignee
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWER"
TaskCompletionStatus
Description
Status of a step that the borrower finishes once.
Values
| Enum Value | Description |
|---|---|
|
|
The borrower gave the details the step asks for, or answered that there are none. |
|
|
The borrower has not finished the step. |
Example
"COMPLETED"
TaskEntityDetails
Description
Details about the entity associated with a task. Deprecated for BorrowerTask: prefer BorrowerTask.relatedEntity, which resolves the associated entity as a Node whose own fields can be queried directly.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
The borrower associated with the task. |
borrowerId - ID
|
The borrower ID associated with the task. Use borrower { id }.
|
borrowerName - String
|
The borrower nameassociated with the task. |
entityDisplayName - String
|
Display name of the entity associated with the task. |
entityKind - String
|
The type of entity associated with the task. |
Example
{
"borrower": Borrower,
"borrowerId": 4,
"borrowerName": "abc123",
"entityDisplayName": "abc123",
"entityKind": "xyz789"
}
TaskStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AutomaticallyCancelled"
TaskType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DataVerification"
TaxIdentifierNumberType
Description
Tax identifier number type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
TemporaryLeaveIncome
Description
Temporary leave income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
TenPercentBucketExceededReason
Description
§1026.19(e)(3)(ii): the bucket total breached ten percent. The test is on the sum, so no single line is at fault.
Fields
| Field Name | Description |
|---|---|
allowanceAmount - MonetaryAmount!
|
|
contributors - [DisclosureDriftFeeIdentity!]!
|
The lines that moved. |
currentTotalAmount - MonetaryAmount!
|
|
disclosedTotalAmount - MonetaryAmount!
|
|
excessAmount - MonetaryAmount!
|
|
kind - DisclosureDriftReasonKind!
|
Example
{
"allowanceAmount": MonetaryAmount,
"contributors": [DisclosureDriftFeeIdentity],
"currentTotalAmount": MonetaryAmount,
"disclosedTotalAmount": MonetaryAmount,
"excessAmount": MonetaryAmount,
"kind": "APR_INACCURATE"
}
TextComparator
Description
Comparisons available on a text field.
Fields
| Input Field | Description |
|---|---|
contains - String
|
|
containsIgnoreCase - String
|
|
endsWith - String
|
|
eq - String
|
|
eqIgnoreCase - String
|
|
in - [String!]
|
|
isNull - Boolean
|
|
neq - String
|
|
neqIgnoreCase - String
|
|
nin - [String!]
|
|
notContains - String
|
|
notContainsIgnoreCase - String
|
|
notEndsWith - String
|
|
notStartsWith - String
|
|
null - Boolean
|
|
search - String
|
|
startsWith - String
|
|
startsWithIgnoreCase - String
|
Example
{
"contains": "xyz789",
"containsIgnoreCase": "abc123",
"endsWith": "abc123",
"eq": "abc123",
"eqIgnoreCase": "abc123",
"in": ["xyz789"],
"isNull": false,
"neq": "xyz789",
"neqIgnoreCase": "abc123",
"nin": ["xyz789"],
"notContains": "abc123",
"notContainsIgnoreCase": "abc123",
"notEndsWith": "xyz789",
"notStartsWith": "abc123",
"null": false,
"search": "abc123",
"startsWith": "abc123",
"startsWithIgnoreCase": "abc123"
}
ThawLoanInput
Description
Input to the thaw mutation.
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
The ID or friendly ID of the loan. |
Example
{"loanId": 4}
ThawLoanResponse
Description
Response of the thaw mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The loan |
Example
{"loan": Loan}
TimeoutBlocker
Description
Timeout occurred during conditional approval check
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
TipIncome
Description
Tip income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
employment - Employment
|
The employment this income is associated with |
employmentId - ID
|
The employment this income is associated with Use employment { id }.
|
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"employment": Employment,
"employmentId": 4,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
Title
Description
Information about the title associated with a loan.
Fields
| Field Name | Description |
|---|---|
agents - [Contact!]!
|
List of title agents. |
clearedToCloseAt - Date
|
Date the title was cleared to close. |
commitmentReceivedAt - DateTime
|
Date the title commitment was received from the title company. |
documents - [Document!]!
|
Documents associated with the title. |
orderedAt - DateTime
|
Date the title order was placed with the title company. |
policyEffectiveAt - Date
|
Effective date listed on the title insurance policy. |
policyReceivedAt - Date
|
Date the title insurance policy document was received. |
Example
{
"agents": [Contact],
"clearedToCloseAt": "2007-12-03",
"commitmentReceivedAt": "2007-12-03T10:15:30Z",
"documents": [Document],
"orderedAt": "2007-12-03T10:15:30Z",
"policyEffectiveAt": "2007-12-03",
"policyReceivedAt": "2007-12-03"
}
TitleFeeDisclosureBaseline
Description
The disclosure package that last disclosed the loan's title fees: the latest package whose title fee lines changed from the package before it, else the loan's first package.
Fields
| Field Name | Description |
|---|---|
disclosedOn - DateTimeISO!
|
|
formType - DisclosedFormType!
|
|
loanAmount - MonetaryAmount
|
The loan amount that package printed. |
packageType - DisclosurePackageType!
|
Always one of the four package types that print TRID terms. |
Example
{
"disclosedOn": "2007-12-03T10:15:30Z",
"formType": "CLOSING_DISCLOSURE",
"loanAmount": MonetaryAmount,
"packageType": "ADVERSE_ACTION"
}
TitleVendor
Fields
| Field Name | Description |
|---|---|
contactInfo - TitleVendorContactInfo!
|
Contact information for the title vendor |
name - String!
|
The name of the title vendor company |
relationType - TitleVendorRelationType!
|
Type of services provided by this title vendor |
Example
{
"contactInfo": TitleVendorContactInfo,
"name": "xyz789",
"relationType": "CLOSING_ONLY"
}
TitleVendorContactInfo
Fields
| Field Name | Description |
|---|---|
address - String
|
Street address of the title vendor |
city - String
|
City where the title vendor is located |
email - String
|
Email address of the title vendor |
licenseNumber - String
|
License number of the title vendor |
pointOfContact - TitleVendorPointOfContact
|
Point of contact information for the title vendor |
state - StateAbbreviated
|
State where the title vendor is located |
website - String
|
Website URL of the title vendor |
zip - String
|
ZIP code of the title vendor |
Example
{
"address": "xyz789",
"city": "abc123",
"email": "xyz789",
"licenseNumber": "xyz789",
"pointOfContact": TitleVendorPointOfContact,
"state": "AK",
"website": "xyz789",
"zip": "xyz789"
}
TitleVendorPointOfContact
TitleVendorRelationType
Description
Type of services provided by the title vendor
Values
| Enum Value | Description |
|---|---|
|
|
Only provides closing/settlement/escrow service. A separate title agent would be necessary for title insurance. |
|
|
Full service title agent. Provides closing/settlement/escrow services and title insurance. No other agent is necessary for a closing. |
|
|
Title only. An escrow/closing/settlement agent will also be necessary. |
|
|
Unknown or unspecified relation type. |
Example
"CLOSING_ONLY"
TitleVendorsInput
Fields
| Input Field | Description |
|---|---|
addressLine - String
|
Property address |
county - String!
|
County where the property is located |
purpose - LoanPurposeType!
|
Purpose of the loan transaction |
state - StateAbbreviated!
|
State code where the property is located |
township - String
|
Township where the property is located |
Example
{
"addressLine": "abc123",
"county": "xyz789",
"purpose": "PURCHASE",
"state": "AK",
"township": "xyz789"
}
ToggleCustomerCommsOptInInput
ToggleCustomerCommsOptInResponse
ToggleEnabledLoanProductInput
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
|
product - PreapprovalProduct!
|
Example
{"enabled": true, "product": "BayviewBayviewJumboAus"}
ToggleEnabledLoanProductResponse
Fields
| Field Name | Description |
|---|---|
enabledLoanProducts - [PreapprovalProduct!]!
|
|
userErrors - [UserError!]!
|
Why the change was refused. Empty when it was applied. |
Example
{
"enabledLoanProducts": ["BayviewBayviewJumboAus"],
"userErrors": [UserError]
}
TogglePlaidProductInput
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
|
product - EnabledPlaidProduct!
|
Example
{"enabled": true, "product": "ASSETS"}
TogglePlaidProductResponse
Fields
| Field Name | Description |
|---|---|
enabledPlaidProducts - [EnabledPlaidProduct!]!
|
Example
{"enabledPlaidProducts": ["ASSETS"]}
TrackedChangesResponse
Description
Experimental.
Fields
| Field Name | Description |
|---|---|
batch - TrackedNodeChangeBatch!
|
Batch of changed entities |
next - String!
|
A cursor that can be used to fetch the next batch. |
Example
{
"batch": TrackedNodeChangeBatch,
"next": "abc123"
}
TrackedNodeChange
Description
Experimental. One changed record, of any tracked kind.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Node id |
node - Node
|
The node data, if available |
type - TrackedNodeType!
|
Node type |
Example
{"id": 4, "node": Node, "type": "Asset"}
TrackedNodeChangeBatch
Description
Experimental.
Fields
| Field Name | Description |
|---|---|
changed - [TrackedNodeChange!]!
|
One page of up to 20 stored changes; a change to something shared by several loans is listed once for each of them |
Example
{"changed": [TrackedNodeChange]}
TrackedNodeType
Description
Every kind of record whose changes trackedChanges reports. Experimental: the list grows, so a client that decodes it strictly should name only the kinds it handles.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Asset"
TrailingCoBorrowerIncome
Description
Trailing co-borrower income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
TriggerAusRunInput
Fields
| Input Field | Description |
|---|---|
loanId - ID!
|
Example
{"loanId": 4}
TriggerAusRunResponse
Fields
| Field Name | Description |
|---|---|
job - AusRunJob
|
|
userErrors - [AusUserError!]!
|
Example
{
"job": AusRunJob,
"userErrors": [MissingAttachmentTypeError]
}
TrustAccountAsset
Description
Trust account asset
Fields
| Field Name | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt!
|
The cash or market value of the asset in dollars |
assetReportId - ID
|
ID of the latest asset report that verified this asset |
borrowerIds - [ID!]
|
Ids of borrowers that are account holders on this asset Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers that are account holders on this asset |
dataSource - AssetDataSource!
|
PLAID for a linked Plaid account; MANUAL for an asset without a Plaid account link, including imported assets. |
id - ID!
|
Node ID |
institutionLogoUrl - String
|
URL of the linked institution's PNG logo. Fetch with a bearer token holding read:asset; browsers must fetch the bytes before displaying them. |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
notableActivities - [FinancialAccountActivity!]!
|
Notable activities |
qualifiedAmount - NonNegativeInt
|
The qualified amount of the asset in dollars, used for underwriting. Null if no qualification has been computed. |
trusteeName - String
|
The legal name of the trustee |
verifiedAmount - NonNegativeInt
|
The verified cash or market value of the asset in dollars, confirmed by a third-party source |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"assetReportId": "4",
"borrowerIds": ["4"],
"borrowers": [Borrower],
"dataSource": "MANUAL",
"id": "4",
"institutionLogoUrl": "abc123",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"],
"notableActivities": [FinancialAccountActivity],
"qualifiedAmount": 123,
"trusteeName": "xyz789",
"verifiedAmount": 123
}
TrustIncome
Description
Trust income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
TruvBridgeToken
Description
TRUV bridge token for initializing widget
Fields
| Field Name | Description |
|---|---|
bridgeToken - String!
|
Bridge token for TRUV Bridge widget |
Example
{"bridgeToken": "xyz789"}
TruvExchangeMetadata
TruvLinkAccess
Description
TRUV token exchange success
Fields
| Field Name | Description |
|---|---|
linkId - String!
|
Truv task ID |
Example
{"linkId": "xyz789"}
TruvVerificationOutcome
Description
Outcome of a Truv verification task. PENDING until the task's income has been ingested or Truv reports no data or a failure; COMPLETE once its income has been ingested; NO_DATA when the payroll connection returned no income; FAILED when the connection failed for good, or when the task has gone ten minutes without any progress. Callers should still bound their own polling.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
TruvVerificationOutcomeInput
UdnMonitorGql
Description
UDN monitor for a borrower
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
The monitored borrower. Null when the borrower has been deleted. |
borrowerId - ID!
|
Use borrower { id }.
|
createdOn - DateTime!
|
|
id - ID!
|
|
lastRetrievedDate - DateTime
|
|
monitoringStartDate - DateTime
|
|
notificationEmails - [String!]!
|
|
status - UdnMonitoringStatus!
|
Example
{
"borrower": Borrower,
"borrowerId": "4",
"createdOn": "2007-12-03T10:15:30Z",
"id": 4,
"lastRetrievedDate": "2007-12-03T10:15:30Z",
"monitoringStartDate": "2007-12-03T10:15:30Z",
"notificationEmails": ["abc123"],
"status": "ACTIVE"
}
UdnMonitoringStatus
Description
Status of UDN monitoring for a borrower
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
UnattachedEmploymentIncomeError
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["abc123"],
"message": "xyz789"
}
UncertainDisclosureSendOutcome
Description
What the loan system shows about a disclosure package whose delivery Pylon could not confirm.
Values
| Enum Value | Description |
|---|---|
|
|
The package went out: the loan system shows it sent after the run's send began. |
|
|
The package never went out: the loan system shows no package of its type sent after the run's send began. |
Example
"DELIVERED"
UnderwriterScheduling
Description
Scheduling for the loan's underwriter. Deliberately anonymous: the underwriter's identity is withheld at the API layer, so this type carries no name, email, or other identifying fields.
Fields
| Field Name | Description |
|---|---|
schedulingUrl - String
|
Booking link (e.g. Calendly) for a meeting with the underwriter, when one resolves; null when the underwriter has no bookable link. |
Example
{"schedulingUrl": "abc123"}
UnderwriterVerdict
Description
The verdict of an underwriter's assessment: FULFILLED (the requirement is met) or UNFULFILLED (it is not). Humans never emit NEEDS_HUMAN.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FULFILLED"
UnderwritingBlockingTask
Description
A task that blocks submitting for underwriting, together with the condition it satisfies: category, entity and requested document type. Group blockers by these instead of parsing task titles.
Fields
| Field Name | Description |
|---|---|
assignedTo - TaskAssignee!
|
Who the task is waiting on. The gate only counts BORROWER and LOAN_OFFICER tasks. |
conditionCategory - String
|
Category of the underlying document condition, e.g. Borrower, Income, Asset, OwnedProperty, PurchaseInformation. Null when the task source does not carry one. |
entity - UnderwritingBlockingTaskEntity
|
The entity the requested evidence is about, when known. |
requestedDocumentTypes - [String!]!
|
Names of the document types that satisfy the task; any one of them completes it. |
task - LoanOfficerDocumentTask!
|
The task itself. Same ids as loanOfficerDocumentTasks. |
Example
{
"assignedTo": "BORROWER",
"conditionCategory": "xyz789",
"entity": UnderwritingBlockingTaskEntity,
"requestedDocumentTypes": ["abc123"],
"task": LoanOfficerDocumentTask
}
UnderwritingBlockingTaskEntity
Description
The loan entity a blocking task is collecting evidence about.
Fields
| Field Name | Description |
|---|---|
displayName - String
|
Human-readable name of the entity (e.g. the borrower's name or the account's institution), when the task source provides one. |
id - ID!
|
Identifier of the entity, stable across the tasks on this loan that are about the same borrower, account, employer or property. |
type - String!
|
Kind of entity, e.g. Borrower, Income, Asset, Property, Liability. |
Example
{
"displayName": "xyz789",
"id": 4,
"type": "xyz789"
}
UnderwritingCostRecovery
Description
How an organization recovers its fixed underwriting cost from the borrower right now, with the history of how it has. Derived from the fee schedule's borrower-paid underwriting fee and the rate-cost configuration, the two things pricing reads.
Fields
| Field Name | Description |
|---|---|
contributor - Contributor
|
Who set the rate cost in force. Null when no rate-cost configuration exists; fee rows carry no attribution. |
dollars - NonNegativeFloat!
|
The amount recovered through mode (the fee amount under FEE, the per-rate dollar cost under RATE); 0 when mode is null. |
effectiveFrom - DateTime
|
When the current configuration took effect. Null for an organization that has never had a fee schedule or a rate cost. |
history - [UnderwritingCostRecoveryVersion!]!
|
Every span of recovery configuration, newest first; the first entry is the one in force. |
mode - UnderwritingCostRecoveryMode
|
The mechanism in force: exactly one of FEE or RATE, never both. Null when neither charges anything (fee $0 and no rate cost), which only a configuration predating the RATE option produces, or when a history span reports a conflict. |
Example
{
"contributor": Contributor,
"dollars": 123.45,
"effectiveFrom": "2007-12-03T10:15:30Z",
"history": [UnderwritingCostRecoveryVersion],
"mode": "FEE"
}
UnderwritingCostRecoveryConflict
Description
A span whose stored configuration charged both a borrower-paid underwriting fee and a rate cost. No supported write produces this; it records a hand-edited state so it is visible rather than reported as one of the two.
Fields
| Field Name | Description |
|---|---|
rateCostDollars - NonNegativeFloat!
|
|
underwritingFeeDollars - NonNegativeFloat!
|
Example
{"rateCostDollars": 123.45, "underwritingFeeDollars": 123.45}
UnderwritingCostRecoveryMode
Description
How an organization recovers its fixed underwriting cost from the borrower: FEE charges it as a borrower-paid underwriting fee line; RATE adds it to the cost of every rate, so it is paid through the price (points) rather than as a fee.
Values
| Enum Value | Description |
|---|---|
|
|
A borrower-paid underwriting fee on the fee schedule. |
|
|
A flat dollar amount added to the cost of every rate. |
Example
"FEE"
UnderwritingCostRecoveryVersion
Description
One span of an organization's underwriting-cost-recovery history: what it charged from effectiveFrom (inclusive) until effectiveTo (exclusive). The span in force right now reports effectiveTo: null.
Fields
| Field Name | Description |
|---|---|
conflict - UnderwritingCostRecoveryConflict
|
Set when this span charged both mechanisms; mode is then null and dollars 0. Never set on the span in force: reading one fails instead. |
contributor - Contributor
|
Who set the rate cost in force. Null when no rate-cost configuration exists; fee rows carry no attribution. |
dollars - NonNegativeFloat!
|
The amount recovered through mode (the fee amount under FEE, the per-rate dollar cost under RATE); 0 when mode is null. |
effectiveFrom - DateTime!
|
|
effectiveTo - DateTime
|
|
mode - UnderwritingCostRecoveryMode
|
The mechanism in force: exactly one of FEE or RATE, never both. Null when neither charges anything (fee $0 and no rate cost), which only a configuration predating the RATE option produces, or when a history span reports a conflict. |
Example
{
"conflict": UnderwritingCostRecoveryConflict,
"contributor": Contributor,
"dollars": 123.45,
"effectiveFrom": "2007-12-03T10:15:30Z",
"effectiveTo": "2007-12-03T10:15:30Z",
"mode": "FEE"
}
UnderwritingEvidenceEdge
Description
One underwriting evidence edge naming this document (fusion CUP-1151, GetDocumentEvidence) — where the upload landed: rejected by a requirement, satisfied one, or, absent any edge at all, matched nothing. A DIFFERENT, unrelated facet from LoanDocumentEvidence above (extraction evidence) — same document node, two independent evidence stories.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTimeISO
|
When this edge was recorded. |
id - ID!
|
The evidence edge's unique identifier. |
kind - String!
|
The edge kind (SUBMISSION, ASSERTION, REJECTION, and so on). |
reasoning - String
|
The author's free-text reasoning for the verdict. |
requirement - Requirement
|
The requirement this edge feeds. Null once the requirement has been removed. |
requirementId - ID!
|
The requirement this edge feeds. Use requirement { id }.
|
verdict - String
|
The verdict (FULFILLED / UNFULFILLED / NEEDS_HUMAN), populated on ASSERTION edges only — null for every other kind. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"kind": "abc123",
"reasoning": "abc123",
"requirement": Requirement,
"requirementId": 4,
"verdict": "xyz789"
}
UnderwritingGateDefaultThresholds
Description
Pylon's default underwriting submission gate thresholds, which apply wherever the organization has not set its own.
Fields
| Field Name | Description |
|---|---|
initialSubmissionPercent - PositiveInt!
|
|
resubmissionPercent - PositiveInt!
|
Example
{"initialSubmissionPercent": 123, "resubmissionPercent": 123}
UnderwritingGateThreshold
Description
The share of a loan's borrower and loan-officer document tasks that must be complete before one round of underwriting submission.
Fields
| Field Name | Description |
|---|---|
percent - PositiveInt!
|
Whole percentage of applicable tasks, 1 to 100. |
source - UnderwritingGateThresholdSource!
|
Example
{"percent": 123, "source": "ORGANIZATION"}
UnderwritingGateThresholdSource
Description
Where an underwriting submission gate threshold comes from: Pylon's default, or a value set for the organization.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ORGANIZATION"
UnderwritingGateThresholdState
Description
Whether an organization's underwriting submission thresholds are applied to its loans. OFF: a submit is never refused for open tasks and Loan.underwritingSubmissionGate reports a required share of 0 while still listing them.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ENFORCED"
UnderwritingGateThresholds
Description
The organization's effective underwriting submission gate thresholds (see Loan.underwritingSubmissionGate): the share of a loan's borrower and loan-officer document tasks that must be complete before a first submission, and before a resubmission of a loan that has already been in underwriting. Each side is the organization's own value or Pylon's default. Enforced only for organizations with the gate turned on.
Fields
| Field Name | Description |
|---|---|
initialSubmission - UnderwritingGateThreshold!
|
|
pylonDefault - UnderwritingGateDefaultThresholds!
|
|
resubmission - UnderwritingGateThreshold!
|
|
thresholdState - UnderwritingGateThresholdState!
|
Whether the thresholds below apply to the organization's loans. They are kept while OFF, for when the organization turns them back on. |
Example
{
"initialSubmission": UnderwritingGateThreshold,
"pylonDefault": UnderwritingGateDefaultThresholds,
"resubmission": UnderwritingGateThreshold,
"thresholdState": "ENFORCED"
}
UnderwritingIntakeOutcome
Description
One intake-outcome recording for this document (fusion CUP-1266, GetIntakeOutcomes) — a single (documentKind, workflowRunId, outcome) row from the extraction orchestrator's per-run processing trace. The one queryable record for an upload that never minted an evidence edge at all (the drop-zone lane), which is exactly the case underwritingEvidence above answers empty for.
Fields
| Field Name | Description |
|---|---|
detail - String
|
The terminal failure message or the usability verdict's flag summary; null for RECEIVED and COMPLETED. |
documentKind - String!
|
The classified document kind (e.g. W2, PAYSTUB). |
outcome - String!
|
The recorded outcome (RECEIVED, COMPLETED, EXTRACTION_FAILED, and the rest of the classed terminal vocabulary). |
recordedAt - DateTimeISO
|
When this outcome was recorded. |
workflowRunId - ID!
|
The Temporal workflow run this recording belongs to — separates one dispatch's honest history from another's. |
Example
{
"detail": "xyz789",
"documentKind": "abc123",
"outcome": "abc123",
"recordedAt": "2007-12-03T10:15:30Z",
"workflowRunId": "4"
}
UnderwritingReviewMutations
Description
Underwriter review mutations namespace.
Fields
| Field Name | Description |
|---|---|
addManualRequirement - AddManualRequirementResponse
|
Mints an underwriter-added requirement, content-addressed on its slug. If the slug's requirement already exists, nothing is written and outcome says whether it is live or removed; a removed one comes back only through restoreRequirement. |
Arguments
|
|
confirmAssessment - ConfirmAssessmentResponse
|
Confirms a prior assessment by writing an endorsement assertion: same verdict, targetRef naming the endorsed edge. Warns (without blocking) when the target is no longer current. |
Arguments
|
|
removeManualRequirement - RemoveManualRequirementResponse
|
Removes an underwriter-added requirement (soft-remove). It comes back only through restoreRequirement. |
Arguments
|
|
reopenAssessment - ReopenAssessmentResponse
|
Reopens a human assessment by writing an INVALIDATION act against it. Rejected unless the target is the requirement's current active human assertion. |
Arguments
|
|
requestReconsideration - RequestReconsiderationResponse
|
Asks the agent lane to revisit its assessment of a requirement. The agent answers asynchronously with a CONCUR/DEFER assertion that can never displace an active human assertion. |
Arguments
|
|
restoreRequirement - RestoreRequirementResponse
|
Brings any removed requirement on the loan back, credited to the calling underwriter: underwriter-added, agent-created, or one removed with its parent. Underwriters only, under the same authorization as the other review mutations. It returns UNPUBLISHED: borrower and loan-officer views see it only after it is published again. |
Arguments
|
|
submitCounterAssessment - SubmitCounterAssessmentResponse
|
Writes the underwriter's own assessment: citation rows plus one UNDERWRITER assertion pinning them. Retries of the same draft (same assertionId) are structural no-ops. |
Arguments
|
|
Example
{
"addManualRequirement": AddManualRequirementResponse,
"confirmAssessment": ConfirmAssessmentResponse,
"removeManualRequirement": RemoveManualRequirementResponse,
"reopenAssessment": ReopenAssessmentResponse,
"requestReconsideration": RequestReconsiderationResponse,
"restoreRequirement": RestoreRequirementResponse,
"submitCounterAssessment": SubmitCounterAssessmentResponse
}
UnderwritingReviewWarning
Description
Non-fatal warning attached to a review write. TARGET_SUPERSEDED: the act targeted an assertion that is no longer current-in-slot (invalidated, disputed away, or superseded by a newer statement), so the write has no fold effect until re-targeted.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TARGET_SUPERSEDED"
UnderwritingSubmissionGate
Description
Readiness of a loan for submission to underwriting: at least requiredCompletionPercent of the loan's borrower and loan-officer document tasks must be complete. The threshold is higher once the loan has already been in underwriting (see isResubmission). The submit mutation enforces the same check whenever it submits the loan: while canSubmit is false, a call that would move the loan into underwriting, or that sets routeToUnderwriting, fails with LOAN_UNDERWRITING_TASKS_INCOMPLETE. A call that only adds a note to a loan already at or past underwriting is not checked.
Fields
| Field Name | Description |
|---|---|
applicableTaskCount - NonNegativeInt!
|
Borrower and loan-officer document tasks that count toward the threshold: completed plus open. Cancelled tasks are excluded. Zero when the gate is disabled. |
blockingTasks - [UnderwritingBlockingTask!]!
|
Open borrower and loan-officer tasks counting against the threshold, each with what it is asking for. Completing (or cancelling) any of them raises the completion percentage. |
canSubmit - Boolean!
|
True when the loan meets the completion threshold and can be submitted for underwriting. |
completedTaskCount - NonNegativeInt!
|
Borrower and loan-officer document tasks completed so far. Zero when the gate is disabled. |
enabled - Boolean!
|
Whether the gate is enforced for this loan's customer. When false, canSubmit is always true. |
isResubmission - Boolean!
|
True when the loan has already been in underwriting, so this submit would be a resubmission and every applicable task must be complete. False when the gate is disabled. |
requiredCompletionPercent - NonNegativeInt!
|
Percentage of applicableTaskCount that must be completed before submitting: the organization's threshold for this round (Pylon's defaults are 80 for a first submission, 100 for a resubmission; see Organization.underwritingGateThresholds). 0 when the organization has turned its threshold off: the gate still reports the counts and open tasks but is always met. |
Example
{
"applicableTaskCount": 123,
"blockingTasks": [UnderwritingBlockingTask],
"canSubmit": false,
"completedTaskCount": 123,
"enabled": true,
"isResubmission": false,
"requiredCompletionPercent": 123
}
UnderwritingTaskGateOverrideInput
Description
A Pylon staff decision to submit the loan for underwriting although its task-completion gate is not met. Requires the internal administrator scope; the explanation is written to the loan's notes with the gate state it overrode.
Fields
| Input Field | Description |
|---|---|
reason - String!
|
Why the gate is being overridden; required and must not be blank (max 10000 characters, measured as UTF-8 bytes so accented characters and emoji count extra) |
Example
{"reason": "xyz789"}
UnemploymentIncome
Description
Unemployment income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
UnmergeCreditReportInput
Description
Input to unmerge a joint credit report into individual reports
Fields
| Input Field | Description |
|---|---|
creditPullId - ID!
|
The ID of the completed joint credit pull to unmerge |
Example
{"creditPullId": 4}
UnmergeCreditReportResponse
Description
Response from unmerging a credit report
Fields
| Field Name | Description |
|---|---|
jobs - [CreditPullJob!]
|
Credit pull jobs for the unmerge (one per borrower) |
userErrors - [GenericUserError!]
|
User errors preventing unmerge |
Example
{
"jobs": [CreditPullJob],
"userErrors": [GenericUserError]
}
UnsatisfiableStructureBlocker
Description
The product structure cannot be satisfied
Fields
| Field Name | Description |
|---|---|
type - String!
|
|
unsatisfiabilityDetails - [ProductStructureUnsatisfiabilityDetailsType!]!
|
Details about the unsatisfiability |
Example
{
"type": "xyz789",
"unsatisfiabilityDetails": [
ProductStructureUnsatisfiabilityDetailsType
]
}
UnsetBorrowerMilitaryServiceInput
Description
Input to unset borrower military service.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
Example
{"borrowerId": "4"}
UnsetBorrowerMilitaryServiceResponse
Description
Response of the unset borrower military service mutation
Fields
| Field Name | Description |
|---|---|
militaryService - BorrowerMilitaryService
|
The updated borrower military service |
Example
{"militaryService": BorrowerMilitaryService}
UnsetSubjectPropertyFirstLienInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the subject property |
Example
{"id": "4"}
UnsetSubjectPropertyFirstLienResponse
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
Updated subject property |
Example
{"subjectProperty": SubjectProperty}
UnsupportedUsStateError
Description
User error indicating that Pylon is not configured to run in the specified US state
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
state - String!
|
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789",
"state": "abc123"
}
UnverifiedAssetBlocker
UnverifiedIncomeBlocker
UpdateAnyAssetInput
Description
Input for updating an Asset of any type. Includes only Asset interface fields.
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"id": 4,
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateAnyIncomeInput
Description
Input for updating an Income of any type. Includes only Income interface fields.
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
id - ID!
|
The ID of the income to update |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
UpdateAssetInput
Description
Input to the updateAsset mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
Example
{
"any": UpdateAnyAssetInput,
"automobile": UpdateAutomobileAssetInput,
"bond": UpdateBondAssetInput,
"bridgeLoanNotDeposited": UpdateBridgeLoanNotDepositedAssetInput,
"cashOnHand": UpdateCashOnHandAssetInput,
"certificateOfDepositTimeDeposit": UpdateCertificateOfDepositTimeDepositAssetInput,
"checkingAccount": UpdateCheckingAccountAssetInput,
"cryptocurrency": UpdateCryptocurrencyAssetInput,
"gift": UpdateGiftAssetInput,
"grant": UpdateGrantAssetInput,
"individualDevelopmentAccount": UpdateIndividualDevelopmentAccountAssetInput,
"lifeInsurance": UpdateLifeInsuranceAssetInput,
"moneyMarketFund": UpdateMoneyMarketFundAssetInput,
"mutualFund": UpdateMutualFundAssetInput,
"other": UpdateOtherAssetInput,
"pendingNetSaleProceedsFromRealEstate": UpdatePendingNetSaleProceedsFromRealEstateAssetInput,
"proceedsFromSaleOfNonRealEstateAsset": UpdateProceedsFromSaleOfNonRealEstateAssetInput,
"proceedsFromSecuredLoan": UpdateProceedsFromSecuredLoanAssetInput,
"proceedsFromUnsecuredLoan": UpdateProceedsFromUnsecuredLoanAssetInput,
"retirementFund": UpdateRetirementFundAssetInput,
"savingsAccount": UpdateSavingsAccountAssetInput,
"stock": UpdateStockAssetInput,
"stockOptions": UpdateStockOptionsAssetInput,
"trustAccount": UpdateTrustAccountAssetInput
}
UpdateAssetResponse
Description
Response of the updateAsset mutation.
Fields
| Field Name | Description |
|---|---|
asset - Asset!
|
The updated asset |
Example
{"asset": Asset}
UpdateAutomobileAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateBondAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateBorrowerConsentInput
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
hardCreditConsentDate - DateTime
|
|
hardCreditConsentType - CreditPullConsentType
|
|
softCreditConsentDate - DateTime
|
|
softCreditConsentType - CreditPullConsentType
|
Example
{
"borrowerId": 4,
"hardCreditConsentDate": "2007-12-03T10:15:30Z",
"hardCreditConsentType": "ELECTRONIC",
"softCreditConsentDate": "2007-12-03T10:15:30Z",
"softCreditConsentType": "ELECTRONIC"
}
UpdateBorrowerConsentResponse
Description
Response of the update borrower consent mutation.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower
|
The borrower whose consent was updated. Null, with an error, when the user cannot access that borrower. |
borrowerId - ID!
|
ID of the borrower to update Use borrower { id }.
|
hardCreditConsentDate - DateTime
|
|
hardCreditConsentType - CreditPullConsentType
|
|
softCreditConsentDate - DateTime
|
|
softCreditConsentType - CreditPullConsentType
|
Example
{
"borrower": Borrower,
"borrowerId": 4,
"hardCreditConsentDate": "2007-12-03T10:15:30Z",
"hardCreditConsentType": "ELECTRONIC",
"softCreditConsentDate": "2007-12-03T10:15:30Z",
"softCreditConsentType": "ELECTRONIC"
}
UpdateBorrowerDependentsInput
Description
Input to the update borrower dependents mutation. Fields with non-null values will be updated, the rest will be ignored.
Example
{
"borrowerId": "4",
"dependentAges": [123.45]
}
UpdateBorrowerDependentsResponse
Description
Response of the update borrower dependents mutation
Fields
| Field Name | Description |
|---|---|
dependentAges - [Float!]!
|
The updated borrower Dependents |
Example
{"dependentAges": [123.45]}
UpdateBorrowerFinancialDeclarationsInput
Description
Input to the update borrower financial declarations mutation. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
bankruptcyChapterType - BankruptcyChapterType
|
The type of bankruptcy filed, if any. |
bankruptcyIndicator - Boolean
|
Indicates if the borrower has filed for bankruptcy. |
borrowerId - ID!
|
ID of the borrower to update |
homeownerPastThreeYears - Boolean
|
Indicates if the borrower has been a homeowner in the past three years. |
intentToOccupy - Boolean
|
Indicates if the borrower intends to occupy the property. |
outstandingJudgmentsIndicator - Boolean
|
Indicates if the borrower has outstanding judgments. |
partyToLawsuitIndicator - Boolean
|
Indicates if the borrower is currently a party to a lawsuit. |
presentlyDelinquentIndicator - Boolean
|
Indicates if the borrower is presently delinquent on any obligations. |
priorPropertyDeedInLieuConveyedIndicator - Boolean
|
Indicates if the borrower has conveyed a prior property deed in lieu of foreclosure. |
priorPropertyForeclosureCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property foreclosure. |
priorPropertyShortSaleCompletedIndicator - Boolean
|
Indicates if the borrower has completed a prior property short sale. |
priorPropertyTitleType - PriorPropertyTitleType
|
Indicates the type of title ownership for the borrower's prior property, such as sole ownership or joint ownership. |
priorPropertyUsageType - PriorPropertyUsageType
|
Specifies how the borrower's prior property was used, such as primary residence, investment, or second home. |
undisclosedComakerOfNoteIndicator - Boolean
|
Indicates if the borrower is an undisclosed co-maker of a note. |
undisclosedCreditApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed credit application. |
undisclosedMortgageApplicationIndicator - Boolean
|
Indicates if the borrower has an undisclosed mortgage application. |
Example
{
"bankruptcyChapterType": "CHAPTER_ELEVEN",
"bankruptcyIndicator": true,
"borrowerId": "4",
"homeownerPastThreeYears": true,
"intentToOccupy": false,
"outstandingJudgmentsIndicator": false,
"partyToLawsuitIndicator": false,
"presentlyDelinquentIndicator": false,
"priorPropertyDeedInLieuConveyedIndicator": true,
"priorPropertyForeclosureCompletedIndicator": true,
"priorPropertyShortSaleCompletedIndicator": true,
"priorPropertyTitleType": "JOINT_WITH_OTHER_THAN_SPOUSE",
"priorPropertyUsageType": "FHA_SECONDARY_RESIDENCE",
"undisclosedComakerOfNoteIndicator": false,
"undisclosedCreditApplicationIndicator": false,
"undisclosedMortgageApplicationIndicator": false
}
UpdateBorrowerFinancialDeclarationsResponse
Description
Response of the update borrower financial declarations mutation
Fields
| Field Name | Description |
|---|---|
financialDeclarations - BorrowerFinancialDeclarations!
|
The updated borrower declarations |
Example
{"financialDeclarations": BorrowerFinancialDeclarations}
UpdateBorrowerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the borrower to update |
isFirstTimeHomeBuyer - Boolean
|
|
maritalStatus - MaritalStatusType
|
|
pointOfContact - Boolean
|
Example
{
"id": 4,
"isFirstTimeHomeBuyer": false,
"maritalStatus": "DIVORCED",
"pointOfContact": true
}
UpdateBorrowerMailingAddressInput
Example
{
"city": "xyz789",
"country": "xyz789",
"id": 4,
"line": "abc123",
"line2": "abc123",
"state": "AK",
"zipCode": "abc123"
}
UpdateBorrowerMailingAddressResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that was updated |
Example
{"borrower": Borrower}
UpdateBorrowerMilitaryServiceInput
Description
Input to the update borrower military service mutation. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
militaryServiceExpectedCompletionDate - Date
|
|
militaryStatusType - MilitaryStatusType
|
|
survivingSpouseIndicator - Boolean
|
Example
{
"borrowerId": "4",
"militaryServiceExpectedCompletionDate": "2007-12-03",
"militaryStatusType": "ACTIVE_DUTY",
"survivingSpouseIndicator": true
}
UpdateBorrowerMilitaryServiceResponse
Description
Response of the update borrower military service mutation
Fields
| Field Name | Description |
|---|---|
militaryService - BorrowerMilitaryService
|
The updated borrower military service |
Example
{"militaryService": BorrowerMilitaryService}
UpdateBorrowerPersonalInformationInput
Fields
| Input Field | Description |
|---|---|
aliases - [String!]
|
|
citizenshipResidencyType - CitizenshipResidencyType
|
|
dateOfBirth - Date
|
|
email - String
|
|
firstName - String
|
|
id - ID!
|
ID of the borrower to update |
lastName - String
|
|
middleName - String
|
|
suffix - String
|
|
taxIdentifierNumber - String
|
Tax identifier number |
taxIdentifierNumberType - TaxIdentifierNumberType
|
Tax identifier number type |
Example
{
"aliases": ["abc123"],
"citizenshipResidencyType": "NON_PERMANENT_RESIDENT_ALIEN",
"dateOfBirth": "2007-12-03",
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastName": "abc123",
"middleName": "abc123",
"suffix": "xyz789",
"taxIdentifierNumber": "xyz789",
"taxIdentifierNumberType": "INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
}
UpdateBorrowerPersonalInformationResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that was updated |
Example
{"borrower": Borrower}
UpdateBorrowerPhoneNumberInput
Description
Input to upsert a borrower's phone number. Pass borrowerId to create-or-update the borrower's phone number; pass id (deprecated) to update a specific existing phone number record. Exactly one of borrowerId or id must be provided.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID
|
ID of the borrower whose phone number should be created or updated. |
number - String
|
Phone Number |
type - PhoneNumberType
|
Phone number type |
Example
{
"borrowerId": "4",
"number": "xyz789",
"type": "CELL"
}
UpdateBorrowerPhoneNumberResponse
Fields
| Field Name | Description |
|---|---|
phoneNumber - BorrowerPhoneNumber!
|
The phone number that was updated |
Example
{"phoneNumber": BorrowerPhoneNumber}
UpdateBorrowerPlaidInput
Description
Input to the updatePlaid mutation.
Fields
| Input Field | Description |
|---|---|
assetReportStatus - PlaidAssetReportStatus
|
The state of the borrower's Plaid asset report. Cleared means NOT_STARTED. Omitted: unchanged. Null: clears. |
borrowerId - ID!
|
ID of the borrower to update. |
consentedProducts - [EnabledPlaidProduct!]
|
The Plaid products the borrower consented to. Cleared means none. Omitted: unchanged. Null: clears. |
Example
{
"assetReportStatus": "CANCELED",
"borrowerId": "4",
"consentedProducts": ["ASSETS"]
}
UpdateBorrowerPlaidResponse
Description
Response of the updatePlaid mutation.
Fields
| Field Name | Description |
|---|---|
plaid - BorrowerPlaid!
|
The borrower's Plaid state after the update. |
Example
{"plaid": BorrowerPlaid}
UpdateBorrowerPreferencesInput
Description
Input to the borrowerPreferences mutation.
Fields
| Input Field | Description |
|---|---|
applyOutOfPocketToLoan - Boolean
|
Represents if Out Of Pocket cash will be applied to reduce loan cost |
closingCosts - NonNegativeFloat
|
The maximum allowable closing costs. |
downPaymentAmount - NonNegativeFloat
|
The down payment amount. |
loanId - ID!
|
The loan ID for borrower preferences. |
loanTermYears - NonNegativeInt
|
The loan term in years. Default = 30 |
maxDiscountPoints - Float
|
Limit number of rate point buys to not exceed this value. |
maxLtv - NonNegativeFloat
|
Max loan-to-value ratio allowed. Will not override takeout requirements. |
maxOutOfPocket - NonNegativeFloat
|
Out of pocket maximum in dollars. |
monthlyPayment - NonNegativeFloat
|
The maximum allowable monthly payment. |
monthlyPaymentAsPercentageOfIncome - Boolean!
|
Interpret monthly payment field as a percentage instead of dollar amount. Default = false |
mortgageInsurance - Boolean
|
Indicates whether mortgage insurance is required. |
principal - NonNegativeFloat
|
The maximum allowable principal amount. |
rate - NonNegativeFloat
|
The preferred interest rate as a percentage (e.g., 5.0 for 5%). |
rateLockTerm - NonNegativeInt
|
The rate lock period in days. Default = 30 |
rollInClosingCosts - Boolean
|
Represents if closing costs will be rolled into loan amount on a ReFi |
totalCost - Float
|
The cost of points for the loan. |
totalPoints - NonNegativeFloat
|
The number of points required for the loan. |
Example
{
"applyOutOfPocketToLoan": false,
"closingCosts": 123.45,
"downPaymentAmount": 123.45,
"loanId": 4,
"loanTermYears": 123,
"maxDiscountPoints": 987.65,
"maxLtv": 123.45,
"maxOutOfPocket": 123.45,
"monthlyPayment": 123.45,
"monthlyPaymentAsPercentageOfIncome": true,
"mortgageInsurance": true,
"principal": 123.45,
"rate": 123.45,
"rateLockTerm": 123,
"rollInClosingCosts": false,
"totalCost": 987.65,
"totalPoints": 123.45
}
UpdateBorrowerPreferencesResponse
Description
Response of the updateBorrowerPreferences mutation.
Fields
| Field Name | Description |
|---|---|
borrowerPreferences - BorrowerPreferences!
|
Updated borrower preferences. |
loanTermYears - NonNegativeInt!
|
Updated loan term in years |
rateLockTerm - NonNegativeInt!
|
Updated rate lock period |
Example
{
"borrowerPreferences": BorrowerPreferences,
"loanTermYears": 123,
"rateLockTerm": 123
}
UpdateBorrowerPropertyDeclarationsInput
Description
Input to the update borrower property declarations mutation. Fields with non-null values will be updated, the rest will be ignored. The exception is undisclosedBorrowedFundsAmount: null clears it.
Fields
| Input Field | Description |
|---|---|
borrowerId - ID!
|
ID of the borrower to update |
otherMortgageOnSubjectPropertyIndicator - Boolean
|
Is there any other mortgage loan on the subject property? |
propertySubjectToPriorityLienIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
specialBorrowerSellerRelationshipIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
undisclosedBorrowedFundsAmount - Float
|
Amount of the undisclosed borrowed funds. Omit to leave unchanged; pass null to clear. |
undisclosedBorrowedFundsIndicator - Boolean
|
Flag to indicate whether realtor tasks are complete on this loan |
Example
{
"borrowerId": 4,
"otherMortgageOnSubjectPropertyIndicator": false,
"propertySubjectToPriorityLienIndicator": false,
"specialBorrowerSellerRelationshipIndicator": false,
"undisclosedBorrowedFundsAmount": 123.45,
"undisclosedBorrowedFundsIndicator": false
}
UpdateBorrowerPropertyDeclarationsResponse
Description
Response of the update borrower property declarations mutation
Fields
| Field Name | Description |
|---|---|
propertyDeclarations - BorrowerPropertyDeclarations!
|
The updated borrower declarations |
Example
{"propertyDeclarations": BorrowerPropertyDeclarations}
UpdateBorrowerResponse
Description
Response of the update borrower mutation.
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower that was updated |
Example
{"borrower": Borrower}
UpdateBridgeLoanNotDepositedAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateCashOnHandAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateCertificateOfDepositTimeDepositAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateCheckingAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateCommsRecipientsInput
Fields
| Input Field | Description |
|---|---|
commsId - ID!
|
|
recipients - [CommsRecipient!]!
|
The role types that should receive this communication |
Example
{"commsId": 4, "recipients": ["BORROWER"]}
UpdateCommsRecipientsResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of comms template |
name - String!
|
Name of the comms template |
recipients - [CommsRecipient!]!
|
Role types that receive this communication |
subject - String!
|
Subject line of comms |
template - String!
|
Comms template |
Example
{
"id": 4,
"name": "abc123",
"recipients": ["BORROWER"],
"subject": "xyz789",
"template": "abc123"
}
UpdateCommsSettingsInput
Fields
| Input Field | Description |
|---|---|
autoSendBorrowerPortalInvite - Boolean!
|
When on, creating a borrower or co-borrower in Command Center also emails that borrower their portal invite. Off by default, and the only gate on that auto-send — the borrower-portal-invite feature flag governs the explicit borrower.sendPortalInvite mutation, not this. Default = false |
Example
{"autoSendBorrowerPortalInvite": false}
UpdateCommsSettingsResponse
Fields
| Field Name | Description |
|---|---|
autoSendBorrowerPortalInvite - Boolean!
|
When on, creating a borrower or co-borrower in Command Center also emails that borrower their portal invite. Off by default, and the only gate on that auto-send — the borrower-portal-invite feature flag governs the explicit borrower.sendPortalInvite mutation, not this. |
customerId - ID!
|
Example
{"autoSendBorrowerPortalInvite": false, "customerId": 4}
UpdateCommsTemplateInput
UpdateCommsTemplateResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of comms template |
name - String!
|
Name of the comms template |
recipients - [CommsRecipient!]!
|
Role types that receive this communication |
subject - String!
|
Subject line of comms |
template - String!
|
Comms template |
Example
{
"id": "4",
"name": "abc123",
"recipients": ["BORROWER"],
"subject": "abc123",
"template": "xyz789"
}
UpdateCompanyNameInput
UpdateCompanyNameResponse
Fields
| Field Name | Description |
|---|---|
blockedLoans - [BlockedLoan!]!
|
|
updatedLoanCount - Int!
|
|
userErrors - [UserError!]!
|
Example
{
"blockedLoans": [BlockedLoan],
"updatedLoanCount": 987,
"userErrors": [UserError]
}
UpdateConcessionInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
|
id - ID!
|
|
reason - String
|
Example
{"amount": 123, "id": 4, "reason": "xyz789"}
UpdateConcessionResponse
Fields
| Field Name | Description |
|---|---|
concession - Concession
|
Example
{"concession": Concession}
UpdateContactInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
Optional U.S. address to create with the contact. |
companyLicenseNumber - String
|
License number of the company the contact represents |
companyLicenseState - StateAbbreviated
|
State where the company's license was issued |
companyName - String
|
Company which the contact is from |
email - String
|
Email address of the contact |
firstName - String
|
First name of the contact |
hazardInsuranceCoverage - HazardInsuranceCoverageType
|
Coverage provided by a hazard insurer |
id - ID!
|
ID of the contact to update. |
individualLicenseNumber - String
|
Professional license number of the individual contact |
individualLicenseState - StateAbbreviated
|
State where the individual's professional license was issued |
lastName - String
|
Last name of the contact |
middleName - String
|
Middle name of the contact |
phoneNumber - String
|
Phone number of the contact |
role - OrganizationContactRole
|
Contact's role, limited to currently supported values. |
Example
{
"address": AddressInput,
"companyLicenseNumber": "abc123",
"companyLicenseState": "AK",
"companyName": "abc123",
"email": "abc123",
"firstName": "xyz789",
"hazardInsuranceCoverage": "EARTHQUAKE",
"id": "4",
"individualLicenseNumber": "abc123",
"individualLicenseState": "AK",
"lastName": "xyz789",
"middleName": "xyz789",
"phoneNumber": "abc123",
"role": "ATTORNEY"
}
UpdateContactResponse
Fields
| Field Name | Description |
|---|---|
updated - Contact!
|
Updated contact details. |
Example
{"updated": Contact}
UpdateContributorContactInfoInput
UpdateContributorInput
Fields
| Input Field | Description |
|---|---|
contactInfo - UpdateContributorContactInfoInput
|
|
id - ID!
|
Example
{
"contactInfo": UpdateContributorContactInfoInput,
"id": 4
}
UpdateContributorResponse
Fields
| Field Name | Description |
|---|---|
contributor - Contributor!
|
Example
{"contributor": Contributor}
UpdateCostAbsorptionInput
Fields
| Input Field | Description |
|---|---|
points - NonNegativeFloat!
|
|
product - PreapprovalProduct!
|
Example
{"points": 123.45, "product": "BayviewBayviewJumboAus"}
UpdateCostAbsorptionResponse
Fields
| Field Name | Description |
|---|---|
costAbsorption - [CostAbsorption!]!
|
Example
{"costAbsorption": [CostAbsorption]}
UpdateCreditInquiryInput
Description
Input for updating a credit inquiry explanation
Example
{
"creditInquiryId": "4",
"incurredNewCredit": 4,
"inquiringCreditor": "abc123"
}
UpdateCreditInquiryResponse
UpdateCryptocurrencyAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
description - String
|
Description of the asset (e.g. coin and platform) |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"description": "abc123",
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateCurrentBorrowerAddressInput
Description
Current Borrower Address Input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update |
borrowerId - ID!
|
Borrower ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": AddressInput,
"borrowerId": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdateCurrentBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
id - ID!
|
Node ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"id": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdateDemographicInfoInput
Fields
| Input Field | Description |
|---|---|
asianOther - String
|
|
asianRace - [AsianRace!]
|
|
ethnicity - [Ethnicity!]
|
|
ethnicityNotDisclosed - Boolean
|
|
hispanicOrigin - [HispanicOrigin!]
|
|
hispanicOther - String
|
|
id - ID!
|
ID of the borrower to update |
pacificIslanderOther - String
|
|
pacificIslanderRace - [PacificIslanderRace!]
|
|
race - [Race!]
|
|
raceNotDisclosed - Boolean
|
|
sex - [Sex!]
|
|
sexNotDisclosed - Boolean
|
|
tribe - String
|
Example
{
"asianOther": "abc123",
"asianRace": ["CHINESE"],
"ethnicity": ["HISPANIC"],
"ethnicityNotDisclosed": true,
"hispanicOrigin": ["CUBA"],
"hispanicOther": "xyz789",
"id": 4,
"pacificIslanderOther": "xyz789",
"pacificIslanderRace": ["GUAMANIAN_OR_CHAMORRO"],
"race": ["AM_INDIAN_ALASKAN"],
"raceNotDisclosed": true,
"sex": ["FEMALE"],
"sexNotDisclosed": false,
"tribe": "abc123"
}
UpdateDemographicInfoResponse
Fields
| Field Name | Description |
|---|---|
borrower - Borrower!
|
The borrower |
Example
{"borrower": Borrower}
UpdateFeeInput
Fields
| Input Field | Description |
|---|---|
feeSpecifiedFixedAmount - NonNegativeInt
|
If set, this field represents a fixed amount due at closing. |
feeTotalPercent - NonNegativeInt
|
If set, this field represents a fee as a percentage of the loan amount, due at closing. |
id - ID!
|
|
payerShares - [FeePaymentInput!]
|
Who pays this fee at closing, and how much each party pays. The shares' sum becomes the fee's fixed amount (a percentage-based fee becomes fixed), so feeTotalPercent cannot be sent alongside and feeSpecifiedFixedAmount, if sent, must equal the sum; a payer left out pays 0. Shares are paid-at-close amounts; anything already paid before closing stays as recorded. Omit to leave the existing split untouched. |
Example
{
"feeSpecifiedFixedAmount": 123,
"feeTotalPercent": 123,
"id": 4,
"payerShares": [FeePaymentInput]
}
UpdateFeeResponse
Fields
| Field Name | Description |
|---|---|
fee - Fee!
|
Example
{"fee": Fee}
UpdateGiftAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
The ID of the asset to update |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "abc123",
"donorName": "abc123",
"donorPhoneNumber": "xyz789",
"id": "4",
"isIncludedInAssetAccount": false,
"isSellerFunded": false,
"nonBorrowerOwnerNames": ["abc123"],
"source": "COMMUNITY_NON_PROFIT"
}
UpdateGrantAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
dateOfTransfer - Date
|
The date when the gift/grant funds were transferred into the borrower's account |
donorEmployeeIdentificationNumber - String
|
Employer Identification Number (EIN) of the gift/grant donor |
donorName - String
|
Full name of the person providing the gift/grant |
donorPhoneNumber - String
|
The phone number of the person providing the gift/grant |
id - ID!
|
The ID of the asset to update |
isIncludedInAssetAccount - Boolean
|
Indicates whether the gift/grant funds have already been included as part of an asset account considered for the loan |
isSellerFunded - Boolean
|
Indicates whether the gift/grant is funded by the seller |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
source - GiftSource
|
Gift/Grant source |
Example
{
"amount": 123,
"dateOfTransfer": "2007-12-03",
"donorEmployeeIdentificationNumber": "xyz789",
"donorName": "xyz789",
"donorPhoneNumber": "abc123",
"id": 4,
"isIncludedInAssetAccount": false,
"isSellerFunded": true,
"nonBorrowerOwnerNames": ["xyz789"],
"source": "COMMUNITY_NON_PROFIT"
}
UpdateIncomeInput
Description
Input to the updateIncome mutation. This is a 'oneOf' type where exactly one field must be populated.
Fields
| Input Field | Description |
|---|---|
any - UpdateAnyIncomeInput
|
Update an Income of any type that implements the Income interface |
mortgageCreditCertificate - UpdateMortgageCreditCertificateIncomeInput
|
|
other - UpdateOtherIncomeInput
|
|
selfEmployment - UpdateSelfEmploymentIncomeInput
|
|
standardEmployment - UpdateStandardEmploymentIncomeInput
|
Example
{
"any": UpdateAnyIncomeInput,
"mortgageCreditCertificate": UpdateMortgageCreditCertificateIncomeInput,
"other": UpdateOtherIncomeInput,
"selfEmployment": UpdateSelfEmploymentIncomeInput,
"standardEmployment": UpdateStandardEmploymentIncomeInput
}
UpdateIncomeResponse
Description
Response of the updateIncome mutation.
Fields
| Field Name | Description |
|---|---|
income - Income!
|
The updated income |
Example
{"income": Income}
UpdateIndividualDevelopmentAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateLiabilityInput
Description
Update an updateLiability. Fields with non-null values will be updated, the rest will be ignored.
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
Account identifier |
balance - NonNegativeFloat
|
Unpaid balance |
bankName - String
|
Bank name |
creditorName - String
|
Creditor name |
id - ID!
|
Liability ID |
lienPriorityType - LienPriorityType
|
Lien priority; overrides the one a positional type implies, and moves a positional type to match. Null clears the position and omitting the field keeps it. Only mortgage loans can hold a position, and a HELOC only below first lien; any other type is returned as a userError with code LIEN_POSITION_NOT_ALLOWED_FOR_TYPE. |
monthlyPayment - NonNegativeFloat
|
Monthly payment |
type - LiabilityType
|
The type of liability |
Example
{
"accountIdentifier": "xyz789",
"balance": 123.45,
"bankName": "abc123",
"creditorName": "abc123",
"id": "4",
"lienPriorityType": "FIRST_LIEN",
"monthlyPayment": 123.45,
"type": "BORROWER_ESTIMATED_TOTAL_MONTHLY_LIABILITY_PAYMENT"
}
UpdateLiabilityResponse
Description
Response of the updateLiability mutation.
Fields
| Field Name | Description |
|---|---|
liability - Liability
|
The updated Liability, or null if the update was rejected |
userErrors - [GenericUserError!]!
|
Example
{
"liability": Liability,
"userErrors": [GenericUserError]
}
UpdateLifeInsuranceAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateLoanInput
Description
Input to the updateLoan mutation.
Fields
| Input Field | Description |
|---|---|
cashOutType - RefinanceCashOutType
|
LO-set refinance/cash-out type (distinct from the pricing-derived value) |
closingDate - Date
|
The date that the purchase is set to close. |
earnestMoneyDeposit - NonNegativeFloat
|
The total amount of earnest money deposit |
homeBuyingProcess - HomeBuyingProcess
|
The stage of the borrower’s home search; null or omission leaves the current value unchanged. |
id - ID!
|
The ID or friendly ID of the loan. |
loanPurpose - LoanPurposeType
|
The purpose for which the loan proceeds will be used. |
loanTermYears - PositiveFloat
|
The term of this loan in years. |
nonBorrowingOwnersTaskStatus - TaskCompletionStatus
|
Status of providing the loan's non-borrowing owners; null or omission leaves the current value unchanged. |
outOfPocketMax - NonNegativeInt
|
The maximum amount of assets (in dollars) to be used towards the loan. |
purchasePrice - NonNegativeInt
|
The actual purchase price (in dollars). |
realtorsTaskStatus - TaskCompletionStatus
|
Status of the step where the borrower gives realtor information; null or omission leaves the current value unchanged. |
refinanceCashOutProceeds - NonNegativeInt
|
Refinance cash out proceeds not used towards paying off existing liens. |
sellerCredit - NonNegativeInt
|
The total seller credit to be applied towards closing costs |
Example
{
"cashOutType": "CASH_OUT",
"closingDate": "2007-12-03",
"earnestMoneyDeposit": 123.45,
"homeBuyingProcess": "ACTIVELY_LOOKING",
"id": "4",
"loanPurpose": "PURCHASE",
"loanTermYears": 123.45,
"nonBorrowingOwnersTaskStatus": "COMPLETED",
"outOfPocketMax": 123,
"purchasePrice": 123,
"realtorsTaskStatus": "COMPLETED",
"refinanceCashOutProceeds": 123,
"sellerCredit": 123
}
UpdateLoanResponse
Description
Response of the updateLoan mutation.
Fields
| Field Name | Description |
|---|---|
loan - Loan!
|
The updated loan. |
userErrors - [UserError!]!
|
A list of user errors that occurred while executing the updateLoan mutation. |
Example
{
"loan": Loan,
"userErrors": [UserError]
}
UpdateLoanScriptInput
Description
Input for updating a loan script.
Fields
| Input Field | Description |
|---|---|
description - String
|
New description. |
scenarioId - String!
|
The scenarioId of the script to update. |
spec - JSONObject
|
Replacement script payload. Validated against the strict loan-script schema. |
Example
{
"description": "xyz789",
"scenarioId": "abc123",
"spec": {}
}
UpdateLoanScriptResponse
Description
Result of updating a loan script.
Fields
| Field Name | Description |
|---|---|
loanScript - LoanScript!
|
The updated script. |
Example
{"loanScript": LoanScript}
UpdateMoneyMarketFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateMortgageCreditCertificateIncomeInput
Description
Input for updating a MortgageCreditCertificateIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
id - ID!
|
The ID of the income to update |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
percentageOfInterest - NonNegativeFloat
|
The percentage of interest that the mortgage credit certificate will cover. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"percentageOfInterest": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
UpdateMutualFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateNonBorrowingOwnerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
personalInformation - PersonalInformationInput
|
Example
{"id": 4, "personalInformation": PersonalInformationInput}
UpdateNonBorrowingOwnerResponse
Fields
| Field Name | Description |
|---|---|
nonBorrowingOwner - NonBorrowingOwner!
|
Example
{"nonBorrowingOwner": NonBorrowingOwner}
UpdateNotableActivityInput
Description
Input to the updateNotableActivity mutation.
Fields
| Input Field | Description |
|---|---|
activityType - FinancialAccountActivityType
|
Activity type |
amount - Int
|
The amount of money in dollars |
date - Date
|
The date when the activity occurred |
description - String
|
Description of the activity |
id - ID!
|
The ID of the FinancialAccountActivity |
Example
{
"activityType": "LARGE_DEPOSIT",
"amount": 987,
"date": "2007-12-03",
"description": "xyz789",
"id": "4"
}
UpdateNotableActivityResponse
Description
Response of the updateNotableActivity mutation.
Fields
| Field Name | Description |
|---|---|
activity - FinancialAccountActivity!
|
The FinancialAccountActivity entity that was updated |
Example
{"activity": FinancialAccountActivity}
UpdateOrganizationCustomerMarginInput
Fields
| Input Field | Description |
|---|---|
customerMargin - NonNegativeFloat!
|
The customer margin to store on an existing fixed-take agreement, in points (1.5 = 1.5%). Share-based agreements are not supported. |
pylonTake - NonNegativeFloat
|
Pylon's fixed take, in points (1.5 = 1.5%). When omitted, the current fixed-take window's stored take is kept. |
Example
{"customerMargin": 123.45, "pylonTake": 123.45}
UpdateOrganizationCustomerMarginResponse
Fields
| Field Name | Description |
|---|---|
customerMargin - NonNegativeFloat!
|
The stored customer margin after the update, in points. |
globalMargin - NonNegativeFloat!
|
The full margin priced into the loan after the update (customer margin + Pylon take), in points. |
pylonTake - NonNegativeFloat!
|
Pylon's take after the update, in points. |
Example
{"customerMargin": 123.45, "globalMargin": 123.45, "pylonTake": 123.45}
UpdateOrganizationHouseHoldbackInput
Fields
| Input Field | Description |
|---|---|
houseHoldback - Float!
|
The part of the customer margin to hold back from the organization's loan officers, in points (0.5 = 0.5%), with at most 4 decimal places. 0 removes the holdback. |
Example
{"houseHoldback": 123.45}
UpdateOrganizationHouseHoldbackResponse
Fields
| Field Name | Description |
|---|---|
margin - OrganizationMargin
|
The margin window the change opened; null when the change was refused (see userErrors), or when its customer margin cannot be read because no share is in force. |
userErrors - [GenericUserError!]!
|
Why the change was refused. A refusal with the code MARGIN_WINDOW_START_BEFORE_CURRENT is retryable. Empty when it was applied. |
Example
{
"margin": OrganizationMargin,
"userErrors": [GenericUserError]
}
UpdateOrganizationInput
Fields
| Input Field | Description |
|---|---|
companyAddress - AddressInput
|
The organization's company address. |
companyLegalName - String
|
|
companyName - String
|
|
companySupportEmail - String
|
|
electronicCommunicationsConsentUrl - String
|
|
nmlsId - String
|
|
privacyPolicyUrl - String
|
|
telephonicCommunicationsConsentEnabled - Boolean
|
|
telephonicCommunicationsConsentUrl - String
|
|
termsOfServiceUrl - String
|
Example
{
"companyAddress": AddressInput,
"companyLegalName": "xyz789",
"companyName": "abc123",
"companySupportEmail": "xyz789",
"electronicCommunicationsConsentUrl": "abc123",
"nmlsId": "xyz789",
"privacyPolicyUrl": "abc123",
"telephonicCommunicationsConsentEnabled": true,
"telephonicCommunicationsConsentUrl": "abc123",
"termsOfServiceUrl": "xyz789"
}
UpdateOrganizationLicensingInput
Fields
| Input Field | Description |
|---|---|
states - [OrganizationStateWithLicensesInput!]!
|
Example
{"states": [OrganizationStateWithLicensesInput]}
UpdateOrganizationLicensingResponse
Fields
| Field Name | Description |
|---|---|
licensing - OrganizationLicensing
|
|
userErrors - [GenericUserError!]!
|
Example
{
"licensing": OrganizationLicensing,
"userErrors": [GenericUserError]
}
UpdateOrganizationMarginInput
Fields
| Input Field | Description |
|---|---|
margin - NonNegativeFloat!
|
The total margin to store, in points (1.5 = 1.5%). |
Example
{"margin": 123.45}
UpdateOrganizationMarginResponse
Fields
| Field Name | Description |
|---|---|
margin - NonNegativeFloat!
|
Example
{"margin": 123.45}
UpdateOrganizationOriginationInput
Fields
| Input Field | Description |
|---|---|
defaultLoanChannel - LoanChannel
|
The origination channel this customer's loans default to. Pass null to reset it to the default channel (Wholesale). |
mersOrgId - Int
|
The customer's MERS Organization ID. Must be a 7-digit integer. Pass null to clear it. |
Example
{"defaultLoanChannel": "Broker", "mersOrgId": 987}
UpdateOrganizationOriginationResponse
Fields
| Field Name | Description |
|---|---|
defaultLoanChannel - LoanChannel
|
|
mersOrgId - Int
|
Example
{"defaultLoanChannel": "Broker", "mersOrgId": 987}
UpdateOrganizationResponse
Fields
| Field Name | Description |
|---|---|
organization - Organization
|
The organization after the change. Null exactly when userErrors is not empty. |
userErrors - [UserError!]!
|
Why the change was not made, when the caller can act on it. Empty when it was made. |
Example
{
"organization": Organization,
"userErrors": [UserError]
}
UpdateOrganizationRolePermissionsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
permissions - [String!]!
|
Example
{
"id": "4",
"permissions": ["abc123"]
}
UpdateOrganizationRolePermissionsResponse
Fields
| Field Name | Description |
|---|---|
organizationRole - OrganizationRole
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationRole": OrganizationRole,
"userErrors": [GenericUserError]
}
UpdateOrganizationUserDetailsInput
Description
Fields to change on an organization user. Omitted fields are left unchanged. Names cannot be cleared, so a null name is also left unchanged; a null phone number or individual NMLS id clears the value.
Fields
| Input Field | Description |
|---|---|
firstName - String
|
New first name. Omit or pass null to leave unchanged. |
id - ID!
|
|
individualNmlsId - String
|
New individual NMLS id. Omit to leave unchanged; pass null to clear. |
lastName - String
|
New last name. Omit or pass null to leave unchanged. |
phoneNumber - String
|
New phone number. Omit to leave unchanged; pass null to clear. |
Example
{
"firstName": "abc123",
"id": "4",
"individualNmlsId": "xyz789",
"lastName": "xyz789",
"phoneNumber": "xyz789"
}
UpdateOrganizationUserDetailsResponse
Fields
| Field Name | Description |
|---|---|
organizationUser - OrganizationUser
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationUser": OrganizationUser,
"userErrors": [GenericUserError]
}
UpdateOrganizationUserLicensesInput
Description
Licenses to add or replace on an organization user. Each supplied state replaces the user's license in that state, and states not supplied are kept.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The organization user to update. |
licenses - [OrganizationUserLicenseInput!]!
|
The licenses to add or replace, at least one, with each state at most once. |
Example
{"id": 4, "licenses": [OrganizationUserLicenseInput]}
UpdateOrganizationUserLicensesResponse
Fields
| Field Name | Description |
|---|---|
organizationUser - OrganizationUser
|
The user after the change. Null when it was refused. |
userErrors - [UserError!]!
|
Example
{
"organizationUser": OrganizationUser,
"userErrors": [UserError]
}
UpdateOrganizationUserRolesInput
UpdateOrganizationUserRolesResponse
Fields
| Field Name | Description |
|---|---|
organizationUser - OrganizationUser
|
|
userErrors - [GenericUserError!]!
|
Example
{
"organizationUser": OrganizationUser,
"userErrors": [GenericUserError]
}
UpdateOtherAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
description - String
|
Description of the asset |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
isLiquid - Boolean
|
Indicates whether or not the asset is liquid |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"description": "abc123",
"id": "4",
"institutionName": "abc123",
"isLiquid": false,
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateOtherIncomeInput
Description
Input for updating an OtherIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
description - String
|
Information about the income type |
id - ID!
|
The ID of the income to update |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"description": "abc123",
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
UpdateOwnedPropertyInput
Description
Input to the updateOwnedProperty mutation.
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
The address of the property |
borrowingOwnerIds - [ID!]
|
IDs of the borrowers who own this property. If this field is defined, it will replace the existing owner IDs. |
currentUsageType - PropertyUsageType
|
How the owner is using this property. |
homeInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly home insurance premium. |
id - ID!
|
The ID of the OwnedProperty |
intendedDisposition - PropertyDisposition
|
The intended disposition of the property. Indicates whether the borrowers will be retaining or selling (or sold) the property. |
intendedUsageType - PropertyUsageType
|
How the owner intends to use this property. |
monthlyAssociationDues - NonNegativeInt
|
Monthly association dues (in dollars) |
monthlyRentalIncome - NonNegativeInt
|
The expected monthly rental income (in dollars) |
mortgageInsuranceMonthlyPayment - NonNegativeInt
|
The dollar amount of monthly mortgage insurance monthly premium. |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing (e.g. single or multi-family) |
propertyTaxMonthlyPayment - NonNegativeInt
|
The dollar amount of property taxes due per month. |
propertyValue - NonNegativeInt
|
The estimated value of the owned property, in whole dollars |
purchaseDate - Date
|
The date when the property was originally purchased. |
sellDate - Date
|
The date when the property was sold. Only relevant for previously owned properties. |
Example
{
"address": AddressInput,
"borrowingOwnerIds": ["4"],
"currentUsageType": "INVESTMENT",
"homeInsuranceMonthlyPayment": 123,
"id": "4",
"intendedDisposition": "PENDING_SALE",
"intendedUsageType": "INVESTMENT",
"monthlyAssociationDues": 123,
"monthlyRentalIncome": 123,
"mortgageInsuranceMonthlyPayment": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyTaxMonthlyPayment": 123,
"propertyValue": 123,
"purchaseDate": "2007-12-03",
"sellDate": "2007-12-03"
}
UpdateOwnedPropertyResponse
Description
Response of the updateOwnedProperty mutation.
Fields
| Field Name | Description |
|---|---|
ownedProperty - OwnedProperty!
|
The updated OwnedProperty |
Example
{"ownedProperty": OwnedProperty}
UpdatePartyInput
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update. Fields with non-null values will be updated, the rest will be ignored. |
id - ID!
|
Node ID |
individual - PartyIndividualInput
|
Details about the individual associated with the party. |
legalEntity - PartyLegalEntityInput
|
Details about the party, if the party is a legal entity |
role - PartyRole
|
Indicates the type of relationship between the party and the loan. |
Example
{
"address": AddressInput,
"id": "4",
"individual": PartyIndividualInput,
"legalEntity": PartyLegalEntityInput,
"role": "APPRAISER"
}
UpdatePartyResponse
Fields
| Field Name | Description |
|---|---|
party - Party
|
|
userErrors - [UserError!]!
|
Example
{
"party": Party,
"userErrors": [UserError]
}
UpdatePendingNetSaleProceedsFromRealEstateAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
ownedPropertyId - ID
|
The ID of the associated OwnedProperty that is pending sale |
salePrice - NonNegativeInt
|
Sale price of the property in dollars |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["xyz789"],
"ownedPropertyId": "4",
"salePrice": 123
}
UpdatePreviousBorrowerAddressInput
Description
Update previous borrower address input
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
US address to update |
id - ID!
|
Borrower Address ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": AddressInput,
"id": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdatePreviousBorrowerAddressResponse
Fields
| Field Name | Description |
|---|---|
address - Address!
|
US Address |
id - ID!
|
Node ID |
monthlyRentAmount - NonNegativeInt
|
The monthly rental amount in dollars |
moveInDate - Date
|
Move in date |
moveOutDate - Date
|
Move out date |
residencyBasis - BorrowerResidencyBasis
|
The basis on which the borrower lives/lived at this address |
Example
{
"address": Address,
"id": "4",
"monthlyRentAmount": 123,
"moveInDate": "2007-12-03",
"moveOutDate": "2007-12-03",
"residencyBasis": "LIVING_RENT_FREE"
}
UpdateProceedsFromSaleOfNonRealEstateAssetInput
Fields
| Input Field | Description |
|---|---|
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"amount": 123,
"id": "4",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateProceedsFromSecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateProceedsFromUnsecuredLoanAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateProcessorFeeInput
UpdateProcessorFeeResponse
Fields
| Field Name | Description |
|---|---|
blockedLoans - [BlockedLoan!]!
|
|
updatedLoanCount - Int!
|
|
userErrors - [UserError!]!
|
Example
{
"blockedLoans": [BlockedLoan],
"updatedLoanCount": 987,
"userErrors": [UserError]
}
UpdateProductRateLockExtensionPoliciesInput
Description
The complete next version of a Best efforts product's own policy, priced by a lookup table of lengths or by one per-day rate. Its prices replace the previous version's; a length left out isn't offered.
Fields
| Input Field | Description |
|---|---|
currentPolicyId - ID
|
The id of the current version this save replaces, as last loaded. Null only when the policy has no current version. |
maxCumulativeDays - Int
|
The most days, in total, a lock can be extended past its original expiry. Null or omitted means no cap. |
maxExtensions - Int
|
The most extensions one lock can take. Null or omitted means no cap. |
perDayBps - Float
|
PER_DAY only: the price of one day, in basis points. Each length from 1 day to maxCumulativeDays costs that many days. |
prices - [RateLockExtensionPolicyPriceInput!]
|
LOOKUP_TABLE only: every length offered, each with a different number of days. |
pricingKind - RateLockExtensionPolicyPricingKind
|
How the prices are entered. Null or omitted means LOOKUP_TABLE. |
productId - ID!
|
The opaque id of the product, as returned in Product.id. |
Example
{
"currentPolicyId": 4,
"maxCumulativeDays": 987,
"maxExtensions": 987,
"perDayBps": 123.45,
"prices": [RateLockExtensionPolicyPriceInput],
"pricingKind": "LOOKUP_TABLE",
"productId": "4"
}
UpdateProductRateLockExtensionPoliciesResponse
Fields
| Field Name | Description |
|---|---|
policy - ProductRateLockExtensionPolicy
|
The saved version. Null when the update was rejected. |
userErrors - [UserError!]!
|
Example
{
"policy": ProductRateLockExtensionPolicy,
"userErrors": [UserError]
}
UpdateRateLockExtensionPoliciesInput
Description
The complete next version of a policy, priced by a lookup table of lengths or by one per-day rate. Its prices replace the previous version's; a length left out isn't offered.
Fields
| Input Field | Description |
|---|---|
currentPolicyId - ID
|
The id of the current version this save replaces, as last loaded. Null only when the policy has no current version. |
maxCumulativeDays - Int
|
The most days, in total, a lock can be extended past its original expiry. Null or omitted means no cap. |
maxExtensions - Int
|
The most extensions one lock can take. Null or omitted means no cap. |
perDayBps - Float
|
PER_DAY only: the price of one day, in basis points. Each length from 1 day to maxCumulativeDays costs that many days. |
policyKey - RateLockExtensionPolicyKey!
|
|
prices - [RateLockExtensionPolicyPriceInput!]
|
LOOKUP_TABLE only: every length offered, each with a different number of days. |
pricingKind - RateLockExtensionPolicyPricingKind
|
How the prices are entered. Null or omitted means LOOKUP_TABLE. |
Example
{
"currentPolicyId": "4",
"maxCumulativeDays": 123,
"maxExtensions": 123,
"perDayBps": 987.65,
"policyKey": "MANDATORY",
"prices": [RateLockExtensionPolicyPriceInput],
"pricingKind": "LOOKUP_TABLE"
}
UpdateRateLockExtensionPoliciesResponse
Fields
| Field Name | Description |
|---|---|
policy - RateLockExtensionPolicy
|
The saved version. Null when the update was rejected. |
userErrors - [UserError!]!
|
Example
{
"policy": RateLockExtensionPolicy,
"userErrors": [UserError]
}
UpdateRetirementFundAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "xyz789",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateSavingsAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "abc123",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateSelfEmploymentBusinessInput
Description
Input for updating a self employment business
Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
|
name - String
|
Name |
percentOwnership - NonNegativeFloat
|
Percent of the business that the borrower owns. This field is expressed as a percent. As an example, 50.1% is expressed as 50.1. |
Example
{
"address": AddressInput,
"name": "xyz789",
"percentOwnership": 123.45
}
UpdateSelfEmploymentIncomeInput
Description
Input for updating a SelfEmploymentIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerId - ID
|
The borrower associated with the income |
business - UpdateSelfEmploymentBusinessInput
|
The associated self-employment business (if one exists) |
employmentClassification - EmploymentClassificationType
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
externalId - String
|
External ID from third-party services |
id - ID!
|
The ID of the income to update |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerId": "4",
"business": UpdateSelfEmploymentBusinessInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"externalId": "xyz789",
"id": "4",
"isCurrentEmployment": true,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "abc123",
"startDate": "2007-12-03",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
UpdateStandardEmploymentIncomeInput
Description
Input for updating a StandardEmploymentIncome
Fields
| Input Field | Description |
|---|---|
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrowerHasSpecialRelationshipWithEmployer - Boolean
|
When true, indicates that the borrower has a special relationship with the employer, such as familial ties. Default = false |
borrowerId - ID
|
The borrower associated with the income |
employer - EmployerInput
|
Employer details |
employmentClassification - EmploymentClassificationType
|
Whether this is the borrower's primary or secondary employer |
endDate - Date
|
End date. A value of null indicates that the employment is current. |
externalId - String
|
External ID from third-party services |
id - ID!
|
The ID of the income to update |
incomePayType - IncomePayType
|
The type of pay (hourly or salaried) |
isCurrentEmployment - Boolean
|
Is the employment current? |
numberOfMonthsInLineOfWork - NonNegativeInt
|
The total number of months the borrower has been employed in this line of work, regardless of employer |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
position - String
|
A name or description of the employment position or job title |
startDate - Date
|
Start date |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt
|
Stated monthly income amount in dollars |
Example
{
"averageHoursPerWeek": 123,
"borrowerHasSpecialRelationshipWithEmployer": true,
"borrowerId": "4",
"employer": EmployerInput,
"employmentClassification": "PRIMARY",
"endDate": "2007-12-03",
"externalId": "abc123",
"id": "4",
"incomePayType": "HOURLY",
"isCurrentEmployment": false,
"numberOfMonthsInLineOfWork": 123,
"payPeriodFrequency": "ANNUALLY",
"position": "abc123",
"startDate": "2007-12-03",
"statedAmount": 123.45,
"statedMonthlyAmount": 123
}
UpdateStockAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": 4,
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["xyz789"]
}
UpdateStockOptionsAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"]
}
UpdateSubjectPropertyInput
Description
Input to the updateSubjectProperty mutation
Fields
| Input Field | Description |
|---|---|
attachmentType - AttachmentEnum
|
Whether the property is physically attached to neighboring units |
borrowerSpecifiedMonthlyPropertyTaxes - NonNegativeInt
|
The borrower-specified monthly property taxes |
city - String
|
City |
country - String
|
Country |
fipsCountyCode - String
|
County-level FIPS code |
hoaDues - NonNegativeInt
|
The monthly HOA dues of the property |
homeInsuranceMonthlyAmount - NonNegativeInt
|
The monthly home insurance premium associated with this property |
id - ID!
|
The ID of the SubjectProperty to update |
isManufacturedHome - Boolean
|
Marks a subject property as a manufactured home |
isMixedUse - Boolean
|
Marks a subject property as having a mixed-use character |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
line - String
|
Street address line 1 |
line2 - String
|
Street address line 2 |
manuallyEstimatedValue - NonNegativeInt
|
The manually estimated value of the property |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of property |
numberOfUnits - NonNegativeInt
|
The number of dwelling units on the property |
propertyTaxesAndInsuranceIncludedInPayment - Boolean
|
Is Property taxes and insurance included in payment |
rentalEstimatedGrossMonthlyRentAmount - NonNegativeInt
|
The estimated gross monthly rent amount (for investment properties) |
rentalStatus - RentalStatus
|
Whether the property is leased, rented short term, or vacant. Omitted: unchanged. Null: clears. |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
zipCode - String
|
Zip code |
Example
{
"attachmentType": "ATTACHED",
"borrowerSpecifiedMonthlyPropertyTaxes": 123,
"city": "xyz789",
"country": "abc123",
"fipsCountyCode": "abc123",
"hoaDues": 123,
"homeInsuranceMonthlyAmount": 123,
"id": "4",
"isManufacturedHome": false,
"isMixedUse": true,
"isPlannedUnitDevelopment": true,
"line": "abc123",
"line2": "xyz789",
"manuallyEstimatedValue": 123,
"neighborhoodHousingType": "CONDOMINIUM",
"numberOfUnits": 123,
"propertyTaxesAndInsuranceIncludedInPayment": true,
"rentalEstimatedGrossMonthlyRentAmount": 123,
"rentalStatus": "LEASED",
"state": "AK",
"zipCode": "xyz789"
}
UpdateSubjectPropertyIntentInput
Description
Input to the updateSubjectPropertyIntent mutation
Fields
| Input Field | Description |
|---|---|
fipsCountyCode - String
|
County-level FIPS code |
id - ID!
|
The ID of the subject property intent to update |
isPlannedUnitDevelopment - Boolean
|
Marks a subject property as being part of a planned unit development |
neighborhoodHousingType - NeighborhoodHousingType
|
The type of housing |
propertyUsageType - PropertyUsageType
|
How the borrower(s) intend to use the property |
state - StateAbbreviated
|
Abbreviated US state name (including DC) |
Example
{
"fipsCountyCode": "abc123",
"id": "4",
"isPlannedUnitDevelopment": true,
"neighborhoodHousingType": "CONDOMINIUM",
"propertyUsageType": "INVESTMENT",
"state": "AK"
}
UpdateSubjectPropertyIntentResponse
Description
Response of the updateSubjectPropertyIntent mutation
Fields
| Field Name | Description |
|---|---|
subjectPropertyIntent - SubjectPropertyIntent!
|
The updated SubjectPropertyIntent |
Example
{"subjectPropertyIntent": SubjectPropertyIntent}
UpdateSubjectPropertyResponse
Description
Response of the updateSubjectProperty mutation
Fields
| Field Name | Description |
|---|---|
subjectProperty - SubjectProperty!
|
The SubjectProperty that was updated |
Example
{"subjectProperty": SubjectProperty}
UpdateTaskNameInput
UpdateTaskNameResponse
Description
Response of the updateTaskName mutation.
Fields
| Field Name | Description |
|---|---|
assignedTo - TaskAssignee!
|
Who the task is assigned to |
assigneeBorrower - Borrower
|
The borrower assigned to the task, if any. |
assigneeBorrowerId - ID
|
The id of the borrower that this task is related to Use assigneeBorrower { id }.
|
completedAt - DateTime
|
The timestamp of when the task was completed |
createdOn - DateTime!
|
The timestamp of when the task was created |
customTaskName - String
|
The custom name override of the task |
deletedAt - DateTime
|
An optional timestamp for when the task was deleted |
details - TaskEntityDetails
|
Details about the entity this task is associated with Use relatedEntity instead, which resolves the associated entity as a Node whose own fields can be queried directly.
|
documentRequiredCondition - [DocumentRequiredCondition!]
|
The required document conditions on the task |
dueDate - DateTime
|
The due date of the task |
id - ID!
|
The Id of the task |
priority - Int
|
The priority level of the task |
relatedEntity - Node
|
The entity this task is about (e.g. the Asset for a bank-statement upload task, or the AssetTransaction for a large-deposit task), resolvable as a Node. Prefer this over the deprecated details field. |
relatedEntityId - String
|
The global id of the entity this task is about, resolvable via relatedEntity or the node(id) query. Use relatedEntity { id } instead — relatedEntity resolves the entity itself (its id plus all its other fields) in one query.
|
status - TaskStatus!
|
The status of task |
taskDescription - String
|
The description of the task |
taskName - String
|
The name of the task |
type - TaskType!
|
The type of task |
Example
{
"assignedTo": "BORROWER",
"assigneeBorrower": Borrower,
"assigneeBorrowerId": "4",
"completedAt": "2007-12-03T10:15:30Z",
"createdOn": "2007-12-03T10:15:30Z",
"customTaskName": "xyz789",
"deletedAt": "2007-12-03T10:15:30Z",
"details": TaskEntityDetails,
"documentRequiredCondition": [
DocumentRequiredCondition
],
"dueDate": "2007-12-03T10:15:30Z",
"id": 4,
"priority": 987,
"relatedEntity": Node,
"relatedEntityId": "xyz789",
"status": "AutomaticallyCancelled",
"taskDescription": "abc123",
"taskName": "abc123",
"type": "DataVerification"
}
UpdateTrustAccountAssetInput
Fields
| Input Field | Description |
|---|---|
accountIdentifier - String
|
A unique alphanumeric string identifying the asset. Also known as 'Account Number' |
accountOpenedDate - Date
|
The date when financial account was opened |
amount - NonNegativeInt
|
The cash or market value of the asset in dollars |
id - ID!
|
The ID of the asset to update |
institutionName - String
|
Institution name |
nonBorrowerOwnerNames - [String!]
|
Full names of asset owners or account holders not included in the loan application |
trusteeName - String
|
The legal name of the trustee |
Example
{
"accountIdentifier": "xyz789",
"accountOpenedDate": "2007-12-03",
"amount": 123,
"id": "4",
"institutionName": "abc123",
"nonBorrowerOwnerNames": ["abc123"],
"trusteeName": "abc123"
}
UpdateUdnNotificationEmailsInput
Description
Input to update UDN notification emails
Fields
| Input Field | Description |
|---|---|
monitorId - ID!
|
The UDN monitor ID |
notificationEmails - [String!]!
|
New notification email addresses |
Example
{
"monitorId": "4",
"notificationEmails": ["abc123"]
}
UpdateUdnNotificationEmailsResponse
UpdateWebhookSubscriptionInput
Description
Changes a webhook endpoint's URL, its event types, its topics, or any of them. An omitted field keeps its current value; name at least one. Any change (the URL, the event types or the topics) needs this key to hold every read scope of every event the endpoint delivers right now (what deliveredEventTypes lists) and of every event it will deliver after the change, or the request is refused with WEBHOOK_TOPIC_SCOPE_MISSING on input: whoever moves, narrows or widens an endpoint's deliveries can read them. A topic set here is also refused with WEBHOOK_TOPIC_KEY_SCOPE_MISSING when no API key of your organization can read any of its events. The event types and topics change at once; a different URL waits in pendingCallbackUrl until a test delivery to it passes. A change to eventTypes or topics that does not name callbackUrl withdraws a waiting pendingCallbackUrl: that move was judged for the lists of its time, so stage it again under the new ones (naming the URL in the same request keeps it, judged on both).
Fields
| Input Field | Description |
|---|---|
callbackUrl - String
|
The https URL to deliver to; same rules as when registering. An endpoint always has a URL. A different URL is held as pendingCallbackUrl until a test delivery to it passes; deliveries continue to the current URL meanwhile. Naming the current URL again withdraws a pending move. Omitted: unchanged. Null: refused. |
enabled - Boolean
|
true resumes an endpoint that is SUSPENDED after persistent delivery failures: it becomes ACTIVE with a clean failure streak and deliveries resume at its current URL. This is the only way back from SUSPENDED; editing the URL or the events, promoting a key or a test delivery leaves a suspended endpoint suspended. It needs a promoted signing key (WEBHOOK_NO_PROMOTED_KEY otherwise). On an endpoint that is not suspended it changes nothing. false is refused (WEBHOOK_ENABLED_FALSE): to stop deliveries, delete the endpoint. Omitted: unchanged. Null: refused.
|
eventTypes - [WebhookEventType!]
|
The events to deliver, replacing the current list. Each listed type needs every read scope its record is read under on this key, or the request is refused with WEBHOOK_TOPIC_SCOPE_MISSING. Empty is accepted only while the endpoint keeps or gains topics; otherwise it is refused with WEBHOOK_EVENT_TYPES_EMPTY. Delete the endpoint to stop all deliveries. Omitted: unchanged. Null: refused. |
subscriptionId - ID!
|
The subscription to change. |
topics - [WebhookTopic!]
|
Topics to deliver beside eventTypes, replacing the current list; this key must hold every read scope of every event the endpoint will deliver through them under your organization's API keys (otherwise WEBHOOK_TOPIC_SCOPE_MISSING), one of those keys must be able to read at least one event of each topic (otherwise WEBHOOK_TOPIC_KEY_SCOPE_MISSING), and what a topic delivers is decided at delivery time against your organization's current scopes. Null or [] means no topics, refused with WEBHOOK_EVENT_TYPES_EMPTY when the endpoint would then have no event types either (on input.topics, or on input when the same request also empties eventTypes). Omitted: unchanged. Null: clears. |
Example
{
"callbackUrl": "xyz789",
"enabled": true,
"eventTypes": ["APPRAISAL_ORDER_CHANGED"],
"subscriptionId": 4,
"topics": ["BORROWERS"]
}
UpdateWebhookSubscriptionResponse
Description
The result of changing a webhook endpoint.
Fields
| Field Name | Description |
|---|---|
subscription - WebhookSubscription
|
The subscription after the change. Null when the request was refused. |
userErrors - [UserError!]!
|
Why the request was refused, if it was. Empty on success. Codes: WEBHOOK_CALLBACK_URL_INVALID, WEBHOOK_EVENT_TYPES_EMPTY, WEBHOOK_UPDATE_EMPTY, WEBHOOK_TOPIC_SCOPE_MISSING, WEBHOOK_TOPIC_KEY_SCOPE_MISSING, WEBHOOK_ENABLED_FALSE, WEBHOOK_NO_PROMOTED_KEY. |
Example
{
"subscription": WebhookSubscription,
"userErrors": [UserError]
}
UpgradeCreditReportInput
Description
Input to upgrade an existing credit report to tri-merge
Fields
| Input Field | Description |
|---|---|
creditPullId - ID!
|
The ID of the completed credit pull to upgrade |
Example
{"creditPullId": 4}
UpgradeCreditReportResponse
Description
Response from upgrading a credit report
Fields
| Field Name | Description |
|---|---|
job - CreditPullJob
|
Credit pull job for the upgrade |
userErrors - [GenericUserError!]
|
User errors preventing upgrade |
Example
{
"job": CreditPullJob,
"userErrors": [GenericUserError]
}
UsCounty
UsState
Fields
| Field Name | Description |
|---|---|
abbreviation - String!
|
Two-letter abbreviation |
counties - [UsCounty!]!
|
|
name - String!
|
Example
{
"abbreviation": "abc123",
"counties": [UsCounty],
"name": "xyz789"
}
UserError
Description
User error interface
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Possible Types
| UserError Types |
|---|
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
VaBenefitsNonEducationalIncome
Description
Veteran's Association benefits that are not related to education
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": 4,
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": 4
}
VendorName
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PLAID"
VerifyMutations
Description
Verification mutations namespace
Fields
| Field Name | Description |
|---|---|
createInitializationToken - CreateInitializationTokenResponse
|
|
Arguments
|
|
createUpdateModeToken - CreateUpdateModeTokenResponse
|
|
Arguments
|
|
exchangePublicToken - ExchangePublicTokenResponse
|
|
Arguments
|
|
getPlaidLayerSession - GetPlaidLayerSessionResponse
|
|
Arguments
|
|
Example
{
"createInitializationToken": PlaidLinkToken,
"createUpdateModeToken": CreateUpdateModeTokenResponse,
"exchangePublicToken": PlaidItemAccess,
"getPlaidLayerSession": GetPlaidLayerSessionResponse
}
VerifyQueries
Description
Verification queries namespace
Fields
| Field Name | Description |
|---|---|
truvVerificationOutcome - TruvVerificationOutcome!
|
|
Arguments
|
|
Example
{"truvVerificationOutcome": "COMPLETE"}
ViewScopeKind
Description
A session's view scope (PAPI-369): "CUSTOMER" for an ordinary workspace, or "ALL_CUSTOMERS" while the session is reading every customer organization at once (the omni-customer pseudo-tenant).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALL_CUSTOMERS"
WaivedRequirement
Description
A requirement that has been explicitly waived by an authorized actor.
Fields
| Field Name | Description |
|---|---|
borrowerIds - [ID!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. Use borrowers { id }.
|
borrowers - [Borrower!]!
|
Borrowers this requirement applies to; empty when the requirement is loan-level. A composite carries the union of its children's borrowers. |
children - [Requirement!]!
|
Child requirements of a composite, each with its own phase, recursing through nested composites so a deep tree renders as a tree. Empty for leaf requirements. Unlike fulfillmentOptions, present in every phase — a satisfied or waived composite still lists its children here. |
description - String!
|
Human-readable label for this requirement, e.g. "W2 for Acme Corp (2025)". |
id - ID!
|
Node ID |
openedAt - DateTimeISO!
|
When this requirement (re)entered its current OPEN period. A removed and later restored requirement carries the restore time, not its original creation time. |
phase - RequirementPhase!
|
Current resolution phase. Redundant with __typename but useful for client-side filtering without fragment matching. |
provenance - [ProvenanceSource!]!
|
Why this requirement exists — rule evaluation, manual condition, or data dependency. |
reason - String!
|
Reason the requirement was waived. |
recommendedAction - RequirementRecommendedAction!
|
The next action recommended for this requirement. Clients must use this field, never the human-readable description, to decide whether to offer a specialized action. |
relatedEntities - [Node!]!
|
Entities this requirement's params point at (borrower, employment, asset, asset transaction, property), resolvable as Nodes. Entities the caller cannot read, that no longer exist, or that belong to another loan are omitted. |
waivedAt - DateTimeISO!
|
When this requirement was waived. |
waivedBy - String!
|
Identifier of the user who waived this requirement. |
Example
{
"borrowerIds": ["4"],
"borrowers": [Borrower],
"children": [Requirement],
"description": "xyz789",
"id": "4",
"openedAt": "2007-12-03T10:15:30Z",
"phase": "OPEN",
"provenance": [ProvenanceSource],
"reason": "xyz789",
"recommendedAction": "ATTACH_LOAN_STRUCTURE",
"relatedEntities": [Node],
"waivedAt": "2007-12-03T10:15:30Z",
"waivedBy": "xyz789"
}
WarehousingCost
WarehousingCosts
Fields
| Field Name | Description |
|---|---|
products - [WarehousingCost!]
|
A list of products and their warehouse margins |
Example
{"products": [WarehousingCost]}
WebhookCallbackUrlInvalidError
Description
The callback URL is not a public https address Pylon may deliver to.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
WebhookDelivery
Description
One delivery of an event to a webhook endpoint: its attempts and outcome. Retries of the delivery update it; a redelivery is a delivery of its own. History is kept for at least 90 days while the subscription exists. It holds no payload, response body or error text.
Fields
| Field Name | Description |
|---|---|
attemptCount - Int!
|
How many delivery attempts Pylon has recorded or confirmed, including attempts turned away before sending. Attempts made before this delivery's history began may be absent. |
completedAt - DateTime
|
When the delivery ended: DELIVERED, FAILED or NOT_STARTED. Null while it is pending or in progress. |
createdAt - DateTime!
|
When this delivery was first recorded. |
event - WebhookDeliveryEvent!
|
The event the delivery carried. |
id - ID!
|
The delivery's id. |
lastAttemptedAt - DateTime
|
Last recorded attempt time, which can mark its start or completion; null if unknown. |
lastFailureReason - WebhookDeliveryFailureReason
|
Why the latest failed attempt, or the delivery once it failed, did not succeed. Kept after a later attempt succeeds; null when no attempt failed. |
lastHttpStatus - Int
|
The latest HTTP response status Pylon recorded for this delivery; null when no status was recorded. |
status - WebhookDeliveryStatus!
|
Where the delivery stands. |
trigger - WebhookDeliveryTrigger!
|
What started the delivery. |
Example
{
"attemptCount": 987,
"completedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"event": WebhookDeliveryEvent,
"id": "4",
"lastAttemptedAt": "2007-12-03T10:15:30Z",
"lastFailureReason": "CUSTOMER_BUSY",
"lastHttpStatus": 987,
"status": "DELIVERED",
"trigger": "AUTOMATIC"
}
WebhookDeliveryConnection
Description
A page of a webhook endpoint's deliveries, newest first.
Fields
| Field Name | Description |
|---|---|
edges - [WebhookDeliveryEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [WebhookDeliveryEdge],
"pageInfo": PageInfo
}
WebhookDeliveryEdge
Fields
| Field Name | Description |
|---|---|
cursor - OpaqueToken!
|
|
node - WebhookDelivery!
|
Example
{
"cursor": OpaqueToken,
"node": WebhookDelivery
}
WebhookDeliveryEvent
Description
The event a delivery carried, as its webhook named it. Its id and sequence identify the same event in the event log.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The event's id: the webhook's id and its X-Pylon-Idempotency-Key. A redelivery carries the same one. |
sequence - PositiveInt!
|
The event's sequence, as its webhook carried it. |
type - WebhookEventType!
|
The event's type. |
Example
{
"id": "4",
"sequence": 123,
"type": "APPRAISAL_ORDER_CHANGED"
}
WebhookDeliveryFailureReason
Description
Why the latest attempt, or the delivery as a whole, did not succeed. RECEIVER_ERROR: your endpoint answered with a status that is retried (5xx, 429, 408, 425, 401, 403, 404). REJECTED: it answered with a status that is not retried (a redirect or another 4xx). UNREACHABLE: no answer: the connection failed or the attempt timed out. MISCONFIGURED: no usable signing key, or the callback URL is not a public https address. SUSPENDED: the endpoint was suspended for persistent failures. SCOPE_REVOKED: the event reached the endpoint through a topic whose read scope no API key of your organization holds now. CUSTOMER_BUSY: your organization already had its most attempts running at once. RETRIES_EXHAUSTED: the retry window ran out. INTERNAL_ERROR: a failure on Pylon's side. NOT_STARTED: the redelivery could not be started.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER_BUSY"
WebhookDeliveryStatus
Description
Where a delivery stands. PENDING: recorded, with no numbered attempt started yet. IN_PROGRESS: an attempt started or the delivery is waiting to retry. DELIVERED: your endpoint answered 2xx. FAILED: delivery ended without a recorded acknowledgement; an internal failure can prevent Pylon confirming acceptance. NOT_STARTED: a redelivery that could not be started; ask again.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DELIVERED"
WebhookDeliveryTrigger
Description
What started a delivery: AUTOMATIC when the event was recorded, REDELIVERY when your organization asked for the event to be sent again.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AUTOMATIC"
WebhookEnabledFalseError
Description
enabled: false was sent. An endpoint is stopped by deleting it, not switched off.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["abc123"],
"message": "xyz789"
}
WebhookEventType
Description
An event Pylon can deliver to a webhook endpoint. CONTRIBUTOR_CREATED is sent when a contributor is created; each *_CHANGED event is sent when the named record changes; the loan-activity events (LOAN_APPLICATION_CREATED, TASK_COMPLETED, RATE_LOCK_CHANGED, FEE_UPDATED, ...) are sent when that happens on a loan, and their entity is the LoanEvent that node(id) resolves.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Sent whenever the loan application's own record is created or written. For example: creating a loan; the loan mutations update, archive, withdraw, updateBorrowerPreferences, attachTitleCompany, setUseOwnTitleCompany, freeze and thaw; a stage change or underwriting decision from the loan system; and removing a non-borrowing owner (nonBorrowingOwner.delete), which sends no NonBorrowingOwner.changed. A stage change or decision also sends its loan-activity event (such as LoanApplication.stageChanged), so the two can arrive together for one action. Changes to the loan's borrowers, assets, incomes, employments, liabilities, properties or parties send those records' own events. Pylon also writes the record during internal syncs, so it can arrive when nothing you can read has changed, and writes close together can arrive as one. It does not identify an action: fetch the loan with node(id:). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPRAISAL_ORDER_CHANGED"
WebhookEventTypesEmptyError
Description
The change would leave the endpoint with neither event types nor topics; an endpoint delivers at least one event.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["xyz789"],
"message": "xyz789"
}
WebhookKeyAlreadyRevokedError
Description
The signing key is already revoked.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["abc123"],
"message": "abc123"
}
WebhookKeyExpiredError
Description
The pending signing key expired before it was used.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
WebhookKeyNotPendingError
Description
The signing key is not in the PENDING state.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["abc123"],
"message": "xyz789"
}
WebhookKeyNotTestedError
Description
The signing key has no successful test delivery to the URL events go to once it is active (the pending callback URL while a change waits, else the callback URL), or that endpoint is not verified yet.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
WebhookNoPromotedKeyError
Description
enabled: true was sent for a suspended endpoint that has no promoted signing key, so nothing could sign its deliveries.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["xyz789"],
"message": "xyz789"
}
WebhookRedeliveryEndpointInactiveError
Description
The endpoint receives no events now: it is not verified, has no promoted signing key, is suspended, or pushed events are not enabled for your organization. Nothing was sent.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["xyz789"],
"message": "xyz789"
}
WebhookRedeliveryNotSubscribedError
Description
The endpoint does not receive the event's type now: it lists neither the type nor a topic of it, or receives it only through a topic whose read scope no API key of your organization holds now. Nothing was sent.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["xyz789"],
"message": "abc123"
}
WebhookRotationInProgressError
Description
A previous rotation's overlap window is still open, so no other key can be promoted yet. retiringSigningKey and retiringKeyExpiresAt say which key holds it open and when it closes on its own; emergencyRevokeWebhookSigningKey on that key closes it at once.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
retiringKeyExpiresAt - DateTime!
|
When the overlap ends on its own: the retiring key's expiresAt. From then another key can be promoted; Pylon revokes the retiring key shortly after. |
retiringSigningKey - WebhookSigningKey!
|
The RETIRING signing key from the previous rotation. Your receiver still accepts it until retiringKeyExpiresAt. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["abc123"],
"message": "abc123",
"retiringKeyExpiresAt": "2007-12-03T10:15:30Z",
"retiringSigningKey": WebhookSigningKey
}
WebhookSigningKey
Description
One signing key for a webhook subscription. The id is sent with every delivery in the X-Pylon-Key-Id header.
Fields
| Field Name | Description |
|---|---|
activatedAt - DateTime
|
When the key became the active signing key, if it has. |
createdAt - DateTime!
|
When the key was created. |
expiresAt - DateTime
|
For a PENDING key, when it expires if it is not promoted. For a RETIRING key, when its overlap window ends: from then another key can be promoted, and Pylon revokes this one shortly after. Null for other states. |
id - ID!
|
The key's id, sent in the X-Pylon-Key-Id header of deliveries signed with it. |
retiringSince - DateTime
|
When the key stopped being the active key and began its overlap window, if it has. |
revocationReason - WebhookSigningKeyRevocationReason
|
Why the key was revoked. Null unless it is REVOKED. |
revokedAt - DateTime
|
When the key was revoked, if it has been. |
state - WebhookSigningKeyState!
|
The key's lifecycle state. |
testedAt - DateTime
|
When a test delivery signed with this key last succeeded against the callback URL events are delivered to. Null if it has not been tested, or that URL has changed since. |
Example
{
"activatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"id": "4",
"retiringSince": "2007-12-03T10:15:30Z",
"revocationReason": "ABANDONED",
"revokedAt": "2007-12-03T10:15:30Z",
"state": "ACTIVE",
"testedAt": "2007-12-03T10:15:30Z"
}
WebhookSigningKeyRevocationReason
Description
Why a webhook signing key was revoked. ABANDONED: a pending key was never promoted before it expired. SUPERSEDED: a pending key was replaced by a newer one. OVERLAP_ELAPSED: a retiring key reached the end of its overlap window. EMERGENCY: revoked on request.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ABANDONED"
WebhookSigningKeyState
Description
Lifecycle state of a webhook signing key. Deliveries are signed with the ACTIVE key only. Your receiver must accept the ACTIVE and RETIRING keys during a rotation, and a PENDING key while you test it. A REVOKED key is never used and should be removed.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
WebhookSubscription
Description
A destination Pylon sends signed webhook deliveries to, and the signing keys used to sign them.
Fields
| Field Name | Description |
|---|---|
callbackUrl - String!
|
The https URL deliveries are sent to. |
deliveredEventTypes - [WebhookEventType!]!
|
Every event type a delivery can carry right now: eventTypes, plus each topic's events whose record your organization's API keys can read at this moment. Topics are checked against your current scopes at delivery time, not when they were set: a topic's event missing here is withheld until a key holds its read scope again, and the subscription itself is unchanged. |
deliveries - WebhookDeliveryConnection!
|
The endpoint's deliveries, newest first: each event sent to it, its attempts and its outcome. Lists only the events whose record this key may read, under the same read scopes an endpoint's event types need. Needs the webhook delivery history feature, which is off unless enabled for the organization. |
Arguments
|
|
eventTypes - [WebhookEventType!]!
|
The event types listed directly on the endpoint; topics add theirs. Empty here does not mean nothing is delivered: deliveredEventTypes is the full set. |
id - ID!
|
The subscription's id. |
pendingCallbackUrl - String
|
The https URL deliveries move to once its receiver passes a test delivery. Set by changing callbackUrl; null when no move is pending. Deliveries keep going to callbackUrl until a key that signs them has passed a test here (the active key, or a pending key when it is promoted); then this URL becomes callbackUrl and this field is cleared. |
signingKeys - [WebhookSigningKey!]!
|
Every signing key of the subscription, including revoked ones, oldest first. |
status - WebhookSubscriptionStatus!
|
Whether the subscription can deliver. |
topics - [WebhookTopic!]!
|
The topics delivered to the callback URL, beside eventTypes. Each topic event delivers only while your organization's API keys hold every read scope its record is read under, checked at delivery time; deliveredEventTypes shows the result. |
verifiedAt - DateTime
|
When a receiver last proved it controls the callback URL, by answering a test delivery's challenge with its HMAC-SHA256 under the key. Null until it has; nothing is delivered to an endpoint while this is null. Changing the callback URL does not take it back: the new URL waits in pendingCallbackUrl until it is verified in turn. |
Example
{
"callbackUrl": "xyz789",
"deliveredEventTypes": ["APPRAISAL_ORDER_CHANGED"],
"deliveries": WebhookDeliveryConnection,
"eventTypes": ["APPRAISAL_ORDER_CHANGED"],
"id": "4",
"pendingCallbackUrl": "xyz789",
"signingKeys": [WebhookSigningKey],
"status": "ACTIVE",
"topics": ["BORROWERS"],
"verifiedAt": "2007-12-03T10:15:30Z"
}
WebhookSubscriptionExistsError
Description
No longer returned: an organization can register several webhook endpoints, each with its own callback URL, event types and signing keys. Kept so clients that match on it keep working.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
WebhookSubscriptionLimitReachedError
Description
The organization already has 10 webhook endpoints, the most it may register. Every endpoint that has not been deleted counts, a registered or disabled one included: a disabled endpoint keeps its secret and keys and can be re-enabled. Delete an endpoint to register another; disabling it does not free a place.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["xyz789"],
"message": "xyz789"
}
WebhookSubscriptionStatus
Description
Whether a webhook subscription can deliver. PENDING: a customer from before signing keys; delivers, signed with the shared secret, until its first key is activated. REGISTERED: registered through the API, and receives nothing until a signing key has been tested and promoted. ACTIVE: delivers, signed by its active signing key. DISABLED: delivery is off because its active signing key was revoked and no replacement has been promoted. SUSPENDED: delivery is off because the endpoint kept failing and was disabled automatically. The one way back is updateWebhookSubscription with enabled: true, which makes it ACTIVE with a clean failure count (it needs a promoted signing key); editing the URL or the events, a test delivery, a key promotion or an emergency revoke followed by a promotion leaves it SUSPENDED. A delivery dropped while suspended is classified as suspended, not as a failing endpoint.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
WebhookTestDeliveryFailedError
Description
The test delivery did not succeed; message says how, and the response's outcome and httpStatus carry the detail.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "xyz789"
}
WebhookTestDeliveryIncompleteError
Description
The test delivery's result is unknown: reload the signing key and check testedAt.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["xyz789"],
"message": "abc123"
}
WebhookTestOutcome
Description
How a webhook test delivery ended. DELIVERED: your endpoint answered 2xx with the HMAC-SHA256 of challenge. + the token under the key, the key is recorded as tested and the endpoint is verified at the URL tested (a pending callback URL becomes the callback URL when the active key was tested or nothing else signs deliveries yet; otherwise it moves with the promotion). REJECTED: it answered with another status. CHALLENGE_NOT_ANSWERED: it answered 2xx but its response was not a JSON object whose challenge is the HMAC-SHA256 of challenge. + the token (echoing the token itself proves nothing), so nothing was recorded. UNREACHABLE: it did not answer. INVALID_URL: the callback URL is not a public https address, so nothing was sent. SECRET_UNREADABLE: the key's secret could not be read. NOT_TESTABLE: the key was replaced or expired, or the callback URL changed during the test. NOT_SENT: the request was refused, so nothing was sent. UNKNOWN: the result could not be read back; reload the key to see whether it was recorded as tested.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHALLENGE_NOT_ANSWERED"
WebhookTopic
Description
A stream of related webhook events subscribed to as one. Each event in a topic is delivered only while your organization's API keys hold, at delivery time, every read scope its record is read under (some records are read under two, such as a loan's document jobs under read:document and read:loan); an event whose scope no key holds is withheld, not sent later, and resumes as soon as a key holds it again, with nothing to resend. Subscribing a topic, or changing an endpoint that has one, needs the key making the request to hold every read scope of every event the topic will deliver under your organization's API keys (WEBHOOK_TOPIC_SCOPE_MISSING: whoever registers or changes an endpoint can read what it delivers), and one of those keys must be able to read at least one of the topic's events (WEBHOOK_TOPIC_KEY_SCOPE_MISSING names the scope no key holds: such a topic could deliver nothing). CONTRIBUTORS reads under read:borrower; LOANS reads under read:loan, read:pricing, read:subject-property, read:party, read:non-borrowing-owner, read:deal, read:pre-qualification, read:document, read:loan-events; BORROWERS reads under read:borrower, read:asset, read:income, read:employment, read:liability, read:owned-property; CREDIT reads under read:credit; UNDERWRITING reads under read:loan; DISCLOSURES reads under read:loan; ORDERS reads under read:loan.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BORROWERS"
WebhookTopicKeyScopeMissingError
Description
A selected topic has no event any API key of your organization may read, so it could deliver nothing; the request stored nothing.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": "4",
"field": ["xyz789"],
"message": "abc123"
}
WebhookTopicScopeMissingError
Description
The endpoint would deliver, under your organization's API keys, an event whose record this key may not read: a listed event type, a selected topic's event, one the endpoint already delivers when it is changed, or an event selected for redelivery. The request stored nothing.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "abc123",
"errorId": 4,
"field": ["xyz789"],
"message": "xyz789"
}
WebhookUpdateEmptyError
Description
The update names none of the callback URL, the event types and the topics.
Fields
| Field Name | Description |
|---|---|
code - String
|
A stable error code for programmatic handling. Format: {DOMAIN}_{ERROR_NAME} (e.g., 'LOAN_CLOSED', 'AUS_NO_PRODUCT_PRICING'). |
errorId - ID!
|
A unique identifier for this error instance, useful for tracking and debugging. |
field - [String!]
|
Path to the input field that caused the error (e.g., ['input', 'customer', 'email']). Null when not associated with a specific field. |
message - String!
|
A human-readable error message. |
Example
{
"code": "xyz789",
"errorId": 4,
"field": ["abc123"],
"message": "abc123"
}
WireInPaymentsReceivedBeforePurchase
Description
How many scheduled borrower payments the seller received before the purchase date.
Values
| Enum Value | Description |
|---|---|
|
|
The seller received the first scheduled payment. |
|
|
The seller received no scheduled payment. |
Example
"FIRST_PAYMENT"
WithdrawLoanInput
Description
Input to the withdrawLoan mutation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the loan to withdraw |
Example
{"id": 4}
WithdrawLoanResponse
Types
| Union Types |
|---|
Example
LoanClosedError
WithdrawLoanSuccess
Description
A successful response after a loan has been archived.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the withdrawn loan |
Example
{"id": 4}
WorkersCompensationIncome
Description
Workers compensation income
Fields
| Field Name | Description |
|---|---|
amounts - IncomeAmounts!
|
Recorded income amounts, preserving cents and negative values. Self-employment losses retain their loss magnitude. |
averageHoursPerWeek - NonNegativeInt
|
The average number of hours worked per week |
borrower - Borrower!
|
The borrower associated with the income |
id - ID!
|
Node ID |
payPeriodFrequency - PayPeriodFrequency
|
The pay cycle frequency of this income |
qualifiedAmount - NonNegativeFloat
|
The qualified amount determined from this income |
statedAmount - NonNegativeFloat
|
The amount paid per cycle for this income |
statedMonthlyAmount - NonNegativeInt!
|
Stated monthly income amount in dollars Use amounts { statedMonthly } to retain cents and support signed income.
|
verifiedAmount - NonNegativeFloat
|
The verified amount of this income |
voieReportId - ID
|
The external report if income has been verified |
Example
{
"amounts": IncomeAmounts,
"averageHoursPerWeek": 123,
"borrower": Borrower,
"id": "4",
"payPeriodFrequency": "ANNUALLY",
"qualifiedAmount": 123.45,
"statedAmount": 123.45,
"statedMonthlyAmount": 123,
"verifiedAmount": 123.45,
"voieReportId": "4"
}
WorstCaseRepricing
Description
The lock expired inside the relock window: the worse of the lock-day and today's rate sheets priced this structure.
Fields
| Field Name | Description |
|---|---|
current - RepricingSheetPrice!
|
Today's rate sheet's price. |
fallbackUsed - Boolean!
|
Whether the lock-day side used the locked product's own lock-day price because the target product had no lock-day sheet. |
pinned - RepricingSheetPrice
|
The lock-day rate sheet's price. Null when the lock-day sheet has no price for this rate. |
worstCaseAdjustmentPoints - Float!
|
The points that worst-case pricing adds to this rate's price; 0 when none. Already included in totalPoints and ratePoints. |
Example
{
"current": RepricingSheetPrice,
"fallbackUsed": false,
"pinned": RepricingSheetPrice,
"worstCaseAdjustmentPoints": 987.65
}
WriteDisputeInput
Fields
| Input Field | Description |
|---|---|
kind - ApprovalProcessDisputeKind!
|
The dispute action being recorded. |
loanId - ID!
|
Loan application id where the dispute evidence will be written. |
reason - String
|
Rejection rationale for REJECTION. |
reasoning - String
|
Reasoning narrative for CHALLENGE and WAIVE. |
target - ID
|
Target requirement id for WAIVE. |
targetRef - ApprovalProcessEvidenceRefInput
|
Target assertion-edge ref for CHALLENGE and REJECTION. Unused for WAIVE. |
Example
{
"kind": "CHALLENGE",
"loanId": 4,
"reason": "xyz789",
"reasoning": "abc123",
"target": 4,
"targetRef": ApprovalProcessEvidenceRefInput
}
WriteDisputeResponse
Fields
| Field Name | Description |
|---|---|
evidence - Evidence!
|
The dispute act the write recorded. |
evidenceId - ID!
|
Id of the inserted dispute evidence row. Use evidence { id }.
|
warnings - [UnderwritingReviewWarning!]!
|
Non-fatal warnings about the write (the review verbs' warning vocabulary). Empty on a clean write. |
Example
{
"evidence": Evidence,
"evidenceId": "4",
"warnings": ["TARGET_SUPERSEDED"]
}
WriteReceiptKind
Description
How a field's current value reached the application: TRANSCRIPTION (an automatic reading landed it), HUMAN_EDIT (a person saved it), HUMAN_RESOLUTION (a person selected one evidenced candidate or supplied a value on their own authority, without cited evidence), or RETRACTION (a person re-typed the document the value was read from, so no reading backs it any more; the value is kept for a person to review).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HUMAN_EDIT"
ZeroToleranceFeeIncreasedReason
Description
§1026.19(e)(3)(i): an individual zero-tolerance charge increased.
Fields
| Field Name | Description |
|---|---|
currentAmount - MonetaryAmount!
|
|
disclosedAmount - MonetaryAmount!
|
|
fee - DisclosureDriftFeeIdentity!
|
|
increaseAmount - MonetaryAmount!
|
|
kind - DisclosureDriftReasonKind!
|
Example
{
"currentAmount": MonetaryAmount,
"disclosedAmount": MonetaryAmount,
"fee": DisclosureDriftFeeIdentity,
"increaseAmount": MonetaryAmount,
"kind": "APR_INACCURATE"
}