# Authentication
Source: https://dev.ownright.com/fundamentals/authentication

Learn how to authenticate with the Ownright Developer Platform

To use any Ownright API, you must authenticate each request with a set of headers that
identify your application and prove that the request is authorized. The authentication process
is simple and stateless — just supply three headers with each request.

## Overview

Every API request must include the following headers:

<ul>
  <li>`X-Ownright-Client-Id` - Identifies your registered API client</li>
  <li>`X-Ownright-API-Key` - Authenticates your request</li>

  <li>
    `X-Ownright-Organization-Id` - Specifies the Ownright platform organization
  </li>
</ul>

<Note>
  All three headers are required for every request, regardless of which API you
  are using.
</Note>

## Steps to obtain and use an API key

<Steps>
  <Step title="Register an API client">
    Contact the Ownright team ([developers@ownright.com](mailto:developers@ownright.com)) to register your application. Once registered, you'll
    receive a unique client ID. You must include this in the `X-Ownright-Client-Id` header
    in every request.

    <Info>Self-service client registration will be available soon.</Info>
  </Step>

  <Step title="Request an API key">
    Our team will issue one or more long-lived API keys tied to your API client record.
    These act like permanent access tokens. You must include the API key in the `X-Ownright-API-Key`
    header with every request.

    <Info>Treat your API keys like secrets — keep them out of client-side code and version control.</Info>
  </Step>

  <Step title="Add the organization ID">
    All requests must include a shared `X-Ownright-Organization-Id` header. This value is
    constant and identifies the core Ownright platform internally.

    We'll provide the correct value during onboarding. There is no need to manage or
    change this identifier.
  </Step>
</Steps>

### Sample request

Refer to the **Connecting** page in your API's reference section for the specific endpoint URL. Here's the general shape of a request:

```http theme={null}
POST /<api-path>/graphql HTTP/1.1
Host: api.ownright.com
X-Ownright-Client-Id: your-client-id
X-Ownright-API-Key: your-api-key
X-Ownright-Organization-Id: ownright-prod-org
Content-Type: application/json

{
  "query": "query { ... }"
}
```

## Security and key management

<ul>
  <li>API keys are tied to your business account and logged internally</li>
  <li>Store them securely — rotate if compromised</li>
  <li>Contact [developers@ownright.com](mailto:developers@ownright.com) to revoke or generate new keys</li>

  <li>
    Webhook signature verification is covered separately in the [Webhooks
    section](/fundamentals/webhooks)
  </li>
</ul>


# Errors and response codes
Source: https://dev.ownright.com/fundamentals/errors-and-response-codes

Understand how our server communicates error states

When working with the Ownright Developer Platform, errors can occur for a variety of reasons —
from invalid headers to malformed input. This page outlines how we communicate
those errors, how you can distinguish between different types, and how to get
help if something doesn't seem right.

## 🧭 Two types of errors

Our APIs use GraphQL, which means responses can contain both:

<ol>
  <li>GraphQL errors – for structural or authentication-level issues</li>

  <li>
    User errors – for problems with your request's input, like validation
    failures
  </li>
</ol>

### 1. GraphQL errors

These errors appear in the top-level errors array of the response. They are used to
communicate problems with the request itself — typically related to authorization,
malformed headers, or server-side issues.

#### Example

```json theme={null}
{
  "errors": [
    {
      "message": "Invalid request `X-Ownright-Client-ID` header, could not find registered API client.",
      "code": "INVALID_API_CLIENT"
    }
  ]
}
```

| Error Code              | HTTP Status | Description                                                              |
| ----------------------- | ----------- | ------------------------------------------------------------------------ |
| `INVALID_API_CLIENT`    | 403         | Used when the supplied `X-Ownright-Client-ID` header is invalid.         |
| `INVALID_TOKEN`         | 403         | Used when the supplied access or refresh token is invalid.               |
| `EXPIRED_TOKEN`         | 403         | Used when the supplied access or refresh token is expired.               |
| `BAD_REQUEST`           | 400         | Used when the request is incorrectly formatted.                          |
| `INTERNAL_SERVER_ERROR` | 500         | Used when there is a server error (likely a bug that needs to be fixed). |

<Note>
  When these errors occur, the HTTP status code of the response will reflect the
  issue (e.g. 403 Forbidden for an invalid token).
</Note>

### 2. User errors

User errors are returned inside the data object of a successful GraphQL response. These
indicate issues with the input provided — for example, a missing field or an invalid value.

```json theme={null}
{
  "data": {
    "purchaseReferralCreate": {
      "userErrors": [
        {
          "code": "INVALID_INPUT",
          "message": "Email must be a valid format."
        }
      ]
    }
  }
}
```

#### Handling user errors

<ul>
  <li>
    User errors do not result in a failed HTTP request. The status will be 200
    OK but the mutation will have no effect.
  </li>

  <li>
    Always check for `userErrors` in the response, especially when calling
    mutations.
  </li>
</ul>

You can build resilient integrations by displaying these error messages to your clients or logging them for review.

## 🏷️ Request ID for debugging

Every API response includes a `X-Request-Id` header. If you're seeing an unexpected error or behavior, please include this Request-Id when contacting support — it allows us to trace and investigate the request quickly.

```
X-Request-Id: req_8e9f2aa02189423d9b2a71e9c4b15e1d
```

## 🛠 Tips for working with errors

<ul>
  <li>
    Log GraphQL and user errors separately — they represent different classes of
    problems.
  </li>

  <li>
    Use GraphQL IDEs (e.g. Insomnia, GraphiQL) to catch schema errors before
    deployment.
  </li>

  <li>
    Always include a Request-Id when reporting issues to
    [developers@ownright.com](mailto:developers@ownright.com).
  </li>
</ul>


# GraphQL
Source: https://dev.ownright.com/fundamentals/graphql

The underlying technology that powers our platform

The Ownright Developer Platform is built using [GraphQL](https://graphql.org/), a modern query language for APIs that
gives you precise control over the data you request. While GraphQL may be less familiar
than traditional REST APIs, it unlocks a more flexible and efficient way to interact with
our platform.

## 🧠 What is GraphQL?

GraphQL is a query language and runtime for APIs originally developed by Facebook.
Unlike REST, which requires multiple endpoints for different data needs, GraphQL exposes
a single endpoint that allows clients to:

<ul>
  <li>Ask for exactly the data they need, and nothing more</li>
  <li>Retrieve nested, related data in a single request</li>

  <li>
    Use a strongly-typed schema to understand what's possible to query or mutate
  </li>
</ul>

All requests to our APIs are made as POST requests to a GraphQL endpoint.
Queries and mutations are written in the GraphQL syntax, and responses are returned in
predictable JSON format.

## 🚀 Why we chose GraphQL

We chose GraphQL because our integrators range from fast-moving startups to established platforms — all with different integration needs.

GraphQL gives your team:

<ul>
  <li>**Flexibility**: Fetch exactly the data you need—no more, no less.</li>

  <li>
    **Efficiency**: Minimize payload size and reduce over-fetching to improve
    performance.
  </li>

  <li>
    **Discoverability**: Explore the schema with introspection, enabling faster
    onboarding.
  </li>

  <li>
    **Scalability**: Confidently build on top of an API that evolves without
    breaking your integration.
  </li>
</ul>

Put simply: GraphQL helps you build faster, cleaner integrations that grow with your product.

## 🛠 GraphQL in action

Here's an example of a simple GraphQL query:

```graphql GraphQL query example theme={null}
query GetReferral {
  referral(id: "gid://ownright/Referral/1") {
    id
    kind
    status
    ...
    # other fields
    ...
    createdAt
    updatedAt
  }
}
```

And here's an example mutation:

```graphql GraphQL mutation example theme={null}
mutation CreatePurchaseReferral {
  purchaseReferralCreate(
    input: {
      address: {
        street: "123 Main St"
        city: "Toronto"
        # ... other input
      }
      # ... other input
    }
  ) {
    referral {
      id
      status
    }
  }
}
```

Each API has its own endpoint — refer to the **Connecting** page in your API's reference section for the specific URL.

## 📚 Learn more about GraphQL

If you're new to GraphQL or want to brush up your skills, here are some great resources:

<ul>
  <li>
    [graphql.org/learn](https://graphql.org/learn) – The official GraphQL
    introduction
  </li>

  <li>
    [How to GraphQL](https://www.howtographql.com/) – A free fullstack GraphQL
    tutorial
  </li>

  <li>
    [Apollo GraphQL Docs](https://www.apollographql.com/docs/) – For tooling,
    best practices, and client-side usage
  </li>

  <li>
    [Postman GraphQL
    Guide](https://learning.postman.com/docs/sending-requests/graphql/graphql-overview/)
    – GraphQL in familiar tools
  </li>
</ul>

## 💡 Developer tip

Many GraphQL clients (like [Insomnia](https://insomnia.rest/), [Postman](https://www.postman.com/), or [GraphiQL](https://github.com/graphql/graphiql))
offer built-in schema explorers. This lets you view available queries, mutations, and types without leaving your
dev environment.


# Pagination
Source: https://dev.ownright.com/fundamentals/pagination

For responses that return lists it's important to understand how we paginate

The Ownright Developer Platform uses the GraphQL "Connection" pattern for pagination —
a powerful and flexible way to request data in chunks while maintaining full control over
ordering and navigation.

If you're used to page and per\_page style pagination, this might feel different at first,
but it offers more precision and consistency — especially in real-time environments where
data can change frequently.

## 🔄 What are GraphQL connections?

Connections are a GraphQL pattern for handling lists of objects (like referrals or matters)
in a standardized way. Instead of simple arrays, connections return a structured object with:

**A list of edges, each containing:**

<ul>
  <li>A node (the item you care about)</li>
  <li>A cursor (a pointer used for pagination)</li>
</ul>

**A pageInfo object that helps you know:**

<ul>
  <li>If there's a `hasNextPage` or `hasPreviousPage`</li>
  <li>What the `startCursor` and `endCursor` are for the current page</li>
</ul>

This model helps avoid missing or duplicate items when new data is created during pagination.

## 📦 Example paginated query

Let's say you want to fetch a list of items, 10 at a time:

```graphql theme={null}
query FetchMatters {
  matters(first: 10) {
    edges {
      node {
        id
        kind
        ...
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
```

When you get the response, you'll receive a list of items, and if `hasNextPage` is true,
you can request the next page using the `endCursor`:

```graphql theme={null}
query FetchMoreMatters {
  matters(first: 10, after: "cursor_from_previous_page") {
    ...
  }
}
```

This gives you cursor-based pagination, which is more reliable than
offset-based pagination when the data is constantly changing.

## 🧠 Common use cases

Here are a few common ways to use connections:

<ul>
  <li>List all records using a query with `first: N` and pagination</li>
  <li>Build an activity feed by scrolling through updates</li>
  <li>Export historical data one page at a time for internal reporting</li>
  <li>Sync new records incrementally by storing the last cursor you've seen</li>
</ul>

## 📚 Learn more about GraphQL connections

If you're new to GraphQL pagination, here are some great resources:

<ul>
  <li>
    [GraphQL Cursor Connections
    Specification](https://relay.dev/graphql/connections.htm) – the original
    spec
  </li>

  <li>
    [Apollo Pagination
    Docs](https://www.apollographql.com/docs/react/pagination/overview/) –
    practical client-side usage
  </li>

  <li>
    [Hasura Pagination Primer](https://hasura.io/learn/graphql/pagination/) –
    friendly intro with visual examples
  </li>
</ul>

## 💡 Tips for implementation

<ul>
  <li>Always check `pageInfo.hasNextPage` before paginating</li>

  <li>
    Don't assume cursors are sequential strings — treat them as opaque tokens
  </li>

  <li>Use cursors to resume pagination if a sync job is interrupted</li>

  <li>
    Avoid using GraphQL offset or skip patterns — they're not supported in our
    APIs
  </li>
</ul>


# Rate limits
Source: https://dev.ownright.com/fundamentals/rate-limits

Understand the protections we have in place to protect our platform

<Note>
  We are in the early stages of rolling out rate limits. No rate limits are currently
  enforced, but we are monitoring usage patterns and will implement fair-use protections soon.
  When enforcement is introduced, this page will be updated to reflect:

  <ul>
    <li>The exact request limits per minute/hour</li>
    <li>Which endpoints or operations are affected</li>
    <li>How to identify when you're being throttled</li>
    <li>How to handle rate limit errors gracefully</li>
  </ul>
</Note>

To ensure reliability and fairness across all integrators, the Ownright Developer
Platform implements rate limiting — a set of controls that prevent any one client
from overwhelming the system.

These limits help us maintain:

<ul>
  <li>✅ Fast and consistent performance for all integrators</li>
  <li>🔐 Protection against accidental or malicious overuse</li>
  <li>📈 Platform scalability as usage grows</li>
</ul>

## 🧠 How to handle rate limits (future)

When limits are enforced, you'll receive a `429 Too Many Requests` response if you exceed them.
We will include headers like:

| Header                           | HTTP Status                               |
| -------------------------------- | ----------------------------------------- |
| `Retry-After`                    | Number of seconds to wait before retrying |
| `X-Ownright-RateLimit-Limit`     | Your current rate limit                   |
| `X-Ownright-RateLimit-Remaining` | How many requests you have left           |
| `X-Ownright-RateLimit-Reset`     | Timestamp when the limit resets           |

Your app should monitor these headers and implement backoff logic where possible.

<Note>Limits apply per API client, not globally across all integrators.</Note>

## 💬 Need higher limits?

If you expect higher volume or have batch processing needs, reach out to our team ([developers@ownright.com](mailto:developers@ownright.com)).
We're happy to review your use case and adjust limits accordingly.

## 🔒 Reminder

Even in the absence of hard limits, we log and monitor usage to ensure platform health.
Please avoid excessive polling and always use webhooks for real-time updates.


# Webhooks
Source: https://dev.ownright.com/fundamentals/webhooks

Enable real time updates in your system by using our webhooks

Webhooks allow Ownright to proactively notify your system when important events happen —
without requiring you to constantly poll the API. They're the best way to keep your platform
in sync with activity on the Ownright platform as it evolves in real time.

## 🔔 What are webhooks?

A webhook is a lightweight HTTP request sent from Ownright to your server when a specific
event occurs. For example, when a referral is converted into a matter, you'll receive a
webhook event immediately — no need to poll for updates.

Webhooks enable:

<ul>
  <li>Real-time updates to your internal systems</li>
  <li>Triggering business logic or workflows (e.g. status sync, UI changes)</li>
  <li>Scalable and event-driven integrations</li>
</ul>

## 🎯 Why we use webhooks

Real estate transactions move fast. Webhooks help you:

<ul>
  <li>Stay informed the moment something progresses</li>
  <li>Automatically update client records or timelines</li>
  <li>Reduce polling overhead and keep your app performant</li>
</ul>

## 📬 Webhook subscriptions

To get started with webhooks you will need to create a "webhook subscription".
Webhook subscriptions allow you to register your server to receive specific events.

Each subscription includes:

<ul>
  <li>A callback URL: The endpoint Ownright will send events to</li>
  <li>A list of event types the URL should receive</li>
  <li>A webhook secret used to verify authenticity</li>
</ul>

### Registering a webhook subscription

Webhook subscriptions are registered via the API. Refer to your API's reference section for the specific mutations available.

When creating a subscription, Ownright will:

<ol>
  <li>Generate a verification token</li>
  <li>Send an HTTP POST request to your callback URL with the token</li>
  <li>Expect a response with the same token in the body</li>
</ol>

If verification succeeds, the webhook subscription will be created and your
callback URL will begin to receive events.

#### Verification example

**Request sent by Ownright:**

```http theme={null}
POST /your/callback/url HTTP/1.1
Content-Type: application/json
X-Ownright-Webhook-Signature: signature
X-Ownright-Webhook-Timestamp: timestamp

{
  "verification_token": "abc123"
}
```

**Expected response from your server:**

```http theme={null}
{
  "verification_token": "abc123"
}
```

## 📦 Receiving webhook events

When an event occurs, we send an HTTP POST request to your callback URL with a JSON payload.

| Header                         | HTTP Status                                               |
| ------------------------------ | --------------------------------------------------------- |
| `X-Ownright-Webhook-Signature` | HMAC SHA256 signature of the request                      |
| `X-Ownright-Webhook-Timestamp` | Timestamp of the request (used to prevent replay attacks) |

### Verifying the webhook

To confirm that a webhook request is legitimate:

<ol>
  <li>
    Concatenate: `"{timestamp}.{raw_request_body}"`
  </li>

  <li>Hash it using `HMAC SHA256` with your webhook secret</li>
  <li>Compare the result to the value in `X-Ownright-Webhook-Signature`</li>
</ol>

If they match, the event is authentic.

<Note>
  Tip: You can also use the timestamp to reject requests that are too old (e.g.,
  more than 5 minutes) to guard against replay attacks.
</Note>

## 🗂 Supported events

The specific events available depend on which API you are using. Refer to the **Webhooks** section in your API's reference for the full list of supported events and their schemas.

## 💡 Best practices

<ul>
  <li>
    Respond with a 2xx status code within 5 seconds to acknowledge receipt
  </li>

  <li>
    Retry logic is built in — failed deliveries will be retried with exponential
    backoff
  </li>

  <li>Your webhook URL should be HTTPS and publicly accessible</li>
  <li>Always verify webhook signatures for security</li>
</ul>


# Introduction
Source: https://dev.ownright.com/introduction

Welcome to the Ownright Developer Platform documentation

<img alt="Ownright Developer Platform Introduction" />

<img alt="Ownright Developer Platform Introduction" />

Welcome to the **Ownright Developer Platform** — a suite of APIs and tools that enable
companies to deliver exceptional residential real estate closing experiences for their clients.
Our platform is designed to give you secure, programmatic access to key Ownright services so
you can integrate legal workflows directly into your product.

## Our APIs

<CardGroup>
  <Card title="Partner API" icon="handshake" href="/partner-api/overview">
    For proptech companies to make referrals, track matters, and receive webhook
    updates as closings progress.
  </Card>

  <Card title="Lender API" icon="building-columns" href="/lender-api/overview">
    For lenders to interact with Ownright's platform and streamline their real
    estate legal workflows.
  </Card>
</CardGroup>

## Learn more

<CardGroup>
  <Card title="Limitations" icon="circle-info" href="/limitations">
    Understand the current scope and limitations of the Ownright Developer
    Platform.
  </Card>

  <Card title="Support and feedback" icon="headset" href="/support-feedback">
    Get in touch with our team for help or to share feedback.
  </Card>
</CardGroup>


# Engagements
Source: https://dev.ownright.com/lender-api/core-concepts/engagements

The foundational object representing a real estate legal file in the Lender API

An **engagement** is the core object in the Lender API. It represents a real estate legal file
that Ownright manages on behalf of your lending organization. When you submit a new file through
the API, you're creating an engagement that our legal team will open, work on, and close.

## Types of engagements

The Lender API supports two types of engagements, each corresponding to a different kind of
real estate transaction:

<ol>
  <li>
    **Purchase** — A transaction where your borrower is purchasing a property.
    Created using the `purchase` field on `EngagementCreateInput`.
  </li>

  <li>
    **Refinance** — A transaction where your borrower is refinancing an existing
    mortgage on their property. Created using the `refinance` field on
    `EngagementCreateInput`.
  </li>
</ol>

Both types share a common set of fields through the `Engagement` interface (such as `id`,
`clients`, `owner`, and `type`), but each has its own status model and type-specific fields
like `property` and `closingDate`.

## Engagement lifecycle

Every engagement follows a predictable lifecycle from the moment it's received to when
the transaction is fully closed (or cancelled). The diagram below illustrates the typical
progression:

<img alt="Engagement Lifecycle Light" />

<img alt="Engagement Lifecycle Dark" />

### Engagement states

Both purchase and refinance engagements share the same set of states:

<ol>
  <li>
    **Received** — Ownright has received engagement details and is actively
    reviewing the information.
  </li>

  <li>
    **Setting up** — Ownright is actively setting up the engagement to begin
    closing preparation.
  </li>

  <li>
    **In progress** — The engagement is actively being worked on by the Ownright
    legal team.
  </li>

  <li>
    **Preparing for closing** — The engagement is being prepared for closing
    day. Documents are being reviewed, title work is underway, and the legal
    team is coordinating with all parties.
  </li>

  <li>
    **Closing in progress** — Final closing actions are in motion and the deal
    is set to close today.
  </li>

  <li>**Closed** — The engagement has been successfully funded and closed.</li>

  <li>
    **Complete** — All post-closing tasks have been finalized and the engagement
    is fully complete.
  </li>

  <li>
    **Cancelled** — The engagement has been cancelled and is no longer being
    worked on. This can happen at any point in the lifecycle.
  </li>
</ol>

<Info>
  The `status` field on `PurchaseEngagement` and `RefinanceEngagement` is an
  interface (`PurchaseEngagementStatus` / `RefinanceEngagementStatus`) that
  contains a `state` enum. Use inline fragments to access the state — see the
  [Fetching engagement details](/lender-api/guides/fetching-engagement-details)
  guide for examples.
</Info>

## Key related objects

Each engagement is associated with several important objects:

* **EngagementClient** — The borrower(s) on the engagement. Each client has a `firstName`,
  `lastName`, `email`, and optional `middleName` and `phoneNumber`.
* **Property** — The real estate property involved in the transaction. Contains an `Address`
  with the full street address, city, province, and postal code.
* **TeamMember** — The person within your lending organization who owns the engagement.
  The `owner` field on an engagement displays this team member's name. See the
  [Lender and team members](/lender-api/core-concepts/lender-and-team-members) core concept
  for more details.

## Next steps

Now that you understand engagements, you're ready to start working with them:

<CardGroup>
  <Card title="Lender and team members" icon="users" href="/lender-api/core-concepts/lender-and-team-members">
    Learn about your organization and team member objects.
  </Card>

  <Card title="Creating an engagement" icon="plus" href="/lender-api/guides/creating-an-engagement">
    Learn how to submit a new file to Ownright through the API.
  </Card>

  <Card title="Searching engagements" icon="magnifying-glass" href="/lender-api/guides/searching-engagements">
    Filter, sort, and paginate through your engagements.
  </Card>

  <Card title="Fetching engagement details" icon="file-lines" href="/lender-api/guides/fetching-engagement-details">
    Retrieve detailed information about a specific engagement.
  </Card>

  <Card title="File uploads" icon="upload" href="/lender-api/guides/file-uploads">
    Understand the staged file upload flow for attaching documents.
  </Card>
</CardGroup>


# Lender and team members
Source: https://dev.ownright.com/lender-api/core-concepts/lender-and-team-members

Your organization and the people within it — the account-level objects in the Lender API

Before creating engagements, it's important to understand the two account-level objects
that represent your organization and its users within the Ownright platform.

## The Lender object

The `Lender` type represents your authenticated lending organization. Think of it as the
"who am I?" object — it tells you about the organization that the current API credentials
belong to.

You can retrieve your lender information using the `lender` query:

```graphql theme={null}
query GetLender {
  lender {
    name
    logoUrl
    members {
      id
      firstName
      lastName
      email
    }
  }
}
```

The response includes:

* **name** — Your organization's name as registered with Ownright.
* **logoUrl** — A URL to your organization's logo, if one has been uploaded.
* **members** — The full list of team members in your organization (see below).

## Team members

A `TeamMember` represents an individual user within your lending organization. Team members
are the people who own and manage engagements on your side.

Each team member has:

| Field       | Type             | Description                     |
| ----------- | ---------------- | ------------------------------- |
| `id`        | `TeamMemberGID!` | Unique identifier in GID format |
| `firstName` | `String`         | The team member's first name    |
| `lastName`  | `String`         | The team member's last name     |
| `email`     | `String`         | The team member's email address |

You can also fetch team members directly using the top-level `teamMembers` query:

```graphql theme={null}
query ListTeamMembers {
  teamMembers {
    id
    firstName
    lastName
    email
  }
}
```

**Sample response:**

```json theme={null}
{
  "data": {
    "teamMembers": [
      {
        "id": "gid://ownright/TeamMember/1",
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "jane.smith@examplelender.com"
      },
      {
        "id": "gid://ownright/TeamMember/2",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@examplelender.com"
      }
    ]
  }
}
```

## How they relate to engagements

When you create an engagement, you must assign an **owner** — this is the team member
responsible for the file on your side. The `owner` field on `PurchaseEngagementCreateInput`
and `RefinanceEngagementCreateInput` requires a `TeamMemberGID`.

<img alt="Lender and Team Members Relationship" />

<img alt="Lender and Team Members Relationship" />

This means you'll typically want to fetch your team members first to get valid owner IDs
before creating engagements.

<Warning>
  If you pass a `TeamMemberGID` that doesn't belong to your organization, the
  `engagementCreate` mutation will return a `TEAM_MEMBER_NOT_FOUND` error.
</Warning>

## Practical workflow

A common pattern when integrating with the Lender API:

<Steps>
  <Step title="Fetch your team members">
    Call the `teamMembers` query to get the list of people in your organization.
    Cache these IDs in your system so you can assign owners when creating
    engagements.
  </Step>

  <Step title="Map team members to your internal users">
    Match each `TeamMemberGID` to the corresponding user in your system — for
    example, by email address. This allows your internal workflows to
    automatically assign the correct owner.
  </Step>

  <Step title="Use the owner ID when creating engagements">
    Pass the `TeamMemberGID` as the `owner` field in your `engagementCreate`
    mutation. See the [Creating an
    engagement](/lender-api/guides/creating-an-engagement) guide for a full
    walkthrough.
  </Step>
</Steps>

## Next steps

<CardGroup>
  <Card title="Creating an engagement" icon="plus" href="/lender-api/guides/creating-an-engagement">
    Submit your first real estate file to Ownright through the API.
  </Card>

  <Card title="Searching engagements" icon="magnifying-glass" href="/lender-api/guides/searching-engagements">
    Filter, sort, and paginate through your engagements.
  </Card>
</CardGroup>


# Cancelling an engagement
Source: https://dev.ownright.com/lender-api/guides/cancelling-an-engagement

How to cancel an engagement that is no longer needed

If an engagement is no longer needed — for example, the deal fell through or was submitted
in error — you can cancel it using the `engagementCancel` mutation.

## Which engagements can be cancelled?

Currently, an engagement can only be cancelled when it is in the **Received** or
**Setting up** state.

<Info>
  Support for cancelling engagements in additional states is planned for a
  future release. Check back for updates.
</Info>

You can check whether a specific engagement is cancellable by querying the `cancellable`
field:

```graphql theme={null}
query CheckCancellable($id: EngagementGID!) {
  engagement(id: $id) {
    ... on PurchaseEngagement {
      id
      cancellable
      status {
        state
      }
    }
    ... on RefinanceEngagement {
      id
      cancellable
      status {
        state
      }
    }
  }
}
```

If `cancellable` is `true`, you can proceed with the cancellation.

## Cancelling an engagement

<Steps>
  <Step title="Verify the engagement is cancellable">
    Query the engagement and check that `cancellable` returns `true`. If the engagement
    has already progressed past the Setting up state, the cancellation will be rejected.
  </Step>

  <Step title="Send the cancel mutation">
    Call `engagementCancel` with the engagement's GID:

    ```graphql Request theme={null}
    mutation CancelEngagement($id: EngagementGID!) {
      engagementCancel(id: $id) {
        engagement {
          ... on PurchaseEngagement {
            id
            shortId
            cancellable
            status {
              state
            }
          }
          ... on RefinanceEngagement {
            id
            shortId
            cancellable
            status {
              state
            }
          }
        }
        userErrors {
          code
          field
          message
        }
      }
    }
    ```

    **Variables:**

    ```json Variables theme={null}
    {
      "id": "gid://ownright/Engagement/42"
    }
    ```
  </Step>

  <Step title="Handle the response">
    On success, the engagement is returned with its status set to **Cancelled**:

    ```json Successful response [expandable] theme={null}
    {
      "data": {
        "engagementCancel": {
          "engagement": {
            "id": "gid://ownright/Engagement/42",
            "shortId": "ENG-42",
            "cancellable": false,
            "status": {
              "state": "CANCELLED"
            }
          },
          "userErrors": []
        }
      }
    }
    ```

    If the engagement cannot be cancelled, the `userErrors` array will contain the
    reason:

    ```json Error response [expandable] theme={null}
    {
      "data": {
        "engagementCancel": {
          "engagement": null,
          "userErrors": [
            {
              "code": "ENGAGEMENT_NOT_CANCELLABLE",
              "field": ["id"],
              "message": "The specified engagement cannot be cancelled."
            }
          ]
        }
      }
    }
    ```
  </Step>
</Steps>

## Error codes

The `engagementCancel` mutation can return the following error codes:

| Code                         | Description                                                           |
| ---------------------------- | --------------------------------------------------------------------- |
| `ENGAGEMENT_NOT_CANCELLABLE` | The engagement is not in a state that allows cancellation             |
| `ENGAGEMENT_NOT_FOUND`       | The specified `EngagementGID` does not exist or you don't have access |

<Warning>
  Cancellation is irreversible. Once an engagement is cancelled, it cannot be
  reopened. Make sure you confirm the cancellation with the appropriate
  stakeholders before proceeding.
</Warning>

## Next steps

<CardGroup>
  <Card title="File uploads" icon="upload" href="/lender-api/guides/file-uploads">
    Learn the staged upload flow for attaching mortgage documents.
  </Card>

  <Card title="API Reference" icon="code" href="/lender-api/reference/connecting">
    Explore all queries, mutations, and types available in the Lender API.
  </Card>
</CardGroup>


# Creating an engagement
Source: https://dev.ownright.com/lender-api/guides/creating-an-engagement

A step-by-step guide to submitting a new real estate file to Ownright

To create an engagement, use the `engagementCreate` mutation. This allows you to submit
a new real estate legal file to Ownright for either a purchase or refinance transaction.

## Understanding `@oneOf`

The `EngagementCreateInput` uses the `@oneOf` directive, which means you must provide
**exactly one** of the type-specific inputs:

* `purchase` — for a purchase engagement
* `refinance` — for a refinance engagement

You cannot supply both at the same time. This pattern ensures the engagement is created
with the correct type-specific fields.

## Steps to create an engagement

<Steps>
  <Step title="Choose the engagement type">
    Decide whether you're creating a **purchase** or **refinance** engagement. This
    determines which input field you'll use:

    | Engagement type | Input field | Input type                       |
    | --------------- | ----------- | -------------------------------- |
    | Purchase        | `purchase`  | `PurchaseEngagementCreateInput`  |
    | Refinance       | `refinance` | `RefinanceEngagementCreateInput` |

    Both input types share the same set of fields: `clients`, `closingDate`, `owner`,
    `newMortgageFileIds`, `newMortgageNumber`, `notes`, and `propertyAddress`.
  </Step>

  <Step title="Gather the required information">
    Before constructing the mutation, make sure you have:

    * **Owner** — A `TeamMemberGID` for the team member who will own this engagement.
      See [Lender and team members](/lender-api/core-concepts/lender-and-team-members)
      for how to fetch these.
    * **At least one client** — Each client needs a `firstName`, `lastName`, and `email`.
      Phone number and middle name are optional.
    * **Closing date** — The expected closing date in ISO 8601 format (e.g., `2025-09-15`).
    * **Mortgage files** (if any) — Upload documents first using the
      [staged file upload flow](/lender-api/guides/file-uploads), then pass the
      resulting `FileRecordGID` values.
  </Step>

  <Step title="Construct and send the mutation">
    Here's a complete example for creating a purchase engagement:

    ```graphql Request [expandable] theme={null}
    mutation CreatePurchaseEngagement($input: EngagementCreateInput!) {
      engagementCreate(input: $input) {
        engagement {
          ... on PurchaseEngagement {
            id
            shortId
            type
            closingDate
            owner
            clients {
              firstName
              lastName
              email
            }
            property {
              address {
                street
                city
                province
                postalCode
              }
            }
            status {
              state
            }
          }
        }
        userErrors {
          code
          field
          message
        }
      }
    }
    ```

    **Variables:**

    ```json Variables [expandable] theme={null}
    {
      "input": {
        "purchase": {
          "owner": "gid://ownright/TeamMember/1",
          "closingDate": "2025-09-15",
          "clients": [
            {
              "firstName": "Jane",
              "lastName": "Doe",
              "email": "jane.doe@example.com",
              "phoneNumber": "+14165551234"
            }
          ],
          "propertyAddress": {
            "street": "123 Main Street",
            "unitNumber": "Unit 4B",
            "city": "Toronto",
            "province": "ONTARIO",
            "postalCode": "M5V 2T6",
            "country": "CANADA"
          },
          "newMortgageNumber": "MTG-2025-001",
          "newMortgageFileIds": [],
          "notes": "Client prefers email communication."
        }
      }
    }
    ```

    <Note>
      To create a refinance engagement instead, use the `refinance` key in the input
      with a `RefinanceEngagementCreateInput`. The fields are identical.
    </Note>
  </Step>

  <Step title="Handle the response">
    On success, the response includes the newly created engagement:

    ```json Successful response [expandable] theme={null}
    {
      "data": {
        "engagementCreate": {
          "engagement": {
            "id": "gid://ownright/Engagement/42",
            "shortId": "ENG-42",
            "type": "PURCHASE",
            "closingDate": "2025-09-15",
            "owner": "Jane Smith",
            "clients": [
              {
                "firstName": "Jane",
                "lastName": "Doe",
                "email": "jane.doe@example.com"
              }
            ],
            "property": {
              "address": {
                "street": "123 Main Street",
                "city": "Toronto",
                "province": "ONTARIO",
                "postalCode": "M5V 2T6"
              }
            },
            "status": {
              "state": "RECEIVED"
            }
          },
          "userErrors": []
        }
      }
    }
    ```

    If something goes wrong, check the `userErrors` array:

    ```json Error response [expandable] theme={null}
    {
      "data": {
        "engagementCreate": {
          "engagement": null,
          "userErrors": [
            {
              "code": "TEAM_MEMBER_NOT_FOUND",
              "field": ["input", "purchase", "owner"],
              "message": "The specified team member could not be found."
            }
          ]
        }
      }
    }
    ```
  </Step>
</Steps>

## Error codes

The `engagementCreate` mutation can return the following error codes:

| Code                       | Description                                                      |
| -------------------------- | ---------------------------------------------------------------- |
| `INVALID_ENGAGEMENT_INPUT` | The engagement input is invalid (e.g., missing required fields)  |
| `TEAM_MEMBER_NOT_FOUND`    | The specified `TeamMemberGID` doesn't exist in your organization |
| `FILE_RECORD_NOT_FOUND`    | A `FileRecordGID` in `newMortgageFileIds` could not be found     |
| `FILE_RECORD_NOT_STAGED`   | A file record hasn't been uploaded yet via the staged upload URL |

## Tips

<ul>
  <li>
    Always fetch your team members first so you have valid `TeamMemberGID`
    values to assign as owners.
  </li>

  <li>
    If you need to attach mortgage documents, complete the [file upload
    flow](/lender-api/guides/file-uploads) before calling `engagementCreate`.
  </li>

  <li>
    The `newMortgageFileIds` array can be empty if you don't have documents to
    attach at creation time.
  </li>

  <li>New engagements always start in the **Received** state.</li>
</ul>

## Next steps

<CardGroup>
  <Card title="Searching engagements" icon="magnifying-glass" href="/lender-api/guides/searching-engagements">
    Filter, sort, and paginate through your engagements.
  </Card>

  <Card title="File uploads" icon="upload" href="/lender-api/guides/file-uploads">
    Learn the staged upload flow for attaching mortgage documents.
  </Card>
</CardGroup>


# Fetching engagement details
Source: https://dev.ownright.com/lender-api/guides/fetching-engagement-details

How to retrieve detailed information about a specific engagement

To retrieve information about a specific engagement, use the `engagement` query with
the engagement's GID. Since the `Engagement` type is an interface implemented by
`PurchaseEngagement` and `RefinanceEngagement`, you'll use inline fragments to access
type-specific fields.

## Fetching a single engagement

Use the `engagement(id: EngagementGID!)` query to retrieve details about one engagement:

```graphql Request theme={null}
query GetEngagementDetails($id: EngagementGID!) {
  engagement(id: $id) {
    ... on PurchaseEngagement {
      id
      shortId
      type
      closingDate
      owner
      createdAt
      clients {
        firstName
        lastName
        email
        phoneNumber
      }
      property {
        address {
          street
          unitNumber
          city
          province
          postalCode
          country
        }
      }
      status {
        state
      }
    }
    ... on RefinanceEngagement {
      id
      shortId
      type
      closingDate
      owner
      createdAt
      clients {
        firstName
        lastName
        email
        phoneNumber
      }
      property {
        address {
          street
          unitNumber
          city
          province
          postalCode
          country
        }
      }
      status {
        state
      }
    }
  }
}
```

**Variables:**

```json Variables theme={null}
{
  "id": "gid://ownright/Engagement/42"
}
```

**Sample response:**

```json Response [expandable] theme={null}
{
  "data": {
    "engagement": {
      "id": "gid://ownright/Engagement/42",
      "shortId": "ENG-42",
      "type": "PURCHASE",
      "closingDate": "2025-09-15",
      "owner": "Jane Smith",
      "createdAt": "2025-08-01T14:30:00Z",
      "clients": [
        {
          "firstName": "Jane",
          "lastName": "Doe",
          "email": "jane.doe@example.com",
          "phoneNumber": "+14165551234"
        }
      ],
      "property": {
        "address": {
          "street": "123 Main Street",
          "unitNumber": "Unit 4B",
          "city": "Toronto",
          "province": "ONTARIO",
          "postalCode": "M5V 2T6",
          "country": "CANADA"
        }
      },
      "status": {
        "state": "PREPARING_FOR_CLOSING"
      }
    }
  }
}
```

## Understanding inline fragments

Since the `engagement` query returns the `Engagement` interface, you need inline fragments
to access the concrete type's fields. The interface provides a common set of fields
(`id`, `shortId`, `type`, `owner`, `clients`, `createdAt`), but type-specific fields
like `closingDate`, `property`, and `status` are only available on the concrete types.

```graphql theme={null}
{
  engagement(id: "gid://ownright/Engagement/42") {
    # Fields from the Engagement interface (available on all types)
    id
    shortId
    type
    owner

    # Type-specific fields require inline fragments
    ... on PurchaseEngagement {
      closingDate
      property {
        address {
          street
          city
        }
      }
      status {
        state
      }
    }
    ... on RefinanceEngagement {
      closingDate
      property {
        address {
          street
          city
        }
      }
      status {
        state
      }
    }
  }
}
```

<Info>
  The `status` field is itself an interface with multiple concrete status types
  (one per state). Each status type currently exposes a `state` field, but this
  pattern allows for additional status-specific fields to be added in the future
  without breaking changes.
</Info>

## Handling a null response

If the engagement ID doesn't exist or you don't have access to it, the query returns
`null`:

```json theme={null}
{
  "data": {
    "engagement": null
  }
}
```

Make sure your integration handles this case gracefully.

## Next steps

<CardGroup>
  <Card title="Cancelling an engagement" icon="ban" href="/lender-api/guides/cancelling-an-engagement">
    Learn how to cancel an engagement that is no longer needed.
  </Card>

  <Card title="File uploads" icon="upload" href="/lender-api/guides/file-uploads">
    Learn the staged upload flow for attaching mortgage documents.
  </Card>
</CardGroup>


# File uploads
Source: https://dev.ownright.com/lender-api/guides/file-uploads

How to upload mortgage documents using the staged file upload flow

The Lender API uses a **staged file upload** pattern to securely handle document uploads.
Rather than sending file data directly through the GraphQL API, you first create a staged
upload to get a signed URL, upload the file to that URL, and then reference the staged file
when creating an engagement.

## The 3-step upload flow

<img alt="Staged File Upload Flow" />

<img alt="Staged File Upload Flow" />

<Steps>
  <Step title="Create a staged file upload">
    Call the `stagedFileUploadCreate` mutation with the filename and MIME type of the
    document you want to upload:

    ```graphql Request theme={null}
    mutation CreateStagedUpload($input: StagedFileUploadInput!) {
      stagedFileUploadCreate(input: $input) {
        stagedFileUpload {
          file {
            id
            filename
            staged
          }
          signedUploadUrl
          signedUploadUrlExpiryDate
        }
        userErrors {
          code
          field
          message
        }
      }
    }
    ```

    **Variables:**

    ```json Variables theme={null}
    {
      "input": {
        "filename": "mortgage-commitment-letter.pdf",
        "mimeType": "DOCUMENT_PDF"
      }
    }
    ```

    **Response:**

    ```json Response [expandable] theme={null}
    {
      "data": {
        "stagedFileUploadCreate": {
          "stagedFileUpload": {
            "file": {
              "id": "gid://ownright/FileRecord/123",
              "filename": "mortgage-commitment-letter.pdf",
              "staged": true
            },
            "signedUploadUrl": "https://storage.example.com/uploads/abc123?signature=xyz",
            "signedUploadUrlExpiryDate": "2025-09-01T15:00:00Z"
          },
          "userErrors": []
        }
      }
    }
    ```

    <Warning>
      The `signedUploadUrl` expires at the date/time indicated by
      `signedUploadUrlExpiryDate`. Make sure you upload the file before this time,
      or you'll need to create a new staged upload.
    </Warning>
  </Step>

  <Step title="Upload the file to the signed URL">
    Use an HTTP `PUT` request to upload the file binary to the `signedUploadUrl`
    returned in step 1. Set the `Content-Type` header to match the file's MIME type:

    ```bash theme={null}
    curl -X PUT \
      -H "Content-Type: application/pdf" \
      --data-binary @mortgage-commitment-letter.pdf \
      "https://storage.example.com/uploads/abc123?signature=xyz"
    ```

    <Note>
      This is a direct upload to the storage service — it does not go through the
      GraphQL API and does not require your API authentication headers.
    </Note>
  </Step>

  <Step title="Pass the file to an engagement">
    Once the file is uploaded, use the `FileRecordGID` (the `id` from step 1) in
    the `newMortgageFileIds` array when creating an engagement:

    ```graphql Request theme={null}
    mutation CreateEngagementWithFiles($input: EngagementCreateInput!) {
      engagementCreate(input: $input) {
        engagement {
          ... on PurchaseEngagement {
            id
            shortId
          }
        }
        userErrors {
          code
          field
          message
        }
      }
    }
    ```

    ```json Variables [expandable] theme={null}
    {
      "input": {
        "purchase": {
          "owner": "gid://ownright/TeamMember/1",
          "closingDate": "2025-09-15",
          "clients": [
            {
              "firstName": "Jane",
              "lastName": "Doe",
              "email": "jane.doe@example.com"
            }
          ],
          "newMortgageFileIds": [
            "gid://ownright/FileRecord/123"
          ],
          "propertyAddress": {
            "street": "123 Main Street",
            "city": "Toronto",
            "province": "ONTARIO",
            "postalCode": "M5V 2T6",
            "country": "CANADA"
          }
        }
      }
    }
    ```
  </Step>
</Steps>

## Uploading multiple files

You can upload multiple files by repeating steps 1 and 2 for each file, then passing
all of the `FileRecordGID` values in the `newMortgageFileIds` array:

```json theme={null}
{
  "newMortgageFileIds": [
    "gid://ownright/FileRecord/123",
    "gid://ownright/FileRecord/124",
    "gid://ownright/FileRecord/125"
  ]
}
```

## Supported MIME types

The `FileMimeType` enum defines the file types you can upload:

| Enum value      | MIME type                                                                  | Description    |
| --------------- | -------------------------------------------------------------------------- | -------------- |
| `DOCUMENT_PDF`  | `application/pdf`                                                          | PDF documents  |
| `DOCUMENT_DOC`  | `application/msword`                                                       | Word documents |
| `DOCUMENT_DOCX` | `application/vnd.openxmlformats-officedocument.wordprocessingml.documents` | Word documents |
| `IMAGE_JPEG`    | `image/jpeg`                                                               | JPEG images    |
| `IMAGE_PNG`     | `image/png`                                                                | PNG images     |
| `IMAGE_HEIC`    | `image/heic`                                                               | HEIC images    |
| `IMAGE_TIFF`    | `image/tiff`                                                               | TIFF images    |

## Error handling

### Staged upload errors

The `stagedFileUploadCreate` mutation can return:

| Code               | Description                                     |
| ------------------ | ----------------------------------------------- |
| `INVALID_FILENAME` | The supplied filename is invalid or unsupported |

### Engagement creation errors (file-related)

When passing file IDs to `engagementCreate`, you may encounter:

| Code                     | Description                                                  |
| ------------------------ | ------------------------------------------------------------ |
| `FILE_RECORD_NOT_FOUND`  | A `FileRecordGID` in `newMortgageFileIds` could not be found |
| `FILE_RECORD_NOT_STAGED` | The file hasn't been uploaded to the signed URL yet          |

<Info>
  The `FILE_RECORD_NOT_STAGED` error means you created the staged upload (step

  1. but haven't completed the actual file upload (step 2) before trying to use
     the file in step 3. Make sure the HTTP PUT to the signed URL completes
     successfully before referencing the file.
</Info>

## Next steps

<CardGroup>
  <Card title="API Reference" icon="code" href="/lender-api/reference/connecting">
    Explore all queries, mutations, and types available in the Lender API.
  </Card>

  <Card title="Changelog" icon="clock-rotate-left" href="/lender-api/reference/changelog">
    Stay up to date with changes to the Lender API.
  </Card>
</CardGroup>


# Searching engagements
Source: https://dev.ownright.com/lender-api/guides/searching-engagements

How to filter, sort, search, and paginate through your engagements

The `engagements` query provides a powerful way to list and search through all of your
engagements. It supports filtering, text search, sorting, and cursor-based pagination.

## Basic paginated list

To retrieve a simple paginated list of engagements, use the `first` argument to specify
how many results you want:

```graphql theme={null}
query ListEngagements {
  engagements(first: 10) {
    edges {
      cursor
      node {
        ... on PurchaseEngagement {
          id
          shortId
          type
          closingDate
          owner
          status {
            state
          }
        }
        ... on RefinanceEngagement {
          id
          shortId
          type
          closingDate
          owner
          status {
            state
          }
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
```

## Filtering

Use the `filters` argument with an `EngagementSearchFilterInput` to narrow down results.
All filter fields are optional and can be combined:

### By status

```graphql theme={null}
query ActiveEngagements {
  engagements(
    first: 20
    filters: { statuses: [RECEIVED, SETTING_UP, PREPARING_FOR_CLOSING] }
  ) {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
          type
        }
        ... on RefinanceEngagement {
          id
          shortId
          type
        }
      }
    }
  }
}
```

### By type

```graphql theme={null}
query PurchaseEngagementsOnly {
  engagements(first: 20, filters: { types: [PURCHASE] }) {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
          closingDate
        }
      }
    }
  }
}
```

### By province

```graphql theme={null}
query OntarioEngagements {
  engagements(first: 20, filters: { provinces: [ONTARIO, BRITISH_COLUMBIA] }) {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
        }
        ... on RefinanceEngagement {
          id
          shortId
        }
      }
    }
  }
}
```

### By date range

Both `closingDate` and `createdAt` support date range filtering:

```graphql theme={null}
query EngagementsClosingThisMonth {
  engagements(
    first: 20
    filters: { closingDate: { startDate: "2025-09-01", endDate: "2025-09-30" } }
  ) {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
          closingDate
        }
        ... on RefinanceEngagement {
          id
          shortId
          closingDate
        }
      }
    }
  }
}
```

### Combining filters

All filter fields can be used together. When multiple filters are specified, results must
match all of them:

```graphql theme={null}
query FilteredEngagements {
  engagements(
    first: 20
    filters: {
      types: [PURCHASE]
      statuses: [PREPARING_FOR_CLOSING, CLOSING_IN_PROGRESS]
      provinces: [ONTARIO]
      closingDate: { startDate: "2025-09-01", endDate: "2025-12-31" }
    }
  ) {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
          closingDate
          owner
        }
      }
    }
  }
}
```

## Text search

Use the `query` parameter to perform a text search across engagements. This is useful
for finding engagements by client name, short ID, or other searchable fields:

```graphql theme={null}
query SearchEngagements {
  engagements(first: 10, query: "Jane Doe") {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
          clients {
            firstName
            lastName
          }
        }
        ... on RefinanceEngagement {
          id
          shortId
          clients {
            firstName
            lastName
          }
        }
      }
    }
  }
}
```

<Info>
  The `query` and `filters` parameters can be combined to perform a text search
  within a filtered set of results.
</Info>

## Sorting

Control the order of results with the `sortOrder` argument using the
`EngagementSearchSortOrder` enum:

| Sort order          | Description                     |
| ------------------- | ------------------------------- |
| `CLOSING_DATE_ASC`  | Closing date, earliest first    |
| `CLOSING_DATE_DESC` | Closing date, most recent first |
| `CREATED_AT_ASC`    | Creation date, oldest first     |
| `CREATED_AT_DESC`   | Creation date, newest first     |

```graphql theme={null}
query EngagementsByClosingDate {
  engagements(first: 20, sortOrder: CLOSING_DATE_ASC) {
    edges {
      node {
        ... on PurchaseEngagement {
          id
          shortId
          closingDate
        }
        ... on RefinanceEngagement {
          id
          shortId
          closingDate
        }
      }
    }
  }
}
```

## Pagination

The `engagements` query uses cursor-based pagination. Use `pageInfo` to determine if
there are more results, and pass the `endCursor` value as the `after` argument to
fetch the next page:

```graphql theme={null}
query NextPage {
  engagements(first: 10, after: "eyJpZCI6MTB9") {
    edges {
      cursor
      node {
        ... on PurchaseEngagement {
          id
          shortId
        }
        ... on RefinanceEngagement {
          id
          shortId
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
```

A typical pagination loop:

<Steps>
  <Step title="Fetch the first page">
    Call `engagements(first: 20)` without an `after` cursor.
  </Step>

  <Step title="Check for more results">
    If `pageInfo.hasNextPage` is `true`, there are more results to fetch.
  </Step>

  <Step title="Fetch subsequent pages">
    Pass `pageInfo.endCursor` as the `after` argument in the next request.
    Repeat until `hasNextPage` is `false`.
  </Step>
</Steps>

<Info>
  For more details on cursor-based pagination patterns, see the
  [Pagination](/fundamentals/pagination) documentation.
</Info>

## Next steps

<CardGroup>
  <Card title="Fetching engagement details" icon="file-lines" href="/lender-api/guides/fetching-engagement-details">
    Retrieve detailed information about a specific engagement.
  </Card>

  <Card title="Cancelling an engagement" icon="ban" href="/lender-api/guides/cancelling-an-engagement">
    Learn how to cancel an engagement that is no longer needed.
  </Card>
</CardGroup>


# Overview
Source: https://dev.ownright.com/lender-api/overview

Streamline your real estate legal workflows by integrating with the Ownright Lender API

<img alt="Lender API Overview" />

<img alt="Lender API Overview" />

The **Lender API** enables lending institutions to programmatically manage their real estate
legal files with Ownright. Instead of manually submitting engagement details, your systems
can create engagements, upload mortgage documents, and track the status of every closing
— all through a single GraphQL API.

With the Lender API, you can:

<ol>
  <li>
    **Create engagements** — Submit new purchase and refinance files to Ownright
    directly from your loan origination system.
  </li>

  <li>
    **Track engagement status** — Monitor the progress of every closing from
    received through to funded and closed.
  </li>

  <li>
    **Upload documents** — Securely attach mortgage commitment letters and other
    documents using the staged file upload flow.
  </li>

  <li>
    **Manage your team** — Retrieve your team members and assign ownership of
    engagements to the right people.
  </li>
</ol>

## Get started

<CardGroup>
  <Card title="Engagements" icon="file-contract" href="/lender-api/core-concepts/engagements">
    Understand engagements — the core object representing a real estate legal
    file.
  </Card>

  <Card title="Lender and team members" icon="users" href="/lender-api/core-concepts/lender-and-team-members">
    Learn about your organization and team member objects.
  </Card>

  <Card title="Authentication" icon="lock" href="/fundamentals/authentication">
    Understand how to authenticate your requests to the Lender API.
  </Card>

  <Card title="Creating an engagement" icon="plus" href="/lender-api/guides/creating-an-engagement">
    Submit your first real estate file to Ownright through the API.
  </Card>

  <Card title="File uploads" icon="upload" href="/lender-api/guides/file-uploads">
    Learn the staged upload flow for attaching mortgage documents.
  </Card>

  <Card title="API Reference" icon="code" href="/lender-api/reference/connecting">
    Explore all queries, mutations, and types available in the Lender API.
  </Card>
</CardGroup>


# Changelog
Source: https://dev.ownright.com/lender-api/reference/changelog

Stay up to date with the changes we make to the Lender API

## Changelog

<Update label="2026-03-20" description="v1.0.0 — Initial release">
  The initial release of the Ownright Lender API, including:

  <ul>
    <li>**Engagement management** — Create purchase and refinance engagements via the `engagementCreate` mutation.</li>
    <li>**Engagement queries** — Fetch a single engagement by GID or search/filter/sort across all engagements with the `engagements` query.</li>
    <li>**File uploads** — Upload mortgage documents using the staged file upload flow with `stagedFileUploadCreate`.</li>
    <li>**Lender and team members** — Retrieve your organization details and team member list via the `lender` and `teamMembers` queries.</li>
  </ul>
</Update>


# Connecting
Source: https://dev.ownright.com/lender-api/reference/connecting

General details on how to connect to the Lender API

Before you start sending queries and mutations, you need to know where to
send requests and what headers to include. This page covers the basics of
making a successful connection to the Ownright Lender API.

## API endpoint

All GraphQL requests are sent to a single HTTPS endpoint:

```
POST https://api.ownright.com/lenders/graphql
```

## Required headers

Every request to the Lender API must include the following headers:

| Header                           | Description                                     |
| -------------------------------- | ----------------------------------------------- |
| `Content-Type: application/json` | Indicates the request body is JSON              |
| `X-Ownright-Client-Id`           | Your unique API client ID                       |
| `X-Ownright-API-Key`             | Your long-lived API key used for authentication |
| `X-Ownright-Organization-Id`     | A constant identifier for the Ownright platform |

These headers are used to authenticate your requests and route them correctly.

## Example request

Here's an example of a basic GraphQL request using curl to fetch your lender
organization details:

```bash Example request theme={null}
curl -X POST https://api.ownright.com/lenders/graphql \
  -H "Content-Type: application/json" \
  -H "X-Ownright-Client-Id: your-client-id" \
  -H "X-Ownright-API-Key: your-api-key" \
  -H "X-Ownright-Organization-Id: ownright-prod-org" \
  -d '{
    "query": "query { lender { name members { id firstName lastName email } } }"
  }'
```

**Example response:**

```json Example response theme={null}
{
  "data": {
    "lender": {
      "name": "Example Lending Corp",
      "members": [
        {
          "id": "gid://ownright/TeamMember/1",
          "firstName": "Jane",
          "lastName": "Smith",
          "email": "jane.smith@examplelender.com"
        }
      ]
    }
  }
}
```

<Tip>
  Use tools like [Postman](https://www.postman.com/),
  [Insomnia](https://insomnia.rest/), or
  [GraphiQL](https://github.com/graphql/graphiql) for easier request building
  and testing.
</Tip>

## Differences from the Partner API

If you've already integrated with the Partner API, the Lender API works the same way — the
only difference is the endpoint URL:

| API         | Endpoint                                    |
| ----------- | ------------------------------------------- |
| Partner API | `https://api.ownright.com/partners/graphql` |
| Lender API  | `https://api.ownright.com/lenders/graphql`  |

Your authentication credentials (client ID, API key, organization ID) are issued per API.
Lender API credentials cannot be used with the Partner API endpoint and vice versa.

## Need help?

If you haven't received your client ID or API key yet, read the
[Authentication](/fundamentals/authentication) documentation or reach out to our
team at [developers@ownright.com](mailto:developers@ownright.com).


# Country
Source: https://dev.ownright.com/lender-api/reference/members/enums/country

Possible countries.

## Values

| Value    | Description                    |
| -------- | ------------------------------ |
| `CANADA` | Represents Canada the country. |

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# EngagementSearchSortOrder
Source: https://dev.ownright.com/lender-api/reference/members/enums/engagement-search-sort-order

Possible ways to sort results when searching engagements.

## Values

| Value               | Description                               |
| ------------------- | ----------------------------------------- |
| `CLOSING_DATE_ASC`  | Sort by closing date in ascending order.  |
| `CLOSING_DATE_DESC` | Sort by closing date in descending order. |
| `CREATED_AT_ASC`    | Sort by created at in ascending order.    |
| `CREATED_AT_DESC`   | Sort by created at in descending order.   |

## Used by

* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)


# EngagementStatus
Source: https://dev.ownright.com/lender-api/reference/members/enums/engagement-status

Possible statuses for engagements.

## Values

| Value                   | Description                                  |
| ----------------------- | -------------------------------------------- |
| `CANCELLED`             | Represents the cancelled status.             |
| `CLOSED`                | Represents the closed status.                |
| `CLOSING_IN_PROGRESS`   | Represents the closing in progress status.   |
| `COMPLETE`              | Represents the complete status.              |
| `IN_PROGRESS`           | Represents the in progress status.           |
| `PREPARING_FOR_CLOSING` | Represents the preparing for closing status. |
| `RECEIVED`              | Represents the received status.              |
| `SETTING_UP`            | Represents the setting up status.            |

## Used by

* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)


# EngagementType
Source: https://dev.ownright.com/lender-api/reference/members/enums/engagement-type

The type of engagement.

## Values

| Value       | Description             |
| ----------- | ----------------------- |
| `PURCHASE`  | A purchase engagement.  |
| `REFINANCE` | A refinance engagement. |

## Used by

* [`engagement`](/lender-api/reference/queries/engagements/engagement) (query)
* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCancel`](/lender-api/reference/mutations/engagements/engagement-cancel) (mutation)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# FileMimeType
Source: https://dev.ownright.com/lender-api/reference/members/enums/file-mime-type

Possible MIME types for files.

## Values

| Value           | Description                                                                                          |
| --------------- | ---------------------------------------------------------------------------------------------------- |
| `DOCUMENT_DOC`  | Represents the `application/msword` MIME type.                                                       |
| `DOCUMENT_DOCX` | Represents the `application/vnd.openxmlformats-officedocument.wordprocessingml.documents` MIME type. |
| `DOCUMENT_PDF`  | Represents the `application/pdf` MIME type.                                                          |
| `IMAGE_HEIC`    | Represents the `image/heic` MIME type.                                                               |
| `IMAGE_JPEG`    | Represents the `image/jpeg` MIME type.                                                               |
| `IMAGE_PNG`     | Represents the `image/png` MIME type.                                                                |
| `IMAGE_TIFF`    | Represents the `image/tiff` MIME type.                                                               |

## Used by

* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# Province
Source: https://dev.ownright.com/lender-api/reference/members/enums/province

Possible provinces.

## Values

| Value                       | Description                                        |
| --------------------------- | -------------------------------------------------- |
| `ALBERTA`                   | Represents Alberta the province.                   |
| `BRITISH_COLUMBIA`          | Represents British Columbia the province.          |
| `MANITOBA`                  | Represents Manitoba the province.                  |
| `NEWFOUNDLAND_AND_LABRADOR` | Represents Newfoundland And Labrador the province. |
| `NEW_BRUNSWICK`             | Represents New Brunswick the province.             |
| `NORTHWEST_TERRITORIES`     | Represents Northwest Territories the province.     |
| `NOVA_SCOTIA`               | Represents Nova Scotia the province.               |
| `NUNAVUT`                   | Represents Nunavut the province.                   |
| `ONTARIO`                   | Represents Ontario the province.                   |
| `PRINCE_EDWARD_ISLAND`      | Represents Prince Edward Island the province.      |
| `QUEBEC`                    | Represents Quebec the province.                    |
| `SASKATCHEWAN`              | Represents Saskatchewan the province.              |
| `YUKON`                     | Represents Yukon the province.                     |

## Used by

* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# PurchaseEngagementState
Source: https://dev.ownright.com/lender-api/reference/members/enums/purchase-engagement-state

Possible states for purchase engagements.

## Values

| Value                   | Description                                                                     |
| ----------------------- | ------------------------------------------------------------------------------- |
| `CANCELLED`             | Engagement has been cancelled and is no longer being worked on.                 |
| `CLOSED`                | Engagement has been successfully funded and closed.                             |
| `CLOSING_IN_PROGRESS`   | Final closing actions are in motion and this deal is set to close today.        |
| `PREPARING_FOR_CLOSING` | Engagement is being prepared for closing day.                                   |
| `RECEIVED`              | Ownright has received engagement details and is actively reviewing information. |
| `SETTING_UP`            | Ownright is actively setting up this engagement to begin closing prep.          |


# RefinanceEngagementState
Source: https://dev.ownright.com/lender-api/reference/members/enums/refinance-engagement-state

Possible states for refinance engagements.

## Values

| Value                   | Description                                                                     |
| ----------------------- | ------------------------------------------------------------------------------- |
| `CANCELLED`             | Engagement has been cancelled and is no longer being worked on.                 |
| `CLOSED`                | Engagement has been successfully funded and closed.                             |
| `CLOSING_IN_PROGRESS`   | Final closing actions are in motion and this deal is set to close today.        |
| `PREPARING_FOR_CLOSING` | Engagement is being prepared for closing day.                                   |
| `RECEIVED`              | Ownright has received engagement details and is actively reviewing information. |
| `SETTING_UP`            | Ownright is actively setting up this engagement to begin closing prep.          |


# AddressInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/address-input

Input for an address.

## Fields

<ParamField type="String">
  The city of the address.
</ParamField>

<ParamField type="Country">
  The country of the address.
</ParamField>

<ParamField type="String">
  The postal code of the address.
</ParamField>

<ParamField type="Province">
  The province of the address.
</ParamField>

<ParamField type="String">
  The street name and number of the address.
</ParamField>

<ParamField type="String">
  The unit number, suite number, apartment number, etc. of the address.
</ParamField>

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# DateRangeInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/date-range-input

Input for a date range.

## Fields

<ParamField type="ISO8601Date">
  The end date of the date range.
</ParamField>

<ParamField type="ISO8601Date">
  The start date of the date range.
</ParamField>

## Used by

* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)


# EngagementClientInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/engagement-client-input

Input for a client on an engagement.

## Fields

<ParamField type="String!">
  The email address of the client.
</ParamField>

<ParamField type="String!">
  The first name of the client.
</ParamField>

<ParamField type="String!">
  The last name of the client.
</ParamField>

<ParamField type="String">
  The middle name of the client.
</ParamField>

<ParamField type="E164PhoneNumber">
  The phone number of the client in E.164 format.
</ParamField>

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# EngagementCreateInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/engagement-create-input

Input to create an engagement. Exactly one of the type-specific inputs must be provided.

<Note>Exactly one of the following fields must be provided.</Note>

## Fields

<ParamField type="PurchaseEngagementCreateInput">
  Input to create a purchase engagement.
</ParamField>

<ParamField type="RefinanceEngagementCreateInput">
  Input to create a refinance engagement.
</ParamField>

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# EngagementSearchFilterInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/engagement-search-filter-input

Input to filter results when performing an engagements search.

## Fields

<ParamField type="DateRangeInput">
  Filter based on engagement closing date.
</ParamField>

<ParamField type="DateRangeInput">
  Filter based on engagement creation date.
</ParamField>

<ParamField type="[Province!]">
  Filter based on province.
</ParamField>

<ParamField type="[EngagementStatus!]">
  Filter based on engagement status.
</ParamField>

<ParamField type="[EngagementType!]">
  Filter based on engagement type.
</ParamField>

## Used by

* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)


# PurchaseEngagementCreateInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/purchase-engagement-create-input

Input to create a purchase engagement.

## Fields

<ParamField type="[EngagementClientInput!]!">
  The clients for this engagement.
</ParamField>

<ParamField type="ISO8601Date!">
  The closing date.
</ParamField>

<ParamField type="[FileRecordGID!]!">
  GIDs of staged file records for new mortgage files.
</ParamField>

<ParamField type="String">
  The new mortgage number.
</ParamField>

<ParamField type="String">
  Notes for the engagement.
</ParamField>

<ParamField type="TeamMemberGID!">
  The team member who owns this engagement.
</ParamField>

<ParamField type="AddressInput">
  The property address.
</ParamField>

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# RefinanceEngagementCreateInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/refinance-engagement-create-input

Input to create a refinance engagement.

## Fields

<ParamField type="[EngagementClientInput!]!">
  The clients for this engagement.
</ParamField>

<ParamField type="ISO8601Date!">
  The expected closing date.
</ParamField>

<ParamField type="[FileRecordGID!]!">
  GIDs of staged file records for new mortgage files.
</ParamField>

<ParamField type="String">
  The new mortgage number.
</ParamField>

<ParamField type="String">
  Notes for the engagement.
</ParamField>

<ParamField type="TeamMemberGID!">
  The team member who owns this engagement.
</ParamField>

<ParamField type="AddressInput">
  The property address.
</ParamField>

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# StagedFileUploadInput
Source: https://dev.ownright.com/lender-api/reference/members/inputs/staged-file-upload-input

Input to create a staged file upload.

## Fields

<ParamField type="String!">
  The name of the file that is being uploaded.
</ParamField>

<ParamField type="FileMimeType!">
  The MIME type of the file that is being uploaded.
</ParamField>

## Used by

* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# Engagement
Source: https://dev.ownright.com/lender-api/reference/members/interfaces/engagement

Represents an engagement.

## Fields

<ResponseField name="cancellable" type="Boolean!">
  Whether the engagement can be cancelled.
</ResponseField>

<ResponseField name="clients" type="[EngagementClient!]!">
  The clients on this engagement.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the engagement was created.
</ResponseField>

<ResponseField name="id" type="EngagementGID!">
  The unique identifier of the engagement.
</ResponseField>

<ResponseField name="owner" type="String">
  The name of the engagement owner.
</ResponseField>

<ResponseField name="shortId" type="String!">
  A short human-readable identifier for the engagement.
</ResponseField>

<ResponseField name="type" type="EngagementType!">
  The type of the engagement.
</ResponseField>

## Implementations

* [PurchaseEngagement](/lender-api/reference/members/objects/purchase-engagement)
* [RefinanceEngagement](/lender-api/reference/members/objects/refinance-engagement)

## Used by

* [`engagement`](/lender-api/reference/queries/engagements/engagement) (query)
* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCancel`](/lender-api/reference/mutations/engagements/engagement-cancel) (mutation)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# File
Source: https://dev.ownright.com/lender-api/reference/members/interfaces/file

Represents a file.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="formattedSize" type="String!">
  The size of the file in a human-readable format.
</ResponseField>

<ResponseField name="id" type="FileRecordGID!">
  The GID of the file record.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="size" type="Int!">
  The size of the file in bytes.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

## Implementations

* [Document](/lender-api/reference/members/objects/document)
* [Image](/lender-api/reference/members/objects/image)
* [Media](/lender-api/reference/members/objects/media)

## Used by

* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# PurchaseEngagementStatus
Source: https://dev.ownright.com/lender-api/reference/members/interfaces/purchase-engagement-status

Represents the status of a purchase engagement.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>

## Implementations

* [PurchaseEngagementCancelledStatus](/lender-api/reference/members/objects/purchase-engagement-cancelled-status)
* [PurchaseEngagementClosedStatus](/lender-api/reference/members/objects/purchase-engagement-closed-status)
* [PurchaseEngagementClosingInProgressStatus](/lender-api/reference/members/objects/purchase-engagement-closing-in-progress-status)
* [PurchaseEngagementPreparingForClosingStatus](/lender-api/reference/members/objects/purchase-engagement-preparing-for-closing-status)
* [PurchaseEngagementReceivedStatus](/lender-api/reference/members/objects/purchase-engagement-received-status)
* [PurchaseEngagementSettingUpStatus](/lender-api/reference/members/objects/purchase-engagement-setting-up-status)


# RefinanceEngagementStatus
Source: https://dev.ownright.com/lender-api/reference/members/interfaces/refinance-engagement-status

Represents the status of a refinance engagement.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>

## Implementations

* [RefinanceEngagementCancelledStatus](/lender-api/reference/members/objects/refinance-engagement-cancelled-status)
* [RefinanceEngagementClosedStatus](/lender-api/reference/members/objects/refinance-engagement-closed-status)
* [RefinanceEngagementClosingInProgressStatus](/lender-api/reference/members/objects/refinance-engagement-closing-in-progress-status)
* [RefinanceEngagementPreparingForClosingStatus](/lender-api/reference/members/objects/refinance-engagement-preparing-for-closing-status)
* [RefinanceEngagementReceivedStatus](/lender-api/reference/members/objects/refinance-engagement-received-status)
* [RefinanceEngagementSettingUpStatus](/lender-api/reference/members/objects/refinance-engagement-setting-up-status)


# Address
Source: https://dev.ownright.com/lender-api/reference/members/objects/address

Represents an address.

## Fields

<ResponseField name="city" type="String!">
  The city of the address.
</ResponseField>

<ResponseField name="country" type="Country!">
  The country of the address.
</ResponseField>

<ResponseField name="latitude" type="Float">
  The latitude of the address.
</ResponseField>

<ResponseField name="longitude" type="Float">
  The longitude of the address.
</ResponseField>

<ResponseField name="postalCode" type="String!">
  The postal code of the address.
</ResponseField>

<ResponseField name="province" type="Province!">
  The province of the address.
</ResponseField>

<ResponseField name="shortTitle" type="String!">
  The shortened title for the address.
</ResponseField>

<ResponseField name="street" type="String!">
  The street name and number of the address.
</ResponseField>

<ResponseField name="title" type="String!">
  The full title for the address.
</ResponseField>

<ResponseField name="unitNumber" type="String">
  The unit number, apartment number, suite number etc.
</ResponseField>


# Document
Source: https://dev.ownright.com/lender-api/reference/members/objects/document

Represents a document.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="formattedSize" type="String!">
  The size of the file in a human-readable format.
</ResponseField>

<ResponseField name="id" type="FileRecordGID!">
  The GID of the file record.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="size" type="Int!">
  The size of the file in bytes.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

<ResponseField name="url" type="Url">
  The URL to the document.
</ResponseField>


# EngagementClient
Source: https://dev.ownright.com/lender-api/reference/members/objects/engagement-client

A client contact on an engagement.

## Fields

<ResponseField name="email" type="String">
  The email address of the client.
</ResponseField>

<ResponseField name="firstName" type="String">
  The first name of the client.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the client.
</ResponseField>

<ResponseField name="middleName" type="String">
  The middle name of the client.
</ResponseField>

<ResponseField name="phoneNumber" type="String">
  The phone number of the client.
</ResponseField>

## Used by

* [`engagement`](/lender-api/reference/queries/engagements/engagement) (query)
* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCancel`](/lender-api/reference/mutations/engagements/engagement-cancel) (mutation)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# Image
Source: https://dev.ownright.com/lender-api/reference/members/objects/image

Represents an image.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="formattedSize" type="String!">
  The size of the file in a human-readable format.
</ResponseField>

<ResponseField name="id" type="FileRecordGID!">
  The GID of the file record.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="size" type="Int!">
  The size of the file in bytes.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

<ResponseField name="url" type="Url">
  The URL to the image.
</ResponseField>


# Lender
Source: https://dev.ownright.com/lender-api/reference/members/objects/lender

The authenticated lender entity.

## Fields

<ResponseField name="logoUrl" type="Url">
  The URL of the lender logo.
</ResponseField>

<ResponseField name="members" type="[TeamMember!]!">
  The team members of the lender.
</ResponseField>

<ResponseField name="name" type="String!">
  The name of the lender.
</ResponseField>

## Used by

* [`lender`](/lender-api/reference/queries/lender/lender) (query)


# Media
Source: https://dev.ownright.com/lender-api/reference/members/objects/media

Represents a media file.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="formattedSize" type="String!">
  The size of the file in a human-readable format.
</ResponseField>

<ResponseField name="id" type="FileRecordGID!">
  The GID of the file record.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="size" type="Int!">
  The size of the file in bytes.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

<ResponseField name="url" type="Url">
  The URL to the media file.
</ResponseField>


# Property
Source: https://dev.ownright.com/lender-api/reference/members/objects/property

Represents a property associated with an engagement.

## Fields

<ResponseField name="address" type="Address!">
  The address of the property.
</ResponseField>


# PurchaseEngagement
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement

A purchase engagement.

## Fields

<ResponseField name="cancellable" type="Boolean!">
  Whether the engagement can be cancelled.
</ResponseField>

<ResponseField name="clients" type="[EngagementClient!]!">
  The clients on this engagement.
</ResponseField>

<ResponseField name="closingDate" type="ISO8601Date">
  The closing date of the engagement.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the engagement was created.
</ResponseField>

<ResponseField name="id" type="EngagementGID!">
  The unique identifier of the engagement.
</ResponseField>

<ResponseField name="owner" type="String">
  The name of the engagement owner.
</ResponseField>

<ResponseField name="property" type="Property">
  The property associated with this engagement.
</ResponseField>

<ResponseField name="shortId" type="String!">
  A short human-readable identifier for the engagement.
</ResponseField>

<ResponseField name="status" type="PurchaseEngagementStatus!">
  The current status of the purchase engagement.
</ResponseField>

<ResponseField name="type" type="EngagementType!">
  The type of the engagement.
</ResponseField>


# PurchaseEngagementCancelledStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement-cancelled-status

Status information for purchase engagements that have been cancelled.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>


# PurchaseEngagementClosedStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement-closed-status

Status information for purchase engagements that have been closed.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>


# PurchaseEngagementClosingInProgressStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement-closing-in-progress-status

Status information for purchase engagements where closing is in progress.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>


# PurchaseEngagementPreparingForClosingStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement-preparing-for-closing-status

Status information for purchase engagements being prepared for closing.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>


# PurchaseEngagementReceivedStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement-received-status

Status information for purchase engagements that have been received.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>


# PurchaseEngagementSettingUpStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/purchase-engagement-setting-up-status

Status information for purchase engagements that are being set up.

## Fields

<ResponseField name="state" type="PurchaseEngagementState!">
  The state of the purchase engagement.
</ResponseField>


# RefinanceEngagement
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement

A refinance engagement.

## Fields

<ResponseField name="cancellable" type="Boolean!">
  Whether the engagement can be cancelled.
</ResponseField>

<ResponseField name="clients" type="[EngagementClient!]!">
  The clients on this engagement.
</ResponseField>

<ResponseField name="closingDate" type="ISO8601Date">
  The closing date of the engagement.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the engagement was created.
</ResponseField>

<ResponseField name="id" type="EngagementGID!">
  The unique identifier of the engagement.
</ResponseField>

<ResponseField name="owner" type="String">
  The name of the engagement owner.
</ResponseField>

<ResponseField name="property" type="Property">
  The property associated with this engagement.
</ResponseField>

<ResponseField name="shortId" type="String!">
  A short human-readable identifier for the engagement.
</ResponseField>

<ResponseField name="status" type="RefinanceEngagementStatus!">
  The current status of the refinance engagement.
</ResponseField>

<ResponseField name="type" type="EngagementType!">
  The type of the engagement.
</ResponseField>


# RefinanceEngagementCancelledStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement-cancelled-status

Status information for refinance engagements that have been cancelled.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>


# RefinanceEngagementClosedStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement-closed-status

Status information for refinance engagements that have been closed.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>


# RefinanceEngagementClosingInProgressStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement-closing-in-progress-status

Status information for refinance engagements where closing is in progress.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>


# RefinanceEngagementPreparingForClosingStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement-preparing-for-closing-status

Status information for refinance engagements being prepared for closing.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>


# RefinanceEngagementReceivedStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement-received-status

Status information for refinance engagements that have been received.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>


# RefinanceEngagementSettingUpStatus
Source: https://dev.ownright.com/lender-api/reference/members/objects/refinance-engagement-setting-up-status

Status information for refinance engagements that are being set up.

## Fields

<ResponseField name="state" type="RefinanceEngagementState!">
  The state of the refinance engagement.
</ResponseField>


# StagedFileUpload
Source: https://dev.ownright.com/lender-api/reference/members/objects/staged-file-upload

Represents a staged file upload.

## Fields

<ResponseField name="file" type="File!">
  The file that is staged for upload.
</ResponseField>

<ResponseField name="signedUploadUrl" type="Url!">
  A signed upload URL to use when uploading file.
</ResponseField>

<ResponseField name="signedUploadUrlExpiryDate" type="ISO8601DateTime!">
  Date when upload URL expires.
</ResponseField>

## Used by

* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# TeamMember
Source: https://dev.ownright.com/lender-api/reference/members/objects/team-member

A team member in a lender entity.

## Fields

<ResponseField name="email" type="String">
  The email address of the team member.
</ResponseField>

<ResponseField name="firstName" type="String">
  The first name of the team member.
</ResponseField>

<ResponseField name="id" type="TeamMemberGID!">
  The unique identifier of the team member.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the team member.
</ResponseField>

## Used by

* [`lender`](/lender-api/reference/queries/lender/lender) (query)
* [`teamMembers`](/lender-api/reference/queries/lender/team-members) (query)


# E164PhoneNumber
Source: https://dev.ownright.com/lender-api/reference/members/scalars/e164-phone-number

A valid phone number string in the E.164 format.

## Description

A valid phone number string in the E.164 format.

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# EngagementGID
Source: https://dev.ownright.com/lender-api/reference/members/scalars/engagement-gid

A global identifier for a Engagement object in format of 'gid://ownright/Engagement/ID'.

## Description

A global identifier for a Engagement object in format of '`gid://ownright/Engagement/ID`'.

## Used by

* [`engagement`](/lender-api/reference/queries/engagements/engagement) (query)
* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCancel`](/lender-api/reference/mutations/engagements/engagement-cancel) (mutation)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# FileRecordGID
Source: https://dev.ownright.com/lender-api/reference/members/scalars/file-record-gid

A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.

## Description

A global identifier for a FileRecord object in format of '`gid://ownright/FileRecord/ID`'.

## Used by

* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)
* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# ISO8601Date
Source: https://dev.ownright.com/lender-api/reference/members/scalars/iso8601-date

An ISO 8601-encoded date

## Description

An ISO 8601-encoded date

## Used by

* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# ISO8601DateTime
Source: https://dev.ownright.com/lender-api/reference/members/scalars/iso8601-date-time

An ISO 8601-encoded datetime

## Description

An ISO 8601-encoded datetime

## Used by

* [`engagement`](/lender-api/reference/queries/engagements/engagement) (query)
* [`engagements`](/lender-api/reference/queries/engagements/engagements) (query)
* [`engagementCancel`](/lender-api/reference/mutations/engagements/engagement-cancel) (mutation)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)
* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# TeamMemberGID
Source: https://dev.ownright.com/lender-api/reference/members/scalars/team-member-gid

A global identifier for a TeamMember object in format of 'gid://ownright/TeamMember/ID'.

## Description

A global identifier for a TeamMember object in format of '`gid://ownright/TeamMember/ID`'.

## Used by

* [`lender`](/lender-api/reference/queries/lender/lender) (query)
* [`teamMembers`](/lender-api/reference/queries/lender/team-members) (query)
* [`engagementCreate`](/lender-api/reference/mutations/engagements/engagement-create) (mutation)


# Url
Source: https://dev.ownright.com/lender-api/reference/members/scalars/url

A valid URL, transported as a string.

## Description

A valid URL, transported as a string.

## Used by

* [`lender`](/lender-api/reference/queries/lender/lender) (query)
* [`stagedFileUploadCreate`](/lender-api/reference/mutations/files/staged-file-upload-create) (mutation)


# Engagement Cancel
Source: https://dev.ownright.com/lender-api/reference/mutations/engagements/engagement-cancel

Cancels an engagement.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation EngagementCancel($id: EngagementGID!) {
    engagementCancel(id: $id) {
      engagement {
        cancellable
        createdAt
        id
        owner
        shortId
        type
        clients {
          email
          firstName
          lastName
          middleName
          phoneNumber
        }
        ... on PurchaseEngagement {
          closingDate
          property {
            address {
              city
              country
              latitude
              longitude
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
          }
        }
        ... on RefinanceEngagement {
          closingDate
          property {
            address {
              city
              country
              latitude
              longitude
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "id": "gid://ownright/Engagement/1"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "engagementCancel": {
        "engagement": {
          "cancellable": true,
          "createdAt": "2025-01-15T10:30:00Z",
          "id": "gid://ownright/Engagement/1",
          "owner": "Jane Doe",
          "shortId": "ABC-123",
          "type": "PURCHASE",
          "clients": [
            {
              "email": "jane@example.com",
              "firstName": "Jane",
              "lastName": "Doe",
              "middleName": "M",
              "phoneNumber": "+14165551234"
            }
          ],
          "closingDate": "2025-06-15",
          "property": {
            "address": {
              "city": "Toronto",
              "country": "CANADA",
              "latitude": 1,
              "longitude": 1,
              "postalCode": "M5V 1A1",
              "province": "ALBERTA",
              "shortTitle": "123 Main St, Toronto",
              "street": "123 Main St",
              "title": "123 Main St, Toronto",
              "unitNumber": "Suite 100"
            }
          },
          "status": {
            "state": "CANCELLED"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`engagementCancel`

### Arguments

<ParamField type="EngagementGID!">
  The GID of the engagement to cancel.
</ParamField>

### Return fields

<ResponseField name="engagement" type="Engagement">
  The cancelled engagement.

  <Expandable title="properties">
    <ResponseField name="cancellable" type="Boolean!">
      Whether the engagement can be cancelled.
    </ResponseField>

    <ResponseField name="clients" type="[EngagementClient!]!">
      The clients on this engagement.

      <Expandable title="properties">
        <ResponseField name="email" type="String">
          The email address of the client.
        </ResponseField>

        <ResponseField name="firstName" type="String">
          The first name of the client.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the client.
        </ResponseField>

        <ResponseField name="middleName" type="String">
          The middle name of the client.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the client.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the engagement was created.
    </ResponseField>

    <ResponseField name="id" type="EngagementGID!">
      The unique identifier of the engagement.
    </ResponseField>

    <ResponseField name="owner" type="String">
      The name of the engagement owner.
    </ResponseField>

    <ResponseField name="shortId" type="String!">
      A short human-readable identifier for the engagement.
    </ResponseField>

    <ResponseField name="type" type="EngagementType!">
      The type of the engagement.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[EngagementCancelUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="EngagementCancelUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Engagement`](/lender-api/reference/members/interfaces/engagement) (interface) — Represents an engagement.
* [`EngagementCancelPayload`](/lender-api/reference/members/objects/engagement-cancel-payload) (object) — Return type for the `engagementCancel` mutation.
* [`EngagementCancelUserError`](/lender-api/reference/members/objects/engagement-cancel-user-error) (object) — An error that could occur during the execution of the `engagementCancel` mutation.
* [`EngagementCancelUserErrorCode`](/lender-api/reference/members/enums/engagement-cancel-user-error-code) (enum) — Possible error codes that can be returned by EngagementCancelUserError.
* [`EngagementClient`](/lender-api/reference/members/objects/engagement-client) (object) — A client contact on an engagement.
* [`EngagementGID`](/lender-api/reference/members/scalars/engagement-gid) (scalar) — A global identifier for a Engagement object in format of 'gid://ownright/Engagement/ID'.
* [`EngagementType`](/lender-api/reference/members/enums/engagement-type) (enum) — The type of engagement.
* [`ISO8601DateTime`](/lender-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime


# Engagement Create
Source: https://dev.ownright.com/lender-api/reference/mutations/engagements/engagement-create

Creates a new engagement.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation EngagementCreate($input: EngagementCreateInput!) {
    engagementCreate(input: $input) {
      engagement {
        cancellable
        createdAt
        id
        owner
        shortId
        type
        clients {
          email
          firstName
          lastName
          middleName
          phoneNumber
        }
        ... on PurchaseEngagement {
          closingDate
          property {
            address {
              city
              country
              latitude
              longitude
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
          }
        }
        ... on RefinanceEngagement {
          closingDate
          property {
            address {
              city
              country
              latitude
              longitude
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": {
      "purchase": {
        "clients": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "middleName": "M",
            "phoneNumber": "+14165551234"
          }
        ],
        "closingDate": "2025-06-15",
        "newMortgageFileIds": [
          "gid://ownright/FileRecord/1"
        ],
        "newMortgageNumber": "example-new-mortgage-number",
        "notes": "Additional notes here",
        "owner": "gid://ownright/TeamMember/1",
        "propertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "street": "123 Main St",
          "unitNumber": "Suite 100"
        }
      }
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "engagementCreate": {
        "engagement": {
          "cancellable": true,
          "createdAt": "2025-01-15T10:30:00Z",
          "id": "gid://ownright/Engagement/1",
          "owner": "Jane Doe",
          "shortId": "ABC-123",
          "type": "PURCHASE",
          "clients": [
            {
              "email": "jane@example.com",
              "firstName": "Jane",
              "lastName": "Doe",
              "middleName": "M",
              "phoneNumber": "+14165551234"
            }
          ],
          "closingDate": "2025-06-15",
          "property": {
            "address": {
              "city": "Toronto",
              "country": "CANADA",
              "latitude": 1,
              "longitude": 1,
              "postalCode": "M5V 1A1",
              "province": "ALBERTA",
              "shortTitle": "123 Main St, Toronto",
              "street": "123 Main St",
              "title": "123 Main St, Toronto",
              "unitNumber": "Suite 100"
            }
          },
          "status": {
            "state": "CANCELLED"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`engagementCreate`

### Arguments

<ParamField type="EngagementCreateInput!">
  Input required to create an engagement.
  <Note>Exactly one of the following fields must be provided.</Note>

  <Expandable title="properties">
    <ParamField type="PurchaseEngagementCreateInput">
      Input to create a purchase engagement.

      <Expandable title="properties">
        <ParamField type="[EngagementClientInput!]!">
          The clients for this engagement.
        </ParamField>

        <ParamField type="ISO8601Date!">
          The closing date.
        </ParamField>

        <ParamField type="[FileRecordGID!]!">
          GIDs of staged file records for new mortgage files.
        </ParamField>

        <ParamField type="String">
          The new mortgage number.
        </ParamField>

        <ParamField type="String">
          Notes for the engagement.
        </ParamField>

        <ParamField type="TeamMemberGID!">
          The team member who owns this engagement.
        </ParamField>

        <ParamField type="AddressInput">
          The property address.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="RefinanceEngagementCreateInput">
      Input to create a refinance engagement.

      <Expandable title="properties">
        <ParamField type="[EngagementClientInput!]!">
          The clients for this engagement.
        </ParamField>

        <ParamField type="ISO8601Date!">
          The expected closing date.
        </ParamField>

        <ParamField type="[FileRecordGID!]!">
          GIDs of staged file records for new mortgage files.
        </ParamField>

        <ParamField type="String">
          The new mortgage number.
        </ParamField>

        <ParamField type="String">
          Notes for the engagement.
        </ParamField>

        <ParamField type="TeamMemberGID!">
          The team member who owns this engagement.
        </ParamField>

        <ParamField type="AddressInput">
          The property address.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="engagement" type="Engagement">
  The created engagement.

  <Expandable title="properties">
    <ResponseField name="cancellable" type="Boolean!">
      Whether the engagement can be cancelled.
    </ResponseField>

    <ResponseField name="clients" type="[EngagementClient!]!">
      The clients on this engagement.

      <Expandable title="properties">
        <ResponseField name="email" type="String">
          The email address of the client.
        </ResponseField>

        <ResponseField name="firstName" type="String">
          The first name of the client.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the client.
        </ResponseField>

        <ResponseField name="middleName" type="String">
          The middle name of the client.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the client.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the engagement was created.
    </ResponseField>

    <ResponseField name="id" type="EngagementGID!">
      The unique identifier of the engagement.
    </ResponseField>

    <ResponseField name="owner" type="String">
      The name of the engagement owner.
    </ResponseField>

    <ResponseField name="shortId" type="String!">
      A short human-readable identifier for the engagement.
    </ResponseField>

    <ResponseField name="type" type="EngagementType!">
      The type of the engagement.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[EngagementCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="EngagementCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`AddressInput`](/lender-api/reference/members/inputs/address-input) (input) — Input for an address.
* [`Country`](/lender-api/reference/members/enums/country) (enum) — Possible countries.
* [`E164PhoneNumber`](/lender-api/reference/members/scalars/e164-phone-number) (scalar) — A valid phone number string in the E.164 format.
* [`Engagement`](/lender-api/reference/members/interfaces/engagement) (interface) — Represents an engagement.
* [`EngagementClient`](/lender-api/reference/members/objects/engagement-client) (object) — A client contact on an engagement.
* [`EngagementClientInput`](/lender-api/reference/members/inputs/engagement-client-input) (input) — Input for a client on an engagement.
* [`EngagementCreateInput`](/lender-api/reference/members/inputs/engagement-create-input) (input) — Input to create an engagement. Exactly one of the type-specific inputs must be provided.
* [`EngagementCreatePayload`](/lender-api/reference/members/objects/engagement-create-payload) (object) — Return type for the `engagementCreate` mutation.
* [`EngagementCreateUserError`](/lender-api/reference/members/objects/engagement-create-user-error) (object) — An error that could occur during the execution of the `engagementCreate` mutation.
* [`EngagementCreateUserErrorCode`](/lender-api/reference/members/enums/engagement-create-user-error-code) (enum) — Possible error codes that can be returned by EngagementCreateUserError.
* [`EngagementGID`](/lender-api/reference/members/scalars/engagement-gid) (scalar) — A global identifier for a Engagement object in format of 'gid://ownright/Engagement/ID'.
* [`EngagementType`](/lender-api/reference/members/enums/engagement-type) (enum) — The type of engagement.
* [`FileRecordGID`](/lender-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`ISO8601Date`](/lender-api/reference/members/scalars/iso8601-date) (scalar) — An ISO 8601-encoded date
* [`ISO8601DateTime`](/lender-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`Province`](/lender-api/reference/members/enums/province) (enum) — Possible provinces.
* [`PurchaseEngagementCreateInput`](/lender-api/reference/members/inputs/purchase-engagement-create-input) (input) — Input to create a purchase engagement.
* [`RefinanceEngagementCreateInput`](/lender-api/reference/members/inputs/refinance-engagement-create-input) (input) — Input to create a refinance engagement.
* [`TeamMemberGID`](/lender-api/reference/members/scalars/team-member-gid) (scalar) — A global identifier for a TeamMember object in format of 'gid://ownright/TeamMember/ID'.


# Staged File Upload Create
Source: https://dev.ownright.com/lender-api/reference/mutations/files/staged-file-upload-create

Creates a staged file upload.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation StagedFileUploadCreate($input: StagedFileUploadInput!) {
    stagedFileUploadCreate(input: $input) {
      stagedFileUpload {
        signedUploadUrl
        signedUploadUrlExpiryDate
        file {
          createdAt
          filename
          formattedSize
          id
          mimeType
          size
          staged
          updatedAt
          ... on Document {
            url
          }
          ... on Image {
            url
          }
          ... on Media {
            url
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": {
      "filename": "document.pdf",
      "mimeType": "DOCUMENT_DOC"
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "stagedFileUploadCreate": {
        "stagedFileUpload": {
          "signedUploadUrl": "https://example.com",
          "signedUploadUrlExpiryDate": "2025-01-15T10:30:00Z",
          "file": {
            "createdAt": "2025-01-15T10:30:00Z",
            "filename": "document.pdf",
            "formattedSize": "example-formatted-size",
            "id": "gid://ownright/FileRecord/1",
            "mimeType": "DOCUMENT_DOC",
            "size": 1024,
            "staged": true,
            "updatedAt": "2025-01-15T10:30:00Z",
            "url": "https://example.com"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`stagedFileUploadCreate`

### Arguments

<ParamField type="StagedFileUploadInput!">
  Input required to make a staged file upload.

  <Expandable title="properties">
    <ParamField type="String!">
      The name of the file that is being uploaded.
    </ParamField>

    <ParamField type="FileMimeType!">
      The MIME type of the file that is being uploaded.
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="stagedFileUpload" type="StagedFileUpload">
  The newly created staged file upload.

  <Expandable title="properties">
    <ResponseField name="file" type="File!">
      The file that is staged for upload.

      <Expandable title="properties">
        <ResponseField name="createdAt" type="ISO8601DateTime!">
          The date the file was created.
        </ResponseField>

        <ResponseField name="filename" type="String!">
          The name of the file.
        </ResponseField>

        <ResponseField name="formattedSize" type="String!">
          The size of the file in a human-readable format.
        </ResponseField>

        <ResponseField name="id" type="FileRecordGID!">
          The GID of the file record.
        </ResponseField>

        <ResponseField name="mimeType" type="FileMimeType!">
          The MIME type of the file.
        </ResponseField>

        <ResponseField name="size" type="Int!">
          The size of the file in bytes.
        </ResponseField>

        <ResponseField name="staged" type="Boolean!">
          Whether the file is staged for upload or not.
        </ResponseField>

        <ResponseField name="updatedAt" type="ISO8601DateTime!">
          The date the file was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="signedUploadUrl" type="Url!">
      A signed upload URL to use when uploading file.
    </ResponseField>

    <ResponseField name="signedUploadUrlExpiryDate" type="ISO8601DateTime!">
      Date when upload URL expires.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[StagedFileUploadCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="StagedFileUploadCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`File`](/lender-api/reference/members/interfaces/file) (interface) — Represents a file.
* [`FileMimeType`](/lender-api/reference/members/enums/file-mime-type) (enum) — Possible MIME types for files.
* [`FileRecordGID`](/lender-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`ISO8601DateTime`](/lender-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`StagedFileUpload`](/lender-api/reference/members/objects/staged-file-upload) (object) — Represents a staged file upload.
* [`StagedFileUploadCreatePayload`](/lender-api/reference/members/objects/staged-file-upload-create-payload) (object) — Return type for the `stagedFileUploadCreate` mutation.
* [`StagedFileUploadCreateUserError`](/lender-api/reference/members/objects/staged-file-upload-create-user-error) (object) — An error that could occur during the execution of the `stagedFileUploadCreate` mutation.
* [`StagedFileUploadCreateUserErrorCode`](/lender-api/reference/members/enums/staged-file-upload-create-user-error-code) (enum) — Possible error codes that can be returned by StagedFileUploadCreateUserError.
* [`StagedFileUploadInput`](/lender-api/reference/members/inputs/staged-file-upload-input) (input) — Input to create a staged file upload.
* [`Url`](/lender-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Engagement
Source: https://dev.ownright.com/lender-api/reference/queries/engagements/engagement

Retrieve a single engagement by GID.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetEngagement($id: EngagementGID!) {
    engagement(id: $id) {
      cancellable
      createdAt
      id
      owner
      shortId
      type
      clients {
        email
        firstName
        lastName
        middleName
        phoneNumber
      }
      ... on PurchaseEngagement {
        closingDate
        property {
          address {
            city
            country
            latitude
            longitude
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        status {
          state
        }
      }
      ... on RefinanceEngagement {
        closingDate
        property {
          address {
            city
            country
            latitude
            longitude
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        status {
          state
        }
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "id": "gid://ownright/Engagement/1"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "engagement": {
        "cancellable": true,
        "createdAt": "2025-01-15T10:30:00Z",
        "id": "gid://ownright/Engagement/1",
        "owner": "Jane Doe",
        "shortId": "ABC-123",
        "type": "PURCHASE",
        "clients": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "middleName": "M",
            "phoneNumber": "+14165551234"
          }
        ],
        "closingDate": "2025-06-15",
        "property": {
          "address": {
            "city": "Toronto",
            "country": "CANADA",
            "latitude": 1,
            "longitude": 1,
            "postalCode": "M5V 1A1",
            "province": "ALBERTA",
            "shortTitle": "123 Main St, Toronto",
            "street": "123 Main St",
            "title": "123 Main St, Toronto",
            "unitNumber": "Suite 100"
          }
        },
        "status": {
          "state": "CANCELLED"
        }
      }
    }
  }
  ```
</ResponseExample>

## Query field

`engagement`

### Arguments

<ParamField type="EngagementGID!">
  The GID of the engagement.
</ParamField>

### Return fields

<ResponseField name="engagement" type="Engagement">
  Retrieve a single engagement by GID.

  <Expandable title="properties">
    <ResponseField name="cancellable" type="Boolean!">
      Whether the engagement can be cancelled.
    </ResponseField>

    <ResponseField name="clients" type="[EngagementClient!]!">
      The clients on this engagement.

      <Expandable title="properties">
        <ResponseField name="email" type="String">
          The email address of the client.
        </ResponseField>

        <ResponseField name="firstName" type="String">
          The first name of the client.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the client.
        </ResponseField>

        <ResponseField name="middleName" type="String">
          The middle name of the client.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the client.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the engagement was created.
    </ResponseField>

    <ResponseField name="id" type="EngagementGID!">
      The unique identifier of the engagement.
    </ResponseField>

    <ResponseField name="owner" type="String">
      The name of the engagement owner.
    </ResponseField>

    <ResponseField name="shortId" type="String!">
      A short human-readable identifier for the engagement.
    </ResponseField>

    <ResponseField name="type" type="EngagementType!">
      The type of the engagement.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Engagement`](/lender-api/reference/members/interfaces/engagement) (interface) — Represents an engagement.
* [`EngagementClient`](/lender-api/reference/members/objects/engagement-client) (object) — A client contact on an engagement.
* [`EngagementGID`](/lender-api/reference/members/scalars/engagement-gid) (scalar) — A global identifier for a Engagement object in format of 'gid://ownright/Engagement/ID'.
* [`EngagementType`](/lender-api/reference/members/enums/engagement-type) (enum) — The type of engagement.
* [`ISO8601DateTime`](/lender-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime


# Engagements
Source: https://dev.ownright.com/lender-api/reference/queries/engagements/engagements

Search and list engagements.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetEngagements($after: String, $before: String, $filters: EngagementSearchFilterInput, $first: Int, $last: Int, $query: String, $sortOrder: EngagementSearchSortOrder) {
    engagements(after: $after, before: $before, filters: $filters, first: $first, last: $last, query: $query, sortOrder: $sortOrder) {
      nodes {
        cancellable
        createdAt
        id
        owner
        shortId
        type
        clients {
          email
          firstName
          lastName
          middleName
          phoneNumber
        }
        ... on PurchaseEngagement {
          closingDate
          property {
            address {
              city
              country
              latitude
              longitude
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
          }
        }
        ... on RefinanceEngagement {
          closingDate
          property {
            address {
              city
              country
              latitude
              longitude
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
          }
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "after": "example-after",
    "before": "example-before",
    "filters": {
      "closingDate": {
        "endDate": "2025-06-15",
        "startDate": "2025-06-15"
      },
      "createdAt": {
        "endDate": "2025-06-15",
        "startDate": "2025-06-15"
      },
      "provinces": [
        "ALBERTA"
      ],
      "statuses": [
        "CANCELLED"
      ],
      "types": [
        "PURCHASE"
      ]
    },
    "first": 10,
    "last": 10,
    "query": "search term",
    "sortOrder": "CLOSING_DATE_ASC"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "engagements": {
        "nodes": [
          {
            "cancellable": true,
            "createdAt": "2025-01-15T10:30:00Z",
            "id": "gid://ownright/Engagement/1",
            "owner": "Jane Doe",
            "shortId": "ABC-123",
            "type": "PURCHASE",
            "clients": [
              {
                "email": "jane@example.com",
                "firstName": "Jane",
                "lastName": "Doe",
                "middleName": "M",
                "phoneNumber": "+14165551234"
              }
            ],
            "closingDate": "2025-06-15",
            "property": {
              "address": {
                "city": "Toronto",
                "country": "CANADA",
                "latitude": 1,
                "longitude": 1,
                "postalCode": "M5V 1A1",
                "province": "ALBERTA",
                "shortTitle": "123 Main St, Toronto",
                "street": "123 Main St",
                "title": "123 Main St, Toronto",
                "unitNumber": "Suite 100"
              }
            },
            "status": {
              "state": "CANCELLED"
            }
          }
        ],
        "pageInfo": {
          "hasNextPage": true,
          "endCursor": "cursor_abc123"
        }
      }
    }
  }
  ```
</ResponseExample>

## Query field

`engagements`

### Arguments

<ParamField type="String">
  Returns the elements in the list that come after the specified cursor.
</ParamField>

<ParamField type="String">
  Returns the elements in the list that come before the specified cursor.
</ParamField>

<ParamField type="EngagementSearchFilterInput">
  Filters to apply to the engagement search.

  <Expandable title="properties">
    <ParamField type="DateRangeInput">
      Filter based on engagement closing date.

      <Expandable title="properties">
        <ParamField type="ISO8601Date">
          The end date of the date range.
        </ParamField>

        <ParamField type="ISO8601Date">
          The start date of the date range.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="DateRangeInput">
      Filter based on engagement creation date.

      <Expandable title="properties">
        <ParamField type="ISO8601Date">
          The end date of the date range.
        </ParamField>

        <ParamField type="ISO8601Date">
          The start date of the date range.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[Province!]">
      Filter based on province.
    </ParamField>

    <ParamField type="[EngagementStatus!]">
      Filter based on engagement status.
    </ParamField>

    <ParamField type="[EngagementType!]">
      Filter based on engagement type.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField type="Int">
  Returns the first *n* elements from the list.
</ParamField>

<ParamField type="Int">
  Returns the last *n* elements from the list.
</ParamField>

<ParamField type="String">
  Text query to search engagements.
</ParamField>

<ParamField type="EngagementSearchSortOrder">
  Sort order for results.
</ParamField>

### Return fields

<ResponseField name="engagements" type="EngagementConnection">
  Search and list engagements.

  <Expandable title="properties">
    <ResponseField name="edges" type="[EngagementEdge]">
      A list of edges.

      <Expandable title="properties">
        <ResponseField name="cursor" type="String!">
          A cursor for use in pagination.
        </ResponseField>

        <ResponseField name="node" type="Engagement">
          The item at the end of the edge.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type="[Engagement]">
      A list of nodes.

      <Expandable title="properties">
        <ResponseField name="cancellable" type="Boolean!">
          Whether the engagement can be cancelled.
        </ResponseField>

        <ResponseField name="clients" type="[EngagementClient!]!">
          The clients on this engagement.
        </ResponseField>

        <ResponseField name="createdAt" type="ISO8601DateTime!">
          The time the engagement was created.
        </ResponseField>

        <ResponseField name="id" type="EngagementGID!">
          The unique identifier of the engagement.
        </ResponseField>

        <ResponseField name="owner" type="String">
          The name of the engagement owner.
        </ResponseField>

        <ResponseField name="shortId" type="String!">
          A short human-readable identifier for the engagement.
        </ResponseField>

        <ResponseField name="type" type="EngagementType!">
          The type of the engagement.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type="PageInfo!">
      Information to aid in pagination.

      <Expandable title="properties">
        <ResponseField name="endCursor" type="String">
          When paginating forwards, the cursor to continue.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!">
          When paginating forwards, are there more items?
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!">
          When paginating backwards, are there more items?
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          When paginating backwards, the cursor to continue.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`DateRangeInput`](/lender-api/reference/members/inputs/date-range-input) (input) — Input for a date range.
* [`Engagement`](/lender-api/reference/members/interfaces/engagement) (interface) — Represents an engagement.
* [`EngagementClient`](/lender-api/reference/members/objects/engagement-client) (object) — A client contact on an engagement.
* [`EngagementConnection`](/lender-api/reference/members/objects/engagement-connection) (object) — The connection type for Engagement.
* [`EngagementEdge`](/lender-api/reference/members/objects/engagement-edge) (object) — An edge in a connection.
* [`EngagementGID`](/lender-api/reference/members/scalars/engagement-gid) (scalar) — A global identifier for a Engagement object in format of 'gid://ownright/Engagement/ID'.
* [`EngagementSearchFilterInput`](/lender-api/reference/members/inputs/engagement-search-filter-input) (input) — Input to filter results when performing an engagements search.
* [`EngagementSearchSortOrder`](/lender-api/reference/members/enums/engagement-search-sort-order) (enum) — Possible ways to sort results when searching engagements.
* [`EngagementStatus`](/lender-api/reference/members/enums/engagement-status) (enum) — Possible statuses for engagements.
* [`EngagementType`](/lender-api/reference/members/enums/engagement-type) (enum) — The type of engagement.
* [`ISO8601Date`](/lender-api/reference/members/scalars/iso8601-date) (scalar) — An ISO 8601-encoded date
* [`ISO8601DateTime`](/lender-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`PageInfo`](/lender-api/reference/members/objects/page-info) (object) — Information about pagination in a connection.
* [`Province`](/lender-api/reference/members/enums/province) (enum) — Possible provinces.


# Lender
Source: https://dev.ownright.com/lender-api/reference/queries/lender/lender

The authenticated lender entity.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetLender {
    lender {
      logoUrl
      name
      members {
        email
        firstName
        id
        lastName
      }
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "lender": {
        "logoUrl": "https://example.com",
        "name": "example-name",
        "members": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "id": "gid://ownright/TeamMember/1",
            "lastName": "Doe"
          }
        ]
      }
    }
  }
  ```
</ResponseExample>

## Query field

`lender`

### Return fields

<ResponseField name="lender" type="Lender!">
  The authenticated lender entity.

  <Expandable title="properties">
    <ResponseField name="logoUrl" type="Url">
      The URL of the lender logo.
    </ResponseField>

    <ResponseField name="members" type="[TeamMember!]!">
      The team members of the lender.

      <Expandable title="properties">
        <ResponseField name="email" type="String">
          The email address of the team member.
        </ResponseField>

        <ResponseField name="firstName" type="String">
          The first name of the team member.
        </ResponseField>

        <ResponseField name="id" type="TeamMemberGID!">
          The unique identifier of the team member.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the team member.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="name" type="String!">
      The name of the lender.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Lender`](/lender-api/reference/members/objects/lender) (object) — The authenticated lender entity.
* [`TeamMember`](/lender-api/reference/members/objects/team-member) (object) — A team member in a lender entity.
* [`TeamMemberGID`](/lender-api/reference/members/scalars/team-member-gid) (scalar) — A global identifier for a TeamMember object in format of 'gid://ownright/TeamMember/ID'.
* [`Url`](/lender-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Team Members
Source: https://dev.ownright.com/lender-api/reference/queries/lender/team-members

List all team members for the authenticated lender entity.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetTeamMembers {
    teamMembers {
      email
      firstName
      id
      lastName
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "teamMembers": [
        {
          "email": "jane@example.com",
          "firstName": "Jane",
          "id": "gid://ownright/TeamMember/1",
          "lastName": "Doe"
        }
      ]
    }
  }
  ```
</ResponseExample>

## Query field

`teamMembers`

### Return fields

<ResponseField name="teamMembers" type="[TeamMember!]!">
  List all team members for the authenticated lender entity.

  <Expandable title="properties">
    <ResponseField name="email" type="String">
      The email address of the team member.
    </ResponseField>

    <ResponseField name="firstName" type="String">
      The first name of the team member.
    </ResponseField>

    <ResponseField name="id" type="TeamMemberGID!">
      The unique identifier of the team member.
    </ResponseField>

    <ResponseField name="lastName" type="String">
      The last name of the team member.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`TeamMember`](/lender-api/reference/members/objects/team-member) (object) — A team member in a lender entity.
* [`TeamMemberGID`](/lender-api/reference/members/scalars/team-member-gid) (scalar) — A global identifier for a TeamMember object in format of 'gid://ownright/TeamMember/ID'.


# Event list
Source: https://dev.ownright.com/lender-api/reference/webhooks/event-list

A complete list of the webhook events supported by the Lender API

<Note>
  Webhook support for the Lender API is coming soon. We're actively working on
  adding event-driven notifications so you can receive real-time updates as
  engagements progress through their lifecycle. Check back for updates or reach
  out to [developers@ownright.com](mailto:developers@ownright.com) for early
  access information.
</Note>


# Limitations
Source: https://dev.ownright.com/limitations

There are a few limitations to be aware of when using the Ownright Developer Platform

The Ownright Developer Platform is built to help you deliver seamless legal support to your clients —
but there are a few limitations to be aware of. These apply both to our current product capabilities
and to the Partner API’s operational scope.

## 📍 Geographic coverage

We currently operate in Ontario, Alberta, and British Columbia, Canada. Referrals for properties outside of these provinces cannot be serviced at this time.

## 🏠 Transaction type scope

Ownright focuses on residential resale transactions. We do not support:

<ul>
  <li>Commercial or mixed-use properties</li>
  <li>New build or pre-construction transactions</li>
  <li>Developer or builder-side work</li>
</ul>

Our services are optimized for homebuyers, sellers, and refinancing clients transacting on existing homes.

## 🕒 Human-powered, not fully automated

The platform is backed by a dedicated legal and client success team.
While our API's are always online, some events are triggered by human activity, not automation.

For example:

<ul>
  <li>
    Referrals submitted outside of business hours may not generate immediate
    webhook updates.
  </li>

  <li>
    Matter status changes depend on actions taken by legal professionals, which
    may happen during business hours only.
  </li>
</ul>

Our business hours are Monday-Friday, 8 AM to 6 PM EST. Excluding Canadian public and bank holidays.

## 🚫 Referral eligibility and rejections

Referrals may be declined if they fall outside of our operating parameters. These include:

<ul>
  <li>Property location outside Ontario, Alberta, or British Columbia</li>
  <li>Ineligible transaction type (e.g., new build)</li>
  <li>Missing or invalid client contact details</li>
  <li>Legal complexity that exceeds our current scope</li>
</ul>

If a referral cannot be accepted, a webhook will be sent notifying you of the status and reason (where possible).

## 🧪 No sandbox environment (Yet)

We currently do not offer a sandbox or test environment.
All API interactions happen in our live environment. Please use test referral data and flag your integrations clearly when conducting integration testing.

We are exploring options for a partner sandbox in future updates.

## 📬 Webhook delivery reliability

Webhooks are delivered as best-effort HTTP POST requests. While we aim for reliability:

<ul>
  <li>
    Webhooks may be delayed slightly depending on event timing and processing
    queue
  </li>

  <li>
    If a delivery fails, we automatically retry up to 3 times with exponential
    backoff
  </li>

  <li>
    After failed retries, the event is marked as undelivered (logging and replay
    functionality coming soon)
  </li>
</ul>

We strongly recommend verifying all webhook signatures and building your integration to be idempotent.

## 🔧 Stability and API versioning

While we aim for stability, breaking changes may occasionally occur. We will always aim to:

<ul>
  <li>Provide early notice via changelog</li>
  <li>Version the API if changes are significant</li>
  <li>Limit disruption to existing integrations</li>
</ul>

Subscribe to our changelog's to stay informed.

## 💬 Still have questions?

If you’re not sure whether your use case is supported or need help assessing an integration, reach out to our team at [developers@ownright.com](mailto:developers@ownright.com).


# Referrals and matters
Source: https://dev.ownright.com/partner-api/core-concepts/referrals-and-matters

The two foundational objects that play a critical role in the Partner API

Understanding how referrals and matters work is essential to integrating with the
Ownright Developer Platform. These are the two foundational objects that represent
the lifecycle of a real estate legal transaction — from initial client handoff to final
legal completion.

## 🧩 The real-world analogy

Think of a **referral** as a warm introduction — you or your product has identified someone
who needs real estate legal support, and you’re handing them off to Ownright to help with
their transaction.

Once that referral is accepted and the client agrees to move forward, it becomes a **matter** —
the actual legal file that our team opens, works on, and completes.

These two stages mirror the real-world journey of a client:

<img alt="Real World Analogy Light" />

<img alt="Real World Analogy Dark" />

### Why we modeled it this way

Real estate transactions are complex, dynamic, and timeline-sensitive.
We’ve structured the referral and matter models to reflect how legal work happens in the real world:

<ol>
  <li>
    **Separation of referral vs matter** helps partners track both pipeline and
    active files
  </li>

  <li>
    **Status-driven lifecycles** allow for clear communication and automation
  </li>

  <li>
    **Granular types and transitions** give you transparency and actionable
    insights throughout the transaction
  </li>
</ol>

## 🤝 Referrals

A **referral** is your way of introducing a potential client to Ownright. It contains basic
information about the client, the type of matter, and any contextual details.

Once a referral is submitted, our client success team attempts to contact the client,
confirm matter details, and determine if the matter is serviceable.

Right now, Ownright supports accepting four different types of referrals:

<ol>
  <li>Purchase - a purchase where your client is the purchaser.</li>
  <li>Sale - a sale where your client is the seller.</li>
  <li>Refinance - a refinance where your client is the borrower.</li>

  <li>
    Status Certificate Review - a status certificate review where your client is
    the prospective purchaser.
  </li>
</ol>

### Referral lifecycle

A referral has a relatively straightforward lifecycle:

<img alt="Referral Lifecycle Light" />

<img alt="Referral Lifecycle Dark" />

<ol>
  <li>
    **Open** - The referral has been received and is awaiting contact or
    qualification.
  </li>

  <li>
    **Converted** - The referral was successful — the client has agreed and a
    matter has been created.
  </li>

  <li>
    **Retired** - The referral is closed without conversion. This can happen if
    the client chose another provider, the transaction is no longer proceeding,
    or Ownright could not service it.
  </li>
</ol>

<Info>
  Every referral object returned in the API includes a `status` field to
  indicate where it stands in its lifecycle. Similarly you can subscribe to
  webhook events to get notified about changes to a referral's status. It is
  possible for a referral to be reopened after it has been marked converted or
  retired. Read the [Partner API Reference](/partner-api/reference/connecting)
  to better understand the structure of a referral object.
</Info>

## 🏡 Matters

A matter represents an active legal file. This is where real legal work happens: title searches, document signing, registration, and more.
Each matter is handled by our legal team and tracked within the Ownright platform.

It is not surprising that Ownright supports the same kind of matters as it does referrals, this is because referrals feed into matters.
To reiterate, the currently supported matters are purchase, sale, refinance, and status certificate reviews.

### Purchase, sale, and refinance lifecycle

Purchases, sales, and refinances all share the same lifecycle (for now):

<img alt="Matter Lifecycle Light" />

<img alt="Matter Lifecycle Dark" />

<ol>
  <li>
    **Before closing** - The file has been opened and legal prep is underway.
  </li>

  <li>
    **Closing in progress** - We’re actively handling closing day tasks —
    registration, etc.
  </li>

  <li>
    **After closing** - The matter has closed, but post-closing tasks (e.g.,
    reporting, final communication) are being finalized.
  </li>

  <li>**Completed** - The legal work is fully done.</li>
  <li>**Abandoned** - The matter fell through or was cancelled.</li>
</ol>

### Status certificate review lifecycle

Status certificate reviews are slightly different from the other types of matters:

<img alt="Status Certificate Review Lifecycle Light" />

<img alt="Status Certificate Review Lifecycle Dark" />

<ol>
  <li>**In Progress** - The review is underway by our team.</li>
  <li>**Completed** - The review has been completed.</li>

  <li>
    **Abandoned** - Review was cancelled, withdrawn, or otherwise stopped.
  </li>
</ol>

## 🚀 Ready to go!

By understanding referrals and matters, you’re equipped to guide your clients through every step
of the closing journey, while keeping your systems in sync with the legal work being done by Ownright
behind the scenes.

## Next steps

<CardGroup>
  <Card title="Making referrals" icon="paper-plane" href="/partner-api/guides/making-referrals">
    Start sending clients to Ownright programmatically by creating a referral.
  </Card>

  <Card title="Authentication" icon="lock" href="/fundamentals/authentication">
    Understand how to authenticate your requests to the Partner API.
  </Card>
</CardGroup>


# Fetching matter details
Source: https://dev.ownright.com/partner-api/guides/fetching-matter-details

An overview of how you can fetch details on matters you have access to

To retrieve information about a real estate transaction (a “matter”), you can query our
GraphQL API using either the `matter` query (for a specific matter) or the `matters`
query (to retrieve a list).

## 🔍 Fetching a specific matter

Use the `matter(id: MatterGID!)` query to retrieve details about a single matter.

```graphql Request theme={null}
query GetMatterDetails {
  matter(id: "gid://ownright/Transaction/1") {
    matter {
      id
      ... on Transaction {
        status
        # ... other fields
      }
    }
  }
}
```

**Sample response**:

```graphql Response theme={null}
{
  "data": {
    "matter": {
      "id": "gid://ownright/Transaction/1",
      "status": "CLOSING_IN_PROGRESS"
    }
  }
}
```

## 📋 Fetching multiple matters

If you don’t know the matter ID or want to browse multiple matters,
you can use the matters query to list them.

```graphql Request theme={null}
query ListMatters {
  matters(first: 10) {
    edges {
      node {
        id
        ... on Transaction {
          status
          # ... other fields
        }
      }
    }
  }
}
```

This query retrieves the first 10 matters, along with their status.

## Next steps

<CardGroup>
  <Card title="Receiving webhooks on referral updates" icon="bell" href="/partner-api/guides/receiving-webhooks-on-referral-updates">
    Get automatic updates when referral statuses change.
  </Card>

  <Card title="Receiving webhooks on matter updates" icon="bell" href="/partner-api/guides/receiving-webhooks-on-matter-updates">
    Get automatic updates when matter statuses change.
  </Card>
</CardGroup>


# Fetching referral details
Source: https://dev.ownright.com/partner-api/guides/fetching-referral-details

An overview of how you can fetch details on referrals you have access to

To retrieve information about a referral, you can query our
GraphQL API using either the `referral` query (for a specific referral) or the `referrals`
query (to retrieve a list).

## 🔍 Fetching a specific referral

Use the `referral(id: ReferralGID!)` query to retrieve details about a single referral.

```graphql Request theme={null}
query GetReferralDetails {
  referral(id: "gid://ownright/Referral/1") {
    referral {
      id
      status
      # ... other fields
    }
  }
}
```

**Sample response**:

```graphql Response theme={null}
{
  "data": {
    "referral": {
      "id": "gid://ownright/Referral/1",
      "status": "OPEN"
    }
  }
}
```

## 📋 Fetching multiple referrals

If you don’t know the referral ID or want to browse multiple referrals,
you can use the referrals query to list them.

```graphql Request theme={null}
query ListReferrals {
  referrals(first: 10) {
    edges {
      node {
        id
        status
        # ... other fields
      }
    }
  }
}
```

This query retrieves the first 10 referrals, along with their status.

## Next steps

<CardGroup>
  <Card title="Fetching matter details" icon="gavel" href="/partner-api/guides/fetching-matter-details">
    Track the progress of your client's legal transaction.
  </Card>

  <Card title="Receiving webhooks on referral updates" icon="bell" href="/partner-api/guides/receiving-webhooks-on-referral-updates">
    Get automatic updates when referral statuses change.
  </Card>
</CardGroup>


# Making referrals
Source: https://dev.ownright.com/partner-api/guides/making-referrals

A quick how-to guide on sending client referrals to Ownright

To create a referral, make a GraphQL mutation request to our API using one of the
available referral create mutations (e.g. `propertyClosingReferralCreate`). This allows
you to refer a client for a specific type of real estate transaction.

## 🛠️ Steps to create a referral

<Steps>
  <Step title="Choose a referral type and mutation">
    You’ll need to specify the type of referral you'd like to make. Once you know what kind of referral,
    choose to use the appropriate GraphQL mutation:

    | Referral type             | Mutation                        | Notes                                        |
    | ------------------------- | ------------------------------- | -------------------------------------------- |
    | Purchase                  | `propertyClosingReferralCreate` | Supply the `PURCHASE_PROPERTY_CLOSING` type. |
    | Sale                      | `propertyClosingReferralCreate` | Supply the `SALE_PROPERTY_CLOSING` type.     |
    | Refinance                 | `refinanceReferralCreate`       |                                              |
    | Status Certificate Review | `statusCertificateReviewCreate` |                                              |

    <Note>
      Read our [Partner API reference](/partner-api/reference/connecting) for all of the details on each mutation.
    </Note>
  </Step>

  <Step title="Construct the GraphQL mutation with all of the inputs">
    Once you know what type of referral you want to make, you need to construct the
    request with your desired inputs, for example:

    ```graphql Request [expandable] theme={null}
    mutation PropertyClosingReferralCreate {
      propertyClosingReferralCreate(input: {
        type: PURCHASE_PROPERTY_CLOSING,
        contacts: [
          {
            firstName: "John",
            email: "something@something.com",
            primary: true
          }
        ],
        # ... other input
      }) {
        referral {
          id
        }
        userErrors {
          code
          message
        }
      }
    }
    ```
  </Step>

  <Step title="Handle the response">
    On success, the response will include the newly created referral and any fields you have queried for.
    If something goes wrong, check the `userErrors` array for the error code and message (read more about
    errors in our [Errors and response codes](/fundamentals/errors-and-response-codes) documentation)

    ✅ **Example response**

    ```json Successful response [expandable] theme={null}
    {
      "data": {
        "propertyClosingReferralCreate": {
          "referral": {
            "id": "ref_12345"
          },
          "userErrors": []
        }
      }
    }
    ```

    ❌ **Error response**

    ```json Error response [expandable] theme={null}
    {
      "data": {
        "propertyClosingReferralCreate": {
          "referral": null,
          "userErrors": [
            {
              "code": "INVALID_EMAIL",
              "message": "Email must be a valid email address."
            }
          ]
        }
      }
    }
    ```
  </Step>
</Steps>

## 🧠 Tips

<ul>
  <li>Ensure the email is valid and unique for each contact.</li>

  <li>
    You can include multiple contacts, but only one should be marked primary:
    true.
  </li>
</ul>

## Next steps

<CardGroup>
  <Card title="Fetching referral details" icon="file-lines" href="/partner-api/guides/fetching-referral-details">
    Retrieve detailed information about a specific referral.
  </Card>

  <Card title="Fetching matter details" icon="gavel" href="/partner-api/guides/fetching-matter-details">
    Track the progress of your client's legal transaction.
  </Card>
</CardGroup>


# Receiving webhooks on matter updates
Source: https://dev.ownright.com/partner-api/guides/receiving-webhooks-on-matter-updates

A practical example of how you can receive automatic updates on matters

<Note>
  This guide isn’t available yet, but it’s on our roadmap. We’re actively
  working on expanding our documentation — check back soon or reach out to
  [developers@ownright.com](mailto:developers@ownright.com) if you need help in the meantime.
</Note>

## Next steps

<CardGroup>
  <Card title="API Reference" icon="code" href="/partner-api/reference/connecting">
    Explore all queries, mutations, and webhooks available in the Partner API.
  </Card>

  <Card title="Changelog" icon="clock-rotate-left" href="/partner-api/reference/changelog">
    Stay up to date with changes to the Partner API.
  </Card>
</CardGroup>


# Receiving webhooks on referral updates
Source: https://dev.ownright.com/partner-api/guides/receiving-webhooks-on-referral-updates

A practical example of how you can receive automatic updates on referrals

<Note>
  This guide isn’t available yet, but it’s on our roadmap. We’re actively
  working on expanding our documentation — check back soon or reach out to
  [developers@ownright.com](mailto:developers@ownright.com) if you need help in the meantime.
</Note>

## Next steps

<CardGroup>
  <Card title="Receiving webhooks on matter updates" icon="bell" href="/partner-api/guides/receiving-webhooks-on-matter-updates">
    Get automatic updates when matter statuses change.
  </Card>

  <Card title="API Reference" icon="code" href="/partner-api/reference/connecting">
    Explore all queries, mutations, and webhooks available in the Partner API.
  </Card>
</CardGroup>


# Overview
Source: https://dev.ownright.com/partner-api/overview

Integrate referral and matter workflows into your product with the Ownright Partner API

<img alt="Partner API Overview" />

<img alt="Partner API Overview" />

The **Partner API** enables proptech companies to programmatically refer clients to Ownright for
their real estate legal needs and track the progress of their transactions.

With the Partner API, you can:

<ol>
  <li>
    🤝 **Make referrals**: Seamlessly hand off your client to Ownright for their
    legal needs.
  </li>

  <li>
    👀 **Track matters**: Get real-time visibility into the status of your
    client's closing.
  </li>

  <li>
    🔔 **Receive webhook updates**: Stay in sync as closings move forward, with
    key event notifications pushed to your system from ours.
  </li>
</ol>

## Get started

<CardGroup>
  <Card title="Core concepts" icon="gavel" href="/partner-api/core-concepts/referrals-and-matters">
    Learn about referrals and matters — the two foundational objects in the
    Partner API.
  </Card>

  <Card title="Authentication" icon="lock" href="/fundamentals/authentication">
    Understand how to authenticate your requests to the Partner API.
  </Card>

  <Card title="Making your first referral" icon="paper-plane" href="/partner-api/guides/making-referrals">
    Start sending clients to Ownright programmatically by creating a referral.
  </Card>

  <Card title="API Reference" icon="code" href="/partner-api/reference/connecting">
    Explore all queries, mutations, and webhooks available in the Partner API.
  </Card>
</CardGroup>


# Changelog
Source: https://dev.ownright.com/partner-api/reference/changelog

Stay up to date with the changes we make to our platform

## Changelog

<Update label="2026-03-20" description="v1.0.0">
  The initial release of the Ownright Developer Platform documentation.
</Update>


# Connecting
Source: https://dev.ownright.com/partner-api/reference/connecting

General details on how to connect to the Partner API

Before you start sending queries and mutations, you need to know where to
send requests and what headers to include. This page covers the basics of
making a successful connection to the Ownright Partner API.

## 🔗 API endpoint

All GraphQL requests are sent to a single HTTPS endpoint:

```
POST https://api.ownright.com/partners/graphql
```

## 🧾 Required headers

Every request to the Partner API must include the following headers:

| Header                           | HTTP Status                                     |
| -------------------------------- | ----------------------------------------------- |
| `Content-Type: application/json` | HMAC SHA256 signature of the request            |
| `X-Ownright-Client-Id`           | Your unique API client ID                       |
| `X-Ownright-API-Key`             | Your long-lived API key used for authentication |
| `X-Ownright-Organization-Id`     | A constant identifier for the Ownright platform |

These headers are used to authenticate your requests and route them correctly.

## 📦 Example Request

Here’s an example of a basic GraphQL request using curl:

```bash Example request theme={null}
curl -X POST https://api.ownright.com/partners/graphql \
  -H "Content-Type: application/json" \
  -H "X-Ownright-Client-Id: your-client-id" \
  -H "X-Ownright-API-Key: your-api-key" \
  -H "X-Ownright-Organization-Id: ownright-prod-org" \
  -d '{"query": "query { referral(id: "gid://ownright/Referral/1") { id } }"}'
```

<Tip>
  Use tools like [Postman](https://www.postman.com/),
  [Insomnia](https://insomnia.rest/), or
  [GraphiQL](https://github.com/graphql/graphiql) for easier request building
  and testing.
</Tip>

## 🔒 Need Help?

If you haven’t received your client ID or API key yet, read the [Authentication]() documentation.


# Country
Source: https://dev.ownright.com/partner-api/reference/members/enums/country

Possible countries.

## Values

| Value    | Description                    |
| -------- | ------------------------------ |
| `CANADA` | Represents Canada the country. |

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# CurrencyCode
Source: https://dev.ownright.com/partner-api/reference/members/enums/currency-code

Possible currency codes.

## Values

| Value | Description                       |
| ----- | --------------------------------- |
| `CAD` | Represents the CAD currency code. |
| `USD` | Represents the USD currency code. |

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)


# CustomAttributeType
Source: https://dev.ownright.com/partner-api/reference/members/enums/custom-attribute-type

Possible custom attribute types.

## Values

| Value          | Description                                                                                                         |
| -------------- | ------------------------------------------------------------------------------------------------------------------- |
| `BOOLEAN`      | A boolean value ("true" or "false").                                                                                |
| `COLOR`        | A hex color code starting with # (e.g., "#FF0000" or "#F00").                                                       |
| `DATE`         | A date in ISO8601 format (YYYY-MM-DD, e.g., "2024-03-19").                                                          |
| `DATE_TIME`    | A datetime in ISO8601 format with timezone (YYYY-MM-DDThh:mm:ssZ, e.g., "2024-03-19T12:00:00Z").                    |
| `EMAIL`        | A valid email address (e.g., "[test@example.com](mailto:test@example.com)").                                        |
| `FLOAT`        | A decimal number value (e.g., "3.14").                                                                              |
| `INTEGER`      | A whole number value (e.g., "42").                                                                                  |
| `JSON`         | A valid JSON value of any type.                                                                                     |
| `MONEY`        | A money value as a JSON object with amount and currency code (e.g., \{"amount": "10.99", "currency\_code": "CAD"}). |
| `PHONE_NUMBER` | A valid E.164 phone number (e.g., "+1234567890").                                                                   |
| `STRING`       | A simple text value.                                                                                                |
| `URL`          | A valid HTTP or HTTPS URL (e.g., "[https://example.com](https://example.com)").                                     |

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# FileMimeType
Source: https://dev.ownright.com/partner-api/reference/members/enums/file-mime-type

Possible MIME types for files.

## Values

| Value                 | Description                                                                                           |
| --------------------- | ----------------------------------------------------------------------------------------------------- |
| `AUDIO_M4A`           | Represents the `audio/x-m4a` MIME type.                                                               |
| `AUDIO_MPEG`          | Represents the `audio/mpeg` MIME type.                                                                |
| `AUDIO_WAV`           | Represents the `audio/wav` MIME type.                                                                 |
| `CSS`                 | Represents the `text/css` MIME type.                                                                  |
| `CSV`                 | Represents the `text/csv` MIME type.                                                                  |
| `DOCUMENT_DOC`        | Represents the `application/msword` MIME type.                                                        |
| `DOCUMENT_DOCX`       | Represents the `application/vnd.openxmlformats-officedocument.wordprocessingml.documents` MIME type.  |
| `DOCUMENT_ODP`        | Represents the `application/vnd.oasis.opendocument.presentation` MIME type.                           |
| `DOCUMENT_ODS`        | Represents the `application/vnd.oasis.opendocument.spreadsheet` MIME type.                            |
| `DOCUMENT_ODT`        | Represents the `application/vnd.oasis.opendocument.text` MIME type.                                   |
| `DOCUMENT_OFFICE_PPT` | Represents the `application/vnd.ms-powerpoint` MIME type.                                             |
| `DOCUMENT_OFFICE_XLS` | Represents the `application/vnd.ms-excel` MIME type.                                                  |
| `DOCUMENT_PDF`        | Represents the `application/pdf` MIME type.                                                           |
| `DOCUMENT_PPTX`       | Represents the `application/vnd.openxmlformats-officedocument.presentationml.presentation` MIME type. |
| `DOCUMENT_RTF`        | Represents the `application/rtf` MIME type.                                                           |
| `DOCUMENT_XLSX`       | Represents the `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` MIME type.         |
| `FONT_TTF`            | Represents the `application/x-font-ttf` MIME type.                                                    |
| `GZIP`                | Represents the `application/gzip` MIME type.                                                          |
| `HTML`                | Represents the `text/html` MIME type.                                                                 |
| `IMAGE_BMP`           | Represents the `image/bmp` MIME type.                                                                 |
| `IMAGE_GIF`           | Represents the `image/gif` MIME type.                                                                 |
| `IMAGE_HEIC`          | Represents the `image/heic` MIME type.                                                                |
| `IMAGE_HEIF`          | Represents the `image/heif` MIME type.                                                                |
| `IMAGE_JPEG`          | Represents the `image/jpeg` MIME type.                                                                |
| `IMAGE_PNG`           | Represents the `image/png` MIME type.                                                                 |
| `IMAGE_SVG`           | Represents the `image/svg+xml` MIME type.                                                             |
| `IMAGE_TIFF`          | Represents the `image/tiff` MIME type.                                                                |
| `IMAGE_WEBP`          | Represents the `image/webp` MIME type.                                                                |
| `JSON`                | Represents the `application/json` MIME type.                                                          |
| `MARKDOWN`            | Represents the `text/markdown` MIME type.                                                             |
| `TEXT_PLAIN`          | Represents the `text/plain` MIME type.                                                                |
| `VIDEO_AVI`           | Represents the `video/x-msvideo` MIME type.                                                           |
| `VIDEO_MOV`           | Represents the `video/quicktime` MIME type.                                                           |
| `VIDEO_MP4`           | Represents the `video/mp4` MIME type.                                                                 |
| `ZIP`                 | Represents the `application/zip` MIME type.                                                           |

## Used by

* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)


# LoanType
Source: https://dev.ownright.com/partner-api/reference/members/enums/loan-type

The type of loan.

## Values

| Value              | Description                     |
| ------------------ | ------------------------------- |
| `BRIDGE_LOAN`      | The bridge loan loan type.      |
| `LINE_OF_CREDIT`   | The line of credit loan type.   |
| `MORTGAGE`         | The mortgage loan type.         |
| `VENDOR_TAKE_BACK` | The vendor take back loan type. |


# MatterClosingActionItemState
Source: https://dev.ownright.com/partner-api/reference/members/enums/matter-closing-action-item-state

Possible states for matters closing action items.

## Values

| Value         | Description                                   |
| ------------- | --------------------------------------------- |
| `COMPLETED`   | The action item has been completed.           |
| `IN_PROGRESS` | The action item is currently being actioned.  |
| `LATE`        | The action item is past its expected at date. |
| `PENDING`     | The action item is waiting to be actioned on. |


# MatterMilestoneHandle
Source: https://dev.ownright.com/partner-api/reference/members/enums/matter-milestone-handle

Possible types of matter milestones.

## Values

| Value                             | Description                                                         |
| --------------------------------- | ------------------------------------------------------------------- |
| `ADJUSTMENTS_CONFIRMED`           | Represents the adjustments confirmed milestone.                     |
| `ALIGNED_WITH_BUYER`              | Represents the aligned with buyer milestone.                        |
| `ALIGNED_WITH_SELLER`             | Represents the aligned with seller milestone.                       |
| `FINANCING_FIRM`                  | Represents the financing firm milestone.                            |
| `FINANCING_INFORMATION_CONFIRMED` | Represents the financing information confirmed milestone.           |
| `KEY_HANDOVER_CONFIRMED`          | Represents the key handover confirmed milestone.                    |
| `LOAN_INSTRUCTIONS_RECEIVED`      | Represents the loan instructions received milestone.                |
| `MONEY_RECEIVED`                  | Represents the money received milestone.                            |
| `PAYOUTS_CONFIRMED`               | Represents the payouts confirmed milestone.                         |
| `PURCHASE_CLOSING_DAY`            | Represents the purchase closing day milestone.                      |
| `PURCHASE_DOCUMENTS_SIGNED`       | Represents the purchase documents signed milestone.                 |
| `PURCHASE_FINAL_REPORT`           | Represents the purchase final report milestone.                     |
| `PURCHASE_OFFER_FIRM`             | Represents the purchase offer firm milestone.                       |
| `PURCHASE_TITLE_SEARCH`           | Represents the purchase title search milestone.                     |
| `REFINANCE_CLOSING_DAY`           | Represents the refinance closing day milestone.                     |
| `REFINANCE_DOCUMENTS_SIGNED`      | Represents the refinance documents signed milestone.                |
| `REFINANCE_FINAL_REPORT`          | Represents the refinance final report milestone.                    |
| `REFINANCE_FINANCING_CONFIRMED`   | Represents the refinance financing information confirmed milestone. |
| `REFINANCE_PAYOUTS_CONFIRMED`     | Represents the refinance payouts confirmed milestone.               |
| `REFINANCE_TITLE_SEARCH`          | Represents the refinance title search milestone.                    |
| `SALE_CLOSING_DAY`                | Represents the sale closing day milestone.                          |
| `SALE_DOCUMENTS_SIGNED`           | Represents the sale documents signed milestone.                     |
| `SALE_FINAL_REPORT`               | Represents the sale final report milestone.                         |
| `SALE_OFFER_FIRM`                 | Represents the sale offer firm milestone.                           |
| `SALE_TITLE_SEARCH`               | Represents the sale title search milestone.                         |


# MatterMilestoneStatus
Source: https://dev.ownright.com/partner-api/reference/members/enums/matter-milestone-status

Possible types of matter milestone statuses.

## Values

| Value       | Description                                |
| ----------- | ------------------------------------------ |
| `COMPLETED` | Represents the completed milestone status. |
| `PENDING`   | Represents the pending milestone status.   |


# MatterParticipantRepresentation
Source: https://dev.ownright.com/partner-api/reference/members/enums/matter-participant-representation

Possible representations matter participants can have.

## Values

| Value               | Description                                                       |
| ------------------- | ----------------------------------------------------------------- |
| `ESTATE_TRUSTEE`    | Given to participants that are represented by estate trustees.    |
| `POWER_OF_ATTORNEY` | Given to participants that are represented by power of attorneys. |


# MatterParticipantTrait
Source: https://dev.ownright.com/partner-api/reference/members/enums/matter-participant-trait

Possible traits matter participants can have.

## Values

| Value                         | Description                                                        |
| ----------------------------- | ------------------------------------------------------------------ |
| `BORROWER`                    | Trait given to participants that are borrowers.                    |
| `CORPORATION_SIGNING_OFFICER` | Trait given to participants that are corporation signing officers. |
| `ESTATE_TRUSTEE`              | Trait given to participants that are estate trustees.              |
| `GUARANTOR`                   | Trait given to participants that are guarantors.                   |
| `LENDER`                      | Trait given to participants that are lenders.                      |
| `NEW_OWNER`                   | Trait given to participants that are new owners.                   |
| `OLD_OWNER`                   | Trait given to participants that are old owners.                   |
| `POWER_OF_ATTORNEY`           | Trait given to participants that are power of attorneys.           |
| `PURCHASER`                   | Trait given to participants that are purchasers.                   |
| `SELLER`                      | Trait given to participants that are sellers.                      |
| `SPOUSE`                      | Trait given to participants that are spouses.                      |


# NotificationDeliveryMechanism
Source: https://dev.ownright.com/partner-api/reference/members/enums/notification-delivery-mechanism

Possible types of delivery mechanisms to deliver a notification.

## Values

| Value   | Description                   |
| ------- | ----------------------------- |
| `EMAIL` | The email delivery mechanism. |
| `SMS`   | The SMS delivery mechanism.   |

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)
* [`matters`](/partner-api/reference/queries/matters/matters) (query)


# PersonRole
Source: https://dev.ownright.com/partner-api/reference/members/enums/person-role

Possible roles for a person.

## Values

| Value                | Description           |
| -------------------- | --------------------- |
| `MORTGAGE_AGENT`     | A mortgage agent.     |
| `MORTGAGE_BROKER`    | A mortgage broker.    |
| `OTHER`              | Other.                |
| `REAL_ESTATE_AGENT`  | A real estate agent.  |
| `REAL_ESTATE_BROKER` | A real estate broker. |


# PropertyType
Source: https://dev.ownright.com/partner-api/reference/members/enums/property-type

Possible types of properties.

## Values

| Value                 | Description                                                  |
| --------------------- | ------------------------------------------------------------ |
| `CONDO`               | A property that is within a condominum building.             |
| `DETACHED_HOUSE`      | A property that is a detached house.                         |
| `LAND`                | A property that doesn't have any meaningful buildings on it. |
| `SEMI_DETACHED_HOUSE` | A property that is a semi-detached house.                    |


# Province
Source: https://dev.ownright.com/partner-api/reference/members/enums/province

Possible provinces.

## Values

| Value                       | Description                                        |
| --------------------------- | -------------------------------------------------- |
| `ALBERTA`                   | Represents Alberta the province.                   |
| `BRITISH_COLUMBIA`          | Represents British Columbia the province.          |
| `MANITOBA`                  | Represents Manitoba the province.                  |
| `NEWFOUNDLAND_AND_LABRADOR` | Represents Newfoundland And Labrador the province. |
| `NEW_BRUNSWICK`             | Represents New Brunswick the province.             |
| `NORTHWEST_TERRITORIES`     | Represents Northwest Territories the province.     |
| `NOVA_SCOTIA`               | Represents Nova Scotia the province.               |
| `NUNAVUT`                   | Represents Nunavut the province.                   |
| `ONTARIO`                   | Represents Ontario the province.                   |
| `PRINCE_EDWARD_ISLAND`      | Represents Prince Edward Island the province.      |
| `QUEBEC`                    | Represents Quebec the province.                    |
| `SASKATCHEWAN`              | Represents Saskatchewan the province.              |
| `YUKON`                     | Represents Yukon the province.                     |

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# ReferralIntentLevel
Source: https://dev.ownright.com/partner-api/reference/members/enums/referral-intent-level

Possible levels of intent for a referral.

## Values

| Value    | Description                                      |
| -------- | ------------------------------------------------ |
| `HIGH`   | Represents a high intent level for a referral.   |
| `LOW`    | Represents a low intent level for a referral.    |
| `MEDIUM` | Represents a medium intent level for a referral. |

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# ReferralStatus
Source: https://dev.ownright.com/partner-api/reference/members/enums/referral-status

Possible statuses for referrals.

## Values

| Value       | Description                                              |
| ----------- | -------------------------------------------------------- |
| `CONVERTED` | Given to referrals that have been converted to a matter. |
| `OPEN`      | Given to referrals that are currently open.              |
| `RETIRED`   | Given to referrals that are no longer being pursued.     |

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# ReferralType
Source: https://dev.ownright.com/partner-api/reference/members/enums/referral-type

Possible types of referrals.

## Values

| Value                       | Description                                            |
| --------------------------- | ------------------------------------------------------ |
| `PURCHASE_PROPERTY_CLOSING` | Represents a referral for a purchase property closing. |
| `REFINANCE`                 | Represents a referral for a refinance.                 |
| `SALE_PROPERTY_CLOSING`     | Represents a referral for a sale property closing.     |
| `STATUS_CERTIFICATE_REVIEW` | Represents a referral for a status certificate review. |

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# RefinanceOwnershipStatus
Source: https://dev.ownright.com/partner-api/reference/members/enums/refinance-ownership-status

The ownership status of a refinance participant or corporation.

## Values

| Value                      | Description                                      |
| -------------------------- | ------------------------------------------------ |
| `BEING_REMOVED_FROM_TITLE` | The "being removed from title" ownership status. |
| `NEW_ON_TITLE`             | The "new on title" ownership status.             |
| `REMAINING_ON_TITLE`       | The "remaining on title" ownership status.       |


# RefinanceState
Source: https://dev.ownright.com/partner-api/reference/members/enums/refinance-state

Possible states for refinances.

## Values

| Value                 | Description                                                                                |
| --------------------- | ------------------------------------------------------------------------------------------ |
| `ABANDONED`           | Given to refinances that are no longer active and have been abandoned.                     |
| `AFTER_CLOSING`       | Given to refinances that have closed.                                                      |
| `BEFORE_CLOSING`      | Given to refinances that are active and before the scheduled closing date.                 |
| `CLOSING_IN_PROGRESS` | Given to refinances that are actively closing on the closing date.                         |
| `COMPLETED`           | Given to refinances that are fully complete, no further work on the refinance is required. |
| `PENDING`             | Given to refinances that are yet to be setup by the primary clients.                       |


# StatusCertificateReviewAssessmentAnswerStatus
Source: https://dev.ownright.com/partner-api/reference/members/enums/status-certificate-review-assessment-answer-status

Represents the status of a status certificate review assessment answer.

## Values

| Value      | Description                            |
| ---------- | -------------------------------------- |
| `INFO`     | Represents the INFO answer status.     |
| `NEGATIVE` | Represents the NEGATIVE answer status. |
| `POSITIVE` | Represents the POSITIVE answer status. |


# StatusCertificateReviewAssessmentSchemaVersion
Source: https://dev.ownright.com/partner-api/reference/members/enums/status-certificate-review-assessment-schema-version

Available schema versions for status certificate review assessment.

## Values

| Value                      | Description                                            |
| -------------------------- | ------------------------------------------------------ |
| `VERSION_2025_06_26_00_00` | The schema version from VERSION\_2025\_06\_26\_00\_00. |


# StatusCertificateReviewAssessmentSectionRating
Source: https://dev.ownright.com/partner-api/reference/members/enums/status-certificate-review-assessment-section-rating

Represents the rating of a status certificate review assessment section.

## Values

| Value       | Description                              |
| ----------- | ---------------------------------------- |
| `EXCELLENT` | Represents the EXCELLENT section rating. |
| `FAIR`      | Represents the FAIR section rating.      |
| `GOOD`      | Represents the GOOD section rating.      |
| `POOR`      | Represents the POOR section rating.      |


# StatusCertificateReviewAssessmentState
Source: https://dev.ownright.com/partner-api/reference/members/enums/status-certificate-review-assessment-state

Represents the current state of a status certificate review assessment.

## Values

| Value         | Description                        |
| ------------- | ---------------------------------- |
| `COMPLETED`   | Represents the COMPLETED state.    |
| `IN_PROGRESS` | Represents the IN\_PROGRESS state. |
| `NOT_STARTED` | Represents the NOT\_STARTED state. |


# StatusCertificateReviewState
Source: https://dev.ownright.com/partner-api/reference/members/enums/status-certificate-review-state

Possible states for status certificate reviews.

## Values

| Value         | Description                                                   |
| ------------- | ------------------------------------------------------------- |
| `ABANDONED`   | Given to status certificate reviews that have been abandoned. |
| `COMPLETED`   | Given to status certificate reviews that have been completed. |
| `DRAFT`       | Given to status certificate reviews that are in draft.        |
| `IN_PROGRESS` | Given to status certificate reviews that are in progress.     |


# TransactionClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/enums/transaction-closing-status

Represents the closing status of a transaction.

## Values

| Value         | Description                       |
| ------------- | --------------------------------- |
| `ACTIVE`      | The `ACTIVE` closing status.      |
| `COMPLETED`   | The `COMPLETED` closing status.   |
| `IN_ESCROW`   | The `IN_ESCROW` closing status.   |
| `NOT_STARTED` | The `NOT_STARTED` closing status. |
| `PAUSED`      | The `PAUSED` closing status.      |


# TransactionSideName
Source: https://dev.ownright.com/partner-api/reference/members/enums/transaction-side-name

Possible sides of a transactions.

## Values

| Value       | Description                        |
| ----------- | ---------------------------------- |
| `PURCHASER` | The buying side of a transaction.  |
| `SELLER`    | The selling side of a transaction. |


# TransactionState
Source: https://dev.ownright.com/partner-api/reference/members/enums/transaction-state

Possible states for transactions.

## Values

| Value                 | Description                                                                                    |
| --------------------- | ---------------------------------------------------------------------------------------------- |
| `ABANDONED`           | Given to transactions that are no longer active and have been abandoned.                       |
| `AFTER_CLOSING`       | Given to transactions that have closed.                                                        |
| `BEFORE_CLOSING`      | Given to transactions that are active and before the scheduled closing date.                   |
| `CLOSING_IN_PROGRESS` | Given to transactions that are actively closing on the closing date.                           |
| `COMPLETED`           | Given to transactions that are fully complete, no further work on the transaction is required. |
| `PENDING`             | Given to transactions that are yet to be setup by the primary clients.                         |


# TransactionType
Source: https://dev.ownright.com/partner-api/reference/members/enums/transaction-type

Possible types of transactions.

## Values

| Value      | Description                           |
| ---------- | ------------------------------------- |
| `PURCHASE` | A transaction to purchase a property. |
| `SALE`     | A transaction to sell a property.     |


# AddressInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/address-input

Input to create or update an address.

## Fields

<ParamField type="String">
  The city of the address.
</ParamField>

<ParamField type="Country">
  The country of the address.
</ParamField>

<ParamField type="String">
  The postal code of the address.
</ParamField>

<ParamField type="Province">
  The province of the address.
</ParamField>

<ParamField type="String">
  The street name and number of the address.
</ParamField>

<ParamField type="String">
  The unit number, suite number, apartment number, etc. of the address.
</ParamField>

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# BusinessContactUpdateInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/business-contact-update-input

Input to update a business contact.

## Fields

<ParamField type="String">
  The first name of the partner.
</ParamField>

<ParamField type="String">
  The last name of the partner.
</ParamField>

<ParamField type="E164PhoneNumber">
  The phone number of the partner.
</ParamField>


# CustomAttributeCreateInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/custom-attribute-create-input

Input to create a custom attribute.

## Fields

<ParamField type="String!">
  The key of the custom attribute.
</ParamField>

<ParamField type="CustomAttributeType!">
  The type of the custom attribute.
</ParamField>

<ParamField type="String!">
  The value of the custom attribute.
</ParamField>

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# FileBulkCommitInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/file-bulk-commit-input

Input for a file to committed as part of a bulk file commit.

## Fields

<ParamField type="FileRecordGID!">
  The identifier of a staged file record to commit.
</ParamField>

<ParamField type="[String!]!">
  Tags to add to the committed versioned file.
</ParamField>

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# ImageTransformInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/image-transform-input

Input to transform an image.

## Fields

<ParamField type="Int">
  The height of the image.
</ParamField>

<ParamField type="Int">
  The width of the image.
</ParamField>

## Used by

* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# MoneyInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/money-input

Input that represents money.

## Fields

<ParamField type="Decimal!">
  The amount of money.
</ParamField>

<ParamField type="CurrencyCode!">
  The currency of the money.
</ParamField>

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)


# PartnerInquiryPersonInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/partner-inquiry-person-input

Input required to create a partner inquiry for a person.

## Fields

<ParamField type="[CustomAttributeCreateInput!]!">
  Custom attributes for the person.
</ParamField>

<ParamField type="String">
  Email address of the person.
</ParamField>

<ParamField type="String">
  Name of the entity associated with the person.
</ParamField>

<ParamField type="String!">
  First name of the person.
</ParamField>

<ParamField type="String">
  Last name of the person.
</ParamField>

<ParamField type="E164PhoneNumber">
  Phone number of the person.
</ParamField>

<ParamField type="PersonRole">
  Role of the person.
</ParamField>


# PropertyClosingReferralInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/property-closing-referral-input

Input to create a property closing referral.

## Fields

<ParamField type="[ReferralContactCreateInput!]">
  Contacts to be associated with the referral.
</ParamField>

<ParamField type="[CustomAttributeCreateInput!]">
  Custom attributes to be associated with the referral.
</ParamField>

<ParamField type="[FileBulkCommitInput!]!">
  The files to be associated with the referral.
</ParamField>

<ParamField type="ReferralIntentLevel">
  The intent level of the referral.
</ParamField>

<ParamField type="MoneyInput">
  The amount the purchase property is being purchased for.
</ParamField>

<ParamField type="AddressInput">
  The address of the property the person is buying.
</ParamField>

<ParamField type="AddressInput">
  The address of the property the person is selling.
</ParamField>

<ParamField type="ReferralType!">
  The type of the referral.
</ParamField>

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)


# ReferralContactCreateInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/referral-contact-create-input

The input to create a referral contact.

## Fields

<ParamField type="String!">
  The email for the referral contact.
</ParamField>

<ParamField type="String!">
  The first name for the referral contact.
</ParamField>

<ParamField type="String">
  The last name for the referral contact.
</ParamField>

<ParamField type="String">
  The phone number for the referral contact.
</ParamField>

<ParamField type="Boolean!">
  Whether this contact is the primary contact for the referral.
</ParamField>

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# RefinanceReferralInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/refinance-referral-input

Input to create a refinance referral.

## Fields

<ParamField type="[ReferralContactCreateInput!]">
  Contacts to be associated with the referral.
</ParamField>

<ParamField type="[CustomAttributeCreateInput!]">
  Custom attributes to be associated with the referral.
</ParamField>

<ParamField type="[FileBulkCommitInput!]!">
  The files to be associated with the referral.
</ParamField>

<ParamField type="ReferralIntentLevel">
  The intent level of the referral.
</ParamField>

<ParamField type="MoneyInput">
  The amount of the new mortgage.
</ParamField>

<ParamField type="AddressInput!">
  The address of the property being refinanced.
</ParamField>

## Used by

* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)


# StagedFileUploadInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/staged-file-upload-input

Input to create a staged file upload.

## Fields

<ParamField type="String!">
  The name of the file that is being uploaded.
</ParamField>

<ParamField type="FileMimeType!">
  The MIME type of the file that is being uploaded.
</ParamField>

## Used by

* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)


# StatusCertificateReviewReferralInput
Source: https://dev.ownright.com/partner-api/reference/members/inputs/status-certificate-review-referral-input

Input to create a status certificate review referral.

## Fields

<ParamField type="Boolean">
  Whether or not the client has made an offer on the property already.
</ParamField>

<ParamField type="[ReferralContactCreateInput!]!">
  Contacts to be associated with the referral.
</ParamField>

<ParamField type="[CustomAttributeCreateInput!]">
  Custom attributes to be associated with the referral.
</ParamField>

<ParamField type="Boolean">
  Whether or not the status certificate review requires an earlier than normal
  review.
</ParamField>

<ParamField type="[FileBulkCommitInput!]!">
  The files to be associated with the referral.
</ParamField>

<ParamField type="ReferralIntentLevel">
  The intent level of the referral.
</ParamField>

<ParamField type="ISO8601DateTime">
  The preferred completion time for the status certificate review.
</ParamField>

<ParamField type="AddressInput!">
  The address of the property for which the status certificate review is being
  requested.
</ParamField>

## Used by

* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# File
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/file

Represents a file.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

## Implementations

* [Document](/partner-api/reference/members/objects/document)
* [Image](/partner-api/reference/members/objects/image)

## Used by

* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)


# Matter
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/matter

Represents a matter.

## Fields

<ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
  The currently authenticated matter business contact information (if any).
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="shortId" type="String!">
  The matter's short identifier.
</ResponseField>

<ResponseField name="test" type="Boolean!">
  Whether the matter is a test matter or not.
</ResponseField>

## Implementations

* [PurchaseTransaction](/partner-api/reference/members/objects/purchase-transaction)
* [Refinance](/partner-api/reference/members/objects/refinance)
* [SaleTransaction](/partner-api/reference/members/objects/sale-transaction)
* [StatusCertificateReview](/partner-api/reference/members/objects/status-certificate-review)

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)
* [`matters`](/partner-api/reference/queries/matters/matters) (query)


# MatterParticipant
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/matter-participant

Represents a matter participant.

## Fields

<ResponseField name="corporationSigningOfficer" type="Boolean!">
  Whether the participant is a corporation signing officer or not.
</ResponseField>

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations the participant is a signing officer for (if any).
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the participant.
</ResponseField>

<ResponseField name="fullName" type="String!">
  The full name of the participant.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the participant.
</ResponseField>

<ResponseField name="primaryClient" type="Boolean!">
  Whether the participant is a primary client for the matter or not.
</ResponseField>

<ResponseField name="representation" type="MatterParticipantRepresentation">
  The representation of the participant (if any).
</ResponseField>

<ResponseField name="represented" type="Boolean!">
  Whether the participant is represented or not.
</ResponseField>

<ResponseField name="representees" type="[MatterParticipant!]!">
  The participants that the participant is representing (if any).
</ResponseField>

<ResponseField name="representors" type="[MatterParticipant!]!">
  The participants that are representing the participant (if any).
</ResponseField>

<ResponseField name="representsPrimaryClient" type="Boolean!">
  Whether the participant represents a primary client for the matter or not.
</ResponseField>

<ResponseField name="traits" type="[MatterParticipantTrait!]!">
  The traits of the participant.
</ResponseField>

## Implementations

* [RefinanceParticipant](/partner-api/reference/members/objects/refinance-participant)
* [StatusCertificateReviewParticipant](/partner-api/reference/members/objects/status-certificate-review-participant)
* [TransactionParticipant](/partner-api/reference/members/objects/transaction-participant)


# PurchaseTransactionStatus
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/purchase-transaction-status

Represents the status of a purchase transaction.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>

## Implementations

* [PurchaseTransactionAbandonedStatus](/partner-api/reference/members/objects/purchase-transaction-abandoned-status)
* [PurchaseTransactionAfterClosingStatus](/partner-api/reference/members/objects/purchase-transaction-after-closing-status)
* [PurchaseTransactionBeforeClosingStatus](/partner-api/reference/members/objects/purchase-transaction-before-closing-status)
* [PurchaseTransactionClosingInProgressStatus](/partner-api/reference/members/objects/purchase-transaction-closing-in-progress-status)
* [PurchaseTransactionCompletedStatus](/partner-api/reference/members/objects/purchase-transaction-completed-status)
* [PurchaseTransactionPendingStatus](/partner-api/reference/members/objects/purchase-transaction-pending-status)


# Referral
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/referral

Represents a referral.

## Fields

<ResponseField name="contacts" type="[ReferralContact!]!">
  The contacts for the referral.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the referral was created.
</ResponseField>

<ResponseField name="customAttributes" type="[CustomAttribute!]!">
  The custom attributes for the referral.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="primaryContact" type="ReferralContact!">
  The primary contact for the referral.
</ResponseField>

<ResponseField name="status" type="ReferralStatus!">
  The current status of the referral.
</ResponseField>

<ResponseField name="type" type="ReferralType!">
  The type of the referral.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The time the referral was updated.
</ResponseField>

## Implementations

* [PurchasePropertyClosingReferral](/partner-api/reference/members/objects/purchase-property-closing-referral)
* [RefinanceReferral](/partner-api/reference/members/objects/refinance-referral)
* [SalePropertyClosingReferral](/partner-api/reference/members/objects/sale-property-closing-referral)
* [StatusCertificateReviewReferral](/partner-api/reference/members/objects/status-certificate-review-referral)

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)


# RefinanceStatus
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/refinance-status

Represents the status of a refinance.

## Fields

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>

## Implementations

* [RefinanceAbandonedStatus](/partner-api/reference/members/objects/refinance-abandoned-status)
* [RefinanceAfterClosingStatus](/partner-api/reference/members/objects/refinance-after-closing-status)
* [RefinanceBeforeClosingStatus](/partner-api/reference/members/objects/refinance-before-closing-status)
* [RefinanceClosingInProgressStatus](/partner-api/reference/members/objects/refinance-closing-in-progress-status)
* [RefinanceCompletedStatus](/partner-api/reference/members/objects/refinance-completed-status)
* [RefinancePendingStatus](/partner-api/reference/members/objects/refinance-pending-status)


# SaleTransactionStatus
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/sale-transaction-status

Represents the status of a sale transaction.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>

## Implementations

* [SaleTransactionAbandonedStatus](/partner-api/reference/members/objects/sale-transaction-abandoned-status)
* [SaleTransactionAfterClosingStatus](/partner-api/reference/members/objects/sale-transaction-after-closing-status)
* [SaleTransactionBeforeClosingStatus](/partner-api/reference/members/objects/sale-transaction-before-closing-status)
* [SaleTransactionClosingInProgressStatus](/partner-api/reference/members/objects/sale-transaction-closing-in-progress-status)
* [SaleTransactionCompletedStatus](/partner-api/reference/members/objects/sale-transaction-completed-status)
* [SaleTransactionPendingStatus](/partner-api/reference/members/objects/sale-transaction-pending-status)


# StatusCertificateReviewAssessmentStatus
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/status-certificate-review-assessment-status

Represents the status of a status certificate review assessment.

## Fields

<ResponseField name="state" type="StatusCertificateReviewAssessmentState!">
  The state of the status certificate review assessment.
</ResponseField>

## Implementations

* [StatusCertificateReviewAssessmentCompletedStatus](/partner-api/reference/members/objects/status-certificate-review-assessment-completed-status)
* [StatusCertificateReviewAssessmentInProgressStatus](/partner-api/reference/members/objects/status-certificate-review-assessment-in-progress-status)
* [StatusCertificateReviewAssessmentNotStartedStatus](/partner-api/reference/members/objects/status-certificate-review-assessment-not-started-status)


# StatusCertificateReviewStatus
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/status-certificate-review-status

Represents the status of a status certificate review.

## Fields

<ResponseField name="state" type="StatusCertificateReviewState!">
  The state of the status certificate review.
</ResponseField>

## Implementations

* [StatusCertificateReviewAbandonedStatus](/partner-api/reference/members/objects/status-certificate-review-abandoned-status)
* [StatusCertificateReviewCompletedStatus](/partner-api/reference/members/objects/status-certificate-review-completed-status)
* [StatusCertificateReviewDraftStatus](/partner-api/reference/members/objects/status-certificate-review-draft-status)
* [StatusCertificateReviewInProgressStatus](/partner-api/reference/members/objects/status-certificate-review-in-progress-status)


# Transaction
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/transaction

Represents a transaction.

## Fields

<ResponseField name="agreementDate" type="ISO8601Date">
  The date the agreement to purchase or sell was made.
</ResponseField>

<ResponseField name="closingDate" type="ISO8601Date">
  The date the purchase is set to close on.
</ResponseField>

<ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
  The currently authenticated matter business contact information (if any).
</ResponseField>

<ResponseField name="depositAmount" type="Money">
  The amount of money deposited with the offer to purchase.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="milestones" type="[MatterMilestone!]!">
  The transaction's milestones
</ResponseField>

<ResponseField name="property" type="Property!">
  The property the transaction is for.
</ResponseField>

<ResponseField name="representedSide" type="TransactionSide!">
  The side of the transaction that is being represented by Ownright.
</ResponseField>

<ResponseField name="shortId" type="String!">
  The matter's short identifier.
</ResponseField>

<ResponseField name="status" type="TransactionStatus!">
  The status of the transaction.
</ResponseField>

<ResponseField name="test" type="Boolean!">
  Whether the matter is a test matter or not.
</ResponseField>

<ResponseField name="type" type="TransactionType!">
  The type of the transaction.
</ResponseField>

## Implementations

* [PurchaseTransaction](/partner-api/reference/members/objects/purchase-transaction)
* [SaleTransaction](/partner-api/reference/members/objects/sale-transaction)


# TransactionStatus
Source: https://dev.ownright.com/partner-api/reference/members/interfaces/transaction-status

Represents the status of a transaction.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>

## Implementations

* [PurchaseTransactionAbandonedStatus](/partner-api/reference/members/objects/purchase-transaction-abandoned-status)
* [PurchaseTransactionAfterClosingStatus](/partner-api/reference/members/objects/purchase-transaction-after-closing-status)
* [PurchaseTransactionBeforeClosingStatus](/partner-api/reference/members/objects/purchase-transaction-before-closing-status)
* [PurchaseTransactionClosingInProgressStatus](/partner-api/reference/members/objects/purchase-transaction-closing-in-progress-status)
* [PurchaseTransactionCompletedStatus](/partner-api/reference/members/objects/purchase-transaction-completed-status)
* [PurchaseTransactionPendingStatus](/partner-api/reference/members/objects/purchase-transaction-pending-status)
* [SaleTransactionAbandonedStatus](/partner-api/reference/members/objects/sale-transaction-abandoned-status)
* [SaleTransactionAfterClosingStatus](/partner-api/reference/members/objects/sale-transaction-after-closing-status)
* [SaleTransactionBeforeClosingStatus](/partner-api/reference/members/objects/sale-transaction-before-closing-status)
* [SaleTransactionClosingInProgressStatus](/partner-api/reference/members/objects/sale-transaction-closing-in-progress-status)
* [SaleTransactionCompletedStatus](/partner-api/reference/members/objects/sale-transaction-completed-status)
* [SaleTransactionPendingStatus](/partner-api/reference/members/objects/sale-transaction-pending-status)


# Address
Source: https://dev.ownright.com/partner-api/reference/members/objects/address

Represents an address.

## Fields

<ResponseField name="city" type="String!">
  The city of the address.
</ResponseField>

<ResponseField name="country" type="Country!">
  The country of the address.
</ResponseField>

<ResponseField name="latitude" type="Float">
  The latitude of the address.
</ResponseField>

<ResponseField name="longitude" type="Float">
  The longitude of the address.
</ResponseField>

<ResponseField name="mapImageUrl" type="Url">
  A link to a map with a pointer on the address's location.
</ResponseField>

<ResponseField name="postalCode" type="String!">
  The postal code of the address.
</ResponseField>

<ResponseField name="province" type="Province!">
  The province of the address.
</ResponseField>

<ResponseField name="shortTitle" type="String!">
  The shortened title for the address.
</ResponseField>

<ResponseField name="street" type="String!">
  The street name and number of the address.
</ResponseField>

<ResponseField name="title" type="String!">
  The full title for the address.
</ResponseField>

<ResponseField name="unitNumber" type="String">
  The unit number, apartment number, suite number etc.
</ResponseField>

## Used by

* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# BuildingRule
Source: https://dev.ownright.com/partner-api/reference/members/objects/building-rule

A building rule or allowance.

## Fields

<ResponseField name="description" type="String!">
  The detailed description of this building rule.
</ResponseField>

<ResponseField name="handle" type="String!">
  The unique handle identifying this building rule.
</ResponseField>

<ResponseField name="icon" type="String">
  The icon representing this building rule.
</ResponseField>

<ResponseField name="label" type="String!">
  The human-readable label for this building rule.
</ResponseField>


# BusinessContact
Source: https://dev.ownright.com/partner-api/reference/members/objects/business-contact

A business contact.

## Fields

<ResponseField name="email" type="String">
  The email of the business contact.
</ResponseField>

<ResponseField name="faxNumber" type="E164PhoneNumber">
  The fax number of the business contact.
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the business contact.
</ResponseField>

<ResponseField name="frontUserIdHash" type="String">
  The Front user ID hash of the business contact.
</ResponseField>

<ResponseField name="fullName" type="String!">
  The full name of the business contact.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the business contact.
</ResponseField>

<ResponseField name="notificationDeliveryMechanisms" type="[NotificationDeliveryMechanism!]!">
  The notification delivery mechanisms the business contact is subscribed to.
</ResponseField>

<ResponseField name="phoneNumber" type="E164PhoneNumber">
  The phone number of the business contact.
</ResponseField>

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)
* [`matters`](/partner-api/reference/queries/matters/matters) (query)


# CustomAttribute
Source: https://dev.ownright.com/partner-api/reference/members/objects/custom-attribute

A custom attribute.

## Fields

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="key" type="String!">
  The key of the custom attribute.
</ResponseField>

<ResponseField name="type" type="CustomAttributeType!">
  The type of the custom attribute.
</ResponseField>

<ResponseField name="value" type="String!">
  The value of the custom attribute.
</ResponseField>

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# Document
Source: https://dev.ownright.com/partner-api/reference/members/objects/document

Represents a document.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

<ResponseField name="url" type="Url">
  The URL to the document.
</ResponseField>


# Image
Source: https://dev.ownright.com/partner-api/reference/members/objects/image

Represents an image.

## Fields

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date the file was created.
</ResponseField>

<ResponseField name="filename" type="String!">
  The name of the file.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="mimeType" type="FileMimeType!">
  The MIME type of the file.
</ResponseField>

<ResponseField name="staged" type="Boolean!">
  Whether the file is staged for upload or not.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date the file was last updated.
</ResponseField>

<ResponseField name="url" type="Url">
  The URL to the image.
</ResponseField>


# Lender
Source: https://dev.ownright.com/partner-api/reference/members/objects/lender

Represents a lender.

## Fields

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="logoImageUrl" type="Url">
  The URL of the lender's logo.
</ResponseField>

<ResponseField name="name" type="String!">
  The name of the lender.
</ResponseField>

<ResponseField name="websiteUrl" type="Url">
  The URL of the lender's website.
</ResponseField>


# Loan
Source: https://dev.ownright.com/partner-api/reference/members/objects/loan

Represents a loan.

## Fields

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lenders" type="[Lender!]!">
  The lenders of the loan.
</ResponseField>

<ResponseField name="principalAmount" type="Money">
  The principal amount of the loan.
</ResponseField>

<ResponseField name="type" type="LoanType!">
  The type of loan.
</ResponseField>


# MatterBusinessContact
Source: https://dev.ownright.com/partner-api/reference/members/objects/matter-business-contact

A business contact that is associated with a matter.

## Fields

<ResponseField name="contact" type="BusinessContact!">
  The contact for the business.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="partnerAccountLinked" type="Boolean!">
  Whether or not the contact has a partner account linked.
</ResponseField>

<ResponseField name="partnerNotificationsMuted" type="Boolean!">
  Whether the partner has muted notifications for the matter or not.
</ResponseField>

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)
* [`matters`](/partner-api/reference/queries/matters/matters) (query)


# MatterClosingActionItem
Source: https://dev.ownright.com/partner-api/reference/members/objects/matter-closing-action-item

Represents an action item that is completed during a matters closing.

## Fields

<ResponseField name="completedAt" type="ISO8601DateTime">
  The date the action item was completed.
</ResponseField>

<ResponseField name="description" type="String!">
  The description of the action item.
</ResponseField>

<ResponseField name="expectedBy" type="ISO8601DateTime!">
  The date the action item is expected to be completed by.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="state" type="MatterClosingActionItemState!">
  The state of the action item.
</ResponseField>

<ResponseField name="title" type="String!">
  The title of the action item.
</ResponseField>


# MatterCorporation
Source: https://dev.ownright.com/partner-api/reference/members/objects/matter-corporation

Represents a matter corporation.

## Fields

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="name" type="String!">
  The name of the corporation.
</ResponseField>

<ResponseField name="refinanceOwnershipStatus" type="RefinanceOwnershipStatus">
  The ownership status of the corporation (only applies for corporations on
  refinances).
</ResponseField>


# MatterMilestone
Source: https://dev.ownright.com/partner-api/reference/members/objects/matter-milestone

Represents a matter milestone.

## Fields

<ResponseField name="completedAt" type="ISO8601DateTime">
  The date the matter milestone was completed (if any).
</ResponseField>

<ResponseField name="description" type="String">
  The description of the matter milestone.
</ResponseField>

<ResponseField name="handle" type="MatterMilestoneHandle!">
  The handle of the matter milestone.
</ResponseField>

<ResponseField name="oneliner" type="String!">
  The oneliner of the matter milestone.
</ResponseField>

<ResponseField name="status" type="MatterMilestoneStatus!">
  The status of the matter milestone.
</ResponseField>

<ResponseField name="title" type="String!">
  The title of the matter milestone.
</ResponseField>


# Money
Source: https://dev.ownright.com/partner-api/reference/members/objects/money

Represents money.

## Fields

<ResponseField name="amount" type="Decimal!">
  The amount of money.
</ResponseField>

<ResponseField name="currencyCode" type="CurrencyCode!">
  The currency of the money.
</ResponseField>

## Used by

* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)


# Organization
Source: https://dev.ownright.com/partner-api/reference/members/objects/organization

Represents an organization.

## Fields

<ResponseField name="address" type="Address">
  The address of the organization.
</ResponseField>

<ResponseField name="email" type="String">
  The email address of the organization.
</ResponseField>

<ResponseField name="faxNumber" type="String">
  The fax number of the organization.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="members" type="[OrganizationMember!]!">
  The members of the organization.
</ResponseField>

<ResponseField name="name" type="String!">
  The name of the organization.
</ResponseField>

<ResponseField name="phoneNumber" type="String">
  The phone number of the organization.
</ResponseField>

<ResponseField name="websiteUrl" type="Url">
  The website of the organization.
</ResponseField>


# OrganizationMember
Source: https://dev.ownright.com/partner-api/reference/members/objects/organization-member

Represents an organization member.

## Fields

<ResponseField name="email" type="String">
  The email address of the member.
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the member.
</ResponseField>

<ResponseField name="fullName" type="String!">
  The full name of the member.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the member.
</ResponseField>

<ResponseField name="lawyer" type="Boolean!">
  Whether the member is a lawyer.
</ResponseField>

<ResponseField name="profileImage" type="Image">
  The profile image of the member.
</ResponseField>


# Property
Source: https://dev.ownright.com/partner-api/reference/members/objects/property

Represents a property.

## Fields

<ResponseField name="address" type="Address!">
  The address of the property.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="type" type="PropertyType">
  The type of the property.
</ResponseField>


# PurchasePropertyClosingReferral
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-property-closing-referral

A referral for a purchase property closing.

## Fields

<ResponseField name="contacts" type="[ReferralContact!]!">
  The contacts for the referral.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the referral was created.
</ResponseField>

<ResponseField name="customAttributes" type="[CustomAttribute!]!">
  The custom attributes for the referral.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="primaryContact" type="ReferralContact!">
  The primary contact for the referral.
</ResponseField>

<ResponseField name="propertyAddress" type="Address">
  The address of the property being purchased.
</ResponseField>

<ResponseField name="purchaseAmount" type="Money">
  The amount of money to purchase the property.
</ResponseField>

<ResponseField name="status" type="ReferralStatus!">
  The current status of the referral.
</ResponseField>

<ResponseField name="type" type="ReferralType!">
  The type of the referral.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The time the referral was updated.
</ResponseField>


# PurchaseTransaction
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction

Represents a purchase transaction.

## Fields

<ResponseField name="agreementDate" type="ISO8601Date">
  The date the agreement to purchase or sell was made.
</ResponseField>

<ResponseField name="closingDate" type="ISO8601Date">
  The date the purchase is set to close on.
</ResponseField>

<ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
  The currently authenticated matter business contact information (if any).
</ResponseField>

<ResponseField name="depositAmount" type="Money">
  The amount of money deposited with the offer to purchase.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="milestones" type="[MatterMilestone!]!">
  The transaction's milestones
</ResponseField>

<ResponseField name="property" type="Property!">
  The property the transaction is for.
</ResponseField>

<ResponseField name="purchaseAmount" type="Money">
  The amount of money to purchase the property.
</ResponseField>

<ResponseField name="representedSide" type="TransactionSide!">
  The side of the transaction that is being represented by Ownright.
</ResponseField>

<ResponseField name="shortId" type="String!">
  The matter's short identifier.
</ResponseField>

<ResponseField name="status" type="TransactionStatus!">
  The status of the transaction.
</ResponseField>

<ResponseField name="test" type="Boolean!">
  Whether the matter is a test matter or not.
</ResponseField>

<ResponseField name="type" type="TransactionType!">
  The type of the transaction.
</ResponseField>


# PurchaseTransactionAbandonedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction-abandoned-status

Status information for purchase transactions that have been abandoned.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# PurchaseTransactionAfterClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction-after-closing-status

Status information for purchase transactions that have closed but are not complete.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# PurchaseTransactionBeforeClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction-before-closing-status

Status information for purchase transactions that have not closed yet.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# PurchaseTransactionClosingInProgressStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction-closing-in-progress-status

Status information for purchase transactions that are actively closing.

## Fields

<ResponseField name="closingActionItems" type="[MatterClosingActionItem!]!">
  The closing action items and their statuses for the closing.
</ResponseField>

<ResponseField name="closingDateAmended" type="Boolean!">
  Whether the closing date has been amended.
</ResponseField>

<ResponseField name="closingStatus" type="TransactionClosingStatus!">
  The closing status of the transaction.
</ResponseField>

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# PurchaseTransactionCompletedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction-completed-status

Status information for purchase transactions that are complete.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# PurchaseTransactionPendingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/purchase-transaction-pending-status

Status information for purchase transactions that are yet to be setup by the primary clients.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# ReferralContact
Source: https://dev.ownright.com/partner-api/reference/members/objects/referral-contact

A contact for a referral.

## Fields

<ResponseField name="email" type="String!">
  The email of the contact.
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the contact.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="isPrimary" type="Boolean!">
  Whether the contact is the primary contact.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the contact.
</ResponseField>

<ResponseField name="phoneNumber" type="String">
  The phone number of the contact.
</ResponseField>

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# Refinance
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance

Represents a refinance.

## Fields

<ResponseField name="closingDate" type="ISO8601Date">
  The date the refinance is closing on.
</ResponseField>

<ResponseField name="commitmentDate" type="ISO8601Date">
  The date the refinance was committed by the borrowers.
</ResponseField>

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations associated with the refinance.
</ResponseField>

<ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
  The currently authenticated matter business contact information (if any).
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="loans" type="[Loan!]!">
  The loans associated with the refinance.
</ResponseField>

<ResponseField name="milestones" type="[MatterMilestone!]!">
  The matter's milestones.
</ResponseField>

<ResponseField name="participants" type="[RefinanceParticipant!]!">
  The participants in the refinance.
</ResponseField>

<ResponseField name="property" type="Property!">
  The property the refinance is for.
</ResponseField>

<ResponseField name="shortId" type="String!">
  The matter's short identifier.
</ResponseField>

<ResponseField name="status" type="RefinanceStatus!">
  The status of the refinance.
</ResponseField>

<ResponseField name="test" type="Boolean!">
  Whether the matter is a test matter or not.
</ResponseField>


# RefinanceAbandonedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-abandoned-status

Status information for refinances that have been abandoned.

## Fields

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>


# RefinanceAfterClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-after-closing-status

Status information for refinances that are after closing.

## Fields

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>


# RefinanceBeforeClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-before-closing-status

Status information for refinances that are before closing.

## Fields

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>


# RefinanceClosingInProgressStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-closing-in-progress-status

Status information for refinances that are closing in progress.

## Fields

<ResponseField name="closingActionItems" type="[MatterClosingActionItem!]!">
  The closing action items and their statuses for the closing.
</ResponseField>

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>


# RefinanceCompletedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-completed-status

Status information for refinances that are completed.

## Fields

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>


# RefinanceParticipant
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-participant

Represents a refinance participant.

## Fields

<ResponseField name="corporationSigningOfficer" type="Boolean!">
  Whether the participant is a corporation signing officer or not.
</ResponseField>

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations the participant is a signing officer for (if any).
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the participant.
</ResponseField>

<ResponseField name="fullName" type="String!">
  The full name of the participant.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the participant.
</ResponseField>

<ResponseField name="ownershipStatus" type="RefinanceOwnershipStatus!">
  The ownership status of the participant.
</ResponseField>

<ResponseField name="primaryClient" type="Boolean!">
  Whether the participant is a primary client for the matter or not.
</ResponseField>

<ResponseField name="representation" type="MatterParticipantRepresentation">
  The representation of the participant (if any).
</ResponseField>

<ResponseField name="represented" type="Boolean!">
  Whether the participant is represented or not.
</ResponseField>

<ResponseField name="representees" type="[MatterParticipant!]!">
  The participants that the participant is representing (if any).
</ResponseField>

<ResponseField name="representors" type="[MatterParticipant!]!">
  The participants that are representing the participant (if any).
</ResponseField>

<ResponseField name="representsPrimaryClient" type="Boolean!">
  Whether the participant represents a primary client for the matter or not.
</ResponseField>

<ResponseField name="traits" type="[MatterParticipantTrait!]!">
  The traits of the participant.
</ResponseField>


# RefinancePendingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-pending-status

Status information for refinances that are yet to be setup by the primary clients.

## Fields

<ResponseField name="state" type="RefinanceState!">
  The state of the refinance.
</ResponseField>


# RefinanceReferral
Source: https://dev.ownright.com/partner-api/reference/members/objects/refinance-referral

A referral for a refinance.

## Fields

<ResponseField name="contacts" type="[ReferralContact!]!">
  The contacts for the referral.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the referral was created.
</ResponseField>

<ResponseField name="customAttributes" type="[CustomAttribute!]!">
  The custom attributes for the referral.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="mortgageAmount" type="Money">
  The amount of the new mortgage involved in the refinance.
</ResponseField>

<ResponseField name="primaryContact" type="ReferralContact!">
  The primary contact for the referral.
</ResponseField>

<ResponseField name="propertyAddress" type="Address">
  The address of the property that is involved in the refinance.
</ResponseField>

<ResponseField name="status" type="ReferralStatus!">
  The current status of the referral.
</ResponseField>

<ResponseField name="type" type="ReferralType!">
  The type of the referral.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The time the referral was updated.
</ResponseField>

## Used by

* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)


# SalePropertyClosingReferral
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-property-closing-referral

A referral for a sale property closing.

## Fields

<ResponseField name="contacts" type="[ReferralContact!]!">
  The contacts for the referral.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the referral was created.
</ResponseField>

<ResponseField name="customAttributes" type="[CustomAttribute!]!">
  The custom attributes for the referral.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="primaryContact" type="ReferralContact!">
  The primary contact for the referral.
</ResponseField>

<ResponseField name="propertyAddress" type="Address">
  The address of the property being sold.
</ResponseField>

<ResponseField name="status" type="ReferralStatus!">
  The current status of the referral.
</ResponseField>

<ResponseField name="type" type="ReferralType!">
  The type of the referral.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The time the referral was updated.
</ResponseField>


# SaleTransaction
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction

Represents a sale transaction.

## Fields

<ResponseField name="agreementDate" type="ISO8601Date">
  The date the agreement to purchase or sell was made.
</ResponseField>

<ResponseField name="closingDate" type="ISO8601Date">
  The date the purchase is set to close on.
</ResponseField>

<ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
  The currently authenticated matter business contact information (if any).
</ResponseField>

<ResponseField name="depositAmount" type="Money">
  The amount of money deposited with the offer to purchase.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="milestones" type="[MatterMilestone!]!">
  The transaction's milestones
</ResponseField>

<ResponseField name="property" type="Property!">
  The property the transaction is for.
</ResponseField>

<ResponseField name="representedSide" type="TransactionSide!">
  The side of the transaction that is being represented by Ownright.
</ResponseField>

<ResponseField name="saleAmount" type="Money">
  The amount of money the property is being sold for.
</ResponseField>

<ResponseField name="shortId" type="String!">
  The matter's short identifier.
</ResponseField>

<ResponseField name="status" type="TransactionStatus!">
  The status of the transaction.
</ResponseField>

<ResponseField name="test" type="Boolean!">
  Whether the matter is a test matter or not.
</ResponseField>

<ResponseField name="type" type="TransactionType!">
  The type of the transaction.
</ResponseField>


# SaleTransactionAbandonedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction-abandoned-status

Status information for sale transactions that have been abandoned.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# SaleTransactionAfterClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction-after-closing-status

Status information for sale transactions that have closed but are not complete.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# SaleTransactionBeforeClosingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction-before-closing-status

Status information for sale transactions that have not closed yet.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# SaleTransactionClosingInProgressStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction-closing-in-progress-status

Status information for sale transactions that are actively closing.

## Fields

<ResponseField name="closingActionItems" type="[MatterClosingActionItem!]!">
  The closing action items and their statuses for the closing.
</ResponseField>

<ResponseField name="closingDateAmended" type="Boolean!">
  Whether the closing date has been amended.
</ResponseField>

<ResponseField name="closingStatus" type="TransactionClosingStatus!">
  The closing status of the transaction.
</ResponseField>

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# SaleTransactionCompletedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction-completed-status

Status information for sale transactions that are complete.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# SaleTransactionPendingStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/sale-transaction-pending-status

Status information for sale transactions that are yet to be setup by the primary clients.

## Fields

<ResponseField name="state" type="TransactionState!">
  The state of the transaction.
</ResponseField>


# StagedFileUpload
Source: https://dev.ownright.com/partner-api/reference/members/objects/staged-file-upload

Represents a staged file upload.

## Fields

<ResponseField name="file" type="File!">
  The file that is staged for upload.
</ResponseField>

<ResponseField name="signedUploadUrl" type="Url!">
  A signed upload URL to use when uploading file.
</ResponseField>

<ResponseField name="signedUploadUrlExpiryDate" type="ISO8601DateTime!">
  Date when upload URL expires.
</ResponseField>

## Used by

* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)


# StatusCertificateReview
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review

Represents a status certificate review.

## Fields

<ResponseField name="assessment" type="StatusCertificateReviewAssessment">
  The assessment associated with the status certificate review.
</ResponseField>

<ResponseField name="completedAt" type="ISO8601DateTime">
  The date the status certificate review was completed.
</ResponseField>

<ResponseField name="completionCommitmentDate" type="ISO8601DateTime">
  The date the status certificate review was committed to be completed by.
</ResponseField>

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations associated with the status certificate review.
</ResponseField>

<ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
  The currently authenticated matter business contact information (if any).
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="participants" type="[StatusCertificateReviewParticipant!]!">
  The participants in the status certificate review.
</ResponseField>

<ResponseField name="property" type="Property!">
  The property the status certificate review is for.
</ResponseField>

<ResponseField name="shortId" type="String!">
  The matter's short identifier.
</ResponseField>

<ResponseField name="status" type="StatusCertificateReviewStatus!">
  The status of the status certificate review.
</ResponseField>

<ResponseField name="test" type="Boolean!">
  Whether the matter is a test matter or not.
</ResponseField>


# StatusCertificateReviewAbandonedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-abandoned-status

Status information for status certificate reviews that have been abandoned.

## Fields

<ResponseField name="state" type="StatusCertificateReviewState!">
  The state of the status certificate review.
</ResponseField>


# StatusCertificateReviewAssessment
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment

A status certificate review assessment.

## Fields

<ResponseField name="buildingInformation" type="StatusCertificateReviewAssessmentBuildingInformation!">
  The information about the building.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The date and time when the assessment was created.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="overallRemarks" type="JSON">
  General remarks and notes about the assessment.
</ResponseField>

<ResponseField name="reviewer" type="OrganizationMember">
  The reviewer of the status certificate review assessment.
</ResponseField>

<ResponseField name="schemaVersion" type="StatusCertificateReviewAssessmentSchemaVersion!">
  The version of the assessment schema being used.
</ResponseField>

<ResponseField name="sections" type="[StatusCertificateReviewAssessmentSection!]!">
  The sections of the assessment.
</ResponseField>

<ResponseField name="status" type="StatusCertificateReviewAssessmentStatus!">
  The current status of the assessment.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The date and time when the assessment was last modified.
</ResponseField>


# StatusCertificateReviewAssessmentBuildingInformation
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-building-information

Information about a building.

## Fields

<ResponseField name="additionalComments" type="String">
  Additional comments about the property information.
</ResponseField>

<ResponseField name="buildingImage" type="Image">
  The image of the building.
</ResponseField>

<ResponseField name="buildingName" type="String">
  The name of the building.
</ResponseField>

<ResponseField name="buildingRules" type="[StatusCertificateReviewAssessmentBuildingRule!]!">
  The rules of the building.
</ResponseField>

<ResponseField name="condoCorporationNumber" type="String">
  The condo corporation number.
</ResponseField>

<ResponseField name="managementCompany" type="String">
  The management company of the building.
</ResponseField>

<ResponseField name="registrationDate" type="ISO8601Date">
  The registration date of the building.
</ResponseField>

<ResponseField name="rentControlled" type="Boolean">
  Whether the building is rent controlled.
</ResponseField>


# StatusCertificateReviewAssessmentBuildingRule
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-building-rule

A building rule and whether it has a restriction.

## Fields

<ResponseField name="hasRestriction" type="Boolean!">
  Indicates whether any restriction was found for the building rule.
</ResponseField>

<ResponseField name="rule" type="BuildingRule!">
  The building rule.
</ResponseField>


# StatusCertificateReviewAssessmentCompletedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-completed-status

Status information for status certificate review assessments that have been completed.

## Fields

<ResponseField name="completedAt" type="ISO8601DateTime!">
  The date the status certificate review assessment was completed.
</ResponseField>

<ResponseField name="state" type="StatusCertificateReviewAssessmentState!">
  The state of the status certificate review assessment.
</ResponseField>


# StatusCertificateReviewAssessmentInProgressStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-in-progress-status

Status information for status certificate review assessments that are in progress.

## Fields

<ResponseField name="state" type="StatusCertificateReviewAssessmentState!">
  The state of the status certificate review assessment.
</ResponseField>


# StatusCertificateReviewAssessmentNotStartedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-not-started-status

Status information for status certificate review assessments that are not started.

## Fields

<ResponseField name="state" type="StatusCertificateReviewAssessmentState!">
  The state of the status certificate review assessment.
</ResponseField>


# StatusCertificateReviewAssessmentQuestion
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-question

A status certificate review assessment question.

## Fields

<ResponseField name="answer" type="StatusCertificateReviewAssessmentQuestionAnswer">
  The answer of the assessment question.
</ResponseField>

<ResponseField name="clientDescription" type="String!">
  The client description of the assessment question.
</ResponseField>

<ResponseField name="handle" type="String!">
  The handle of the assessment question.
</ResponseField>

<ResponseField name="options" type="[StatusCertificateReviewAssessmentQuestionOption!]!">
  The options for the assessment question.
</ResponseField>

<ResponseField name="title" type="String!">
  The title of the assessment question.
</ResponseField>


# StatusCertificateReviewAssessmentQuestionAnswer
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-question-answer

A status certificate review assessment answer.

## Fields

<ResponseField name="answer" type="JSON">
  The answer of the assessment question in JSON format.
</ResponseField>

<ResponseField name="answerStatus" type="StatusCertificateReviewAssessmentAnswerStatus!">
  The status of the assessment question answer.
</ResponseField>

<ResponseField name="clientDescription" type="String">
  The client description of the assessment question answer.
</ResponseField>


# StatusCertificateReviewAssessmentQuestionOption
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-question-option

A status certificate review assessment question option.

## Fields

<ResponseField name="clientMessage" type="String!">
  The client message for the option.
</ResponseField>

<ResponseField name="status" type="StatusCertificateReviewAssessmentAnswerStatus!">
  The status of the option.
</ResponseField>

<ResponseField name="value" type="JSON">
  The value of the option.
</ResponseField>


# StatusCertificateReviewAssessmentSection
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-assessment-section

A status certificate review assessment section.

## Fields

<ResponseField name="clientDescription" type="String">
  The client description of the assessment section.
</ResponseField>

<ResponseField name="handle" type="String!">
  The handle of the assessment section.
</ResponseField>

<ResponseField name="questions" type="[StatusCertificateReviewAssessmentQuestion!]!">
  The questions of the assessment section.
</ResponseField>

<ResponseField name="rating" type="StatusCertificateReviewAssessmentSectionRating">
  The rating of the assessment section.
</ResponseField>

<ResponseField name="title" type="String!">
  The title of the assessment section.
</ResponseField>


# StatusCertificateReviewCompletedStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-completed-status

Status information for status certificate reviews that have been completed.

## Fields

<ResponseField name="completedAt" type="ISO8601DateTime!">
  The date the status certificate review was completed.
</ResponseField>

<ResponseField name="state" type="StatusCertificateReviewState!">
  The state of the status certificate review.
</ResponseField>


# StatusCertificateReviewDraftStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-draft-status

Status information for status certificate reviews that are in draft.

## Fields

<ResponseField name="state" type="StatusCertificateReviewState!">
  The state of the status certificate review.
</ResponseField>


# StatusCertificateReviewInProgressStatus
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-in-progress-status

Status information for status certificate reviews that are in progress.

## Fields

<ResponseField name="state" type="StatusCertificateReviewState!">
  The state of the status certificate review.
</ResponseField>


# StatusCertificateReviewParticipant
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-participant

Represents a status certificate review participant.

## Fields

<ResponseField name="corporationSigningOfficer" type="Boolean!">
  Whether the participant is a corporation signing officer or not.
</ResponseField>

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations the participant is a signing officer for (if any).
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the participant.
</ResponseField>

<ResponseField name="fullName" type="String!">
  The full name of the participant.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the participant.
</ResponseField>

<ResponseField name="primaryClient" type="Boolean!">
  Whether the participant is a primary client for the matter or not.
</ResponseField>

<ResponseField name="representation" type="MatterParticipantRepresentation">
  The representation of the participant (if any).
</ResponseField>

<ResponseField name="represented" type="Boolean!">
  Whether the participant is represented or not.
</ResponseField>

<ResponseField name="representees" type="[MatterParticipant!]!">
  The participants that the participant is representing (if any).
</ResponseField>

<ResponseField name="representors" type="[MatterParticipant!]!">
  The participants that are representing the participant (if any).
</ResponseField>

<ResponseField name="representsPrimaryClient" type="Boolean!">
  Whether the participant represents a primary client for the matter or not.
</ResponseField>

<ResponseField name="traits" type="[MatterParticipantTrait!]!">
  The traits of the participant.
</ResponseField>


# StatusCertificateReviewReferral
Source: https://dev.ownright.com/partner-api/reference/members/objects/status-certificate-review-referral

A referral for a status certificate review.

## Fields

<ResponseField name="clientHasMadeOffer" type="Boolean!">
  Indicates whether the client has made an offer on a property already or not.
</ResponseField>

<ResponseField name="contacts" type="[ReferralContact!]!">
  The contacts for the referral.
</ResponseField>

<ResponseField name="createdAt" type="ISO8601DateTime!">
  The time the referral was created.
</ResponseField>

<ResponseField name="customAttributes" type="[CustomAttribute!]!">
  The custom attributes for the referral.
</ResponseField>

<ResponseField name="earlyDeadlineRequest" type="Boolean!">
  Indicates whether the status certificate review requires an earlier than
  normal review.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="preferredCompletionTime" type="ISO8601DateTime">
  The preferred completion time for the status certificate review.
</ResponseField>

<ResponseField name="primaryContact" type="ReferralContact!">
  The primary contact for the referral.
</ResponseField>

<ResponseField name="propertyAddress" type="Address">
  The address of the property that is involved in the status certificate review.
</ResponseField>

<ResponseField name="status" type="ReferralStatus!">
  The current status of the referral.
</ResponseField>

<ResponseField name="type" type="ReferralType!">
  The type of the referral.
</ResponseField>

<ResponseField name="updatedAt" type="ISO8601DateTime!">
  The time the referral was updated.
</ResponseField>

## Used by

* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# TransactionParticipant
Source: https://dev.ownright.com/partner-api/reference/members/objects/transaction-participant

Represents a transaction participant.

## Fields

<ResponseField name="corporationSigningOfficer" type="Boolean!">
  Whether the participant is a corporation signing officer or not.
</ResponseField>

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations the participant is a signing officer for (if any).
</ResponseField>

<ResponseField name="firstName" type="String!">
  The first name of the participant.
</ResponseField>

<ResponseField name="fullName" type="String!">
  The full name of the participant.
</ResponseField>

<ResponseField name="id" type="GID!">
  ID of the object.
</ResponseField>

<ResponseField name="lastName" type="String">
  The last name of the participant.
</ResponseField>

<ResponseField name="primaryClient" type="Boolean!">
  Whether the participant is a primary client for the matter or not.
</ResponseField>

<ResponseField name="representation" type="MatterParticipantRepresentation">
  The representation of the participant (if any).
</ResponseField>

<ResponseField name="represented" type="Boolean!">
  Whether the participant is represented or not.
</ResponseField>

<ResponseField name="representees" type="[MatterParticipant!]!">
  The participants that the participant is representing (if any).
</ResponseField>

<ResponseField name="representors" type="[MatterParticipant!]!">
  The participants that are representing the participant (if any).
</ResponseField>

<ResponseField name="representsPrimaryClient" type="Boolean!">
  Whether the participant represents a primary client for the matter or not.
</ResponseField>

<ResponseField name="traits" type="[MatterParticipantTrait!]!">
  The traits of the participant.
</ResponseField>

<ResponseField name="transactionSide" type="TransactionSideName!">
  The side of the transaction the participant belongs to.
</ResponseField>


# TransactionSide
Source: https://dev.ownright.com/partner-api/reference/members/objects/transaction-side

A side of a transaction.

## Fields

<ResponseField name="corporations" type="[MatterCorporation!]!">
  The corporations in the transaction.
</ResponseField>

<ResponseField name="name" type="TransactionSideName!">
  The name of the transaction side.
</ResponseField>

<ResponseField name="participants" type="[MatterParticipant!]!">
  The participants in the transaction.
</ResponseField>


# Decimal
Source: https://dev.ownright.com/partner-api/reference/members/scalars/decimal

A signed decimal number, which supports arbitrary precision and is serialized as a string.

## Description

A signed decimal number, which supports arbitrary precision and is serialized as a string.

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)


# E164PhoneNumber
Source: https://dev.ownright.com/partner-api/reference/members/scalars/e164-phone-number

A valid phone number string in the E.164 format.

## Description

A valid phone number string in the E.164 format.

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)
* [`matters`](/partner-api/reference/queries/matters/matters) (query)


# FileRecordGID
Source: https://dev.ownright.com/partner-api/reference/members/scalars/file-record-gid

A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.

## Description

A global identifier for a FileRecord object in format of '`gid://ownright/FileRecord/ID`'.

## Used by

* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# GID
Source: https://dev.ownright.com/partner-api/reference/members/scalars/gid

A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.

## Description

A global identifier for an object in the format of '`gid://ownright/ObjectType/ID`'.

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)
* [`matters`](/partner-api/reference/queries/matters/matters) (query)
* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# ISO8601Date
Source: https://dev.ownright.com/partner-api/reference/members/scalars/iso8601-date

An ISO 8601-encoded date

## Description

An ISO 8601-encoded date


# ISO8601DateTime
Source: https://dev.ownright.com/partner-api/reference/members/scalars/iso8601-date-time

An ISO 8601-encoded datetime

## Description

An ISO 8601-encoded datetime

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)
* [`referrals`](/partner-api/reference/queries/referrals/referrals) (query)
* [`propertyClosingReferralBulkCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create) (mutation)
* [`propertyClosingReferralCreate`](/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create) (mutation)
* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# JSON
Source: https://dev.ownright.com/partner-api/reference/members/scalars/json

Represents untyped JSON

## Description

Represents untyped JSON


# MatterGID
Source: https://dev.ownright.com/partner-api/reference/members/scalars/matter-gid

A global identifier for a matter object (ex. Transaction) in format of 'gid://ownright/{MatterKind}/ID'.

## Description

A global identifier for a matter object (ex. Transaction) in format of '`gid://ownright/{MatterKind}/ID`'.

## Used by

* [`matter`](/partner-api/reference/queries/matters/matter) (query)


# ReferralGID
Source: https://dev.ownright.com/partner-api/reference/members/scalars/referral-gid

A global identifier for a Referral object in format of 'gid://ownright/Referral/ID'.

## Description

A global identifier for a Referral object in format of '`gid://ownright/Referral/ID`'.

## Used by

* [`referral`](/partner-api/reference/queries/referrals/referral) (query)


# Url
Source: https://dev.ownright.com/partner-api/reference/members/scalars/url

A valid URL, transported as a string.

## Description

A valid URL, transported as a string.

## Used by

* [`refinanceReferralBulkCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create) (mutation)
* [`refinanceReferralCreate`](/partner-api/reference/mutations/referrals/refinance/refinance-referral-create) (mutation)
* [`stagedFileUploadCreate`](/partner-api/reference/mutations/files/staged-file-upload-create) (mutation)
* [`statusCertificateReviewReferralBulkCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create) (mutation)
* [`statusCertificateReviewReferralCreate`](/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create) (mutation)


# Staged File Upload Create
Source: https://dev.ownright.com/partner-api/reference/mutations/files/staged-file-upload-create

Creates a staged file upload.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation StagedFileUploadCreate($input: StagedFileUploadInput!) {
    stagedFileUploadCreate(input: $input) {
      stagedFileUpload {
        signedUploadUrl
        signedUploadUrlExpiryDate
        file {
          createdAt
          filename
          id
          mimeType
          staged
          updatedAt
          ... on Document {
            url
          }
          ... on Image {
            url
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": {
      "filename": "document.pdf",
      "mimeType": "AUDIO_M4A"
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "stagedFileUploadCreate": {
        "stagedFileUpload": {
          "signedUploadUrl": "https://example.com",
          "signedUploadUrlExpiryDate": "2025-01-15T10:30:00Z",
          "file": {
            "createdAt": "2025-01-15T10:30:00Z",
            "filename": "document.pdf",
            "id": "gid://ownright/Object/1",
            "mimeType": "AUDIO_M4A",
            "staged": true,
            "updatedAt": "2025-01-15T10:30:00Z",
            "url": "https://example.com"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`stagedFileUploadCreate`

### Arguments

<ParamField type="StagedFileUploadInput!">
  Input required to make a staged file upload.

  <Expandable title="properties">
    <ParamField type="String!">
      The name of the file that is being uploaded.
    </ParamField>

    <ParamField type="FileMimeType!">
      The MIME type of the file that is being uploaded.
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="stagedFileUpload" type="StagedFileUpload">
  The newly created staged file upload.

  <Expandable title="properties">
    <ResponseField name="file" type="File!">
      The file that is staged for upload.

      <Expandable title="properties">
        <ResponseField name="createdAt" type="ISO8601DateTime!">
          The date the file was created.
        </ResponseField>

        <ResponseField name="filename" type="String!">
          The name of the file.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="mimeType" type="FileMimeType!">
          The MIME type of the file.
        </ResponseField>

        <ResponseField name="staged" type="Boolean!">
          Whether the file is staged for upload or not.
        </ResponseField>

        <ResponseField name="updatedAt" type="ISO8601DateTime!">
          The date the file was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="signedUploadUrl" type="Url!">
      A signed upload URL to use when uploading file.
    </ResponseField>

    <ResponseField name="signedUploadUrlExpiryDate" type="ISO8601DateTime!">
      Date when upload URL expires.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[StagedFileUploadCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="StagedFileUploadCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`File`](/partner-api/reference/members/interfaces/file) (interface) — Represents a file.
* [`FileMimeType`](/partner-api/reference/members/enums/file-mime-type) (enum) — Possible MIME types for files.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`StagedFileUpload`](/partner-api/reference/members/objects/staged-file-upload) (object) — Represents a staged file upload.
* [`StagedFileUploadCreatePayload`](/partner-api/reference/members/objects/staged-file-upload-create-payload) (object) — Return type for the `stagedFileUploadCreate` mutation.
* [`StagedFileUploadCreateUserError`](/partner-api/reference/members/objects/staged-file-upload-create-user-error) (object) — An error that could occur during the execution of the `stagedFileUploadCreate` mutation.
* [`StagedFileUploadCreateUserErrorCode`](/partner-api/reference/members/enums/staged-file-upload-create-user-error-code) (enum) — Possible error codes that can be returned by StagedFileUploadCreateUserError.
* [`StagedFileUploadInput`](/partner-api/reference/members/inputs/staged-file-upload-input) (input) — Input to create a staged file upload.
* [`Url`](/partner-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Property Closing Referral Bulk Create
Source: https://dev.ownright.com/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-bulk-create

Creates multiple property closing referrals.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation PropertyClosingReferralBulkCreate($input: [PropertyClosingReferralInput!]!) {
    propertyClosingReferralBulkCreate(input: $input) {
      referrals {
        createdAt
        id
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        ... on PurchasePropertyClosingReferral {
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
          purchaseAmount {
            amount
            currencyCode
          }
        }
        ... on RefinanceReferral {
          mortgageAmount {
            amount
            currencyCode
          }
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        ... on SalePropertyClosingReferral {
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": [
      {
        "contacts": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "+14165551234",
            "primary": true
          }
        ],
        "customAttributes": [
          {
            "key": "example-key",
            "type": "BOOLEAN",
            "value": "example-value"
          }
        ],
        "files": [
          {
            "fileRecordId": "gid://ownright/FileRecord/1",
            "tags": [
              "example-tags"
            ]
          }
        ],
        "intentLevel": "HIGH",
        "purchaseAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "purchasePropertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "street": "123 Main St",
          "unitNumber": "Suite 100"
        },
        "salePropertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "street": "123 Main St",
          "unitNumber": "Suite 100"
        },
        "type": "PURCHASE_PROPERTY_CLOSING"
      }
    ]
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "propertyClosingReferralBulkCreate": {
        "referrals": [
          {
            "createdAt": "2025-01-15T10:30:00Z",
            "id": "gid://ownright/Object/1",
            "status": "CONVERTED",
            "type": "PURCHASE_PROPERTY_CLOSING",
            "updatedAt": "2025-01-15T10:30:00Z",
            "contacts": [
              {
                "email": "jane@example.com",
                "firstName": "Jane",
                "id": "gid://ownright/Object/1",
                "isPrimary": true,
                "lastName": "Doe",
                "phoneNumber": "+14165551234"
              }
            ],
            "customAttributes": [
              {
                "id": "gid://ownright/Object/1",
                "key": "example-key",
                "type": "BOOLEAN",
                "value": "example-value"
              }
            ],
            "primaryContact": {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            },
            "propertyAddress": {
              "city": "Toronto",
              "country": "CANADA",
              "latitude": 1,
              "longitude": 1,
              "mapImageUrl": "https://example.com",
              "postalCode": "M5V 1A1",
              "province": "ALBERTA",
              "shortTitle": "123 Main St, Toronto",
              "street": "123 Main St",
              "title": "123 Main St, Toronto",
              "unitNumber": "Suite 100"
            },
            "purchaseAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            },
            "mortgageAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            }
          }
        ],
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`propertyClosingReferralBulkCreate`

### Arguments

<ParamField type="[PropertyClosingReferralInput!]!">
  Input required to create property closing referrals.

  <Expandable title="properties">
    <ParamField type="[ReferralContactCreateInput!]">
      Contacts to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The email for the referral contact.
        </ParamField>

        <ParamField type="String!">
          The first name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The last name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The phone number for the referral contact.
        </ParamField>

        <ParamField type="Boolean!">
          Whether this contact is the primary contact for the referral.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[CustomAttributeCreateInput!]">
      Custom attributes to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The key of the custom attribute.
        </ParamField>

        <ParamField type="CustomAttributeType!">
          The type of the custom attribute.
        </ParamField>

        <ParamField type="String!">
          The value of the custom attribute.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[FileBulkCommitInput!]!">
      The files to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="FileRecordGID!">
          The identifier of a staged file record to commit.
        </ParamField>

        <ParamField type="[String!]!">
          Tags to add to the committed versioned file.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralIntentLevel">
      The intent level of the referral.
    </ParamField>

    <ParamField type="MoneyInput">
      The amount the purchase property is being purchased for.

      <Expandable title="properties">
        <ParamField type="Decimal!">
          The amount of money.
        </ParamField>

        <ParamField type="CurrencyCode!">
          The currency of the money.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="AddressInput">
      The address of the property the person is buying.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="AddressInput">
      The address of the property the person is selling.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralType!">
      The type of the referral.
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="referrals" type="[Referral!]">
  The created referrals.

  <Expandable title="properties">
    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[PropertyClosingReferralBulkCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="PropertyClosingReferralBulkCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`AddressInput`](/partner-api/reference/members/inputs/address-input) (input) — Input to create or update an address.
* [`Country`](/partner-api/reference/members/enums/country) (enum) — Possible countries.
* [`CurrencyCode`](/partner-api/reference/members/enums/currency-code) (enum) — Possible currency codes.
* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeCreateInput`](/partner-api/reference/members/inputs/custom-attribute-create-input) (input) — Input to create a custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`Decimal`](/partner-api/reference/members/scalars/decimal) (scalar) — A signed decimal number, which supports arbitrary precision and is serialized as a string.
* [`FileBulkCommitInput`](/partner-api/reference/members/inputs/file-bulk-commit-input) (input) — Input for a file to committed as part of a bulk file commit.
* [`FileRecordGID`](/partner-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`MoneyInput`](/partner-api/reference/members/inputs/money-input) (input) — Input that represents money.
* [`PropertyClosingReferralBulkCreatePayload`](/partner-api/reference/members/objects/property-closing-referral-bulk-create-payload) (object) — Return type for the `propertyClosingReferralBulkCreate` mutation.
* [`PropertyClosingReferralBulkCreateUserError`](/partner-api/reference/members/objects/property-closing-referral-bulk-create-user-error) (object) — An error that could occur during the execution of the `propertyClosingReferralBulkCreate` mutation.
* [`PropertyClosingReferralBulkCreateUserErrorCode`](/partner-api/reference/members/enums/property-closing-referral-bulk-create-user-error-code) (enum) — Possible error codes that can be returned by PropertyClosingReferralBulkCreateUserError.
* [`PropertyClosingReferralInput`](/partner-api/reference/members/inputs/property-closing-referral-input) (input) — Input to create a property closing referral.
* [`Province`](/partner-api/reference/members/enums/province) (enum) — Possible provinces.
* [`Referral`](/partner-api/reference/members/interfaces/referral) (interface) — Represents a referral.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralContactCreateInput`](/partner-api/reference/members/inputs/referral-contact-create-input) (input) — The input to create a referral contact.
* [`ReferralIntentLevel`](/partner-api/reference/members/enums/referral-intent-level) (enum) — Possible levels of intent for a referral.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.


# Property Closing Referral Create
Source: https://dev.ownright.com/partner-api/reference/mutations/referrals/property-closings/property-closing-referral-create

Creates a new property closing referral.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation PropertyClosingReferralCreate($input: PropertyClosingReferralInput!) {
    propertyClosingReferralCreate(input: $input) {
      referral {
        createdAt
        id
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        ... on PurchasePropertyClosingReferral {
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
          purchaseAmount {
            amount
            currencyCode
          }
        }
        ... on RefinanceReferral {
          mortgageAmount {
            amount
            currencyCode
          }
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        ... on SalePropertyClosingReferral {
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": {
      "contacts": [
        {
          "email": "jane@example.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "phoneNumber": "+14165551234",
          "primary": true
        }
      ],
      "customAttributes": [
        {
          "key": "example-key",
          "type": "BOOLEAN",
          "value": "example-value"
        }
      ],
      "files": [
        {
          "fileRecordId": "gid://ownright/FileRecord/1",
          "tags": [
            "example-tags"
          ]
        }
      ],
      "intentLevel": "HIGH",
      "purchaseAmount": {
        "amount": "100.00",
        "currencyCode": "CAD"
      },
      "purchasePropertyAddress": {
        "city": "Toronto",
        "country": "CANADA",
        "postalCode": "M5V 1A1",
        "province": "ALBERTA",
        "street": "123 Main St",
        "unitNumber": "Suite 100"
      },
      "salePropertyAddress": {
        "city": "Toronto",
        "country": "CANADA",
        "postalCode": "M5V 1A1",
        "province": "ALBERTA",
        "street": "123 Main St",
        "unitNumber": "Suite 100"
      },
      "type": "PURCHASE_PROPERTY_CLOSING"
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "propertyClosingReferralCreate": {
        "referral": {
          "createdAt": "2025-01-15T10:30:00Z",
          "id": "gid://ownright/Object/1",
          "status": "CONVERTED",
          "type": "PURCHASE_PROPERTY_CLOSING",
          "updatedAt": "2025-01-15T10:30:00Z",
          "contacts": [
            {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            }
          ],
          "customAttributes": [
            {
              "id": "gid://ownright/Object/1",
              "key": "example-key",
              "type": "BOOLEAN",
              "value": "example-value"
            }
          ],
          "primaryContact": {
            "email": "jane@example.com",
            "firstName": "Jane",
            "id": "gid://ownright/Object/1",
            "isPrimary": true,
            "lastName": "Doe",
            "phoneNumber": "+14165551234"
          },
          "propertyAddress": {
            "city": "Toronto",
            "country": "CANADA",
            "latitude": 1,
            "longitude": 1,
            "mapImageUrl": "https://example.com",
            "postalCode": "M5V 1A1",
            "province": "ALBERTA",
            "shortTitle": "123 Main St, Toronto",
            "street": "123 Main St",
            "title": "123 Main St, Toronto",
            "unitNumber": "Suite 100"
          },
          "purchaseAmount": {
            "amount": "100.00",
            "currencyCode": "CAD"
          },
          "mortgageAmount": {
            "amount": "100.00",
            "currencyCode": "CAD"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`propertyClosingReferralCreate`

### Arguments

<ParamField type="PropertyClosingReferralInput!">
  Input required to create a property closing referral.

  <Expandable title="properties">
    <ParamField type="[ReferralContactCreateInput!]">
      Contacts to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The email for the referral contact.
        </ParamField>

        <ParamField type="String!">
          The first name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The last name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The phone number for the referral contact.
        </ParamField>

        <ParamField type="Boolean!">
          Whether this contact is the primary contact for the referral.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[CustomAttributeCreateInput!]">
      Custom attributes to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The key of the custom attribute.
        </ParamField>

        <ParamField type="CustomAttributeType!">
          The type of the custom attribute.
        </ParamField>

        <ParamField type="String!">
          The value of the custom attribute.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[FileBulkCommitInput!]!">
      The files to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="FileRecordGID!">
          The identifier of a staged file record to commit.
        </ParamField>

        <ParamField type="[String!]!">
          Tags to add to the committed versioned file.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralIntentLevel">
      The intent level of the referral.
    </ParamField>

    <ParamField type="MoneyInput">
      The amount the purchase property is being purchased for.

      <Expandable title="properties">
        <ParamField type="Decimal!">
          The amount of money.
        </ParamField>

        <ParamField type="CurrencyCode!">
          The currency of the money.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="AddressInput">
      The address of the property the person is buying.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="AddressInput">
      The address of the property the person is selling.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralType!">
      The type of the referral.
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="referral" type="Referral">
  The created referral.

  <Expandable title="properties">
    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[PropertyClosingReferralCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="PropertyClosingReferralCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`AddressInput`](/partner-api/reference/members/inputs/address-input) (input) — Input to create or update an address.
* [`Country`](/partner-api/reference/members/enums/country) (enum) — Possible countries.
* [`CurrencyCode`](/partner-api/reference/members/enums/currency-code) (enum) — Possible currency codes.
* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeCreateInput`](/partner-api/reference/members/inputs/custom-attribute-create-input) (input) — Input to create a custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`Decimal`](/partner-api/reference/members/scalars/decimal) (scalar) — A signed decimal number, which supports arbitrary precision and is serialized as a string.
* [`FileBulkCommitInput`](/partner-api/reference/members/inputs/file-bulk-commit-input) (input) — Input for a file to committed as part of a bulk file commit.
* [`FileRecordGID`](/partner-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`MoneyInput`](/partner-api/reference/members/inputs/money-input) (input) — Input that represents money.
* [`PropertyClosingReferralCreatePayload`](/partner-api/reference/members/objects/property-closing-referral-create-payload) (object) — Return type for the `propertyClosingReferralCreate` mutation.
* [`PropertyClosingReferralCreateUserError`](/partner-api/reference/members/objects/property-closing-referral-create-user-error) (object) — An error that could occur during the execution of the `propertyClosingReferralCreate` mutation.
* [`PropertyClosingReferralCreateUserErrorCode`](/partner-api/reference/members/enums/property-closing-referral-create-user-error-code) (enum) — Possible error codes that can be returned by PropertyClosingReferralCreateUserError.
* [`PropertyClosingReferralInput`](/partner-api/reference/members/inputs/property-closing-referral-input) (input) — Input to create a property closing referral.
* [`Province`](/partner-api/reference/members/enums/province) (enum) — Possible provinces.
* [`Referral`](/partner-api/reference/members/interfaces/referral) (interface) — Represents a referral.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralContactCreateInput`](/partner-api/reference/members/inputs/referral-contact-create-input) (input) — The input to create a referral contact.
* [`ReferralIntentLevel`](/partner-api/reference/members/enums/referral-intent-level) (enum) — Possible levels of intent for a referral.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.


# Refinance Referral Bulk Create
Source: https://dev.ownright.com/partner-api/reference/mutations/referrals/refinance/refinance-referral-bulk-create

Creates multiple refinance referrals.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation RefinanceReferralBulkCreate($input: [RefinanceReferralInput!]!) {
    refinanceReferralBulkCreate(input: $input) {
      referrals {
        createdAt
        id
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        mortgageAmount {
          amount
          currencyCode
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": [
      {
        "contacts": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "+14165551234",
            "primary": true
          }
        ],
        "customAttributes": [
          {
            "key": "example-key",
            "type": "BOOLEAN",
            "value": "example-value"
          }
        ],
        "files": [
          {
            "fileRecordId": "gid://ownright/FileRecord/1",
            "tags": [
              "example-tags"
            ]
          }
        ],
        "intentLevel": "HIGH",
        "mortgageAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "propertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "street": "123 Main St",
          "unitNumber": "Suite 100"
        }
      }
    ]
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "refinanceReferralBulkCreate": {
        "referrals": [
          {
            "createdAt": "2025-01-15T10:30:00Z",
            "id": "gid://ownright/Object/1",
            "status": "CONVERTED",
            "type": "PURCHASE_PROPERTY_CLOSING",
            "updatedAt": "2025-01-15T10:30:00Z",
            "contacts": [
              {
                "email": "jane@example.com",
                "firstName": "Jane",
                "id": "gid://ownright/Object/1",
                "isPrimary": true,
                "lastName": "Doe",
                "phoneNumber": "+14165551234"
              }
            ],
            "customAttributes": [
              {
                "id": "gid://ownright/Object/1",
                "key": "example-key",
                "type": "BOOLEAN",
                "value": "example-value"
              }
            ],
            "mortgageAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            },
            "primaryContact": {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            },
            "propertyAddress": {
              "city": "Toronto",
              "country": "CANADA",
              "latitude": 1,
              "longitude": 1,
              "mapImageUrl": "https://example.com",
              "postalCode": "M5V 1A1",
              "province": "ALBERTA",
              "shortTitle": "123 Main St, Toronto",
              "street": "123 Main St",
              "title": "123 Main St, Toronto",
              "unitNumber": "Suite 100"
            }
          }
        ],
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`refinanceReferralBulkCreate`

### Arguments

<ParamField type="[RefinanceReferralInput!]!">
  Input required to create refinance referrals.

  <Expandable title="properties">
    <ParamField type="[ReferralContactCreateInput!]">
      Contacts to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The email for the referral contact.
        </ParamField>

        <ParamField type="String!">
          The first name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The last name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The phone number for the referral contact.
        </ParamField>

        <ParamField type="Boolean!">
          Whether this contact is the primary contact for the referral.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[CustomAttributeCreateInput!]">
      Custom attributes to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The key of the custom attribute.
        </ParamField>

        <ParamField type="CustomAttributeType!">
          The type of the custom attribute.
        </ParamField>

        <ParamField type="String!">
          The value of the custom attribute.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[FileBulkCommitInput!]!">
      The files to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="FileRecordGID!">
          The identifier of a staged file record to commit.
        </ParamField>

        <ParamField type="[String!]!">
          Tags to add to the committed versioned file.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralIntentLevel">
      The intent level of the referral.
    </ParamField>

    <ParamField type="MoneyInput">
      The amount of the new mortgage.

      <Expandable title="properties">
        <ParamField type="Decimal!">
          The amount of money.
        </ParamField>

        <ParamField type="CurrencyCode!">
          The currency of the money.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="AddressInput!">
      The address of the property being refinanced.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="referrals" type="[RefinanceReferral!]">
  The created referrals.

  <Expandable title="properties">
    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="mortgageAmount" type="Money">
      The amount of the new mortgage involved in the refinance.

      <Expandable title="properties">
        <ResponseField name="amount" type="Decimal!">
          The amount of money.
        </ResponseField>

        <ResponseField name="currencyCode" type="CurrencyCode!">
          The currency of the money.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="propertyAddress" type="Address">
      The address of the property that is involved in the refinance.

      <Expandable title="properties">
        <ResponseField name="city" type="String!">
          The city of the address.
        </ResponseField>

        <ResponseField name="country" type="Country!">
          The country of the address.
        </ResponseField>

        <ResponseField name="latitude" type="Float">
          The latitude of the address.
        </ResponseField>

        <ResponseField name="longitude" type="Float">
          The longitude of the address.
        </ResponseField>

        <ResponseField name="mapImageUrl" type="Url">
          A link to a map with a pointer on the address's location.
        </ResponseField>

        <ResponseField name="postalCode" type="String!">
          The postal code of the address.
        </ResponseField>

        <ResponseField name="province" type="Province!">
          The province of the address.
        </ResponseField>

        <ResponseField name="shortTitle" type="String!">
          The shortened title for the address.
        </ResponseField>

        <ResponseField name="street" type="String!">
          The street name and number of the address.
        </ResponseField>

        <ResponseField name="title" type="String!">
          The full title for the address.
        </ResponseField>

        <ResponseField name="unitNumber" type="String">
          The unit number, apartment number, suite number etc.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[RefinanceReferralBulkCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="RefinanceReferralBulkCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Address`](/partner-api/reference/members/objects/address) (object) — Represents an address.
* [`AddressInput`](/partner-api/reference/members/inputs/address-input) (input) — Input to create or update an address.
* [`Country`](/partner-api/reference/members/enums/country) (enum) — Possible countries.
* [`CurrencyCode`](/partner-api/reference/members/enums/currency-code) (enum) — Possible currency codes.
* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeCreateInput`](/partner-api/reference/members/inputs/custom-attribute-create-input) (input) — Input to create a custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`Decimal`](/partner-api/reference/members/scalars/decimal) (scalar) — A signed decimal number, which supports arbitrary precision and is serialized as a string.
* [`FileBulkCommitInput`](/partner-api/reference/members/inputs/file-bulk-commit-input) (input) — Input for a file to committed as part of a bulk file commit.
* [`FileRecordGID`](/partner-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`ImageTransformInput`](/partner-api/reference/members/inputs/image-transform-input) (input) — Input to transform an image.
* [`Money`](/partner-api/reference/members/objects/money) (object) — Represents money.
* [`MoneyInput`](/partner-api/reference/members/inputs/money-input) (input) — Input that represents money.
* [`Province`](/partner-api/reference/members/enums/province) (enum) — Possible provinces.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralContactCreateInput`](/partner-api/reference/members/inputs/referral-contact-create-input) (input) — The input to create a referral contact.
* [`ReferralIntentLevel`](/partner-api/reference/members/enums/referral-intent-level) (enum) — Possible levels of intent for a referral.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.
* [`RefinanceReferral`](/partner-api/reference/members/objects/refinance-referral) (object) — A referral for a refinance.
* [`RefinanceReferralBulkCreatePayload`](/partner-api/reference/members/objects/refinance-referral-bulk-create-payload) (object) — Return type for the `refinanceReferralBulkCreate` mutation.
* [`RefinanceReferralBulkCreateUserError`](/partner-api/reference/members/objects/refinance-referral-bulk-create-user-error) (object) — An error that could occur during the execution of the `refinanceReferralBulkCreate` mutation.
* [`RefinanceReferralBulkCreateUserErrorCode`](/partner-api/reference/members/enums/refinance-referral-bulk-create-user-error-code) (enum) — Possible error codes that can be returned by RefinanceReferralBulkCreateUserError.
* [`RefinanceReferralInput`](/partner-api/reference/members/inputs/refinance-referral-input) (input) — Input to create a refinance referral.
* [`Url`](/partner-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Refinance Referral Create
Source: https://dev.ownright.com/partner-api/reference/mutations/referrals/refinance/refinance-referral-create

Creates a new refinance referral.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation RefinanceReferralCreate($input: RefinanceReferralInput!) {
    refinanceReferralCreate(input: $input) {
      referral {
        createdAt
        id
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        mortgageAmount {
          amount
          currencyCode
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": {
      "contacts": [
        {
          "email": "jane@example.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "phoneNumber": "+14165551234",
          "primary": true
        }
      ],
      "customAttributes": [
        {
          "key": "example-key",
          "type": "BOOLEAN",
          "value": "example-value"
        }
      ],
      "files": [
        {
          "fileRecordId": "gid://ownright/FileRecord/1",
          "tags": [
            "example-tags"
          ]
        }
      ],
      "intentLevel": "HIGH",
      "mortgageAmount": {
        "amount": "100.00",
        "currencyCode": "CAD"
      },
      "propertyAddress": {
        "city": "Toronto",
        "country": "CANADA",
        "postalCode": "M5V 1A1",
        "province": "ALBERTA",
        "street": "123 Main St",
        "unitNumber": "Suite 100"
      }
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "refinanceReferralCreate": {
        "referral": {
          "createdAt": "2025-01-15T10:30:00Z",
          "id": "gid://ownright/Object/1",
          "status": "CONVERTED",
          "type": "PURCHASE_PROPERTY_CLOSING",
          "updatedAt": "2025-01-15T10:30:00Z",
          "contacts": [
            {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            }
          ],
          "customAttributes": [
            {
              "id": "gid://ownright/Object/1",
              "key": "example-key",
              "type": "BOOLEAN",
              "value": "example-value"
            }
          ],
          "mortgageAmount": {
            "amount": "100.00",
            "currencyCode": "CAD"
          },
          "primaryContact": {
            "email": "jane@example.com",
            "firstName": "Jane",
            "id": "gid://ownright/Object/1",
            "isPrimary": true,
            "lastName": "Doe",
            "phoneNumber": "+14165551234"
          },
          "propertyAddress": {
            "city": "Toronto",
            "country": "CANADA",
            "latitude": 1,
            "longitude": 1,
            "mapImageUrl": "https://example.com",
            "postalCode": "M5V 1A1",
            "province": "ALBERTA",
            "shortTitle": "123 Main St, Toronto",
            "street": "123 Main St",
            "title": "123 Main St, Toronto",
            "unitNumber": "Suite 100"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`refinanceReferralCreate`

### Arguments

<ParamField type="RefinanceReferralInput!">
  Input required to create a refinance referral.

  <Expandable title="properties">
    <ParamField type="[ReferralContactCreateInput!]">
      Contacts to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The email for the referral contact.
        </ParamField>

        <ParamField type="String!">
          The first name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The last name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The phone number for the referral contact.
        </ParamField>

        <ParamField type="Boolean!">
          Whether this contact is the primary contact for the referral.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[CustomAttributeCreateInput!]">
      Custom attributes to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The key of the custom attribute.
        </ParamField>

        <ParamField type="CustomAttributeType!">
          The type of the custom attribute.
        </ParamField>

        <ParamField type="String!">
          The value of the custom attribute.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[FileBulkCommitInput!]!">
      The files to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="FileRecordGID!">
          The identifier of a staged file record to commit.
        </ParamField>

        <ParamField type="[String!]!">
          Tags to add to the committed versioned file.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralIntentLevel">
      The intent level of the referral.
    </ParamField>

    <ParamField type="MoneyInput">
      The amount of the new mortgage.

      <Expandable title="properties">
        <ParamField type="Decimal!">
          The amount of money.
        </ParamField>

        <ParamField type="CurrencyCode!">
          The currency of the money.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="AddressInput!">
      The address of the property being refinanced.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="referral" type="RefinanceReferral">
  The created referral.

  <Expandable title="properties">
    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="mortgageAmount" type="Money">
      The amount of the new mortgage involved in the refinance.

      <Expandable title="properties">
        <ResponseField name="amount" type="Decimal!">
          The amount of money.
        </ResponseField>

        <ResponseField name="currencyCode" type="CurrencyCode!">
          The currency of the money.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="propertyAddress" type="Address">
      The address of the property that is involved in the refinance.

      <Expandable title="properties">
        <ResponseField name="city" type="String!">
          The city of the address.
        </ResponseField>

        <ResponseField name="country" type="Country!">
          The country of the address.
        </ResponseField>

        <ResponseField name="latitude" type="Float">
          The latitude of the address.
        </ResponseField>

        <ResponseField name="longitude" type="Float">
          The longitude of the address.
        </ResponseField>

        <ResponseField name="mapImageUrl" type="Url">
          A link to a map with a pointer on the address's location.
        </ResponseField>

        <ResponseField name="postalCode" type="String!">
          The postal code of the address.
        </ResponseField>

        <ResponseField name="province" type="Province!">
          The province of the address.
        </ResponseField>

        <ResponseField name="shortTitle" type="String!">
          The shortened title for the address.
        </ResponseField>

        <ResponseField name="street" type="String!">
          The street name and number of the address.
        </ResponseField>

        <ResponseField name="title" type="String!">
          The full title for the address.
        </ResponseField>

        <ResponseField name="unitNumber" type="String">
          The unit number, apartment number, suite number etc.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[RefinanceReferralCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="RefinanceReferralCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Address`](/partner-api/reference/members/objects/address) (object) — Represents an address.
* [`AddressInput`](/partner-api/reference/members/inputs/address-input) (input) — Input to create or update an address.
* [`Country`](/partner-api/reference/members/enums/country) (enum) — Possible countries.
* [`CurrencyCode`](/partner-api/reference/members/enums/currency-code) (enum) — Possible currency codes.
* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeCreateInput`](/partner-api/reference/members/inputs/custom-attribute-create-input) (input) — Input to create a custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`Decimal`](/partner-api/reference/members/scalars/decimal) (scalar) — A signed decimal number, which supports arbitrary precision and is serialized as a string.
* [`FileBulkCommitInput`](/partner-api/reference/members/inputs/file-bulk-commit-input) (input) — Input for a file to committed as part of a bulk file commit.
* [`FileRecordGID`](/partner-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`ImageTransformInput`](/partner-api/reference/members/inputs/image-transform-input) (input) — Input to transform an image.
* [`Money`](/partner-api/reference/members/objects/money) (object) — Represents money.
* [`MoneyInput`](/partner-api/reference/members/inputs/money-input) (input) — Input that represents money.
* [`Province`](/partner-api/reference/members/enums/province) (enum) — Possible provinces.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralContactCreateInput`](/partner-api/reference/members/inputs/referral-contact-create-input) (input) — The input to create a referral contact.
* [`ReferralIntentLevel`](/partner-api/reference/members/enums/referral-intent-level) (enum) — Possible levels of intent for a referral.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.
* [`RefinanceReferral`](/partner-api/reference/members/objects/refinance-referral) (object) — A referral for a refinance.
* [`RefinanceReferralCreatePayload`](/partner-api/reference/members/objects/refinance-referral-create-payload) (object) — Return type for the `refinanceReferralCreate` mutation.
* [`RefinanceReferralCreateUserError`](/partner-api/reference/members/objects/refinance-referral-create-user-error) (object) — An error that could occur during the execution of the `refinanceReferralCreate` mutation.
* [`RefinanceReferralCreateUserErrorCode`](/partner-api/reference/members/enums/refinance-referral-create-user-error-code) (enum) — Possible error codes that can be returned by RefinanceReferralCreateUserError.
* [`RefinanceReferralInput`](/partner-api/reference/members/inputs/refinance-referral-input) (input) — Input to create a refinance referral.
* [`Url`](/partner-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Status Certificate Review Referral Bulk Create
Source: https://dev.ownright.com/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-bulk-create

Creates multiple status certificate review referrals.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation StatusCertificateReviewReferralBulkCreate($input: [StatusCertificateReviewReferralInput!]!) {
    statusCertificateReviewReferralBulkCreate(input: $input) {
      referrals {
        clientHasMadeOffer
        createdAt
        earlyDeadlineRequest
        id
        preferredCompletionTime
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": [
      {
        "clientHasMadeOffer": true,
        "contacts": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "+14165551234",
            "primary": true
          }
        ],
        "customAttributes": [
          {
            "key": "example-key",
            "type": "BOOLEAN",
            "value": "example-value"
          }
        ],
        "earlyDeadlineRequest": true,
        "files": [
          {
            "fileRecordId": "gid://ownright/FileRecord/1",
            "tags": [
              "example-tags"
            ]
          }
        ],
        "intentLevel": "HIGH",
        "preferredCompletionTime": "2025-01-15T10:30:00Z",
        "propertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "street": "123 Main St",
          "unitNumber": "Suite 100"
        }
      }
    ]
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "statusCertificateReviewReferralBulkCreate": {
        "referrals": [
          {
            "clientHasMadeOffer": true,
            "createdAt": "2025-01-15T10:30:00Z",
            "earlyDeadlineRequest": true,
            "id": "gid://ownright/Object/1",
            "preferredCompletionTime": "2025-01-15T10:30:00Z",
            "status": "CONVERTED",
            "type": "PURCHASE_PROPERTY_CLOSING",
            "updatedAt": "2025-01-15T10:30:00Z",
            "contacts": [
              {
                "email": "jane@example.com",
                "firstName": "Jane",
                "id": "gid://ownright/Object/1",
                "isPrimary": true,
                "lastName": "Doe",
                "phoneNumber": "+14165551234"
              }
            ],
            "customAttributes": [
              {
                "id": "gid://ownright/Object/1",
                "key": "example-key",
                "type": "BOOLEAN",
                "value": "example-value"
              }
            ],
            "primaryContact": {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            },
            "propertyAddress": {
              "city": "Toronto",
              "country": "CANADA",
              "latitude": 1,
              "longitude": 1,
              "mapImageUrl": "https://example.com",
              "postalCode": "M5V 1A1",
              "province": "ALBERTA",
              "shortTitle": "123 Main St, Toronto",
              "street": "123 Main St",
              "title": "123 Main St, Toronto",
              "unitNumber": "Suite 100"
            }
          }
        ],
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`statusCertificateReviewReferralBulkCreate`

### Arguments

<ParamField type="[StatusCertificateReviewReferralInput!]!">
  Input required to create status certificate review referrals.

  <Expandable title="properties">
    <ParamField type="Boolean">
      Whether or not the client has made an offer on the property already.
    </ParamField>

    <ParamField type="[ReferralContactCreateInput!]!">
      Contacts to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The email for the referral contact.
        </ParamField>

        <ParamField type="String!">
          The first name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The last name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The phone number for the referral contact.
        </ParamField>

        <ParamField type="Boolean!">
          Whether this contact is the primary contact for the referral.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[CustomAttributeCreateInput!]">
      Custom attributes to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The key of the custom attribute.
        </ParamField>

        <ParamField type="CustomAttributeType!">
          The type of the custom attribute.
        </ParamField>

        <ParamField type="String!">
          The value of the custom attribute.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="Boolean">
      Whether or not the status certificate review requires an earlier than normal
      review.
    </ParamField>

    <ParamField type="[FileBulkCommitInput!]!">
      The files to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="FileRecordGID!">
          The identifier of a staged file record to commit.
        </ParamField>

        <ParamField type="[String!]!">
          Tags to add to the committed versioned file.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralIntentLevel">
      The intent level of the referral.
    </ParamField>

    <ParamField type="ISO8601DateTime">
      The preferred completion time for the status certificate review.
    </ParamField>

    <ParamField type="AddressInput!">
      The address of the property for which the status certificate review is being requested.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="referrals" type="[StatusCertificateReviewReferral!]">
  The created referrals.

  <Expandable title="properties">
    <ResponseField name="clientHasMadeOffer" type="Boolean!">
      Indicates whether the client has made an offer on a property already or not.
    </ResponseField>

    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="earlyDeadlineRequest" type="Boolean!">
      Indicates whether the status certificate review requires an earlier than
      normal review.
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="preferredCompletionTime" type="ISO8601DateTime">
      The preferred completion time for the status certificate review.
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="propertyAddress" type="Address">
      The address of the property that is involved in the status certificate review.

      <Expandable title="properties">
        <ResponseField name="city" type="String!">
          The city of the address.
        </ResponseField>

        <ResponseField name="country" type="Country!">
          The country of the address.
        </ResponseField>

        <ResponseField name="latitude" type="Float">
          The latitude of the address.
        </ResponseField>

        <ResponseField name="longitude" type="Float">
          The longitude of the address.
        </ResponseField>

        <ResponseField name="mapImageUrl" type="Url">
          A link to a map with a pointer on the address's location.
        </ResponseField>

        <ResponseField name="postalCode" type="String!">
          The postal code of the address.
        </ResponseField>

        <ResponseField name="province" type="Province!">
          The province of the address.
        </ResponseField>

        <ResponseField name="shortTitle" type="String!">
          The shortened title for the address.
        </ResponseField>

        <ResponseField name="street" type="String!">
          The street name and number of the address.
        </ResponseField>

        <ResponseField name="title" type="String!">
          The full title for the address.
        </ResponseField>

        <ResponseField name="unitNumber" type="String">
          The unit number, apartment number, suite number etc.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[StatusCertificateReviewReferralBulkCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="StatusCertificateReviewReferralBulkCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Address`](/partner-api/reference/members/objects/address) (object) — Represents an address.
* [`AddressInput`](/partner-api/reference/members/inputs/address-input) (input) — Input to create or update an address.
* [`Country`](/partner-api/reference/members/enums/country) (enum) — Possible countries.
* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeCreateInput`](/partner-api/reference/members/inputs/custom-attribute-create-input) (input) — Input to create a custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`FileBulkCommitInput`](/partner-api/reference/members/inputs/file-bulk-commit-input) (input) — Input for a file to committed as part of a bulk file commit.
* [`FileRecordGID`](/partner-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`ImageTransformInput`](/partner-api/reference/members/inputs/image-transform-input) (input) — Input to transform an image.
* [`Province`](/partner-api/reference/members/enums/province) (enum) — Possible provinces.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralContactCreateInput`](/partner-api/reference/members/inputs/referral-contact-create-input) (input) — The input to create a referral contact.
* [`ReferralIntentLevel`](/partner-api/reference/members/enums/referral-intent-level) (enum) — Possible levels of intent for a referral.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.
* [`StatusCertificateReviewReferral`](/partner-api/reference/members/objects/status-certificate-review-referral) (object) — A referral for a status certificate review.
* [`StatusCertificateReviewReferralBulkCreatePayload`](/partner-api/reference/members/objects/status-certificate-review-referral-bulk-create-payload) (object) — Return type for the `statusCertificateReviewReferralBulkCreate` mutation.
* [`StatusCertificateReviewReferralBulkCreateUserError`](/partner-api/reference/members/objects/status-certificate-review-referral-bulk-create-user-error) (object) — An error that could occur during the execution of the `statusCertificateReviewReferralBulkCreate` mutation.
* [`StatusCertificateReviewReferralBulkCreateUserErrorCode`](/partner-api/reference/members/enums/status-certificate-review-referral-bulk-create-user-error-code) (enum) — Possible error codes that can be returned by StatusCertificateReviewReferralBulkCreateUserError.
* [`StatusCertificateReviewReferralInput`](/partner-api/reference/members/inputs/status-certificate-review-referral-input) (input) — Input to create a status certificate review referral.
* [`Url`](/partner-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Status Certificate Review Referral Create
Source: https://dev.ownright.com/partner-api/reference/mutations/referrals/status-certificate-review/status-certificate-review-referral-create

Creates a new status certificate review referral.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  mutation StatusCertificateReviewReferralCreate($input: StatusCertificateReviewReferralInput!) {
    statusCertificateReviewReferralCreate(input: $input) {
      referral {
        clientHasMadeOffer
        createdAt
        earlyDeadlineRequest
        id
        preferredCompletionTime
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "input": {
      "clientHasMadeOffer": true,
      "contacts": [
        {
          "email": "jane@example.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "phoneNumber": "+14165551234",
          "primary": true
        }
      ],
      "customAttributes": [
        {
          "key": "example-key",
          "type": "BOOLEAN",
          "value": "example-value"
        }
      ],
      "earlyDeadlineRequest": true,
      "files": [
        {
          "fileRecordId": "gid://ownright/FileRecord/1",
          "tags": [
            "example-tags"
          ]
        }
      ],
      "intentLevel": "HIGH",
      "preferredCompletionTime": "2025-01-15T10:30:00Z",
      "propertyAddress": {
        "city": "Toronto",
        "country": "CANADA",
        "postalCode": "M5V 1A1",
        "province": "ALBERTA",
        "street": "123 Main St",
        "unitNumber": "Suite 100"
      }
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "statusCertificateReviewReferralCreate": {
        "referral": {
          "clientHasMadeOffer": true,
          "createdAt": "2025-01-15T10:30:00Z",
          "earlyDeadlineRequest": true,
          "id": "gid://ownright/Object/1",
          "preferredCompletionTime": "2025-01-15T10:30:00Z",
          "status": "CONVERTED",
          "type": "PURCHASE_PROPERTY_CLOSING",
          "updatedAt": "2025-01-15T10:30:00Z",
          "contacts": [
            {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            }
          ],
          "customAttributes": [
            {
              "id": "gid://ownright/Object/1",
              "key": "example-key",
              "type": "BOOLEAN",
              "value": "example-value"
            }
          ],
          "primaryContact": {
            "email": "jane@example.com",
            "firstName": "Jane",
            "id": "gid://ownright/Object/1",
            "isPrimary": true,
            "lastName": "Doe",
            "phoneNumber": "+14165551234"
          },
          "propertyAddress": {
            "city": "Toronto",
            "country": "CANADA",
            "latitude": 1,
            "longitude": 1,
            "mapImageUrl": "https://example.com",
            "postalCode": "M5V 1A1",
            "province": "ALBERTA",
            "shortTitle": "123 Main St, Toronto",
            "street": "123 Main St",
            "title": "123 Main St, Toronto",
            "unitNumber": "Suite 100"
          }
        },
        "userErrors": []
      }
    }
  }
  ```
</ResponseExample>

## Mutation field

`statusCertificateReviewReferralCreate`

### Arguments

<ParamField type="StatusCertificateReviewReferralInput!">
  Input required to create a status certificate review referral.

  <Expandable title="properties">
    <ParamField type="Boolean">
      Whether or not the client has made an offer on the property already.
    </ParamField>

    <ParamField type="[ReferralContactCreateInput!]!">
      Contacts to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The email for the referral contact.
        </ParamField>

        <ParamField type="String!">
          The first name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The last name for the referral contact.
        </ParamField>

        <ParamField type="String">
          The phone number for the referral contact.
        </ParamField>

        <ParamField type="Boolean!">
          Whether this contact is the primary contact for the referral.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="[CustomAttributeCreateInput!]">
      Custom attributes to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="String!">
          The key of the custom attribute.
        </ParamField>

        <ParamField type="CustomAttributeType!">
          The type of the custom attribute.
        </ParamField>

        <ParamField type="String!">
          The value of the custom attribute.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="Boolean">
      Whether or not the status certificate review requires an earlier than normal
      review.
    </ParamField>

    <ParamField type="[FileBulkCommitInput!]!">
      The files to be associated with the referral.

      <Expandable title="properties">
        <ParamField type="FileRecordGID!">
          The identifier of a staged file record to commit.
        </ParamField>

        <ParamField type="[String!]!">
          Tags to add to the committed versioned file.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="ReferralIntentLevel">
      The intent level of the referral.
    </ParamField>

    <ParamField type="ISO8601DateTime">
      The preferred completion time for the status certificate review.
    </ParamField>

    <ParamField type="AddressInput!">
      The address of the property for which the status certificate review is being requested.

      <Expandable title="properties">
        <ParamField type="String">
          The city of the address.
        </ParamField>

        <ParamField type="Country">
          The country of the address.
        </ParamField>

        <ParamField type="String">
          The postal code of the address.
        </ParamField>

        <ParamField type="Province">
          The province of the address.
        </ParamField>

        <ParamField type="String">
          The street name and number of the address.
        </ParamField>

        <ParamField type="String">
          The unit number, suite number, apartment number, etc. of the address.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

### Return fields

<ResponseField name="referral" type="StatusCertificateReviewReferral">
  The created referral.

  <Expandable title="properties">
    <ResponseField name="clientHasMadeOffer" type="Boolean!">
      Indicates whether the client has made an offer on a property already or not.
    </ResponseField>

    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="earlyDeadlineRequest" type="Boolean!">
      Indicates whether the status certificate review requires an earlier than
      normal review.
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="preferredCompletionTime" type="ISO8601DateTime">
      The preferred completion time for the status certificate review.
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="propertyAddress" type="Address">
      The address of the property that is involved in the status certificate review.

      <Expandable title="properties">
        <ResponseField name="city" type="String!">
          The city of the address.
        </ResponseField>

        <ResponseField name="country" type="Country!">
          The country of the address.
        </ResponseField>

        <ResponseField name="latitude" type="Float">
          The latitude of the address.
        </ResponseField>

        <ResponseField name="longitude" type="Float">
          The longitude of the address.
        </ResponseField>

        <ResponseField name="mapImageUrl" type="Url">
          A link to a map with a pointer on the address's location.
        </ResponseField>

        <ResponseField name="postalCode" type="String!">
          The postal code of the address.
        </ResponseField>

        <ResponseField name="province" type="Province!">
          The province of the address.
        </ResponseField>

        <ResponseField name="shortTitle" type="String!">
          The shortened title for the address.
        </ResponseField>

        <ResponseField name="street" type="String!">
          The street name and number of the address.
        </ResponseField>

        <ResponseField name="title" type="String!">
          The full title for the address.
        </ResponseField>

        <ResponseField name="unitNumber" type="String">
          The unit number, apartment number, suite number etc.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="userErrors" type="[StatusCertificateReviewReferralCreateUserError!]!">
  List of errors that occurred while executing the mutation.

  <Expandable title="properties">
    <ResponseField name="code" type="StatusCertificateReviewReferralCreateUserErrorCode">
      Error code associated with the error.
    </ResponseField>

    <ResponseField name="field" type="[String!]">
      The path to the input field that caused the error.
    </ResponseField>

    <ResponseField name="message" type="String!">
      A description of the error.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`Address`](/partner-api/reference/members/objects/address) (object) — Represents an address.
* [`AddressInput`](/partner-api/reference/members/inputs/address-input) (input) — Input to create or update an address.
* [`Country`](/partner-api/reference/members/enums/country) (enum) — Possible countries.
* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeCreateInput`](/partner-api/reference/members/inputs/custom-attribute-create-input) (input) — Input to create a custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`FileBulkCommitInput`](/partner-api/reference/members/inputs/file-bulk-commit-input) (input) — Input for a file to committed as part of a bulk file commit.
* [`FileRecordGID`](/partner-api/reference/members/scalars/file-record-gid) (scalar) — A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`ImageTransformInput`](/partner-api/reference/members/inputs/image-transform-input) (input) — Input to transform an image.
* [`Province`](/partner-api/reference/members/enums/province) (enum) — Possible provinces.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralContactCreateInput`](/partner-api/reference/members/inputs/referral-contact-create-input) (input) — The input to create a referral contact.
* [`ReferralIntentLevel`](/partner-api/reference/members/enums/referral-intent-level) (enum) — Possible levels of intent for a referral.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.
* [`StatusCertificateReviewReferral`](/partner-api/reference/members/objects/status-certificate-review-referral) (object) — A referral for a status certificate review.
* [`StatusCertificateReviewReferralCreatePayload`](/partner-api/reference/members/objects/status-certificate-review-referral-create-payload) (object) — Return type for the `statusCertificateReviewReferralCreate` mutation.
* [`StatusCertificateReviewReferralCreateUserError`](/partner-api/reference/members/objects/status-certificate-review-referral-create-user-error) (object) — An error that could occur during the execution of the `statusCertificateReviewReferralCreate` mutation.
* [`StatusCertificateReviewReferralCreateUserErrorCode`](/partner-api/reference/members/enums/status-certificate-review-referral-create-user-error-code) (enum) — Possible error codes that can be returned by StatusCertificateReviewReferralCreateUserError.
* [`StatusCertificateReviewReferralInput`](/partner-api/reference/members/inputs/status-certificate-review-referral-input) (input) — Input to create a status certificate review referral.
* [`Url`](/partner-api/reference/members/scalars/url) (scalar) — A valid URL, transported as a string.


# Matter
Source: https://dev.ownright.com/partner-api/reference/queries/matters/matter

Returns a matter.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetMatter($id: MatterGID!) {
    matter(id: $id) {
      id
      shortId
      test
      currentUserMatterBusinessContact {
        id
        partnerAccountLinked
        partnerNotificationsMuted
        contact {
          email
          faxNumber
          firstName
          frontUserIdHash
          fullName
          id
          lastName
          notificationDeliveryMechanisms
          phoneNumber
        }
      }
      ... on PurchaseTransaction {
        agreementDate
        closingDate
        depositAmount {
          amount
          currencyCode
        }
        milestones {
          completedAt
          description
          handle
          oneliner
          status
          title
        }
        property {
          id
          type
          address {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        purchaseAmount {
          amount
          currencyCode
        }
        representedSide {
          name
          corporations {
            id
            name
            refinanceOwnershipStatus
          }
          participants {
            corporationSigningOfficer
            firstName
            fullName
            id
            lastName
            primaryClient
            representation
            represented
            representsPrimaryClient
            traits
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            ... on RefinanceParticipant {
              ownershipStatus
            }
            ... on TransactionParticipant {
              transactionSide
            }
          }
        }
        status {
          state
          ... on PurchaseTransactionClosingInProgressStatus {
            closingActionItems {
              completedAt
              description
              expectedBy
              id
              state
              title
            }
            closingDateAmended
            closingStatus
          }
          ... on SaleTransactionClosingInProgressStatus {
            closingActionItems {
              completedAt
              description
              expectedBy
              id
              state
              title
            }
            closingDateAmended
            closingStatus
          }
        }
        type
      }
      ... on Refinance {
        closingDate
        commitmentDate
        corporations {
          id
          name
          refinanceOwnershipStatus
        }
        loans {
          id
          type
          lenders {
            id
            logoImageUrl
            name
            websiteUrl
          }
          principalAmount {
            amount
            currencyCode
          }
        }
        milestones {
          completedAt
          description
          handle
          oneliner
          status
          title
        }
        participants {
          corporationSigningOfficer
          firstName
          fullName
          id
          lastName
          ownershipStatus
          primaryClient
          representation
          represented
          representsPrimaryClient
          traits
          corporations {
            id
            name
            refinanceOwnershipStatus
          }
          representees {
            corporationSigningOfficer
            firstName
            fullName
            id
            lastName
            primaryClient
            representation
            represented
            representsPrimaryClient
            traits
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            ... on RefinanceParticipant {
              ownershipStatus
            }
            ... on TransactionParticipant {
              transactionSide
            }
          }
          representors {
            corporationSigningOfficer
            firstName
            fullName
            id
            lastName
            primaryClient
            representation
            represented
            representsPrimaryClient
            traits
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            ... on RefinanceParticipant {
              ownershipStatus
            }
            ... on TransactionParticipant {
              transactionSide
            }
          }
        }
        property {
          id
          type
          address {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        status {
          state
          ... on RefinanceClosingInProgressStatus {
            closingActionItems {
              completedAt
              description
              expectedBy
              id
              state
              title
            }
          }
        }
      }
      ... on SaleTransaction {
        agreementDate
        closingDate
        depositAmount {
          amount
          currencyCode
        }
        milestones {
          completedAt
          description
          handle
          oneliner
          status
          title
        }
        property {
          id
          type
          address {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        representedSide {
          name
          corporations {
            id
            name
            refinanceOwnershipStatus
          }
          participants {
            corporationSigningOfficer
            firstName
            fullName
            id
            lastName
            primaryClient
            representation
            represented
            representsPrimaryClient
            traits
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            ... on RefinanceParticipant {
              ownershipStatus
            }
            ... on TransactionParticipant {
              transactionSide
            }
          }
        }
        saleAmount {
          amount
          currencyCode
        }
        status {
          state
          ... on PurchaseTransactionClosingInProgressStatus {
            closingActionItems {
              completedAt
              description
              expectedBy
              id
              state
              title
            }
            closingDateAmended
            closingStatus
          }
          ... on SaleTransactionClosingInProgressStatus {
            closingActionItems {
              completedAt
              description
              expectedBy
              id
              state
              title
            }
            closingDateAmended
            closingStatus
          }
        }
        type
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "id": "gid://ownright/Matter/1"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "matter": {
        "id": "gid://ownright/Object/1",
        "shortId": "ABC-123",
        "test": true,
        "currentUserMatterBusinessContact": {
          "id": "gid://ownright/Object/1",
          "partnerAccountLinked": true,
          "partnerNotificationsMuted": true,
          "contact": {
            "email": "jane@example.com",
            "faxNumber": "+14165551234",
            "firstName": "Jane",
            "frontUserIdHash": "example-front-user-id-hash",
            "fullName": "example-full-name",
            "id": "gid://ownright/Object/1",
            "lastName": "Doe",
            "notificationDeliveryMechanisms": [
              "EMAIL"
            ],
            "phoneNumber": "+14165551234"
          }
        },
        "agreementDate": "2025-06-15",
        "closingDate": "2025-06-15",
        "depositAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "milestones": [
          {
            "completedAt": "2025-01-15T10:30:00Z",
            "description": "example-description",
            "handle": "ADJUSTMENTS_CONFIRMED",
            "oneliner": "example-oneliner",
            "status": "COMPLETED",
            "title": "123 Main St, Toronto"
          }
        ],
        "property": {
          "id": "gid://ownright/Object/1",
          "type": "CONDO",
          "address": {
            "city": "Toronto",
            "country": "CANADA",
            "latitude": 1,
            "longitude": 1,
            "mapImageUrl": "https://example.com",
            "postalCode": "M5V 1A1",
            "province": "ALBERTA",
            "shortTitle": "123 Main St, Toronto",
            "street": "123 Main St",
            "title": "123 Main St, Toronto",
            "unitNumber": "Suite 100"
          }
        },
        "purchaseAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "representedSide": {
          "name": "PURCHASER",
          "corporations": [
            {
              "id": "gid://ownright/Object/1",
              "name": "example-name",
              "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
            }
          ],
          "participants": [
            {
              "corporationSigningOfficer": true,
              "firstName": "Jane",
              "fullName": "example-full-name",
              "id": "gid://ownright/Object/1",
              "lastName": "Doe",
              "primaryClient": true,
              "representation": "ESTATE_TRUSTEE",
              "represented": true,
              "representsPrimaryClient": true,
              "traits": [
                "BORROWER"
              ],
              "corporations": [
                {
                  "id": "gid://ownright/Object/1",
                  "name": "example-name",
                  "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
                }
              ],
              "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
              "transactionSide": "PURCHASER"
            }
          ]
        },
        "status": {
          "state": "ABANDONED",
          "closingActionItems": [
            {
              "completedAt": "2025-01-15T10:30:00Z",
              "description": "example-description",
              "expectedBy": "2025-01-15T10:30:00Z",
              "id": "gid://ownright/Object/1",
              "state": "COMPLETED",
              "title": "123 Main St, Toronto"
            }
          ],
          "closingDateAmended": true,
          "closingStatus": "ACTIVE"
        },
        "type": "PURCHASE",
        "commitmentDate": "2025-06-15",
        "corporations": [
          {
            "id": "gid://ownright/Object/1",
            "name": "example-name",
            "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
          }
        ],
        "loans": [
          {
            "id": "gid://ownright/Object/1",
            "type": "BRIDGE_LOAN",
            "lenders": [
              {
                "id": "gid://ownright/Object/1",
                "logoImageUrl": "https://example.com",
                "name": "example-name",
                "websiteUrl": "https://example.com"
              }
            ],
            "principalAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            }
          }
        ],
        "participants": [
          {
            "corporationSigningOfficer": true,
            "firstName": "Jane",
            "fullName": "example-full-name",
            "id": "gid://ownright/Object/1",
            "lastName": "Doe",
            "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
            "primaryClient": true,
            "representation": "ESTATE_TRUSTEE",
            "represented": true,
            "representsPrimaryClient": true,
            "traits": [
              "BORROWER"
            ],
            "corporations": [
              {
                "id": "gid://ownright/Object/1",
                "name": "example-name",
                "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
              }
            ],
            "representees": [
              {
                "corporationSigningOfficer": true,
                "firstName": "Jane",
                "fullName": "example-full-name",
                "id": "gid://ownright/Object/1",
                "lastName": "Doe",
                "primaryClient": true,
                "representation": "ESTATE_TRUSTEE",
                "represented": true,
                "representsPrimaryClient": true,
                "traits": [
                  "BORROWER"
                ],
                "corporations": [
                  {
                    "id": "gid://ownright/Object/1",
                    "name": "example-name",
                    "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
                  }
                ],
                "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
                "transactionSide": "PURCHASER"
              }
            ],
            "representors": [
              {
                "corporationSigningOfficer": true,
                "firstName": "Jane",
                "fullName": "example-full-name",
                "id": "gid://ownright/Object/1",
                "lastName": "Doe",
                "primaryClient": true,
                "representation": "ESTATE_TRUSTEE",
                "represented": true,
                "representsPrimaryClient": true,
                "traits": [
                  "BORROWER"
                ],
                "corporations": [
                  {
                    "id": "gid://ownright/Object/1",
                    "name": "example-name",
                    "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
                  }
                ],
                "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
                "transactionSide": "PURCHASER"
              }
            ]
          }
        ],
        "saleAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        }
      }
    }
  }
  ```
</ResponseExample>

## Query field

`matter`

### Arguments

<ParamField type="MatterGID!">
  The identifier of the matter to find.
</ParamField>

### Return fields

<ResponseField name="matter" type="Matter">
  Returns a matter.

  <Expandable title="properties">
    <ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
      The currently authenticated matter business contact information (if any).

      <Expandable title="properties">
        <ResponseField name="contact" type="BusinessContact!">
          The contact for the business.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="partnerAccountLinked" type="Boolean!">
          Whether or not the contact has a partner account linked.
        </ResponseField>

        <ResponseField name="partnerNotificationsMuted" type="Boolean!">
          Whether the partner has muted notifications for the matter or not.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="shortId" type="String!">
      The matter's short identifier.
    </ResponseField>

    <ResponseField name="test" type="Boolean!">
      Whether the matter is a test matter or not.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`BusinessContact`](/partner-api/reference/members/objects/business-contact) (object) — A business contact.
* [`E164PhoneNumber`](/partner-api/reference/members/scalars/e164-phone-number) (scalar) — A valid phone number string in the E.164 format.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`Matter`](/partner-api/reference/members/interfaces/matter) (interface) — Represents a matter.
* [`MatterBusinessContact`](/partner-api/reference/members/objects/matter-business-contact) (object) — A business contact that is associated with a matter.
* [`MatterGID`](/partner-api/reference/members/scalars/matter-gid) (scalar) — A global identifier for a matter object (ex. Transaction) in format of 'gid://ownright//ID'.
* [`NotificationDeliveryMechanism`](/partner-api/reference/members/enums/notification-delivery-mechanism) (enum) — Possible types of delivery mechanisms to deliver a notification.


# Matters
Source: https://dev.ownright.com/partner-api/reference/queries/matters/matters

Returns all matters the business contact is involved in.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetMatters($after: String, $before: String, $first: Int, $last: Int) {
    matters(after: $after, before: $before, first: $first, last: $last) {
      nodes {
        id
        shortId
        test
        currentUserMatterBusinessContact {
          id
          partnerAccountLinked
          partnerNotificationsMuted
          contact {
            email
            faxNumber
            firstName
            frontUserIdHash
            fullName
            id
            lastName
            notificationDeliveryMechanisms
            phoneNumber
          }
        }
        ... on PurchaseTransaction {
          agreementDate
          closingDate
          depositAmount {
            amount
            currencyCode
          }
          milestones {
            completedAt
            description
            handle
            oneliner
            status
            title
          }
          property {
            id
            type
            address {
              city
              country
              latitude
              longitude
              mapImageUrl
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          purchaseAmount {
            amount
            currencyCode
          }
          representedSide {
            name
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            participants {
              corporationSigningOfficer
              firstName
              fullName
              id
              lastName
              primaryClient
              representation
              represented
              representsPrimaryClient
              traits
              ... on RefinanceParticipant {
                ownershipStatus
              }
              ... on TransactionParticipant {
                transactionSide
              }
            }
          }
          status {
            state
            ... on PurchaseTransactionClosingInProgressStatus {
              closingActionItems {
                completedAt
                description
                expectedBy
                id
                state
                title
              }
              closingDateAmended
              closingStatus
            }
            ... on SaleTransactionClosingInProgressStatus {
              closingActionItems {
                completedAt
                description
                expectedBy
                id
                state
                title
              }
              closingDateAmended
              closingStatus
            }
          }
          type
        }
        ... on Refinance {
          closingDate
          commitmentDate
          corporations {
            id
            name
            refinanceOwnershipStatus
          }
          loans {
            id
            type
            lenders {
              id
              logoImageUrl
              name
              websiteUrl
            }
            principalAmount {
              amount
              currencyCode
            }
          }
          milestones {
            completedAt
            description
            handle
            oneliner
            status
            title
          }
          participants {
            corporationSigningOfficer
            firstName
            fullName
            id
            lastName
            ownershipStatus
            primaryClient
            representation
            represented
            representsPrimaryClient
            traits
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            representees {
              corporationSigningOfficer
              firstName
              fullName
              id
              lastName
              primaryClient
              representation
              represented
              representsPrimaryClient
              traits
              ... on RefinanceParticipant {
                ownershipStatus
              }
              ... on TransactionParticipant {
                transactionSide
              }
            }
            representors {
              corporationSigningOfficer
              firstName
              fullName
              id
              lastName
              primaryClient
              representation
              represented
              representsPrimaryClient
              traits
              ... on RefinanceParticipant {
                ownershipStatus
              }
              ... on TransactionParticipant {
                transactionSide
              }
            }
          }
          property {
            id
            type
            address {
              city
              country
              latitude
              longitude
              mapImageUrl
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          status {
            state
            ... on RefinanceClosingInProgressStatus {
              closingActionItems {
                completedAt
                description
                expectedBy
                id
                state
                title
              }
            }
          }
        }
        ... on SaleTransaction {
          agreementDate
          closingDate
          depositAmount {
            amount
            currencyCode
          }
          milestones {
            completedAt
            description
            handle
            oneliner
            status
            title
          }
          property {
            id
            type
            address {
              city
              country
              latitude
              longitude
              mapImageUrl
              postalCode
              province
              shortTitle
              street
              title
              unitNumber
            }
          }
          representedSide {
            name
            corporations {
              id
              name
              refinanceOwnershipStatus
            }
            participants {
              corporationSigningOfficer
              firstName
              fullName
              id
              lastName
              primaryClient
              representation
              represented
              representsPrimaryClient
              traits
              ... on RefinanceParticipant {
                ownershipStatus
              }
              ... on TransactionParticipant {
                transactionSide
              }
            }
          }
          saleAmount {
            amount
            currencyCode
          }
          status {
            state
            ... on PurchaseTransactionClosingInProgressStatus {
              closingActionItems {
                completedAt
                description
                expectedBy
                id
                state
                title
              }
              closingDateAmended
              closingStatus
            }
            ... on SaleTransactionClosingInProgressStatus {
              closingActionItems {
                completedAt
                description
                expectedBy
                id
                state
                title
              }
              closingDateAmended
              closingStatus
            }
          }
          type
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "after": "example-after",
    "before": "example-before",
    "first": 10,
    "last": 10
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "matters": {
        "nodes": [
          {
            "id": "gid://ownright/Object/1",
            "shortId": "ABC-123",
            "test": true,
            "currentUserMatterBusinessContact": {
              "id": "gid://ownright/Object/1",
              "partnerAccountLinked": true,
              "partnerNotificationsMuted": true,
              "contact": {
                "email": "jane@example.com",
                "faxNumber": "+14165551234",
                "firstName": "Jane",
                "frontUserIdHash": "example-front-user-id-hash",
                "fullName": "example-full-name",
                "id": "gid://ownright/Object/1",
                "lastName": "Doe",
                "notificationDeliveryMechanisms": [
                  "EMAIL"
                ],
                "phoneNumber": "+14165551234"
              }
            },
            "agreementDate": "2025-06-15",
            "closingDate": "2025-06-15",
            "depositAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            },
            "milestones": [
              {
                "completedAt": "2025-01-15T10:30:00Z",
                "description": "example-description",
                "handle": "ADJUSTMENTS_CONFIRMED",
                "oneliner": "example-oneliner",
                "status": "COMPLETED",
                "title": "123 Main St, Toronto"
              }
            ],
            "property": {
              "id": "gid://ownright/Object/1",
              "type": "CONDO",
              "address": {
                "city": "Toronto",
                "country": "CANADA",
                "latitude": 1,
                "longitude": 1,
                "mapImageUrl": "https://example.com",
                "postalCode": "M5V 1A1",
                "province": "ALBERTA",
                "shortTitle": "123 Main St, Toronto",
                "street": "123 Main St",
                "title": "123 Main St, Toronto",
                "unitNumber": "Suite 100"
              }
            },
            "purchaseAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            },
            "representedSide": {
              "name": "PURCHASER",
              "corporations": [
                {
                  "id": "gid://ownright/Object/1",
                  "name": "example-name",
                  "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
                }
              ],
              "participants": [
                {
                  "corporationSigningOfficer": true,
                  "firstName": "Jane",
                  "fullName": "example-full-name",
                  "id": "gid://ownright/Object/1",
                  "lastName": "Doe",
                  "primaryClient": true,
                  "representation": "ESTATE_TRUSTEE",
                  "represented": true,
                  "representsPrimaryClient": true,
                  "traits": [
                    "BORROWER"
                  ],
                  "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
                  "transactionSide": "PURCHASER"
                }
              ]
            },
            "status": {
              "state": "ABANDONED",
              "closingActionItems": [
                {
                  "completedAt": "2025-01-15T10:30:00Z",
                  "description": "example-description",
                  "expectedBy": "2025-01-15T10:30:00Z",
                  "id": "gid://ownright/Object/1",
                  "state": "COMPLETED",
                  "title": "123 Main St, Toronto"
                }
              ],
              "closingDateAmended": true,
              "closingStatus": "ACTIVE"
            },
            "type": "PURCHASE",
            "commitmentDate": "2025-06-15",
            "corporations": [
              {
                "id": "gid://ownright/Object/1",
                "name": "example-name",
                "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
              }
            ],
            "loans": [
              {
                "id": "gid://ownright/Object/1",
                "type": "BRIDGE_LOAN",
                "lenders": [
                  {
                    "id": "gid://ownright/Object/1",
                    "logoImageUrl": "https://example.com",
                    "name": "example-name",
                    "websiteUrl": "https://example.com"
                  }
                ],
                "principalAmount": {
                  "amount": "100.00",
                  "currencyCode": "CAD"
                }
              }
            ],
            "participants": [
              {
                "corporationSigningOfficer": true,
                "firstName": "Jane",
                "fullName": "example-full-name",
                "id": "gid://ownright/Object/1",
                "lastName": "Doe",
                "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
                "primaryClient": true,
                "representation": "ESTATE_TRUSTEE",
                "represented": true,
                "representsPrimaryClient": true,
                "traits": [
                  "BORROWER"
                ],
                "corporations": [
                  {
                    "id": "gid://ownright/Object/1",
                    "name": "example-name",
                    "refinanceOwnershipStatus": "BEING_REMOVED_FROM_TITLE"
                  }
                ],
                "representees": [
                  {
                    "corporationSigningOfficer": true,
                    "firstName": "Jane",
                    "fullName": "example-full-name",
                    "id": "gid://ownright/Object/1",
                    "lastName": "Doe",
                    "primaryClient": true,
                    "representation": "ESTATE_TRUSTEE",
                    "represented": true,
                    "representsPrimaryClient": true,
                    "traits": [
                      "BORROWER"
                    ],
                    "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
                    "transactionSide": "PURCHASER"
                  }
                ],
                "representors": [
                  {
                    "corporationSigningOfficer": true,
                    "firstName": "Jane",
                    "fullName": "example-full-name",
                    "id": "gid://ownright/Object/1",
                    "lastName": "Doe",
                    "primaryClient": true,
                    "representation": "ESTATE_TRUSTEE",
                    "represented": true,
                    "representsPrimaryClient": true,
                    "traits": [
                      "BORROWER"
                    ],
                    "ownershipStatus": "BEING_REMOVED_FROM_TITLE",
                    "transactionSide": "PURCHASER"
                  }
                ]
              }
            ],
            "saleAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            }
          }
        ],
        "pageInfo": {
          "hasNextPage": true,
          "endCursor": "cursor_abc123"
        }
      }
    }
  }
  ```
</ResponseExample>

## Query field

`matters`

### Arguments

<ParamField type="String">
  Returns the elements in the list that come after the specified cursor.
</ParamField>

<ParamField type="String">
  Returns the elements in the list that come before the specified cursor.
</ParamField>

<ParamField type="Int">
  Returns the first *n* elements from the list.
</ParamField>

<ParamField type="Int">
  Returns the last *n* elements from the list.
</ParamField>

### Return fields

<ResponseField name="matters" type="MatterConnection!">
  Returns all matters the business contact is involved in.

  <Expandable title="properties">
    <ResponseField name="edges" type="[MatterEdge]">
      A list of edges.

      <Expandable title="properties">
        <ResponseField name="cursor" type="String!">
          A cursor for use in pagination.
        </ResponseField>

        <ResponseField name="node" type="Matter">
          The item at the end of the edge.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type="[Matter]">
      A list of nodes.

      <Expandable title="properties">
        <ResponseField name="currentUserMatterBusinessContact" type="MatterBusinessContact">
          The currently authenticated matter business contact information (if any).
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="shortId" type="String!">
          The matter's short identifier.
        </ResponseField>

        <ResponseField name="test" type="Boolean!">
          Whether the matter is a test matter or not.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type="PageInfo!">
      Information to aid in pagination.

      <Expandable title="properties">
        <ResponseField name="endCursor" type="String">
          When paginating forwards, the cursor to continue.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!">
          When paginating forwards, are there more items?
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!">
          When paginating backwards, are there more items?
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          When paginating backwards, the cursor to continue.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`BusinessContact`](/partner-api/reference/members/objects/business-contact) (object) — A business contact.
* [`E164PhoneNumber`](/partner-api/reference/members/scalars/e164-phone-number) (scalar) — A valid phone number string in the E.164 format.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`Matter`](/partner-api/reference/members/interfaces/matter) (interface) — Represents a matter.
* [`MatterBusinessContact`](/partner-api/reference/members/objects/matter-business-contact) (object) — A business contact that is associated with a matter.
* [`MatterConnection`](/partner-api/reference/members/objects/matter-connection) (object) — The connection type for Matter.
* [`MatterEdge`](/partner-api/reference/members/objects/matter-edge) (object) — An edge in a connection.
* [`NotificationDeliveryMechanism`](/partner-api/reference/members/enums/notification-delivery-mechanism) (enum) — Possible types of delivery mechanisms to deliver a notification.
* [`PageInfo`](/partner-api/reference/members/objects/page-info) (object) — Information about pagination in a connection.


# Referral
Source: https://dev.ownright.com/partner-api/reference/queries/referrals/referral

Returns a referral.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetReferral($id: ReferralGID!) {
    referral(id: $id) {
      createdAt
      id
      status
      type
      updatedAt
      contacts {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      customAttributes {
        id
        key
        type
        value
      }
      primaryContact {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      ... on PurchasePropertyClosingReferral {
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
        purchaseAmount {
          amount
          currencyCode
        }
      }
      ... on RefinanceReferral {
        mortgageAmount {
          amount
          currencyCode
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      ... on SalePropertyClosingReferral {
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "id": "gid://ownright/Referral/1"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "referral": {
        "createdAt": "2025-01-15T10:30:00Z",
        "id": "gid://ownright/Object/1",
        "status": "CONVERTED",
        "type": "PURCHASE_PROPERTY_CLOSING",
        "updatedAt": "2025-01-15T10:30:00Z",
        "contacts": [
          {
            "email": "jane@example.com",
            "firstName": "Jane",
            "id": "gid://ownright/Object/1",
            "isPrimary": true,
            "lastName": "Doe",
            "phoneNumber": "+14165551234"
          }
        ],
        "customAttributes": [
          {
            "id": "gid://ownright/Object/1",
            "key": "example-key",
            "type": "BOOLEAN",
            "value": "example-value"
          }
        ],
        "primaryContact": {
          "email": "jane@example.com",
          "firstName": "Jane",
          "id": "gid://ownright/Object/1",
          "isPrimary": true,
          "lastName": "Doe",
          "phoneNumber": "+14165551234"
        },
        "propertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "latitude": 1,
          "longitude": 1,
          "mapImageUrl": "https://example.com",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "shortTitle": "123 Main St, Toronto",
          "street": "123 Main St",
          "title": "123 Main St, Toronto",
          "unitNumber": "Suite 100"
        },
        "purchaseAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "mortgageAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        }
      }
    }
  }
  ```
</ResponseExample>

## Query field

`referral`

### Arguments

<ParamField type="ReferralGID!">
  The identifier of the referral to find.
</ParamField>

### Return fields

<ResponseField name="referral" type="Referral">
  Returns a referral.

  <Expandable title="properties">
    <ResponseField name="contacts" type="[ReferralContact!]!">
      The contacts for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="ISO8601DateTime!">
      The time the referral was created.
    </ResponseField>

    <ResponseField name="customAttributes" type="[CustomAttribute!]!">
      The custom attributes for the referral.

      <Expandable title="properties">
        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="key" type="String!">
          The key of the custom attribute.
        </ResponseField>

        <ResponseField name="type" type="CustomAttributeType!">
          The type of the custom attribute.
        </ResponseField>

        <ResponseField name="value" type="String!">
          The value of the custom attribute.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="id" type="GID!">
      ID of the object.
    </ResponseField>

    <ResponseField name="primaryContact" type="ReferralContact!">
      The primary contact for the referral.

      <Expandable title="properties">
        <ResponseField name="email" type="String!">
          The email of the contact.
        </ResponseField>

        <ResponseField name="firstName" type="String!">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="isPrimary" type="Boolean!">
          Whether the contact is the primary contact.
        </ResponseField>

        <ResponseField name="lastName" type="String">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phoneNumber" type="String">
          The phone number of the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="ReferralStatus!">
      The current status of the referral.
    </ResponseField>

    <ResponseField name="type" type="ReferralType!">
      The type of the referral.
    </ResponseField>

    <ResponseField name="updatedAt" type="ISO8601DateTime!">
      The time the referral was updated.
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`Referral`](/partner-api/reference/members/interfaces/referral) (interface) — Represents a referral.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralGID`](/partner-api/reference/members/scalars/referral-gid) (scalar) — A global identifier for a Referral object in format of 'gid://ownright/Referral/ID'.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.


# Referrals
Source: https://dev.ownright.com/partner-api/reference/queries/referrals/referrals

Returns all referrals the business contact is involved in.

<RequestExample>
  ```graphql Request [expandable] theme={null}
  query GetReferrals($after: String, $before: String, $first: Int, $last: Int) {
    referrals(after: $after, before: $before, first: $first, last: $last) {
      nodes {
        createdAt
        id
        status
        type
        updatedAt
        contacts {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        customAttributes {
          id
          key
          type
          value
        }
        primaryContact {
          email
          firstName
          id
          isPrimary
          lastName
          phoneNumber
        }
        ... on PurchasePropertyClosingReferral {
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
          purchaseAmount {
            amount
            currencyCode
          }
        }
        ... on RefinanceReferral {
          mortgageAmount {
            amount
            currencyCode
          }
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        ... on SalePropertyClosingReferral {
          propertyAddress {
            city
            country
            latitude
            longitude
            mapImageUrl
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
  ```

  ```graphql Variables theme={null}
  {
    "after": "example-after",
    "before": "example-before",
    "first": 10,
    "last": 10
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "referrals": {
        "nodes": [
          {
            "createdAt": "2025-01-15T10:30:00Z",
            "id": "gid://ownright/Object/1",
            "status": "CONVERTED",
            "type": "PURCHASE_PROPERTY_CLOSING",
            "updatedAt": "2025-01-15T10:30:00Z",
            "contacts": [
              {
                "email": "jane@example.com",
                "firstName": "Jane",
                "id": "gid://ownright/Object/1",
                "isPrimary": true,
                "lastName": "Doe",
                "phoneNumber": "+14165551234"
              }
            ],
            "customAttributes": [
              {
                "id": "gid://ownright/Object/1",
                "key": "example-key",
                "type": "BOOLEAN",
                "value": "example-value"
              }
            ],
            "primaryContact": {
              "email": "jane@example.com",
              "firstName": "Jane",
              "id": "gid://ownright/Object/1",
              "isPrimary": true,
              "lastName": "Doe",
              "phoneNumber": "+14165551234"
            },
            "propertyAddress": {
              "city": "Toronto",
              "country": "CANADA",
              "latitude": 1,
              "longitude": 1,
              "mapImageUrl": "https://example.com",
              "postalCode": "M5V 1A1",
              "province": "ALBERTA",
              "shortTitle": "123 Main St, Toronto",
              "street": "123 Main St",
              "title": "123 Main St, Toronto",
              "unitNumber": "Suite 100"
            },
            "purchaseAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            },
            "mortgageAmount": {
              "amount": "100.00",
              "currencyCode": "CAD"
            }
          }
        ],
        "pageInfo": {
          "hasNextPage": true,
          "endCursor": "cursor_abc123"
        }
      }
    }
  }
  ```
</ResponseExample>

## Query field

`referrals`

### Arguments

<ParamField type="String">
  Returns the elements in the list that come after the specified cursor.
</ParamField>

<ParamField type="String">
  Returns the elements in the list that come before the specified cursor.
</ParamField>

<ParamField type="Int">
  Returns the first *n* elements from the list.
</ParamField>

<ParamField type="Int">
  Returns the last *n* elements from the list.
</ParamField>

### Return fields

<ResponseField name="referrals" type="ReferralConnection!">
  Returns all referrals the business contact is involved in.

  <Expandable title="properties">
    <ResponseField name="edges" type="[ReferralEdge]">
      A list of edges.

      <Expandable title="properties">
        <ResponseField name="cursor" type="String!">
          A cursor for use in pagination.
        </ResponseField>

        <ResponseField name="node" type="Referral">
          The item at the end of the edge.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type="[Referral]">
      A list of nodes.

      <Expandable title="properties">
        <ResponseField name="contacts" type="[ReferralContact!]!">
          The contacts for the referral.
        </ResponseField>

        <ResponseField name="createdAt" type="ISO8601DateTime!">
          The time the referral was created.
        </ResponseField>

        <ResponseField name="customAttributes" type="[CustomAttribute!]!">
          The custom attributes for the referral.
        </ResponseField>

        <ResponseField name="id" type="GID!">
          ID of the object.
        </ResponseField>

        <ResponseField name="primaryContact" type="ReferralContact!">
          The primary contact for the referral.
        </ResponseField>

        <ResponseField name="status" type="ReferralStatus!">
          The current status of the referral.
        </ResponseField>

        <ResponseField name="type" type="ReferralType!">
          The type of the referral.
        </ResponseField>

        <ResponseField name="updatedAt" type="ISO8601DateTime!">
          The time the referral was updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type="PageInfo!">
      Information to aid in pagination.

      <Expandable title="properties">
        <ResponseField name="endCursor" type="String">
          When paginating forwards, the cursor to continue.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!">
          When paginating forwards, are there more items?
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!">
          When paginating backwards, are there more items?
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          When paginating backwards, the cursor to continue.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Types

* [`CustomAttribute`](/partner-api/reference/members/objects/custom-attribute) (object) — A custom attribute.
* [`CustomAttributeType`](/partner-api/reference/members/enums/custom-attribute-type) (enum) — Possible custom attribute types.
* [`GID`](/partner-api/reference/members/scalars/gid) (scalar) — A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
* [`ISO8601DateTime`](/partner-api/reference/members/scalars/iso8601-date-time) (scalar) — An ISO 8601-encoded datetime
* [`PageInfo`](/partner-api/reference/members/objects/page-info) (object) — Information about pagination in a connection.
* [`Referral`](/partner-api/reference/members/interfaces/referral) (interface) — Represents a referral.
* [`ReferralConnection`](/partner-api/reference/members/objects/referral-connection) (object) — The connection type for Referral.
* [`ReferralContact`](/partner-api/reference/members/objects/referral-contact) (object) — A contact for a referral.
* [`ReferralEdge`](/partner-api/reference/members/objects/referral-edge) (object) — An edge in a connection.
* [`ReferralStatus`](/partner-api/reference/members/enums/referral-status) (enum) — Possible statuses for referrals.
* [`ReferralType`](/partner-api/reference/members/enums/referral-type) (enum) — Possible types of referrals.


# Event list
Source: https://dev.ownright.com/partner-api/reference/webhooks/event-list

A complete list of the webhook events that are supported

<Note>
  We’re actively working on expanding our webhook documentation — check back
  soon or reach out to [developers@ownright.com](mailto:developers@ownright.com) if you need help in the meantime.
</Note>


# Create
Source: https://dev.ownright.com/partner-api/reference/webhooks/webhook-subscriptions/create-webhook-subscription

Reference for creating a webhook subscription

<Note>
  We’re actively working on expanding our webhook documentation — check back
  soon or reach out to [developers@ownright.com](mailto:developers@ownright.com) if you need help in the meantime.
</Note>


# Delete
Source: https://dev.ownright.com/partner-api/reference/webhooks/webhook-subscriptions/delete-webhook-subscription

Reference for deleting a webhook subscription

<Note>
  We’re actively working on expanding our webhook documentation — check back
  soon or reach out to [developers@ownright.com](mailto:developers@ownright.com) if you need help in the meantime.
</Note>


# Update
Source: https://dev.ownright.com/partner-api/reference/webhooks/webhook-subscriptions/update-webhook-subscription

Reference for updating a webhook subscription

<Note>
  We’re actively working on expanding our webhook documentation — check back
  soon or reach out to [developers@ownright.com](mailto:developers@ownright.com) if you need help in the meantime.
</Note>


# Support and feedback
Source: https://dev.ownright.com/support-feedback

We're here to help and to listen to your feedback 

We’re here to help you build a smooth and reliable integration with the
Ownright Developer Platform. Whether you’re setting up your first referral flow or
debugging a webhook, we want to ensure you get the support you need.

## 🛠 Technical support

If you run into issues or have questions about any of our APIs, our team is available to help.

<ul>
  <li>**Email support**: [developers@ownright.com](mailto:developers@ownright.com)</li>

  <li>
    **Response time**: We aim to respond to partner technical requests within 1
    business day
  </li>
</ul>

When reaching out, please include:

<ul>
  <li>A clear description of the issue</li>
  <li>Any relevant request IDs, referral or matter IDs</li>
  <li>Timestamps or logs (especially for webhook troubleshooting)</li>
  <li>Screenshots or API payloads are helpful</li>
</ul>

## 📝 Feedback and feature requests

We’re actively evolving the Developer Platform and would love your input.
If there are features you’d like to see — such as:

<ul>
  <li>Additional webhook events</li>
  <li>New mutation or query capabilities</li>
  <li>Sandbox support</li>
  <li>Better observability or retry tools</li>
</ul>

Please let us know at [developers@ownright.com](mailto:developers@ownright.com) or through your direct contact if you have one.

## 📢 Stay updated

To stay informed about changes to the platform:

<ul>
  <li>
    Check the changelog for your API regularly for updates, enhancements, and
    deprecations.
  </li>

  <li>
    We’ll notify all registered partners via email of major updates or breaking
    changes.
  </li>
</ul>