Skip to content

Review Documents

Get Review Documents

This endpoint retrieves all review documents for a specific review type. Currently only supports “reggora” as the review_type.

HTTP Request

GET https://sandbox.reggora.io/lender/review/<review_type>/documents

URL Parameters

Parameter	Description
review_type	The type of review documents to retrieve. Currently only supports “reggora”.

Query Parameters

Parameter	Default	Description
order_id	None	Filter documents by order ID.
submission_version	None	Filter documents by submission version (optional).

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

# Example query parameters
query_params = {
    'order_id': '688d421b2bfb82f7c92d4982',
    'submission_version': '1'
}

response = requests.get('https://sandbox.reggora.io/lender/review/reggora/documents', params=query_params, headers=headers)

Example Response

{
    "status": 200,
    "data": {
        "count": 2,
        "results": [
            {
                "id": "688d46fe148f8c02179954f4",
                "order_id": "688d421b2bfb82f7c92d4982",
                "submission_version": 2,
                "created": "2025-08-01 23:00:14.024000",
                "updated": "2025-08-01 23:00:14.024000",
                "file_type": "review_artifact",
                "file_name": "review-artifact-6d92a475-a507-4e5b-8052-1c44171513ec.pdf"
            }
        ]
    }
}

Get Review Document by ID

This endpoint retrieves a specific review document by ID and returns the actual PDF file.

HTTP Request

GET https://sandbox.reggora.io/lender/review/<review_type>/documents/<document_id>

URL Parameters

Parameter	Description
review_type	The type of review document. Currently only supports “reggora”.
document_id	The ID of the review document.

Example Request

import requests

headers = {
    'Authorization': 'Bearer {}'.format(REGGORA_AUTH_TOKEN),
    'integration': '{}'.format(REGGORA_INTEGRATION_KEY)
}

response = requests.get('https://sandbox.reggora.io/lender/review/reggora/documents/<document_id>', headers=headers)

The above command returns the PDF document file directly.