OCocrolus
File Uploads

Upload AUS findings XML

Uploads an Automated Underwriting System (AUS) findings XML file to a <glossary:Book>.

After you have created a Book, call this endpoint to upload one AUS findings XML file to it. The file must contain Desktop Underwriter (DU) findings (CodifiedFindings) or Loan Product Advisor (LPA) findings (LPALoanAssessmentServiceResponse). 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.

📘 Accepted does not mean parsed

  • A 200 response means the XML file was accepted and queued for processing. Processing of the findings continues after the response is returned.
  • The maximum payload size is 200 MB.

Restrictions

RuleWhat happens
One file per requestOnly the aus_file part is read. Any other file part is ignored.
XML files onlyThe filename must end in .xml, and the MIME type must be application/xml or text/xml.
Book with no loan dataThe upload is still accepted if the XML itself is valid.
Duplicate uploadsUploading the same file again is not rejected.
Processing timingParsing starts after the response is returned.
post/v1/book/upload/aus-xml

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/book/upload/aus-xml
  • 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 AUS findings XML file to.

aus_filestring binary required

One AUS findings 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",
  "aus_file": "aus-findings.xml"
}

Response

Success. The AUS findings XML file was accepted 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": "AUS findings XML uploaded"
  },
  "message": "OK"
}

Changes

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