Files & Requests
Create a request
Create a new evidence or claims request.
POST
/
v1
/
requests
Create a request
curl --request POST \
--url https://api.slate.inc/files/v1/requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"priority": 123,
"triggerContexts": [
{
"templateType": "<string>"
}
],
"owner": "<string>",
"createdOn": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.slate.inc/files/v1/requests"
payload = {
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"priority": 123,
"triggerContexts": [{ "templateType": "<string>" }],
"owner": "<string>",
"createdOn": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
matterId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>',
priority: 123,
triggerContexts: [{templateType: '<string>'}],
owner: '<string>',
createdOn: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.slate.inc/files/v1/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.slate.inc/files/v1/requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'matterId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>',
'priority' => 123,
'triggerContexts' => [
[
'templateType' => '<string>'
]
],
'owner' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.slate.inc/files/v1/requests"
payload := strings.NewReader("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"priority\": 123,\n \"triggerContexts\": [\n {\n \"templateType\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.slate.inc/files/v1/requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"priority\": 123,\n \"triggerContexts\": [\n {\n \"templateType\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slate.inc/files/v1/requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"priority\": 123,\n \"triggerContexts\": [\n {\n \"templateType\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matterId": "<string>",
"owner": "<string>",
"status": "pending",
"exhibits": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"exhibitOrder": 123,
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"key": "<string>",
"templateIndex": 123,
"fileName": "<string>"
}
],
"templates": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>",
"templateReference": "<string>",
"index": 123,
"labelingMode": "numbers",
"templateContext": {
"debtor": "borrower"
},
"pendingDelete": true,
"triggerContext": {
"templateType": "<string>",
"lifecycleStep": "<string>",
"lineOfBusiness": "<string>"
}
}
],
"state": "<string>",
"crid": "<string>",
"priority": 123,
"createdOn": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"completedBy": "<string>",
"completedOn": "2023-11-07T05:31:56Z",
"rejectedBy": "<string>",
"rejectedOn": "2023-11-07T05:31:56Z",
"processingBy": "<string>",
"processingStartedOn": "2023-11-07T05:31:56Z",
"firmCode": "<string>",
"firmId": "<string>",
"workflowStatus": "draft",
"signatureRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qualityCheckRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signedFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signedOn": "2023-11-07T05:31:56Z",
"qcApprovedOn": "2023-11-07T05:31:56Z",
"requestedFields": [
{
"templateId": "<string>",
"fields": [
{
"name": "<string>",
"label": "<string>",
"required": true,
"type": "string",
"enumValues": [
"<string>"
],
"description": "<string>",
"displayed": true
}
]
}
],
"filledFields": [
{
"templateId": "<string>",
"fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"generatedFile": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": "<string>",
"status": "active",
"uploadStatus": "pending",
"fileName": "<string>",
"crid": "<string>",
"key": "<string>",
"description": "<string>",
"uploadedOn": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"creditorCreationDate": "2023-11-07T05:31:56Z",
"uploadedBy": "<string>",
"lastViewed": "2023-11-07T05:31:56Z",
"lastViewedBy": "<string>",
"lastDownloaded": "2023-11-07T05:31:56Z",
"lastDownloadedBy": "<string>",
"fileType": "<string>",
"metadata": {
"fileRequest": {
"totalSize": 123,
"outputDocuments": [
{
"fileSize": 123,
"isExhibit": true,
"pageOffset": 123
}
]
}
},
"fileAttributes": {
"application/pdf": {
"pageCount": 123,
"textOnlyPageCount": 123,
"imageOnlyPageCount": 123,
"mixedPageCount": 123,
"dpiMin": 123,
"dpiMax": 123
},
"sizeBytes": 123,
"contentType": "<string>"
},
"redactionSummary": {
"latestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latestStatus": "pending",
"count": 2,
"latestCreatedOn": "2023-11-07T05:31:56Z",
"latestErrorMessage": "<string>"
}
},
"notes": "<string>"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}Authorizations
Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.
Body
application/json
Available options:
pending, completed, rejected A single trigger context. Supported for backward compatibility; prefer triggerContexts. Combined with triggerContexts when both are supplied. At least one template type across the two is required.
Show child attributes
Show child attributes
One or more trigger contexts to build the file request from. Each resolves its matching templates; the request is created carrying the union across all of them.
Show child attributes
Show child attributes
Response
Request created
Available options:
pending, completed, rejected Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Deprecated: use firmId going forward. The snapshotted service firm code for the firm handling this matter, taken at creation time.
The snapshotted service firm UUID for the firm handling this matter, taken at creation time.
Where the document has reached across the whole workflow, which carries on after the request's own status is completed. A document is done once it has been both signed and reviewed, and workflows run those two steps in either order, so this is derived from those two facts rather than from a position in a sequence.
| Value | Meaning |
|---|---|
draft | The request is open and not yet approved. |
prepared | Approved, with the document saved to the CRID. Nothing downstream has started. |
awaiting_signature | Still unsigned, whether or not it has been reviewed. |
wet_ink_pending | Marked for wet-ink signing in a workflow where QC comes after signing, and the signed scan has not been uploaded yet. |
awaiting_qc | Signed, not yet reviewed. |
qc_rejected | Quality control rejected the document. |
signature_rejected | The signature request was rejected. |
completed | Signed and reviewed. |
rejected | The file request itself was rejected, deleted, or closed out. Terminal. |
Available options:
draft, prepared, awaiting_signature, wet_ink_pending, awaiting_qc, qc_rejected, signature_rejected, completed, rejected The signature request raised for this file request, once one exists. Use it with GET /v2/requests/{signatureRequestId} on the Signatures API.
The quality check request raised for this file request, once one exists. Use it with GET /v2/qc/requests/{qcrID} on the Quality Control API.
The signed document saved to the CRID, once Slate has created it. Its presence alone does not mean the workflow finished — read workflowStatus for that.
When the document was signed, by whichever route: an e-signature ceremony completing, a wet-ink mark where QC comes before signing, or a signed wet-ink scan being uploaded where QC comes after signing.
When quality control approved the document.
Show child attributes
Show child attributes
The effective value of every template field, resolved when the request is read: an override if one was set, otherwise the account's current value, otherwise the template's default. This is what the generated document will render.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Create a request
curl --request POST \
--url https://api.slate.inc/files/v1/requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"priority": 123,
"triggerContexts": [
{
"templateType": "<string>"
}
],
"owner": "<string>",
"createdOn": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.slate.inc/files/v1/requests"
payload = {
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"priority": 123,
"triggerContexts": [{ "templateType": "<string>" }],
"owner": "<string>",
"createdOn": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
matterId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>',
priority: 123,
triggerContexts: [{templateType: '<string>'}],
owner: '<string>',
createdOn: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.slate.inc/files/v1/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.slate.inc/files/v1/requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'matterId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>',
'priority' => 123,
'triggerContexts' => [
[
'templateType' => '<string>'
]
],
'owner' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.slate.inc/files/v1/requests"
payload := strings.NewReader("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"priority\": 123,\n \"triggerContexts\": [\n {\n \"templateType\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.slate.inc/files/v1/requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"priority\": 123,\n \"triggerContexts\": [\n {\n \"templateType\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slate.inc/files/v1/requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"priority\": 123,\n \"triggerContexts\": [\n {\n \"templateType\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matterId": "<string>",
"owner": "<string>",
"status": "pending",
"exhibits": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"exhibitOrder": 123,
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"key": "<string>",
"templateIndex": 123,
"fileName": "<string>"
}
],
"templates": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>",
"templateReference": "<string>",
"index": 123,
"labelingMode": "numbers",
"templateContext": {
"debtor": "borrower"
},
"pendingDelete": true,
"triggerContext": {
"templateType": "<string>",
"lifecycleStep": "<string>",
"lineOfBusiness": "<string>"
}
}
],
"state": "<string>",
"crid": "<string>",
"priority": 123,
"createdOn": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"completedBy": "<string>",
"completedOn": "2023-11-07T05:31:56Z",
"rejectedBy": "<string>",
"rejectedOn": "2023-11-07T05:31:56Z",
"processingBy": "<string>",
"processingStartedOn": "2023-11-07T05:31:56Z",
"firmCode": "<string>",
"firmId": "<string>",
"workflowStatus": "draft",
"signatureRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qualityCheckRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signedFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signedOn": "2023-11-07T05:31:56Z",
"qcApprovedOn": "2023-11-07T05:31:56Z",
"requestedFields": [
{
"templateId": "<string>",
"fields": [
{
"name": "<string>",
"label": "<string>",
"required": true,
"type": "string",
"enumValues": [
"<string>"
],
"description": "<string>",
"displayed": true
}
]
}
],
"filledFields": [
{
"templateId": "<string>",
"fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"generatedFile": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": "<string>",
"status": "active",
"uploadStatus": "pending",
"fileName": "<string>",
"crid": "<string>",
"key": "<string>",
"description": "<string>",
"uploadedOn": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"creditorCreationDate": "2023-11-07T05:31:56Z",
"uploadedBy": "<string>",
"lastViewed": "2023-11-07T05:31:56Z",
"lastViewedBy": "<string>",
"lastDownloaded": "2023-11-07T05:31:56Z",
"lastDownloadedBy": "<string>",
"fileType": "<string>",
"metadata": {
"fileRequest": {
"totalSize": 123,
"outputDocuments": [
{
"fileSize": 123,
"isExhibit": true,
"pageOffset": 123
}
]
}
},
"fileAttributes": {
"application/pdf": {
"pageCount": 123,
"textOnlyPageCount": 123,
"imageOnlyPageCount": 123,
"mixedPageCount": 123,
"dpiMin": 123,
"dpiMax": 123
},
"sizeBytes": 123,
"contentType": "<string>"
},
"redactionSummary": {
"latestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latestStatus": "pending",
"count": 2,
"latestCreatedOn": "2023-11-07T05:31:56Z",
"latestErrorMessage": "<string>"
}
},
"notes": "<string>"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}