List Document Requests

Fetch paginated document requests for the authenticated user.

/regulatory-documents/requests

GET https://api.terminal.africa/v1/regulatory-documents/requests

Query Parameters

Name	Type	Description
page	Number	Page number. Defaults to 1.
perPage	Number	Records per page. Defaults to 20. Maximum 100.
status	String	Filter by status. Single value or comma-separated. e.g. draft, completed, draft,processing.
source	String	Filter by source. shipment or invoice.
shipment_id	String	Filter by Terminal shipment id.
tracking_number	String	Filter by carrier tracking number.
search	String	Search across request_id, shipment_id, and tracking_number.
generated	Boolean	true = completed with at least one generated document URL. false = not fully generated.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type*	String	Set value to application/json

200: OK Document requests retrieved successfully

{
    "status": true,
    "message": "Document requests retrieved successfully",
    "data": {
        "requests": [
            {
                "request_id": "DRQ-ABC1234567",
                "user_id": "USR-1234567890",
                "source": "invoice",
                "status": "draft",
                "tracking_number": "1Z999AA10123456784",
                "file_url": "https://cdn.example.com/invoices/inv-001.pdf",
                "currency": "USD",
                "carrier_slug": "dhl-ng",
                "carrier_logo": "https://cdn.terminal.africa/carriers/dhl.png",
                "pickup_address": {
                    "first_name": "Ada",
                    "last_name": "Obi",
                    "line1": "1 Marina",
                    "city": "Lagos",
                    "state": "Lagos",
                    "country": "NG",
                    "zip": "100001"
                },
                "receiver_address": {
                    "first_name": "John",
                    "last_name": "Doe",
                    "line1": "123 Main St",
                    "city": "New York",
                    "state": "NY",
                    "country": "US",
                    "zip": "10001"
                },
                "item_count": 2,
                "available_documents": [
                    {
                        "type": "FDA",
                        "name": "FDA Prior Notice",
                        "amount": 1.67,
                        "currency": "USD",
                        "free": false,
                        "automated": true,
                        "logo": "https://cdn.terminal.africa/regulatory/fda.png"
                    }
                ],
                "available_document_count": 1,
                "purchased_documents": [],
                "purchased_document_count": 0,
                "generated_document_count": 0,
                "pending_document_count": 0,
                "delivery_country": "US",
                "payment": {},
                "created_at": "2026-09-01T10:00:00.000Z",
                "updated_at": "2026-09-01T10:00:00.000Z"
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 20,
            "total": 1,
            "pageCount": 1,
            "hasNextPage": false,
            "hasPrevPage": false,
            "nextPage": null,
            "prevPage": null
        }
    }
}