MUmuralpay
Documents

Get a document

Changed on

Returns the document details.

get/api/documents/{documentId}

Request

Path parameters

documentIdstring uuid required

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Response

Document returned successfully.

createdAtstring date-time required

Timestamp when the document record was created.

filenamestring required

Human-readable filename of the document.

idstring uuid required

Unique identifier for the document.

status'PENDING_UPLOAD' | 'UPLOADED' required

Current status of the document. PENDING_UPLOAD means the file has not yet been received; UPLOADED means the file is ready.

updatedAtstring date-time required

Timestamp when the document was last updated.

Changes

  • 65aadbefe527Revision changes
    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • info

      added the non-success response with the status