File Uploads
Upload credit report XML
Uploads a MISMO credit report XML file to a <glossary:Book>.
After you have created a Book, call this endpoint to upload one credit report XML file to it. The file must be a MISMO credit report that contains RESPONSE_GROUP and CREDIT_RESPONSE elements. 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 credit report continues after the response is returned.
- The maximum payload size is 200 MB.
Restrictions
| Rule | What happens |
|---|---|
| One file per request | Only the credit_file part is read. Any other file part is ignored. |
| XML files only | The filename must end in .xml, and the MIME type must be application/xml or text/xml. |
| Book with no loan data | The upload is still accepted if the XML itself is valid. |
| Duplicate uploads | Uploading the same file again is not rejected. |
| Processing timing | Parsing starts after the response is returned. |
post/v1/book/upload/credit-xml
Request
- Base URLhttps://api.ocrolus.com
- URLhttps://api.ocrolus.com/v1/book/upload/credit-xml
- AuthOAuth 2Client credentialsToken URL: https://auth.ocrolus.com/oauth/token
Request body multipart/form-data
Example request
{
"book_uuid": "19aab921-25a5-4beb-a59e-ac72320061d6",
"credit_file": "credit-report.xml"
}Response
Success. The credit report XML file was accepted and queued for processing.
Example response
{
"status": 200,
"response": {
"message": "Credit report XML uploaded"
},
"message": "OK"
}Changes
No recorded changes to this operation across all 1 revision of this API.