---
title: "Upload MISMO XML"
method: POST
path: "/v1/book/upload/mismo"
tags: ["File Uploads"]
---

# Upload MISMO XML

`POST /v1/book/upload/mismo`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v1/book/upload/mismo`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

Uploads a Mortgage Industry Standards Maintenance Organization (MISMO) XML file to a <<glossary:Book>>.

---

After you have [created a Book](https://docs.ocrolus.com/v1_MISMO_XML/reference/book-add), call this endpoint to upload one MISMO XML file to it. Ocrolus stores the file and processes it asynchronously. Send the file as a `multipart/form-data` encoded payload. To learn more, see the [multipart/form-data](https://docs.ocrolus.com/v1_MISMO_XML/reference/multipartform-data-payloads) guide.

> 📘 Note
> - Accepted does not mean parsed. A `200` response means the XML file was stored and queued for processing. MISMO parsing has not finished at that point. It starts after the response is returned.
> - The maximum payload size is 200 MB.

### Restrictions

| Rule | What happens |
|---|---|
| One file per request | Only the `mismo_file` part is read. |
| Well-formed XML | Malformed XML is rejected with `400`. |
| Identical XML on the same Book | A second upload of the same file returns `409`. |
| Another LOS already on the Book | Books connected to Encompass or MeridianLink reject the upload with `400`. |
| Processing timing | Parsing starts after the response is returned. |

## Request body `multipart/form-data`

- object
  - `book_uuid` string, uuid, required: UUID of the <<glossary:Book>> to upload the MISMO XML file to. You must have update access to the Book.
  - `mismo_file` string, binary, required: One MISMO XML file. The filename must end in `.xml`, and the MIME type must be `application/xml` or `text/xml`.

## Response `200`

Success. The MISMO XML file was stored and queued for processing.

- object
  - `status` integer: A numerical code that indicates the status of the request.
  - `response` object: An object received from the server that potentially contains data.
    - `message` string: Confirms that the MISMO XML file was stored. Processing continues asynchronously.
  - `message` string: A textual description that indicates details about this response's status.

## Other responses

- `400`: Bad Request. Request validation errors return an `error` field. Errors from MISMO processing return `type` and `msg` fields.
- `403`: Forbidden. You do not have permission to access this Book.
- `409`: Conflict. The same MISMO XML file has already been stored for this Book.
- `415`: Unsupported Media Type. The file is not XML, or its MIME type is not `application/xml` or `text/xml`.
- `500`: Internal server error

---

[API](https://skmtc.dev/ocrolus/apis/file-uploads.md) - [All operations](https://skmtc.dev/ocrolus/apis/file-uploads/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/file-uploads/revisions/f5da69c79aff?raw)