OCocrolus
File Uploads

Upload MISMO XML

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

After you have created a Book, 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 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

RuleWhat happens
One file per requestOnly the mismo_file part is read.
Well-formed XMLMalformed XML is rejected with 400.
Identical XML on the same BookA second upload of the same file returns 409.
Another LOS already on the BookBooks connected to Encompass or MeridianLink reject the upload with 400.
Processing timingParsing starts after the response is returned.
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

Request body multipart/form-data

book_uuidstring uuid required

UUID of the <glossary:Book> to upload the MISMO XML file to. You must have update access to the Book.

mismo_filestring binary required

One MISMO XML file. The filename must end in .xml, and the MIME type must be application/xml or text/xml.

Example request

{
  "book_uuid": "19aab921-25a5-4beb-a59e-ac72320061d6",
  "mismo_file": "loan-data.xml"
}

Response

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

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "message": "MISMO XML data stored successfully"
  },
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.