You are here: Mandates > Mandate APIs > Upload Mandate Document

Upload Mandate Document

If you want to upload a representation of the mandate, for example if you have a signed paper mandate, have scanned it and saved it as a PDF, you can upload this to Nuapay so that it is linked to the required mandate.

This can then be viewed later if you use the Retrieve Mandate Document call.

 

REQUEST
API Reference Upload Mandate Document
Usage You may reference a mandate in any status
Method POST
URI /schemes/{CS_ID}/mandates/{MANDATE_ID}/document
File Content Types

application/pdf

image/jpeg

image/gif

The following optional argument may be provided:

fileName

Use if you want to apply a specific file name to the binary file; if not provided the file name of the uploaded file is used.

Format: String (max 39 characters)

RESPONSE

A successful request will return a 200 OK response code.

If you do not see a 200, see the HTTP Response Codes section of the API Reference to assist you to troubleshoot the issue.

The following data is returned:

id A resource identifier that uniquely identifies the uploaded document
uri A resolvable path containing the resource identifier of the mandate and linked binary document.