Retry Document Generation

Re-run generation for a purchased document that failed or is pending.

/regulatory-documents/request/:request_id/documents/:document_id/retry

POST https://api.terminal.africa/v1/regulatory-documents/request/:request_id/documents/:document_id/retry

Does not charge the wallet again. Only available for automated documents in a retryable state (failed or pending).

Path Parameters

Name	Type	Description
request_id*	String	Document request id. e.g. DRQ-ABC1234567.
document_id*	String	Purchased document id. e.g. DOC-XYZ789.

Headers

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

No request body required.

200: OK Document generation retry started successfully

{
    "status": true,
    "message": "Document generation retry started successfully",
    "data": {
        "request_id": "DRQ-ABC1234567",
        "status": "processing",
        "purchased_documents": [
            {
                "type": "FDA",
                "name": "FDA Prior Notice",
                "document_id": "DOC-XYZ789",
                "document_url": "",
                "status": "pending",
                "paid": true,
                "amount": 1.67,
                "currency": "USD",
                "automated": true,
                "error": ""
            }
        ],
        "generation": {
            "pending": [
                {
                    "type": "FDA",
                    "document_id": "DOC-XYZ789",
                    "status": "pending"
                }
            ]
        }
    }
}

Tab 2

Common errors

Status	Message
404	Document not found for document_id - {id}
400	Document is not eligible for retry
400	Document generation has already completed