neuron Document Experience API
home
This document is technically focussed and intended for individuals with experience in use of APIs and wishes to integrate with Neuron's services.
Neuron provides a suite of RESTful APIs designed following established API design patterns and security protocols. The Document Experience API allows insurers and brokers to interact with documents, including uploading, downloading, and deleting them. The documents can be tagged as well during the upload process. Insurers can access documents uploaded by brokers and upload any document needed by the broker. Below are the details on the various functionalities provided by the API.
Business Functionality
Via this API, insurers and broker can do the following actions:
Upload a document
The API provides an option to upload documents up to 2GB file size. The file type supported by the API are mentioned below. More details on the API endpoint can be found in the API specification section of the document.
File Types Allowed:
- PDF (application/pdf)
- Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)
- Word (application/vnd.openxmlformats-officedocument.wordprocessingml.document)
- CSV (text/csv)
- JPEG (image/jpeg)
- PNG (image/png)
- Text (text/plain)
- Outlook Email (application/vnd.ms-outlook)
- Email (message/rfc822)
Retrieve a document
The API also provide an endpoint to download the document based on the submission Id and Document Id against which the document was uploaded. More details on the API endpoint can be found in the API specification section of the document.
Delete a document
The API provides an option to delete the document based on the document Id. More details on the API endpoint can be found in the API specification section of the document.
Retrieve list of documents
The API provide an endpoint to list down the documents available on a specific risk.
Navigate to pages below
NOTE: The API's structure is currently in development and may undergo changes.