| POST | /Document/UploadByUrl | Uploads a file by url | Uploads a file using a url |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| File | model | object | Yes | The file infomation |
| Folder | model | string | No | Upload the file and put in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API.Allowable Values
|
| MatterNumber | model | string | No | Matter/Ref Number |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientReference | model | string | No | The reference of the document on client side |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | model | string | Yes | File Name |
| FileType | model | string | Yes | File type of fileAllowable Values
|
| FileUrl | model | string | Yes | Url to download retrieve file data |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | Document reference, used for document access |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Document/UploadByUrl HTTP/1.1
Host: api.securedsigning.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"File":{"ClientReference":"String","Name":"String","FileType":"String","FileUrl":"String"},"Folder":"String","MatterNumber":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Reference":"String"}